cucumber 2.99.0 → 3.0.0

data/lib/cucumber/multiline_argument/data_table.rb

@@ -1,7 +1,9 @@
+# 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
   module MultilineArgument
@@ -25,38 +27,10 @@ module Cucumber
     # This will store <tt>[['a', 'b'], ['c', 'd']]</tt> in the <tt>data</tt> variable.
     #
     class DataTable
-      class Different < StandardError
-        def initialize(table)
-          super("Tables were not identical:\n#{table}")
-        end
-      end
-
-      class Builder
-        attr_reader :rows
-
-        def initialize
-          @rows = []
-        end
-
-        def row(row)
-          @rows << row
-        end
-
-        def eof
-        end
-      end
-
-      include Enumerable
       include Core::Ast::DescribesItself
-      extend Forwardable
-
-      NULL_CONVERSIONS = Hash.new({ :strict => false, :proc => lambda{ |cell_value| cell_value } }).freeze
-
-      attr_accessor :file
-      def_delegator :@ast_table, :location
 
       def self.default_arg_name #:nodoc:
-        "table"
+        'table'
       end
 
       class << self
@@ -67,11 +41,12 @@ module Cucumber
           when String
             parse(data, location)
           else
-            raise ArgumentError, "expected data to be a String or an Array."
+            raise ArgumentError, 'expected data to be a String or an Array.'
           end
         end
 
         private
+
         def parse(text, location = Core::Ast::Location.of_caller)
           builder = Builder.new
           parser = Cucumber::Gherkin::DataTableParser.new(builder)
@@ -84,13 +59,30 @@ module Cucumber
         end
       end
 
