Class: Hirb::Helpers::Table

Inherits:
Object
  • Object
show all
Defined in:
lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb,
lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table/filters.rb,
lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table/resizer.rb

Overview

derived from gist.github.com/72234

Defined Under Namespace

Modules: Filters Classes: Resizer, TooManyFieldsForWidthError

Constant Summary collapse

BORDER_LENGTH =

“ | ” and “-+-” are the borders

3
MIN_FIELD_LENGTH = 
3

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rows, options = {}) ⇒ Table

Returns a new instance of Table.

Raises:

  • (ArgumentError) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 122

def initialize(rows, options={})
  raise ArgumentError, "Table must be an array of hashes or array of arrays" unless rows.is_a?(Array) &&
    (rows[0].is_a?(Hash) or rows[0].is_a?(Array) or rows.empty?)
  @options = {:description=>true, :filters=>{}, :change_fields=>{}, :escape_special_chars=>true,
    :filter_any=>Helpers::Table.filter_any, :resize=>true}.merge(options)
  @fields = set_fields(rows)
  @rows = set_rows(rows)
  @headers = set_headers
  if @options[:number]
    @headers[:hirb_number] = "number"
    @fields.unshift :hirb_number
  end
  Helpers::Table.last_table = self
end

Class Attribute Details

.filter_any ⇒ Object

Boolean which sets the default for :filter_any option.



114
115
116
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 114

def filter_any
  @filter_any
end

.filter_classes ⇒ Object

A hash which maps a cell value’s class to a filter. This serves to set a default filter per field if all of its values are a class in this hash. By default, Array values are comma joined and Hashes are inspected. See the :filter_any option to apply this filter per value.



112
113
114
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 112

def filter_classes
  @filter_classes
end

.last_table ⇒ Object

Holds last table object created



116
117
118
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 116

def last_table
  @last_table
end

Instance Attribute Details

#field_lengths ⇒ Object

:stopdoc:



121
122
123
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 121

def field_lengths
  @field_lengths
end

#fields ⇒ Object

:stopdoc:



121
122
123
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 121

def fields
  @fields
end

#max_fields ⇒ Object

:stopdoc:



121
122
123
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 121

def max_fields
  @max_fields
end

#width ⇒ Object

:stopdoc:



121
122
123
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 121

def width
  @width
end

Class Method Details

.render(rows, options = {}) ⇒ Object

Main method which returns a formatted table.

Options:

:fields

An array which overrides the default fields and can be used to indicate field order.

:headers

A hash of fields and their header names. Fields that aren’t specified here default to their name. When set to false, headers are hidden. Can also be an array but only for array rows.

:max_fields

A hash of fields and their maximum allowed lengths. Maximum length can also be a percentage of the total width (decimal less than one). When a field exceeds it’s maximum then it’s truncated and has a … appended to it. Fields that aren’t specified have no maximum.

:max_width

The maximum allowed width of all fields put together including field borders. Only valid when :resize is true. Default is Hirb::View.width.

:resize

Resizes table to display all columns in allowed :max_width. Default is true. Setting this false will display the full length of each field.

:number

When set to true, numbers rows by adding a :hirb_number column as the first column. Default is false.

:change_fields

A hash to change old field names to new field names. This can also be an array of new names but only for array rows. This is useful when wanting to change auto-generated keys to more user-friendly names i.e. for array rows.

:filters

A hash of fields and their filters, applied to every row in a field. A filter can be a proc, an instance method applied to the field value or a Filters method. Also see the filter_classes attribute below.

:header_filter

A filter, like one in :filters, that is applied to all headers after the :headers option.

:filter_any

When set to true, any cell defaults to being filtered by its class in :filter_classes. Default Hirb::Helpers::Table.filter_any().

:filter_classes

Hash which maps classes to filters. Default is Hirb::Helpers::Table.filter_classes().

:vertical

When set to true, renders a vertical table using Hirb::Helpers::VerticalTable. Default is false.

:all_fields

When set to true, renders fields in all rows. Valid only in rows that are hashes. Default is false.

:description

When set to true, renders row count description at bottom. Default is true.

