Class: Hirb::Helpers::Table

Inherits:
Object
  • Object
show all
Defined in:
lib/hirb/helpers/table.rb,
lib/hirb/helpers/table/filters.rb,
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
CHARS = 
{
  :top => {:left => '+', :center => '+', :right => '+', :horizontal => '-',
    :vertical => {:outside => '|', :inside => '|'} },
  :middle => {:left => '+', :center => '+', :right => '+', :horizontal => '-'},
  :bottom => {:left => '+', :center => '+', :right => '+', :horizontal => '-',
    :vertical => {:outside => '|', :inside => '|'} }
}

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) 


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/hirb/helpers/table.rb', line 165

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)
  @fields = @fields.select {|e| e.to_s[@options[:grep_fields]] } if @options[:grep_fields]
  @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.



152
153
154
 
# File 'lib/hirb/helpers/table.rb', line 152

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.



150
151
152
 
# File 'lib/hirb/helpers/table.rb', line 150

def filter_classes
  @filter_classes
end

.last_table ⇒ Object

Holds last table object created



154
155
156
 
# File 'lib/hirb/helpers/table.rb', line 154

def last_table
  @last_table
end

Instance Attribute Details

#field_lengths ⇒ Object

:stopdoc:



164
165
166
 
# File 'lib/hirb/helpers/table.rb', line 164

def field_lengths
  @field_lengths
end

#fields ⇒ Object

:stopdoc:



164
165
166
 
# File 'lib/hirb/helpers/table.rb', line 164

def fields
  @fields
end

#max_fields ⇒ Object

:stopdoc:



164
165
166
 
# File 'lib/hirb/helpers/table.rb', line 164

def max_fields
  @max_fields
end

#width ⇒ Object

:stopdoc:



164
165
166
 
# File 'lib/hirb/helpers/table.rb', line 164

def width
  @width
end

Class Method Details

.choose_style(rows, options) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/hirb/helpers/table.rb', line 125

def choose_style(rows, options)
  case options[:style]
  when :vertical
    Helpers::VerticalTable.render(rows, options)
  when :unicode
    Helpers::UnicodeTable.render(rows, options)
  when :tab
    Helpers::TabTable.render(rows, options)
  when :markdown
    Helpers::MarkdownTable.render(rows, options)
  when :simple
    new(rows, options).render
  else
    options[:vertical] ? Helpers::VerticalTable.render(rows, options) :
      options[:unicode]  ? Helpers::UnicodeTable.render(rows, options) :
      options[:tab]      ? Helpers::TabTable.render(rows, options) :
      options[:markdown] ? Helpers::MarkdownTable.render(rows, options) :
      new(rows, options).render
  end
end

.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.

:grep_fields

A regexp that selects which fields to display. By default this is not set and applied.

: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().

: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.

:vertical

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

:unicode

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

:tab

When set to true, renders a tab-delimited table using Hirb::Helpers::TabTable. Default is false.

:style

Choose style of table: :simple, :vertical, :unicode, :tab or :markdown. :simple just uses the default render. Other values map to a capitalized namespace in format Hirb::Helpers::OptionValTable.

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]}
Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}], :style=> :simple}



117
118
119
120
121
122
123
 
# File 'lib/hirb/helpers/table.rb', line 117

def render(rows, options={})
  choose_style(rows, options)
rescue TooManyFieldsForWidthError
  $stderr.puts "", "** Hirb Warning: 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 



312
313
314
 
# File 'lib/hirb/helpers/table.rb', line 312

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.



371
372
373
 
# File 'lib/hirb/helpers/table.rb', line 371

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

#call_filter(filter, val) ⇒ Object 



356
357
358
359
 
# File 'lib/hirb/helpers/table.rb', line 356

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

#chars ⇒ Object 



159
160
161
 
# File 'lib/hirb/helpers/table.rb', line 159

def chars
  self.class.const_get(:CHARS)
end

#default_field_lengths ⇒ Object

find max length for each field; start with the headers



322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/hirb/helpers/table.rb', line 322

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 



301
302
303
 
# File 'lib/hirb/helpers/table.rb', line 301

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 



344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/hirb/helpers/table.rb', line 344

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 



270
271
272
273
274
275
276
 
# File 'lib/hirb/helpers/table.rb', line 270

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

#format_values(values) ⇒ Object 



266
267
268
 
# File 'lib/hirb/helpers/table.rb', line 266

def format_values(values)
  @fields.map {|field| format_cell(values[field], @field_lengths[field]) }
end

#render ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/hirb/helpers/table.rb', line 232

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(which) ⇒ Object 



259
260
261
262
263
264
 
# File 'lib/hirb/helpers/table.rb', line 259

def render_border(which)
  chars[which][:left] + chars[which][:horizontal] +
    @fields.map {|f| chars[which][:horizontal] * @field_lengths[f] }.
    join(chars[which][:horizontal] + chars[which][:center] + chars[which][:horizontal]) +
    chars[which][:horizontal] + chars[which][:right]
end

#render_footer ⇒ Object 



248
249
250
 
# File 'lib/hirb/helpers/table.rb', line 248

def render_footer
  [render_border(:bottom)]
end

#render_header ⇒ Object 



244
245
246
 
# File 'lib/hirb/helpers/table.rb', line 244

def render_header
  @headers ? render_table_header : [render_border(:top)]
end

#render_rows ⇒ Object 



278
279
280
281
282
283
284
 
# File 'lib/hirb/helpers/table.rb', line 278

def render_rows
  @rows.map do |row|
    chars[:bottom][:vertical][:outside] + ' ' +
      format_values(row).join(' ' + chars[:bottom][:vertical][:inside] + ' ') +
      ' ' + chars[:bottom][:vertical][:outside]
  end
end

#render_table_description ⇒ Object 



286
287
288
289
 
# File 'lib/hirb/helpers/table.rb', line 286

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 



252
253
254
255
256
257
 
# File 'lib/hirb/helpers/table.rb', line 252

def render_table_header
  title_row = chars[:top][:vertical][:outside] + ' ' +
    format_values(@headers).join(' ' + chars[:top][:vertical][:inside] +' ') +
    ' ' + chars[:top][:vertical][:outside]
  [render_border(:top), title_row, render_border(:middle)]
end

#set_fields(rows) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/hirb/helpers/table.rb', line 181

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 



334
335
336
337
338
339
340
341
342
 
# File 'lib/hirb/helpers/table.rb', line 334

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 



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/hirb/helpers/table.rb', line 218

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 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/hirb/helpers/table.rb', line 198

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 



291
292
293
294
295
296
297
298
299
 
# File 'lib/hirb/helpers/table.rb', line 291

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 



361
362
363
364
365
366
367
368
 
# File 'lib/hirb/helpers/table.rb', line 361

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