cucumber 3.0.0.pre.2 → 4.0.0.rc.5

data/lib/cucumber/multiline_argument/data_table.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 require 'cucumber/gherkin/data_table_parser'
 require 'cucumber/gherkin/formatter/escaping'
-require 'cucumber/core/ast/describes_itself'
 require 'cucumber/multiline_argument/data_table/diff_matrices'
 
 module Cucumber
@@ -27,19 +27,21 @@ module Cucumber
     # This will store <tt>[['a', 'b'], ['c', 'd']]</tt> in the <tt>data</tt> variable.
     #
     class DataTable
-      include Core::Ast::DescribesItself
-
       def self.default_arg_name #:nodoc:
         'table'
       end
 
+      def describe_to(visitor, *args)
+        visitor.legacy_table(self, *args)
+      end
+
       class << self
-        def from(data, location = Core::Ast::Location.of_caller)
+        def from(data)
           case data
           when Array
-            from_array(data, location)
+            from_array(data)
           when String
-            parse(data, location)
+            parse(data)
           else
             raise ArgumentError, 'expected data to be a String or an Array.'
           end
@@ -47,15 +49,15 @@ module Cucumber
 
         private
 
-        def parse(text, location = Core::Ast::Location.of_caller)
+        def parse(text)
           builder = Builder.new
           parser = Cucumber::Gherkin::DataTableParser.new(builder)
           parser.parse(text)
-          from_array(builder.rows, location)
+          from_array(builder.rows)
         end
 
-        def from_array(data, location = Core::Ast::Location.of_caller)
-          new Core::Ast::DataTable.new(data, location)
+        def from_array(data)
+          new Core::Test::DataTable.new(data)
         end
       end
 
@@ -70,19 +72,17 @@ module Cucumber
           @rows << row
         end
 
-        def eof
-        end
+        def eof; end
       end
 
+      NULL_CONVERSIONS = Hash.new(strict: false, proc: ->(cell_value) { cell_value }).freeze
 
-      NULL_CONVERSIONS = Hash.new({ :strict => false, :proc => lambda{ |cell_value| cell_value } }).freeze
-
-      # @param data [Core::Ast::DataTable] the data for the table
+      # @param data [Core::Test::DataTable] the data for the table
       # @param conversion_procs [Hash] see map_columns!
       # @param header_mappings [Hash] see map_headers!
       # @param header_conversion_proc [Proc] see map_headers!
       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
+        raise ArgumentError, 'data must be a Core::Test::DataTable' unless data.is_a? Core::Test::DataTable
         ast_table = data
         # Verify that it's square
         ast_table.transpose
@@ -111,7 +111,7 @@ module Cucumber
       # registered with #map_column! and #map_headers!.
       #
       def dup
-        self.class.new(Core::Ast::DataTable.new(raw, location), @conversion_procs.dup, @header_mappings.dup, @header_conversion_proc)
+        self.class.new(Core::Test::DataTable.new(raw), @conversion_procs.dup, @header_mappings.dup, @header_conversion_proc)
       end
 
       # Returns a new, transposed table. Example:
@@ -126,7 +126,7 @@ module Cucumber
       #   | 4 | 2 |
       #
       def transpose
-        self.class.new(Core::Ast::DataTable.new(raw.transpose, location), @conversion_procs.dup, @header_mappings.dup, @header_conversion_proc)
+        self.class.new(Core::Test::DataTable.new(raw.transpose), @conversion_procs.dup, @header_mappings.dup, @header_conversion_proc)
       end
 
       # Converts this table into an Array of Hash where the keys of each
@@ -159,8 +159,10 @@ module Cucumber
       #   [{:foo => '2', :bar => '3', :foo_bar => '5'}, {:foo => '7', :bar => '9', :foo_bar => '16'}]
       #
       def symbolic_hashes
-        @header_conversion_proc = lambda { |h| symbolize_key(h) }
-        @symbolic_hashes ||= build_hashes
+        @symbolic_hashes ||=
+          hashes.map do |string_hash|
+            Hash[string_hash.map { |a, b| [symbolize_key(a), b] }]
+          end
       end
 
       # Converts this table into a Hash where the first column is
@@ -178,7 +180,7 @@ module Cucumber
       def rows_hash
         return @rows_hash if @rows_hash
         verify_table_width(2)