:escape_special_chars

When set to true, escapes special characters n,t,r so they don’t disrupt tables. Default is false for vertical tables and true for anything else.

Examples:

Hirb::Helpers::Table.render [[1,2], [2,3]]
Hirb::Helpers::Table.render [[1,2], [2,3]], :max_fields=>{0=>10}, :header_filter=>:capitalize
Hirb::Helpers::Table.render [['a',1], ['b',2]], :change_fields=>%w{letters numbers}, :max_fields=>{'numbers'=>0.4}
Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}]
Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}], :headers=>{:weight=>"Weight(lbs)"}
Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}], :filters=>{:age=>[:to_f]}



100
101
102
103
104
105
106
107
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 100

def render(rows, options={})
  options[:vertical] ? Helpers::VerticalTable.render(rows, options) :
  new(rows, options).render
rescue TooManyFieldsForWidthError
  $stderr.puts "", "** Error: Too many fields for the current width. Configure your width " +
    "and/or fields to avoid this error. Defaulting to a vertical table. **"
  Helpers::VerticalTable.render(rows, options)
end

Instance Method Details

#actual_width ⇒ Object 



260
261
262
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 260

def actual_width
  @actual_width ||= self.width - (@fields.size * BORDER_LENGTH + 1)
end

#array_to_indices_hash(array) ⇒ Object

Converts an array to a hash mapping a numerical index to its array value.



318
319
320
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 318

def array_to_indices_hash(array)
  array.inject({}) {|hash,e|  hash[hash.size] = e; hash }
end

#call_filter(filter, val) ⇒ Object 



303
304
305
306
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 303

def call_filter(filter, val)
  filter.is_a?(Proc) ? filter.call(val) :
    val.respond_to?(Array(filter)[0]) ? val.send(*filter) : Filters.send(filter, val)
end

#default_field_lengths ⇒ Object

find max length for each field; start with the headers



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 269

def default_field_lengths
  field_lengths = @headers ? @headers.inject({}) {|h,(k,v)| h[k] = String.size(v); h} :
    @fields.inject({}) {|h,e| h[e] = 1; h }
  @rows.each do |row|
    @fields.each do |field|
      len = String.size(row[field])
      field_lengths[field] = len if len > field_lengths[field].to_i
    end
  end
  field_lengths
end

#enforce_field_constraints ⇒ Object 



250
251
252
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 250

def enforce_field_constraints
  max_fields.each {|k,max| @field_lengths[k] = max if @field_lengths[k].to_i > max }
end

#filter_values(rows) ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 291

def filter_values(rows)
  @filter_classes = Helpers::Table.filter_classes.merge @options[:filter_classes] || {}
  set_filter_defaults(rows) unless @options[:filter_any]
  rows.map {|row|
    @fields.inject({}) {|new_row,f|
      (filter = @options[:filters][f]) || (@options[:filter_any] && (filter = @filter_classes[row[f].class]))
      new_row[f] = filter ? call_filter(filter, row[f]) : row[f]
      new_row
    }
  }
end

#format_cell(value, cell_width) ⇒ Object 



219
220
221
222
223
224
225
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 219

def format_cell(value, cell_width)
  text = String.size(value) > cell_width ?
    (
    (cell_width < 5) ? String.slice(value, 0, cell_width) : String.slice(value, 0, cell_width - 3) + '...'
    ) : value
  String.ljust(text, cell_width)
end

#render ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 188

def render
  body = []
  unless @rows.length == 0
    setup_field_lengths
    body += render_header
    body += render_rows
    body += render_footer
  end
  body << render_table_description if @options[:description]
  body.join("\n")
end

#render_border ⇒ Object 



215
216
217
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 215

def render_border
  '+-' + @fields.map {|f| '-' * @field_lengths[f] }.join('-+-') + '-+'
end

#render_footer ⇒ Object 



204
205
206
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 204

def render_footer
  [render_border]
end

#render_header ⇒ Object 



200
201
202
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 200

def render_header
  @headers ? render_table_header : [render_border]
end

#render_rows ⇒ Object 



