Module: ZTK::Report::List

Included in:
ZTK::Report
Defined in:
lib/ztk/report/list.rb

Overview

Report List Functionality

Instance Method Summary (collapse)

Instance Method Details

- (OpenStruct) list(dataset, headers, &block)

Displays data in a key-value list style.

+-------------------------------------------------------------------+
|                      PROVIDER: Cucumber::Chef::Provider::Vagrant  |
|                            ID: default                            |
|                         STATE: aborted                            |
|                      USERNAME: vagrant                            |
|                    IP ADDRESS: 127.0.0.1                          |
|                          PORT: 2222                               |
|               CHEF-SERVER API: http://127.0.0.1:4000              |
|             CHEF-SERVER WEBUI: http://127.0.0.1:4040              |
|      CHEF-SERVER DEFAULT USER: admin                              |
|  CHEF-SERVER DEFAULT PASSWORD: p@ssw0rd1                          |
+-------------------------------------------------------------------+

Parameters:

  • dataset (Array<Object>, Object) —

    A single object or an array of objects for which we want to generate a report

  • headers (Array) —

    An array of headers used for ordering the output.

Returns:

  • (OpenStruct) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ztk/report/list.rb', line 26

def list(dataset, headers, &block)
  !block_given? and log_and_raise(ReportError, "You must supply a block!")
  headers.nil? and log_and_raise(ReportError, "Headers can not be nil!")
  dataset.nil? and log_and_raise(ReportError, "Dataset can not be nil!")

  rows = Array.new
  max_lengths = OpenStruct.new
  headers = headers.map(&:to_s).map(&:downcase).map(&:to_sym)

  if dataset.is_a?(Array)
    dataset.each do |data|
      rows << block.call(data)
    end
  else
    rows << block.call(dataset)
  end
  rows.compact!

  if rows.count > 0
    max_key_length = headers.collect{ |header| header.to_s.length }.max
    max_value_length = rows.collect{ |row| headers.collect{ |header| (row.send(:table) rescue row)[header].to_s.length }.max }.max

    width = (max_key_length + max_value_length + 2 + 2 + 2)

    rows.each do |row|
      config.ui.stdout.puts("+#{"-" * width}+")
      headers.each do |header|
        entry_line = format_entry(header, max_key_length, (row.send(:table) rescue row)[header], max_value_length)
        config.ui.stdout.puts(entry_line)
      end
    end
    config.ui.stdout.puts("+#{"-" * width}+")
    OpenStruct.new(:rows => rows, :max_key_length => max_key_length, :max_value_length => max_value_length, :width => width)
  else
    OpenStruct.new(:rows => rows, :max_key_length => 0, :max_value_length => 0, :width => 0)
  end
end