+      class Builder
+        attr_reader :rows
+
+        def initialize
+          @rows = []
+        end
+
+        def row(row)
+          @rows << row
+        end
+
+        def eof
+        end
+      end
+
+
+      NULL_CONVERSIONS = Hash.new({ :strict => false, :proc => lambda{ |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!
       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::Ast::DataTable' unless data.is_a? Core::Ast::DataTable
         ast_table = data
         # Verify that it's square
         ast_table.transpose
@@ -109,6 +101,12 @@ module Cucumber
         dup
       end
 
+      attr_accessor :file
+
+      def location
+        @ast_table.location
+      end
+
       # Creates a copy of this table, inheriting any column and header mappings
       # registered with #map_column! and #map_headers!.
       #
@@ -161,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 ||=
+          self.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
@@ -336,80 +336,22 @@ module Cucumber
       # a Table argument, if you want to compare that table to some actual values.
       #
       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
-        @cell_matrix, other_table_cell_matrix = pad_and_match(@cell_matrix, 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
+        DiffMatrices.new(cell_matrix, other_table.cell_matrix, options).call
+      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
+      class Different < StandardError
+        attr_reader :table
+        def initialize(table)
+          @table = table
+          super("Tables were not identical:\n#{table}")
         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
 
       def to_hash(cells) #:nodoc:
@@ -452,9 +394,7 @@ module Cucumber
         cells_rows[0][col]
       end
 
-      def cell_matrix #:nodoc:
-        @cell_matrix
-      end
+      attr_reader :cell_matrix
 
       def col_width(col) #:nodoc:
         columns[col].__send__(:width)
@@ -469,12 +409,13 @@ module Cucumber
 
         c = Cucumber::Term::ANSIColor.coloring?
         Cucumber::Term::ANSIColor.coloring = options[:color]
-        formatter = Formatter::Pretty.new(nil, io, options)
+        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 = "\n" + io.read + (' ' * (options[:indent] - 2))
         s
       end
 
@@ -492,11 +433,10 @@ module Cucumber
         raw.to_json(*args)
       end
 
-      private
-
       TO_S_PREFIXES = Hash.new('    ')
       TO_S_PREFIXES[:comment]   = '(+) '
       TO_S_PREFIXES[:undefined] = '(-) '
+      private_constant :TO_S_PREFIXES
 
       protected
 
@@ -508,16 +448,6 @@ module Cucumber
         end
       end
 
-      def inspect_rows(missing_row, inserted_row) #:nodoc:
-        missing_row.each_with_index do |missing_cell, col|
-          inserted_cell = inserted_row[col]
-          if(missing_cell.value != inserted_cell.value && (missing_cell.value.to_s == inserted_cell.value.to_s))
-            missing_cell.inspect!
-            inserted_cell.inspect!
-          end
-        end
-      end
-
       def create_cell_matrix(ast_table) #:nodoc:
         ast_table.raw.map do |raw_row|
           line = raw_row.line rescue -1
@@ -554,85 +484,21 @@ module Cucumber
           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
           mapped_cells[0].value = post
-          if @conversion_procs.has_key?(pre)
+          if @conversion_procs.key?(pre)
             @conversion_procs[post] = @conversion_procs.delete(pre)
           end
         end
       end
 
-      def require_diff_lcs #:nodoc:
-        begin
-          require 'diff/lcs'
-        rescue LoadError => e
-          e.message << "\n Please gem install diff-lcs\n"
-          raise e
-        end
-      end
-
       def clear_cache! #:nodoc:
         @hashes = @rows_hash = @col_names = @rows = @columns = nil
       end
 
-      # Pads two cell matrices to same column width and matches columns according to header value.
-      # The first cell matrix is the reference matrix with the second matrix matched against it.
-      def pad_and_match(a_cell_matrix, other_cell_matrix) #:nodoc:
-        clear_cache!
-        cols = a_cell_matrix.transpose
-        unmatched_cols = other_cell_matrix.transpose
-
-
-        header_values = cols.map(&:first)
-        matched_cols = []
-
-        header_values.each_with_index do |v, i|
-          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 = other_cell_matrix.collect {SurplusCell.new(nil, self, -1)}
-            empty_col.first.value = v
-            matched_cols << empty_col
-          end
-        end
-
-
-        empty_col = cell_matrix.collect {SurplusCell.new(nil, self, -1)}
-        unmatched_cols.each do
-          cols << empty_col
-        end
-
-        return cols.transpose, (matched_cols + unmatched_cols).transpose
-      end
-
       def ensure_table(table_or_array) #:nodoc:
         return table_or_array if DataTable === table_or_array
         DataTable.from(table_or_array)
       end
 
-      def ensure_array_of_array(array)
-        Hash === array[0] ? hashes_to_array(array) : array
-      end
-
-      def hashes_to_array(hashes) #:nodoc:
-        header = hashes[0].keys.sort
-        [header] + hashes.map{|hash| header.map{|key| hash[key]}}
-      end
-
-      def ensure_green! #:nodoc:
-        each_cell{|cell| cell.status = :passed}
-      end
-
-      def each_cell(&proc) #:nodoc:
-        cell_matrix.each{|row| row.each(&proc)}
-      end
-
-      def mark_as_missing(col) #:nodoc:
-        col.each do |cell|
-          cell.status = :undefined
-        end
-      end
-
       def symbolize_key(key)
         key.downcase.tr(' ', '_').to_sym
       end
@@ -731,7 +597,7 @@ module Cucumber
           :comment
         end
 
-        def ==(o)
+        def ==(_o)
           true
         end
 

data/lib/cucumber/multiline_argument/doc_string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module MultilineArgument
     class DocString < SimpleDelegator

data/lib/cucumber/multiline_argument.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'delegate'
 require 'cucumber/multiline_argument/data_table'
 require 'cucumber/multiline_argument/doc_string'
@@ -10,14 +11,14 @@ module Cucumber
         builder.wrap(node)
       end
 
-      def from(argument, location=nil)
+      def from(argument, location=nil, content_type=nil)
         location ||= Core::Ast::Location.of_caller
         case argument
         when String
-          doc_string(argument, 'text/plain', location)
+          builder.doc_string(Core::Ast::DocString.new(argument, content_type, location))
         when Array
           location = location.on_line(argument.first.line..argument.last.line)
-          data_table(argument.map{ |row| row.cells }, location)
+          builder.data_table(argument.map{ |row| row.cells }, location)
         when DataTable, DocString, None
           argument
         when nil
@@ -27,14 +28,6 @@ module Cucumber
         end
       end
 
-      def doc_string(argument, content_type, location)
-        builder.doc_string(Core::Ast::DocString.new(argument, content_type, location))
-      end
-
-      def data_table(data, location)
-        builder.data_table(Core::Ast::DataTable.new(data, location))
-      end
-
       private
 
       def builder
@@ -48,11 +41,11 @@ module Cucumber
           @result
         end
 
-        def doc_string(node, *args)
+        def doc_string(node, *_args)
           @result = DocString.new(node)
         end
 
-        def data_table(node, *args)
+        def data_table(node, *_args)
           @result = DataTable.new(node)
         end
       end
@@ -67,5 +60,3 @@ module Cucumber
     end
   end
 end
-
-require 'cucumber/ast'

data/lib/cucumber/platform.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Detect the platform we're running on so we can tweak behaviour
 # in various places.
 require 'rbconfig'
@@ -5,20 +6,18 @@ require 'cucumber/core/platform'
 
 module Cucumber
   unless defined?(Cucumber::VERSION)
-    VERSION       = File.read(File.expand_path("../version", __FILE__))
+    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')
     RAILS         = defined?(Rails)
     RUBY_BINARY   = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-    RUBY_2_2      = RUBY_VERSION =~ /^2\.2/
-    RUBY_2_1      = RUBY_VERSION =~ /^2\.1/
-    RUBY_2_3      = RUBY_VERSION =~ /^2\.3/
+    RUBY          = defined? RUBY_VERSION
 
     class << self
       attr_accessor :use_full_backtrace
 
       # @private
-      def file_mode(m, encoding="UTF-8")
+      def file_mode(m, encoding='UTF-8')
         "#{m}:#{encoding}"
       end
     end

data/lib/cucumber/project_initializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
 
   # Generates generic file structure for a cucumber project
@@ -26,7 +27,7 @@ module Cucumber
                     :touch
                   end
 
-      report_exists(file_name) || return if File.exists?(file_name)
+      report_exists(file_name) || return if File.exist?(file_name)
 
       report_creating(file_name)
       FileUtils.send file_type, file_name
@@ -40,4 +41,4 @@ module Cucumber
       puts "  create   #{file}"
     end
   end
-end
+end

data/lib/cucumber/rake/task.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
 begin
@@ -34,7 +35,7 @@ module Cucumber
         attr_reader :args
 
         def initialize(libs, cucumber_opts, feature_files)
-          raise "libs must be an Array when running in-process" unless Array === libs
+          raise 'libs must be an Array when running in-process' unless Array === libs
           libs.reverse.each{|lib| $LOAD_PATH.unshift(lib)}
           @args = (
             cucumber_opts +
@@ -45,7 +46,7 @@ module Cucumber
         def run
           require 'cucumber/cli/main'
           failure = Cucumber::Cli::Main.execute(args)
-          raise "Cucumber failed" if failure
+          raise 'Cucumber failed' if failure
         end
       end
 
@@ -60,16 +61,16 @@ module Cucumber
           @feature_files = feature_files
         end
 
-        def load_path(libs)
-          ['"%s"' % @libs.join(File::PATH_SEPARATOR)]
+        def load_path
+          [format('"%s"', @libs.join(File::PATH_SEPARATOR))]
         end
 
         def quoted_binary(cucumber_bin)
-          ['"%s"' % cucumber_bin]
+          [format('"%s"', cucumber_bin)]
         end
 
         def use_bundler
-          @bundler.nil? ? File.exist?("./Gemfile") && bundler_gem_available? : @bundler
+          @bundler.nil? ? File.exist?('./Gemfile') && bundler_gem_available? : @bundler
         end
 
         def bundler_gem_available?
@@ -80,16 +81,20 @@ module Cucumber
 
         def cmd
           if use_bundler
-            [ Cucumber::RUBY_BINARY, '-S', 'bundle', 'exec', 'cucumber', @cucumber_opts,
-            @feature_files ].flatten
+            [
+              Cucumber::RUBY_BINARY,'-S', 'bundle', 'exec', 'cucumber',
+              @cucumber_opts, @feature_files
+            ].flatten
           else
-            [ Cucumber::RUBY_BINARY, '-I', load_path(@libs), quoted_binary(@cucumber_bin),
-            @cucumber_opts, @feature_files ].flatten
+            [
+              Cucumber::RUBY_BINARY, '-I', load_path,
+              quoted_binary(@cucumber_bin), @cucumber_opts, @feature_files
+            ].flatten
           end
         end
 
         def run
-          sh cmd.join(" ") do |ok, res|
+          sh cmd.join(' ') do |ok, res|
             if !ok
               exit res.exitstatus
             end
@@ -127,7 +132,7 @@ module Cucumber
       attr_accessor :bundler
 
       # Define Cucumber Rake task
-      def initialize(task_name = "cucumber", desc = "Run Cucumber features")
+      def initialize(task_name = 'cucumber', desc = 'Run Cucumber features')
         @task_name, @desc = task_name, desc
         @fork = true
         @libs = ['lib']
@@ -144,7 +149,7 @@ module Cucumber
         end
       end
 
-      def runner(task_args = nil) #:nodoc:
+      def runner(_task_args = nil) #:nodoc:
         cucumber_opts = [(ENV['CUCUMBER_OPTS'] ? ENV['CUCUMBER_OPTS'].split(/\s+/) : nil) || cucumber_opts_with_profile]
         if(@fork)
           return ForkedCucumberRunner.new(libs, binary, cucumber_opts, bundler, feature_files)
@@ -153,7 +158,7 @@ module Cucumber
       end
 
       def cucumber_opts_with_profile #:nodoc:
-        Array(cucumber_opts).concat Array(@profile).flat_map {|p| ["--profile", p] }
+        Array(cucumber_opts).concat Array(@profile).flat_map {|p| ['--profile', p] }
       end
 
       def feature_files #:nodoc:

data/lib/cucumber/rspec/disable_option_parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module Spec #:nodoc:
@@ -7,7 +8,7 @@ module Spec #:nodoc:
     # will fail when running cucumber)
     class OptionParser < ::OptionParser #:nodoc:
       NEUTERED_RSPEC = Object.new
-      def NEUTERED_RSPEC.method_missing(m, *args); self; end
+      def NEUTERED_RSPEC.method_missing(_m, *_args); self; end
 
       def self.method_added(m)
         unless @__neutering_rspec

data/lib/cucumber/rspec/doubles.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'rspec/mocks'
 
 World(RSpec::Mocks::ExampleMethods)
 
 Before do
-  if RSpec::Mocks::Version::STRING >= "2.9.9"
+  if RSpec::Mocks::Version::STRING >= '2.9.9'
     RSpec::Mocks.setup
   else
     RSpec::Mocks.setup(self)

data/lib/cucumber/running_test_case.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 require 'delegate'
-require 'cucumber/deprecate'
 
 module Cucumber
   # Represents the current status of a running test case.
@@ -32,11 +32,11 @@ module Cucumber
       def feature(feature)
       end
 
-      def scenario(scenario)
+      def scenario(_scenario)
         @factory = Scenario
       end
 
-      def scenario_outline(scenario)
+      def scenario_outline(_scenario)
         @factory = ScenarioOutlineExample
       end
 
@@ -80,34 +80,10 @@ module Cucumber
         !failed?
       end
 
-      def title
-        Cucumber.deprecate(
-          "Call #name instead",
-          "RunningTestCase#title",
-          "2.9.9")
-        name
-      end
-
-      def source_tags
-        Cucumber.deprecate(
-          "Call #tags instead",
-          "RunningTestCase#source_tags",
-          "2.9.9")
-        tags
-      end
-
       def source_tag_names
         tags.map &:name
       end
 
-      def skip_invoke!
-        Cucumber.deprecate(
-          "Call #skip_this_scenario directly (not on any object)",
-          "RunningTestCase#skip_invoke!",
-          "2.9.9")
-        raise Cucumber::Core::Test::Result::Skipped
-      end
-
       def outline?
         false
       end

data/lib/cucumber/runtime/after_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   class Runtime
     class AfterHooks
@@ -18,7 +19,7 @@ module Cucumber
         @hooks.map do |hook|
           action = ->(result) { hook.invoke('After', @scenario.with_result(result)) }
           Hooks.after_hook(source, hook.location, &action)
-        end          
+        end
       end
     end
   end

data/lib/cucumber/runtime/before_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/hooks'
 
 module Cucumber