227
228
229
230
231
232
233
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 227

def render_rows
  @rows.map do |row|
    row = '| ' + @fields.map {|f|
      format_cell(row[f], @field_lengths[f])
    }.join(' | ') + ' |'
  end
end

#render_table_description ⇒ Object 



235
236
237
238
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 235

def render_table_description
  (@rows.length == 0) ? "0 rows in set" :
    "#{@rows.length} #{@rows.length == 1 ? 'row' : 'rows'} in set"
end

#render_table_header ⇒ Object 



208
209
210
211
212
213
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 208

def render_table_header
  title_row = '| ' + @fields.map {|f|
    format_cell(@headers[f], @field_lengths[f])
  }.join(' | ') + ' |'
  [render_border, title_row, render_border]
end

#set_fields(rows) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 137

def set_fields(rows)
  @options[:change_fields] = array_to_indices_hash(@options[:change_fields]) if @options[:change_fields].is_a?(Array)
  return @options[:fields].dup if @options[:fields]

  fields = if rows[0].is_a?(Hash)
    keys = @options[:all_fields] ? rows.map {|e| e.keys}.flatten.uniq : rows[0].keys
    keys.sort {|a,b| a.to_s <=> b.to_s}
  else
    rows[0].is_a?(Array) ? (0..rows[0].length - 1).to_a : []
  end

  @options[:change_fields].each do |oldf, newf|
    (index = fields.index(oldf)) && fields[index] = newf
  end
  fields
end

#set_filter_defaults(rows) ⇒ Object 



281
282
283
284
285
286
287
288
289
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 281

def set_filter_defaults(rows)
  @filter_classes.each do |klass, filter|
    @fields.each {|field|
      if rows.all? {|r| r[field].class == klass }
        @options[:filters][field] ||= filter
      end
    }
  end
end

#set_headers ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 174

def set_headers
  headers = @fields.inject({}) {|h,e| h[e] = e.to_s; h}
  if @options.has_key?(:headers)
    headers = @options[:headers].is_a?(Hash) ? headers.merge(@options[:headers]) :
      (@options[:headers].is_a?(Array) ? array_to_indices_hash(@options[:headers]) : @options[:headers])
  end
  if @options[:header_filter]
    headers.each {|k,v|
      headers[k] = call_filter(@options[:header_filter], v)
    }
  end
  headers
end

#set_rows(rows) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 154

def set_rows(rows)
  rows = Array(rows)
  if rows[0].is_a?(Array)
    rows = rows.inject([]) {|new_rows, row|
      new_rows << array_to_indices_hash(row)
    }
  end
  @options[:change_fields].each do |oldf, newf|
    rows.each {|e| e[newf] = e.delete(oldf) if e.key?(oldf) }
  end
  rows = filter_values(rows)
  rows.each_with_index {|e,i| e[:hirb_number] = (i + 1).to_s} if @options[:number]
  deleted_callbacks = Array(@options[:delete_callbacks]).map {|e| "#{e}_callback" }
  (methods.grep(/_callback$/).map {|e| e.to_s} - deleted_callbacks).sort.each do |meth|
    rows = send(meth, rows, @options.dup)
  end
  validate_values(rows)
  rows
end

#setup_field_lengths ⇒ Object 



240
241
242
243
244
245
246
247
248
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 240

def setup_field_lengths
  @field_lengths = default_field_lengths
  if @options[:resize]
    raise TooManyFieldsForWidthError if @fields.size > self.actual_width.to_f / MIN_FIELD_LENGTH
    Resizer.resize!(self)
  else
    enforce_field_constraints
  end
end

#validate_values(rows) ⇒ Object 



308
309
310
311
312
313
314
315
 
# File 'lib/bbcloud/vendor/hirb-0.3.4/lib/hirb/helpers/table.rb', line 308

def validate_values(rows)
  rows.each {|row|
    @fields.each {|f|
      row[f] = row[f].to_s || ''
      row[f] = row[f].gsub(/(\t|\r|\n)/) {|e| e.dump.gsub('"','') } if @options[:escape_special_chars]
    }
  }
end