cucumber 3.1.2 → 8.0.0

data/lib/cucumber/multiline_argument/data_table.rb

@@ -3,7 +3,6 @@
 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
@@ -28,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:
+      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
@@ -48,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
 
@@ -71,18 +72,18 @@ module Cucumber
           @rows << row
         end
 
-        def eof
-        end
+        def eof; end
       end
 
-      NULL_CONVERSIONS = Hash.new({ :strict => false, :proc => lambda { |cell_value| cell_value } }).freeze
+      NULL_CONVERSIONS = Hash.new(strict: false, proc: ->(cell_value) { cell_value }).freeze
 
-      # @param data [Core::Ast::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!
+      # @param data [Core::Test::DataTable] the data for the table
+      # @param conversion_procs [Hash] see map_column
+      # @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.is_a? 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
@@ -107,13 +108,6 @@ module Cucumber
         @ast_table.location
       end
 
-      # Creates a copy of this table, inheriting any column and header mappings
-      # 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)
-      end
-
       # Returns a new, transposed table. Example:
       #
       #   | a | 7 | 4 |
@@ -126,7 +120,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
@@ -141,7 +135,7 @@ module Cucumber
       #
       #   [{'a' => '2', 'b' => '3', 'sum' => '5'}, {'a' => '7', 'b' => '9', 'sum' => '16'}]
       #
-      # Use #map_column! to specify how values in a column are converted.
+      # Use #map_column to specify how values in a column are converted.
       #
       def hashes
         @hashes ||= build_hashes
@@ -160,8 +154,8 @@ module Cucumber
       #
       def symbolic_hashes
         @symbolic_hashes ||=
-          self.hashes.map do |string_hash|
-            Hash[string_hash.map { |a, b| [symbolize_key(a), b] }]
+          hashes.map do |string_hash|
+            string_hash.transform_keys { |a| symbolize_key(a) }
           end
       end
 
@@ -179,8 +173,9 @@ 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
@@ -199,8 +194,8 @@ module Cucumber
         end
       end
 
-      def column_names #:nodoc:
-        @col_names ||= cell_matrix[0].map(&:value)
+      def column_names # :nodoc:
+        @column_names ||= cell_matrix[0].map(&:value)
       end
 
       def rows
@@ -209,7 +204,7 @@ module Cucumber
         end
       end
 
-      def each_cells_row(&proc) #:nodoc:
+      def each_cells_row(&proc) # :nodoc:
         cells_rows.each(&proc)
       end
 
@@ -228,7 +223,8 @@ module Cucumber
         pattern.match(header_to_match)
       end
 
-      # Redefines the table headers. This makes it possible to use
+      # Returns a new Table where the headers are redefined.
+      # 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
@@ -244,57 +240,44 @@ module Cucumber
       # 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.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.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.map_headers('Address' => 'ADDRESS') { |header| header.downcase }
       #   table.hashes.keys
       #   # => ['phone number', 'ADDRESS']
       #
-      def map_headers!(mappings = {}, &block)
-        # TODO: Remove this method for 2.0
-        clear_cache!
-        @header_mappings = mappings
-        @header_conversion_proc = block
-      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)
+        self.class.new(Core::Test::DataTable.new(raw), @conversion_procs.dup, mappings, block)
       end
 
+      # Returns a new Table with an additional column mapping.
+      #
       # 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 = 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
       #
-      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
-
-      # 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
@@ -312,8 +295,8 @@ module Cucumber
       # 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.
+      # 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 <em>not</em> raised for surplus columns. An
@@ -346,15 +329,20 @@ module Cucumber
 
       class Different < StandardError
         attr_reader :table
+
         def initialize(table)
           @table = table
           super("Tables were not identical:\n#{table}")
         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)
@@ -362,66 +350,90 @@ module Cucumber
         hash
       end
 
-      def index(cells) #:nodoc:
+      def index(cells) # :nodoc:
         cells_rows.index(cells)
       end
 
