Class: Chef::Knife::Core::TextFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/knife/core/text_formatter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data, ui) ⇒ TextFormatter

Returns a new instance of TextFormatter.



27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/chef/knife/core/text_formatter.rb', line 27

def initialize(data, ui)
  @ui = ui
  @data = if data.respond_to?(:display_hash)
            data.display_hash
          elsif data.is_a?(Array)
            data
          elsif data.respond_to?(:to_hash)
            data.to_hash
          else
            data
          end
end

Instance Attribute Details

#dataObject (readonly)

Returns the value of attribute data.



24
25
26
# File 'lib/chef/knife/core/text_formatter.rb', line 24

def data
  @data
end

#uiObject (readonly)

Returns the value of attribute ui.



25
26
27
# File 'lib/chef/knife/core/text_formatter.rb', line 25

def ui
  @ui
end

Instance Method Details

#formatted_dataObject



40
41
42
# File 'lib/chef/knife/core/text_formatter.rb', line 40

def formatted_data
  @formatted_data ||= text_format(data)
end

#is_singleton(value) ⇒ Object



79
80
81
# File 'lib/chef/knife/core/text_formatter.rb', line 79

def is_singleton(value)
  !(value.is_a?(Array) || value.respond_to?(:keys))
end

#text_format(data) ⇒ Object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/chef/knife/core/text_formatter.rb', line 44

def text_format(data)
  buffer = ""

  if data.respond_to?(:keys)
    justify_width = data.keys.map { |k| k.to_s.size }.max.to_i + 1
    data.sort.each do |key, value|
      # key: ['value'] should be printed as key: value
      if value.is_a?(Array) && value.size == 1 && is_singleton(value[0])
        value = value[0]
      end
      if is_singleton(value)
        # Strings are printed as key: value.
        justified_key = ui.color("#{key}:".ljust(justify_width), :cyan)
        buffer << "#{justified_key} #{value}\n"
      else
        # Arrays and hashes get indented on their own lines.
        buffer << ui.color("#{key}:\n", :cyan)
        lines = text_format(value).split("\n")
        lines.each { |line| buffer << "  #{line}\n" }
      end
    end
  elsif data.is_a?(Array)
    data.each_index do |index|
      item = data[index]
      buffer << text_format(data[index])
      # Separate items with newlines if it's an array of hashes or an
      # array of arrays
      buffer << "\n" if !is_singleton(data[index]) && index != data.size - 1
    end
  else
    buffer << "#{data}\n"
  end
  buffer
end