Class: Cucumber::MultilineArgument::DataTable

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Core::Ast::DescribesItself, Enumerable
Defined in:
lib/cucumber/multiline_argument/data_table.rb

Overview

Step Definitions that match a plain text Step with a multiline argument table will receive it as an instance of Table. A Table object holds the data of a table parsed from a feature file and lets you access and manipulate the data in different ways.

For example:

Given I have:
  | a | b |
  | c | d |

And a matching StepDefinition:

Given /I have:/ do |table|
  data = table.raw
end

This will store [['a', 'b'], ['c', 'd']] in the data variable.

Defined Under Namespace

Classes: Builder, Cell, Cells, Different, SurplusCell

Constant Summary collapse

NULL_CONVERSIONS = 
Hash.new({ :strict => false, :proc => lambda{ |cell_value| cell_value } }).freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data, conversion_procs = NULL_CONVERSIONS.dup, header_mappings = {}, header_conversion_proc = nil) ⇒ DataTable

Returns a new instance of DataTable.

Parameters:

  • data (Core::Ast::DataTable) —

    the data for the table

  • conversion_procs (Hash) (defaults to: NULL_CONVERSIONS.dup) —

    see map_columns!

  • header_mappings (Hash) (defaults to: {}) —

    see map_headers!

  • header_conversion_proc (Proc) (defaults to: nil) —

    see map_headers!

Raises:

  • (ArgumentError) 


91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 91

def initialize(data, conversion_procs = NULL_CONVERSIONS.dup, header_mappings = {}, header_conversion_proc = nil)
  raise ArgumentError, "data must be a Core::Ast::DataTable" unless data.kind_of? Core::Ast::DataTable
  ast_table = data
  # Verify that it's square
  ast_table.transpose
  @cell_matrix = create_cell_matrix(ast_table)
  @conversion_procs = conversion_procs
  @header_mappings = header_mappings
  @header_conversion_proc = header_conversion_proc
  @ast_table = ast_table
end

Instance Attribute Details

#file ⇒ Object

Returns the value of attribute file.



54
55
56
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 54

def file
  @file
end

Class Method Details

.default_arg_name ⇒ Object

:nodoc:



57
58
59
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 57

def self.default_arg_name #:nodoc:
  "table"
end

.from(data, location = Core::Ast::Location.of_caller) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 62

def from(data, location = Core::Ast::Location.of_caller)
  case data
  when Array
    from_array(data, location)
  when String
    parse(data, location)
  else
    raise ArgumentError, "expected data to be a String or an Array."
  end
end

Instance Method Details

#append_to(array) ⇒ Object 



103
104
105
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 103

def append_to(array)
  array << self
end

#cell_matrix ⇒ Object

:nodoc:



438
439
440
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 438

def cell_matrix #:nodoc:
  @cell_matrix
end

#cells_rows ⇒ Object

:nodoc:



424
425
426
427
428
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 424

def cells_rows #:nodoc:
  @rows ||= cell_matrix.map do |cell_row|
    Cells.new(self, cell_row)
  end
end

#col_width(col) ⇒ Object

:nodoc:



442
443
444
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 442

def col_width(col) #:nodoc:
  columns[col].__send__(:width)
end

#column_names ⇒ Object

:nodoc:



187
188
189
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 187

def column_names #:nodoc:
  @col_names ||= cell_matrix[0].map { |cell| cell.value }
end

#columns ⇒ Object

:nodoc:



468
469
470
471
472
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 468

def columns #:nodoc:
  @columns ||= cell_matrix.transpose.map do |cell_row|
    Cells.new(self, cell_row)
  end
end

#description_for_visitors ⇒ Object 



464
465
466
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 464

def description_for_visitors
  :legacy_table
end

#diff!(other_table, options = {}) ⇒ Object

Compares other_table to self. If other_table contains columns and/or rows that are not in self, new columns/rows are added at the relevant positions, marking the cells in those rows/columns as surplus. Likewise, if other_table lacks columns and/or rows that are present in self, these are marked as missing.