-        @rows_hash = self.transpose.hashes[0]
+        @rows_hash = transpose.hashes[0]
       end
 
       # Gets the raw data of this table. For example, a Table built from
@@ -193,14 +195,12 @@ module Cucumber
       #
       def raw
         cell_matrix.map do |row|
-          row.map do |cell|
-            cell.value
-          end
+          row.map(&:value)
         end
       end
 
       def column_names #:nodoc:
-        @col_names ||= cell_matrix[0].map { |cell| cell.value }
+        @column_names ||= cell_matrix[0].map(&:value)
       end
 
       def rows
@@ -260,7 +260,7 @@ module Cucumber
       #   table.hashes.keys
       #   # => ['phone number', 'ADDRESS']
       #
-      def map_headers!(mappings={}, &block)
+      def map_headers!(mappings = {}, &block)
         # TODO: Remove this method for 2.0
         clear_cache!
         @header_mappings = mappings
@@ -268,8 +268,8 @@ module Cucumber
       end
 
       # Returns a new Table where the headers are redefined. See #map_headers!
-      def map_headers(mappings={}, &block)
-        self.class.new(Core::Ast::DataTable.new(raw, location), @conversion_procs.dup, mappings, block)
+      def map_headers(mappings = {}, &block)
+        self.class.new(Core::Test::DataTable.new(raw), @conversion_procs.dup, mappings, block)
       end
 
       # Change how #hashes converts column values. The +column_name+ argument identifies the column
@@ -284,17 +284,17 @@ module Cucumber
       #     end
       #   end
       #
-      def map_column!(column_name, strict=true, &conversion_proc)
+      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 }
+        @conversion_procs[column_name.to_s] = { strict: strict, proc: conversion_proc }
         self
       end
 
       # Returns a new Table with an additional column mapping. See #map_column!
-      def map_column(column_name, strict=true, &conversion_proc)
+      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)
+        conversion_procs[column_name.to_s] = { strict: strict, proc: conversion_proc }
+        self.class.new(Core::Test::DataTable.new(raw), conversion_procs, @header_mappings.dup, @header_conversion_proc)
       end
 
       # Compares +other_table+ to self. If +other_table+ contains columns
@@ -333,7 +333,7 @@ module Cucumber
       # Calling this method is particularly useful in <tt>Then</tt> steps that take
       # a Table argument, if you want to compare that table to some actual values.
       #
-      def diff!(other_table, options={})
+      def diff!(other_table, options = {})
         other_table = ensure_table(other_table)
         other_table.convert_headers!
         other_table.convert_columns!
@@ -352,9 +352,13 @@ module Cucumber
         end
       end
 
-      def to_hash(cells) #:nodoc:
-        hash = Hash.new do |hash, key|
-          hash[key.to_s] if key.is_a?(Symbol)
+      def to_hash
+        cells_rows.map { |cells| cells.map(&:value) }
+      end
+
+      def cells_to_hash(cells) #:nodoc:
+        hash = Hash.new do |hash_inner, key|
+          hash_inner[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)
@@ -367,19 +371,21 @@ module Cucumber
       end
 
       def verify_column(column_name) #:nodoc:
-        raise %{The column named "#{column_name}" does not exist} unless raw[0].include?(column_name)
+        raise %(The column named "#{column_name}" does not exist) unless raw[0].include?(column_name)
       end
 
       def verify_table_width(width) #:nodoc:
-        raise %{The table must have exactly #{width} columns} unless raw[0].size == width
+        raise %(The table must have exactly #{width} columns) unless raw[0].size == width
       end
 
-      def has_text?(text) #:nodoc:
-        raw.flatten.compact.detect{|cell_value| cell_value.index(text)}
+      # TODO: remove the below function if it's not actually being used.
+      # Nothing else in this repo calls it.
+      def text?(text) #:nodoc:
+        raw.flatten.compact.detect { |cell_value| cell_value.index(text) }
       end
 
       def cells_rows #:nodoc:
-        @rows ||= cell_matrix.map do |cell_row|
+        @rows ||= cell_matrix.map do |cell_row| # rubocop:disable Naming/MemoizedInstanceVariableName
           Cells.new(self, cell_row)
         end
       end
@@ -399,26 +405,48 @@ module Cucumber
       end
 
       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]
-        runtime = Struct.new(:configuration).new(Configuration.new)
-        formatter = Formatter::Pretty.new(runtime, 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
+        indentation = options.key?(:indent) ? options[:indent] : 2
+        prefixes = options.key?(:prefixes) ? options[:prefixes] : TO_S_PREFIXES
+        DataTablePrinter.new(self, indentation, prefixes).to_s
       end
 
-      def description_for_visitors
-        :legacy_table
+      class DataTablePrinter #:nodoc:
+        include Cucumber::Gherkin::Formatter::Escaping
+        attr_reader :data_table, :indentation, :prefixes
+        private :data_table, :indentation, :prefixes
+
+        def initialize(data_table, indentation, prefixes)
+          @data_table = data_table
+          @indentation = indentation
+          @prefixes = prefixes
+        end
+
+        def to_s
+          leading_row = "\n"
+          end_indentation = indentation - 2
+          trailing_row = "\n" + (' ' * end_indentation)
+          table_rows = data_table.cell_matrix.map { |row| format_row(row) }
+          leading_row + table_rows.join("\n") + trailing_row
+        end
+
+        private
+
+        def format_row(row)
+          row_start = (' ' * indentation) + '| '
+          row_end = '|'
+          cells = row.map.with_index do |cell, i|
+            format_cell(cell, data_table.col_width(i))
+          end
+          row_start + cells.join('| ') + row_end
+        end
+
+        def format_cell(cell, col_width)
+          cell_text = escape_cell(cell.value.to_s)
+          cell_text_width = cell_text.unpack('U*').length
+          padded_text = cell_text + (' ' * (col_width - cell_text_width))
+          prefix = prefixes[cell.status]
+          "#{prefix}#{padded_text} "
+        end
       end
 
       def columns #:nodoc:
@@ -441,14 +469,16 @@ module Cucumber
       def build_hashes
         convert_headers!
         convert_columns!
-        cells_rows[1..-1].map do |row|
-          row.to_hash
-        end
+        cells_rows[1..-1].map(&:to_hash)
       end
 
       def create_cell_matrix(ast_table) #:nodoc:
         ast_table.raw.map do |raw_row|
-          line = raw_row.line rescue -1
+          line = begin
+                   raw_row.line
+                 rescue StandardError
+                   -1
+                 end
           raw_row.map do |raw_cell|
             Cell.new(raw_cell, self, line)
           end
@@ -473,27 +503,25 @@ module Cucumber
         header_cells = cell_matrix[0]
 
         if @header_conversion_proc
-          header_values = header_cells.map { |cell| cell.value } - @header_mappings.keys
+          header_values = header_cells.map(&:value) - @header_mappings.keys
           @header_mappings = @header_mappings.merge(Hash[*header_values.zip(header_values.map(&@header_conversion_proc)).flatten])
         end
 
         @header_mappings.each_pair do |pre, post|
-          mapped_cells = header_cells.select { |cell| pre === cell.value }
+          mapped_cells = header_cells.reject { |cell| cell.value.match(pre).nil? }
           raise "No headers matched #{pre.inspect}" if mapped_cells.empty?
-          raise "#{mapped_cells.length} headers matched #{pre.inspect}: #{mapped_cells.map { |c| c.value }.inspect}" if mapped_cells.length > 1
+          raise "#{mapped_cells.length} headers matched #{pre.inspect}: #{mapped_cells.map(&:value).inspect}" if mapped_cells.length > 1
           mapped_cells[0].value = post
-          if @conversion_procs.key?(pre)
-            @conversion_procs[post] = @conversion_procs.delete(pre)
-          end
+          @conversion_procs[post] = @conversion_procs.delete(pre) if @conversion_procs.key?(pre)
         end
       end
 
       def clear_cache! #:nodoc:
-        @hashes = @rows_hash = @col_names = @rows = @columns = nil
+        @hashes = @rows_hash = @column_names = @rows = @columns = nil
       end
 
       def ensure_table(table_or_array) #:nodoc:
-        return table_or_array if DataTable === table_or_array
+        return table_or_array if DataTable == table_or_array.class
         DataTable.from(table_or_array)
       end
 
@@ -509,7 +537,8 @@ module Cucumber
         attr_reader :exception
 
         def initialize(table, cells)
-          @table, @cells = table, cells
+          @table = table
+          @cells = cells
         end
 
         def accept(visitor)
@@ -522,11 +551,11 @@ module Cucumber
 
         # For testing only
         def to_sexp #:nodoc:
-          [:row, line, *@cells.map{|cell| cell.to_sexp}]
+          [:row, line, *@cells.map(&:to_sexp)]
         end
 
         def to_hash #:nodoc:
-          @to_hash ||= @table.to_hash(self)
+          @to_hash ||= @table.cells_to_hash(self)
         end
 
         def value(n) #:nodoc:
@@ -556,7 +585,7 @@ module Cucumber
         end
 
         def width
-          map{|cell| cell.value ? escape_cell(cell.value.to_s).unpack('U*').length : 0}.max
+          map { |cell| cell.value ? escape_cell(cell.value.to_s).unpack('U*').length : 0 }.max
         end
       end
 
@@ -565,19 +594,21 @@ module Cucumber
         attr_accessor :status, :value
 
         def initialize(value, table, line)
-          @value, @table, @line = value, table, line
+          @value = value
+          @table = table
+          @line = line
         end
 
         def inspect!
           @value = "(i) #{value.inspect}"
         end
 
-        def ==(o)
-          SurplusCell === o || value == o.value
+        def ==(other)
+          SurplusCell == other.class || value == other.value
         end
 
-        def eql?(o)
-          self == o
+        def eql?(other)
+          self == other
         end
 
         def hash
@@ -595,7 +626,7 @@ module Cucumber
           :comment
         end
 
-        def ==(_o)
+        def ==(_other)
           true
         end
 

data/lib/cucumber/multiline_argument/data_table/diff_matrices.rb

@@ -26,7 +26,7 @@ module Cucumber
           @original_header = other_table_cell_matrix[0]
           pad_and_match
           @padded_width = cell_matrix[0].length
-          @row_indices = Array.new(other_table_cell_matrix.length) {|n| n}
+          @row_indices = Array.new(other_table_cell_matrix.length) { |n| n }
         end
 
         # Pads two cell matrices to same column width and matches columns according to header value.
@@ -38,19 +38,19 @@ module Cucumber
           matched_cols = []
 
           header_values.each_with_index do |v, i|
-            mapped_index = unmatched_cols.index{|unmapped_col| unmapped_col.first == v}
+            mapped_index = unmatched_cols.index { |unmapped_col| unmapped_col.first == v }
             if mapped_index
               matched_cols << unmatched_cols.delete_at(mapped_index)
             else
               mark_as_missing(cols[i])
-              empty_col = ensure_2d(other_table_cell_matrix).collect {SurplusCell.new(nil, self, -1)}
+              empty_col = ensure_2d(other_table_cell_matrix).collect { SurplusCell.new(nil, self, -1) }
               empty_col.first.value = v
               matched_cols << empty_col
             end
           end
 
           unmatched_cols.each do
-            empty_col = cell_matrix.collect {SurplusCell.new(nil, self, -1)}
+            empty_col = cell_matrix.collect { SurplusCell.new(nil, self, -1) }
             cols << empty_col
           end
 
@@ -68,7 +68,6 @@ module Cucumber
           array[0].is_a?(Array) ? array : [array]
         end
 
-
         def perform_diff
           inserted    = 0
           missing     = 0
@@ -77,13 +76,13 @@ module Cucumber
           changes.each do |change|
             if change.action == '-'
               @missing_row_pos = change.position + inserted
-              cell_matrix[missing_row_pos].each{|cell| cell.status = :undefined}
+              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}
+              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 == '-'
@@ -109,7 +108,6 @@ module Cucumber
           end
         end
 
-
         def fill_in_missing_values
           other_table_cell_matrix.each_with_index do |other_row, i|
             row_index = row_indices.index(i)
@@ -123,7 +121,7 @@ module Cucumber
         end
 
         def missing_col
-          cell_matrix[0].find{|cell| cell.status == :undefined}
+          cell_matrix[0].find { |cell| cell.status == :undefined }
         end
 
         def surplus_col
@@ -134,11 +132,10 @@ module Cucumber
           cell_matrix[0] != original_header
         end
 
-
         def raise_error
           table = DataTable.from([[]])
           table.instance_variable_set :@cell_matrix, cell_matrix
-          raise Different.new(table) if should_raise?
+          raise Different, table if should_raise?
         end
 
         def should_raise?
@@ -155,4 +152,3 @@ module Cucumber
     end
   end
 end
-