-      def verify_column(column_name) #:nodoc:
-        raise %{The column named "#{column_name}" does not exist} unless raw[0].include?(column_name)
+      def verify_column(column_name) # :nodoc:
+        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
+      def verify_table_width(width) # :nodoc:
+        raise %(The table must have exactly #{width} columns) unless raw[0].size == width
       end
 
-      def has_text?(text) #:nodoc:
+      # 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|
+      def cells_rows # :nodoc:
+        @rows ||= cell_matrix.map do |cell_row| # rubocop:disable Naming/MemoizedInstanceVariableName
           Cells.new(self, cell_row)
         end
       end
 
-      def headers #:nodoc:
+      def headers # :nodoc:
         raw.first
       end
 
-      def header_cell(col) #:nodoc:
+      def header_cell(col) # :nodoc:
         cells_rows[0][col]
       end
 
       attr_reader :cell_matrix
 
-      def col_width(col) #:nodoc:
+      def col_width(col) # :nodoc:
         columns[col].__send__(:width)
       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
+      def to_s(options = {}) # :nodoc:
+        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:
+      def columns # :nodoc:
         @columns ||= cell_matrix.transpose.map do |cell_row|
           Cells.new(self, cell_row)
         end
@@ -441,19 +453,23 @@ module Cucumber
       def build_hashes
         convert_headers!
         convert_columns!
-        cells_rows[1..-1].map(&:to_hash)
+        cells_rows[1..].map(&:to_hash)
       end
 
-      def create_cell_matrix(ast_table) #:nodoc:
+      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
         end
       end
 
-      def convert_columns! #:nodoc:
+      def convert_columns! # :nodoc:
         @conversion_procs.each do |column_name, conversion_proc|
           verify_column(column_name) if conversion_proc[:strict]
         end
@@ -461,13 +477,13 @@ module Cucumber
         cell_matrix.transpose.each do |col|
           column_name = col[0].value
           conversion_proc = @conversion_procs[column_name][:proc]
-          col[1..-1].each do |cell|
+          col[1..].each do |cell|
             cell.value = conversion_proc.call(cell.value)
           end
         end
       end
 
-      def convert_headers! #:nodoc:
+      def convert_headers! # :nodoc:
         header_cells = cell_matrix[0]
 
         if @header_conversion_proc
@@ -476,22 +492,22 @@ module Cucumber
         end
 
         @header_mappings.each_pair do |pre, post|
-          mapped_cells = header_cells.select { |cell| pre === cell.value }
+          mapped_cells = header_cells.select { |cell| pre.is_a?(Regexp) ? cell.value.match?(pre) : cell.value == pre }
           raise "No headers matched #{pre.inspect}" if mapped_cells.empty?
           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
+      def clear_cache! # :nodoc:
+        @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
+      def ensure_table(table_or_array) # :nodoc:
+        return table_or_array if DataTable == table_or_array.class
+
         DataTable.from(table_or_array)
       end
 
@@ -500,18 +516,20 @@ module Cucumber
       end
 
       # Represents a row of cells or columns of cells
-      class Cells #:nodoc:
+      class Cells # :nodoc:
         include Enumerable
         include Cucumber::Gherkin::Formatter::Escaping
 
         attr_reader :exception
 
         def initialize(table, cells)
-          @table, @cells = table, cells
+          @table = table
+          @cells = cells
         end
 
         def accept(visitor)
           return if Cucumber.wants_to_quit
+
           each do |cell|
             visitor.visit_table_cell(cell)
           end
@@ -519,15 +537,15 @@ module Cucumber
         end
 
         # For testing only
-        def to_sexp #:nodoc:
+        def to_sexp # :nodoc:
           [:row, line, *@cells.map(&:to_sexp)]
         end
 
-        def to_hash #:nodoc:
-          @to_hash ||= @table.to_hash(self)
+        def to_hash # :nodoc:
+          @to_hash ||= @table.cells_to_hash(self)
         end
 
-        def value(n) #:nodoc:
+        def value(n) # :nodoc:
           self[n].value
         end
 
@@ -558,24 +576,26 @@ module Cucumber
         end
       end
 
-      class Cell #:nodoc:
+      class Cell # :nodoc:
         attr_reader :line, :table
         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
@@ -583,17 +603,17 @@ module Cucumber
         end
 
         # For testing only
-        def to_sexp #:nodoc:
+        def to_sexp # :nodoc:
           [:cell, @value]
         end
       end
 
-      class SurplusCell < Cell #:nodoc:
+      class SurplusCell < Cell # :nodoc:
         def status
           :comment
         end
 
-        def ==(_o)
+        def ==(_other)
           true
         end
 

data/lib/cucumber/multiline_argument/doc_string.rb

@@ -4,7 +4,7 @@ module Cucumber
   module MultilineArgument
     class DocString < SimpleDelegator
       def append_to(array)
-        array << self.to_s
+        array << to_s
       end
     end
   end

data/lib/cucumber/multiline_argument.rb

@@ -12,10 +12,10 @@ module Cucumber
       end
 
       def from(argument, location = nil, content_type = nil)
-        location ||= Core::Ast::Location.of_caller
+        location ||= Core::Test::Location.of_caller
         case argument
         when String
-          builder.doc_string(Core::Ast::DocString.new(argument, content_type, location))
+          builder.doc_string(Core::Test::DocString.new(argument, content_type))
         when Array
           location = location.on_line(argument.first.line..argument.last.line)
           builder.data_table(argument.map(&:cells), location)
@@ -52,11 +52,9 @@ module Cucumber
     end
 
     class None
-      def append_to(array)
-      end
+      def append_to(array); end
 
-      def describe_to(visitor)
-      end
+      def describe_to(visitor); end
     end
   end
 end

data/lib/cucumber/platform.rb

@@ -7,9 +7,9 @@ require 'cucumber/core/platform'
 
 module Cucumber
   unless defined?(Cucumber::VERSION)
-    VERSION       = File.read(File.expand_path('../version', __FILE__))
-    BINARY        = File.expand_path(File.dirname(__FILE__) + '/../../bin/cucumber')
-    LIBDIR        = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+    VERSION       = File.read(File.expand_path('version', __dir__)).strip
+    BINARY        = File.expand_path("#{File.dirname(__FILE__)}/../../bin/cucumber")
+    LIBDIR        = File.expand_path("#{File.dirname(__FILE__)}/../../lib")
     RAILS         = defined?(Rails)
     RUBY_BINARY   = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
     RUBY          = defined? RUBY_VERSION
@@ -18,8 +18,8 @@ module Cucumber
       attr_accessor :use_full_backtrace
 
       # @private
-      def file_mode(m, encoding = 'UTF-8')
-        "#{m}:#{encoding}"
+      def file_mode(mode, encoding = 'UTF-8')
+        "#{mode}:#{encoding}"
       end
     end
     self.use_full_backtrace = false