surplus and missing cells are recognised by formatters and displayed so that it’s easy to read the differences.

Cells that are different, but look identical (for example the boolean true and the string “true”) are converted to their Object#inspect representation and preceded with (i) - to make it easier to identify where the difference actually is.

Since all tables that are passed to StepDefinitions always have String objects in their cells, you may want to use #map_column! before calling #diff!. You can use #map_column! on either of the tables.

A Different error is raised if there are missing rows or columns, or surplus rows. An error is not raised for surplus columns. An error is not raised for misplaced (out of sequence) columns. Whether to raise or not raise can be changed by setting values in options to true or false:

  • missing_row : Raise on missing rows (defaults to true)

  • surplus_row : Raise on surplus rows (defaults to true)

  • missing_col : Raise on missing columns (defaults to true)

  • surplus_col : Raise on surplus columns (defaults to false)

  • misplaced_col : Raise on misplaced columns (defaults to false)

The other_table argument can be another Table, an Array of Array or an Array of Hash (similar to the structure returned by #hashes).

Calling this method is particularly useful in Then steps that take a Table argument, if you want to compare that table to some actual values.

Raises:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 321

def diff!(other_table, options={})
  options = {
    :missing_row   => true,
    :surplus_row   => true,
    :missing_col   => true,
    :surplus_col   => false,
    :misplaced_col => false
  }.merge(options)

  other_table = ensure_table(other_table)
  other_table.convert_headers!
  other_table.convert_columns!
  ensure_green!

  convert_headers!
  convert_columns!

  original_width = cell_matrix[0].length
  other_table_cell_matrix = pad!(other_table.cell_matrix)
  padded_width = cell_matrix[0].length

  missing_col = cell_matrix[0].detect{|cell| cell.status == :undefined}
  surplus_col = padded_width > original_width
  misplaced_col = cell_matrix[0] != other_table.cell_matrix[0]

  require_diff_lcs
  cell_matrix.extend(Diff::LCS)
  changes = cell_matrix.diff(other_table_cell_matrix).flatten

  inserted = 0
  missing  = 0

  row_indices = Array.new(other_table_cell_matrix.length) {|n| n}

  last_change = nil
  missing_row_pos = nil
  insert_row_pos  = nil

  changes.each do |change|
    if(change.action == '-')
      missing_row_pos = change.position + inserted
      cell_matrix[missing_row_pos].each{|cell| cell.status = :undefined}
      row_indices.insert(missing_row_pos, nil)
      missing += 1
    else # '+'
      insert_row_pos = change.position + missing
      inserted_row = change.element
      inserted_row.each{|cell| cell.status = :comment}
      cell_matrix.insert(insert_row_pos, inserted_row)
      row_indices[insert_row_pos] = nil
      inspect_rows(cell_matrix[missing_row_pos], inserted_row) if last_change && last_change.action == '-'
      inserted += 1
    end
    last_change = change
  end

  other_table_cell_matrix.each_with_index do |other_row, i|
    row_index = row_indices.index(i)
    row = cell_matrix[row_index] if row_index
    if row
      (original_width..padded_width).each do |col_index|
        surplus_cell = other_row[col_index]
        row[col_index].value = surplus_cell.value if row[col_index]
      end
    end
  end

  clear_cache!
  should_raise =
    missing_row_pos && options[:missing_row] ||
    insert_row_pos  && options[:surplus_row] ||
    missing_col     && options[:missing_col] ||
    surplus_col     && options[:surplus_col] ||
    misplaced_col   && options[:misplaced_col]
  raise Different.new(self) if should_raise
end

#dup ⇒ Object

Creates a copy of this table, inheriting any column and header mappings registered with #map_column! and #map_headers!.



114
115
116
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 114

def dup
  self.class.new(Core::Ast::DataTable.new(raw, location), @conversion_procs.dup, @header_mappings.dup, @header_conversion_proc)
end

#each_cells_row(&proc) ⇒ Object

:nodoc:



197
198
199
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 197

def each_cells_row(&proc) #:nodoc:
  cells_rows.each(&proc)
end

#has_text?(text) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


420
421
422
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 420

def has_text?(text) #:nodoc:
  raw.flatten.compact.detect{|cell_value| cell_value.index(text)}
end

#hashes ⇒ Object

Converts this table into an Array of Hash where the keys of each Hash are the headers in the table. For example, a Table built from the following plain text:

| a | b | sum |
| 2 | 3 | 5   |
| 7 | 9 | 16  |

Gets converted into the following:

[{'a' => '2', 'b' => '3', 'sum' => '5'}, {'a' => '7', 'b' => '9', 'sum' => '16'}]

Use #map_column! to specify how values in a column are converted.



147
148
149
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 147

def hashes
  @hashes ||= build_hashes
end

#header_cell(col) ⇒ Object

:nodoc:



434
435
436
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 434

def header_cell(col) #:nodoc:
  cells_rows[0][col]
end

#headers ⇒ Object

:nodoc:



430
431
432
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 430

def headers #:nodoc:
  raw.first
end

#index(cells) ⇒ Object

:nodoc:



408
409
410
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 408

def index(cells) #:nodoc:
  cells_rows.index(cells)
end

#map_column(column_name, strict = true, &conversion_proc) ⇒ Object

Returns a new Table with an additional column mapping. See #map_column!



279
280
281
282
283
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 279

def map_column(column_name, strict=true, &conversion_proc)
  conversion_procs = @conversion_procs.dup
  conversion_procs[column_name.to_s] = { :strict => strict, :proc => conversion_proc }
  self.class.new(Core::Ast::DataTable.new(raw, location), conversion_procs, @header_mappings.dup, @header_conversion_proc)
end

#map_column!(column_name, strict = true, &conversion_proc) ⇒ Object

Change how #hashes converts column values. The column_name argument identifies the column and conversion_proc performs the conversion for each cell in that column. If strict is true, an error will be raised if the column named column_name is not found. If strict is false, no error will be raised. Example:

Given /^an expense report for (.*) with the following posts:$/ do |table|
  posts_table.map_column!('amount') { |a| a.to_i }
  posts_table.hashes.each do |post|
    # post['amount'] is a Fixnum, rather than a String
  end
end



272
273
274
275
276
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 272

def map_column!(column_name, strict=true, &conversion_proc)
  # TODO: Remove this method for 2.0
  @conversion_procs[column_name.to_s] = { :strict => strict, :proc => conversion_proc }
  self
end

#map_headers(mappings = {}, &block) ⇒ Object

Returns a new Table where the headers are redefined. See #map_headers!



256
257
258
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 256

def map_headers(mappings={}, &block)
  self.class.new(Core::Ast::DataTable.new(raw, location), @conversion_procs.dup, mappings, block)
end

#map_headers!(mappings = {}, &block) ⇒ Object

Redefines the table headers. This makes it possible to use prettier and more flexible header names in the features. The keys of mappings are Strings or regular expressions (anything that responds to #=== will work) that may match column headings in the table. The values of mappings are desired names for the columns.

Example:

| Phone Number | Address |
| 123456       | xyz     |
| 345678       | abc     |

A StepDefinition receiving this table can then map the columns with both Regexp and String:

table.map_headers!(/phone( number)?/i => :phone, 'Address' => :address)
table.hashes
# => [{:phone => '123456', :address => 'xyz'}, {:phone => '345678', :address => 'abc'}]

You may also pass in a block if you wish to convert all of the headers:

table.map_headers! { |header| header.downcase }
table.hashes.keys
# => ['phone number', 'address']

When a block is passed in along with a hash then the mappings in the hash take precendence:

table.map_headers!('Address' => 'ADDRESS') { |header| header.downcase }
table.hashes.keys
# => ['phone number', 'ADDRESS']



248
249
250
251
252
253
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 248

def map_headers!(mappings={}, &block)
  # TODO: Remove this method for 2.0
  clear_cache!
  @header_mappings = mappings
  @header_conversion_proc = block
end

#match(pattern) ⇒ Object

Matches pattern against the header row of the table. This is used especially for argument transforms.

Example:

| column_1_name | column_2_name |
| x             | y             |

table.match(/table:column_1_name,column_2_name/) #=> non-nil

Note: must use ‘table:’ prefix on match



211
212
213
214
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 211

def match(pattern)
  header_to_match = "table:#{headers.join(',')}"
  pattern.match(header_to_match)
end

#raw ⇒ Object

Gets the raw data of this table. For example, a Table built from the following plain text:

| a | b |
| c | d |

gets converted into the following:

[['a', 'b'], ['c', 'd']]



179
180
181
182
183
184
185
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 179

def raw
  cell_matrix.map do |row|
    row.map do |cell|
      cell.value
    end
  end
end

#rows ⇒ Object 



191
192
193
194
195
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 191

def rows
  hashes.map do |hash|
    hash.values_at *headers
  end
end

#rows_hash ⇒ Object

Converts this table into a Hash where the first column is used as keys and the second column is used as values

| a | 2 |
| b | 3 |

Gets converted into the following:

{'a' => '2', 'b' => '3'}

The table must be exactly two columns wide



163
164
165
166
167
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 163

def rows_hash
  return @rows_hash if @rows_hash
  verify_table_width(2)
  @rows_hash = self.transpose.hashes[0]
end

#to_hash(cells) ⇒ Object

:nodoc:



398
399
400
401
402
403
404
405
406
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 398

def to_hash(cells) #:nodoc:
  hash = Hash.new do |hash, key|
    hash[key.to_s] if key.is_a?(Symbol)
  end
  column_names.each_with_index do |column_name, column_index|
    hash[column_name] = cells.value(column_index)
  end
  hash
end

#to_json(*args) ⇒ Object 



474
475
476
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 474

def to_json(*args)
  raw.to_json(*args)
end

#to_s(options = {}) ⇒ Object

:nodoc:



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 446

def to_s(options = {}) #:nodoc:
  # TODO: factor out this code so we don't depend on such a big lump of old cruft
  require 'cucumber/formatter/pretty'
  require 'cucumber/formatter/legacy_api/adapter'
  options = {:color => true, :indent => 2, :prefixes => TO_S_PREFIXES}.merge(options)
  io = StringIO.new

  c = Cucumber::Term::ANSIColor.coloring?
  Cucumber::Term::ANSIColor.coloring = options[:color]
  formatter = Formatter::Pretty.new(nil, io, options)
  formatter.instance_variable_set('@indent', options[:indent])
  Formatter::LegacyApi::Ast::MultilineArg.for(self).accept(Formatter::Fanout.new([formatter]))
  Cucumber::Term::ANSIColor.coloring = c
  io.rewind
  s = "\n" + io.read + (" " * (options[:indent] - 2))
  s
end

#to_step_definition_arg ⇒ Object 



107
108
109
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 107

def to_step_definition_arg
  dup
end

#transpose ⇒ Object

Returns a new, transposed table. Example:

| a | 7 | 4 |
| b | 9 | 2 |

Gets converted into the following:

| a | b |
| 7 | 9 |
| 4 | 2 |



129
130
131
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 129

def transpose
  self.class.new(Core::Ast::DataTable.new(raw.transpose, location), @conversion_procs.dup, @header_mappings.dup, @header_conversion_proc)
end

#verify_column(column_name) ⇒ Object

:nodoc:



412
413
414
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 412

def verify_column(column_name) #:nodoc:
  raise %{The column named "#{column_name}" does not exist} unless raw[0].include?(column_name)
end

#verify_table_width(width) ⇒ Object

:nodoc:



416
417
418
 
# File 'lib/cucumber/multiline_argument/data_table.rb', line 416

def verify_table_width(width) #:nodoc:
  raise %{The table must have exactly #{width} columns} unless raw[0].size == width
end