cucumber 3.0.2 → 4.0.0

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?

data/lib/cucumber/multiline_argument/doc_string.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Cucumber
   module MultilineArgument
     class DocString < SimpleDelegator
       def append_to(array)
-        array << self.to_s
+        array << to_s
       end
     end
   end

data/lib/cucumber/platform.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Detect the platform we're running on so we can tweak behaviour
 # in various places.
 require 'rbconfig'
@@ -6,7 +7,7 @@ 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', __dir__)).strip
     BINARY        = File.expand_path(File.dirname(__FILE__) + '/../../bin/cucumber')
     LIBDIR        = File.expand_path(File.dirname(__FILE__) + '/../../lib')
     RAILS         = defined?(Rails)
@@ -17,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

data/lib/cucumber/project_initializer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module Cucumber
 
+module Cucumber
   # Generates generic file structure for a cucumber project
   class ProjectInitializer
     def run

data/lib/cucumber/rake/task.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
+
 require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
 begin
   # Support Rake > 0.8.7
   require 'rake/dsl_definition'
+  # rubocop:disable Lint/HandleExceptions
 rescue LoadError
+  # rubocop:enable Lint/HandleExceptions
 end
 
 module Cucumber
@@ -35,8 +38,8 @@ 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
-          libs.reverse.each{|lib| $LOAD_PATH.unshift(lib)}
+          raise 'libs must be an Array when running in-process' unless Array == libs.class
+          libs.reverse_each { |lib| $LOAD_PATH.unshift(lib) }
           @args = (
             cucumber_opts +
             feature_files
@@ -62,11 +65,11 @@ module Cucumber
         end
 
         def load_path
-          [format('"%s"', @libs.join(File::PATH_SEPARATOR))]
+          [format('"%<path>s"', path: @libs.join(File::PATH_SEPARATOR))]
         end
 
         def quoted_binary(cucumber_bin)
-          [format('"%s"', cucumber_bin)]
+          [format('"%<path>s"', path: cucumber_bin)]
         end
 
         def use_bundler
@@ -82,7 +85,7 @@ module Cucumber
         def cmd
           if use_bundler
             [
-              Cucumber::RUBY_BINARY,'-S', 'bundle', 'exec', 'cucumber',
+              Cucumber::RUBY_BINARY, '-S', 'bundle', 'exec', 'cucumber',
               @cucumber_opts, @feature_files
             ].flatten
           else
@@ -95,9 +98,7 @@ module Cucumber
 
         def run
           sh cmd.join(' ') do |ok, res|
-            if !ok
-              exit res.exitstatus
-            end
+            exit res.exitstatus unless ok
           end
         end
       end
@@ -110,9 +111,9 @@ module Cucumber
 
       # Extra options to pass to the cucumber binary. Can be overridden by the CUCUMBER_OPTS environment variable.
       # It's recommended to pass an Array, but if it's a String it will be #split by ' '.
-      attr_accessor :cucumber_opts
+      attr_reader :cucumber_opts
       def cucumber_opts=(opts) #:nodoc:
-        @cucumber_opts = String === opts ? opts.split(' ') : opts
+        @cucumber_opts = String == opts.class ? opts.split(' ') : opts
       end
 
       # Whether or not to fork a new ruby interpreter. Defaults to true. You may gain
@@ -131,12 +132,16 @@ module Cucumber
       # Note that this attribute has no effect if you don't run in forked mode.
       attr_accessor :bundler
 
+      # Name of the running task
+      attr_reader :task_name
+
       # Define Cucumber Rake task
       def initialize(task_name = 'cucumber', desc = 'Run Cucumber features')
-        @task_name, @desc = task_name, desc
+        @task_name = task_name
+        @desc = desc
         @fork = true
         @libs = ['lib']
-        @rcov_opts = %w{--rails --exclude osx\/objc,gems\/}
+        @rcov_opts = %w[--rails --exclude osx\/objc,gems\/]
         yield self if block_given?
         @binary = binary.nil? ? Cucumber::BINARY : File.expand_path(binary)
         define_task
@@ -151,22 +156,20 @@ module Cucumber
 
       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)
-        end
+        return ForkedCucumberRunner.new(libs, binary, cucumber_opts, bundler, feature_files) if fork
         InProcessCucumberRunner.new(libs, cucumber_opts, feature_files)
       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:
-        make_command_line_safe(FileList[ ENV['FEATURE'] || [] ])
+        make_command_line_safe(FileList[ENV['FEATURE'] || []])
       end
 
       def make_command_line_safe(list)
-        list.map{|string| string.gsub(' ', '\ ')}
+        list.map { |string| string.gsub(' ', '\ ') }
       end
     end
   end

data/lib/cucumber/rspec/disable_option_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'optparse'
 
 module Spec #:nodoc:
@@ -8,16 +9,17 @@ 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(_method, *_args) # rubocop:disable Style/MissingRespondToMissing
+        self || super
+      end
 
-      def self.method_added(m)
-        unless @__neutering_rspec
-          @__neutering_rspec = true
-          define_method(m) do |*a|
-            NEUTERED_RSPEC
-          end
-          @__neutering_rspec = false
+      def self.method_added(method)
+        return if @__neutering_rspec
+        @__neutering_rspec = true
+        define_method(method) do |*_a|
+          NEUTERED_RSPEC
         end
+        @__neutering_rspec = false
       end
     end
   end

data/lib/cucumber/rspec/doubles.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rspec/mocks'
 
 World(RSpec::Mocks::ExampleMethods)

data/lib/cucumber/running_test_case.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 require 'delegate'
 
 module Cucumber
-  # Represents the current status of a running test case.
+  # Represents the current status of a running test case.
   #
   # This wraps a `Cucumber::Core::Test::Case` and delegates
   # many methods to that object.
@@ -14,45 +15,12 @@ module Cucumber
   # the passed / failed / undefined / skipped status of
   # the test case.
   #
-  # The test case might come from a regular Scenario or
-  # a Scenario outline. You can call the `#outline?`
-  # predicate to find out. If it's from an outline,
-  # you get a couple of extra methods.
   module RunningTestCase
     def self.new(test_case)
-      Builder.new(test_case).running_test_case
-    end
-
-    class Builder
-      def initialize(test_case)
-        @test_case = test_case
-        test_case.describe_source_to(self)
-      end
-
-      def feature(feature)
-      end
-
-      def scenario(_scenario)
-        @factory = Scenario
-      end
-
-      def scenario_outline(_scenario)
-        @factory = ScenarioOutlineExample
-      end
-
-      def examples_table(examples_table)
-      end
-
-      def examples_table_row(row)
-      end
-
-      def running_test_case
-        @factory.new(@test_case)
-      end
+      TestCase.new(test_case)
     end
-    private_constant :Builder
 
-    class Scenario < SimpleDelegator
+    class TestCase < SimpleDelegator
       def initialize(test_case, result = Core::Test::Result::Unknown.new)
         @test_case = test_case
         @result = result
@@ -84,27 +52,9 @@ module Cucumber
         tags.map &:name
       end
 
-      def outline?
-        false
-      end
-
       def with_result(result)
         self.class.new(@test_case, result)
       end
     end
-
-    class ScenarioOutlineExample < Scenario
-      def outline?
-        true
-      end
-
-      def scenario_outline
-        self
-      end
-
-      def cell_values
-        source.last.values
-      end
-    end
   end
 end

data/lib/cucumber/runtime.rb

@@ -1,7 +1,6 @@
-# -*- coding: utf-8 -*-
 # frozen_string_literal: true
+
 require 'fileutils'
-require 'multi_json'
 require 'cucumber/configuration'
 require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
@@ -10,6 +9,8 @@ require 'cucumber/filters'
 require 'cucumber/formatter/fanout'
 require 'cucumber/gherkin/i18n'
 require 'cucumber/step_match_search'
+require 'cucumber/messages'
+require 'sys/uname'
 
 module Cucumber
   module FixRuby21Bug9285
@@ -18,8 +19,8 @@ module Cucumber
     end
   end
 
-  class FileException < Exception
-    attr :path
+  class FileException < RuntimeError
+    attr_reader :path
 
     def initialize(original_exception, path)
       super(original_exception)
@@ -30,7 +31,7 @@ module Cucumber
   class FileNotFoundException < FileException
   end
 
-  class FeatureFolderNotFoundException < Exception
+  class FeatureFolderNotFoundException < RuntimeError
     def initialize(path)
       @path = path
     end
@@ -53,7 +54,6 @@ module Cucumber
     def initialize(configuration = Configuration.default)
       @configuration = Configuration.new(configuration)
       @support_code = SupportCode.new(self, @configuration)
-      @results = Formatter::LegacyApi::Results.new
     end
 
     # Allows you to take an existing runtime and change its configuration
@@ -64,6 +64,10 @@ module Cucumber
 
     require 'cucumber/wire/plugin'
     def run!
+      @configuration.notify :envelope, Cucumber::Messages::Envelope.new(
+        meta: make_meta
+      )
+
       load_step_definitions
       install_wire_plugin
       fire_after_configuration_hook
@@ -71,7 +75,7 @@ module Cucumber
       self.visitor = report
 
       receiver = Test::Runner.new(@configuration.event_bus)
-      compile features, receiver, filters
+      compile features, receiver, filters, @configuration.event_bus
       @configuration.notify :test_run_finished
     end
 
@@ -83,14 +87,6 @@ module Cucumber
       @configuration.dry_run?
     end
 
-    def scenarios(status = nil)
-      @results.scenarios(status)
-    end
-
-    def steps(status = nil)
-      @results.steps(status)
-    end
-
     def unmatched_step_definitions
       @support_code.unmatched_step_definitions
     end
@@ -105,14 +101,34 @@ module Cucumber
 
     # Returns Ast::DocString for +string_without_triple_quotes+.
     #
-    def doc_string(string_without_triple_quotes, content_type='', _line_offset=0)
-      location = Core::Ast::Location.of_caller
-      Core::Ast::DocString.new(string_without_triple_quotes, content_type, location)
+    def doc_string(string_without_triple_quotes, content_type = '', _line_offset = 0)
+      Core::Test::DocString.new(string_without_triple_quotes, content_type)
+    end
+
+    def make_meta
+      Cucumber::Messages::Meta.new(
+        protocol_version: Cucumber::Messages::VERSION,
+        implementation: Cucumber::Messages::Meta::Product.new(
+          name: 'cucumber-ruby',
+          version: Cucumber::VERSION
+        ),
+        runtime: Cucumber::Messages::Meta::Product.new(
+          name: RUBY_ENGINE,
+          version: RUBY_VERSION
+        ),
+        os: Cucumber::Messages::Meta::Product.new(
+          name: RbConfig::CONFIG['target_os'],
+          version: Sys::Uname.uname.version
+        ),
+        cpu: Cucumber::Messages::Meta::Product.new(
+          name: RbConfig::CONFIG['target_cpu']
+        )
+      )
     end
 
     private
 
-    def fire_after_configuration_hook #:nodoc
+    def fire_after_configuration_hook #:nodoc:
       @support_code.fire_hook(:after_configuration, @configuration)
     end
 
@@ -142,14 +158,12 @@ module Cucumber
       end
 
       def initialize(path)
-        begin
-          @file = File.new(path)
-          set_encoding
-        rescue Errno::EACCES => e
-          raise FileNotFoundException.new(e, File.expand_path(path))
-        rescue Errno::ENOENT
-          raise FeatureFolderNotFoundException.new(path)
-        end
+        @file = File.new(path)
+        set_encoding
+      rescue Errno::EACCES => e
+        raise FileNotFoundException.new(e, File.expand_path(path))
+      rescue Errno::ENOENT
+        raise FeatureFolderNotFoundException, path
       end
 
       def read
@@ -161,7 +175,7 @@ module Cucumber
       def set_encoding
         @file.each do |line|
           if ENCODING_PATTERN =~ line
-            @file.set_encoding $1
+            @file.set_encoding Regexp.last_match(1)
             break
           end
           break unless COMMENT_OR_EMPTY_LINE_PATTERN =~ line
@@ -170,9 +184,6 @@ module Cucumber
       end
     end
 
-    require 'cucumber/formatter/legacy_api/adapter'
-    require 'cucumber/formatter/legacy_api/runtime_facade'
-    require 'cucumber/formatter/legacy_api/results'
     require 'cucumber/formatter/ignore_missing_messages'
     require 'cucumber/formatter/fail_fast'
     require 'cucumber/core/report/summary'
@@ -193,38 +204,26 @@ module Cucumber
 
     def formatters
       @formatters ||=
-        @configuration.formatter_factories do |factory, formatter_options, path_or_io, options|
-          create_formatter(factory, formatter_options, path_or_io, options)
+        @configuration.formatter_factories do |factory, formatter_options, path_or_io|
+          create_formatter(factory, formatter_options, path_or_io)
         end
     end
 
-    def create_formatter(factory, formatter_options, path_or_io, cli_options)
-      if !legacy_formatter?(factory)
-        if accept_options?(factory)
-          return factory.new(@configuration, formatter_options) if path_or_io.nil?
-          return factory.new(@configuration.with_options(out_stream: path_or_io),
-                             formatter_options)
-        else
-          return factory.new(@configuration) if path_or_io.nil?
-          return factory.new(@configuration.with_options(out_stream: path_or_io))
-        end
+    def create_formatter(factory, formatter_options, path_or_io)
+      if accept_options?(factory)
+        return factory.new(@configuration, formatter_options) if path_or_io.nil?
+        factory.new(@configuration.with_options(out_stream: path_or_io),
+                    formatter_options)
+      else
+        return factory.new(@configuration) if path_or_io.nil?
+        factory.new(@configuration.with_options(out_stream: path_or_io))
       end
-      results = Formatter::LegacyApi::Results.new
-      runtime_facade = Formatter::LegacyApi::RuntimeFacade.new(results, @support_code, @configuration)
-      formatter = factory.new(runtime_facade, path_or_io, cli_options)
-      Formatter::LegacyApi::Adapter.new(
-        Formatter::IgnoreMissingMessages.new(formatter),
-        results, @configuration)
     end
 
     def accept_options?(factory)
       factory.instance_method(:initialize).arity > 1
     end
 
-    def legacy_formatter?(factory)
-      factory.instance_method(:initialize).arity > 2
-    end
-
     def failure?
       if @configuration.wip?
         summary_report.test_cases.total_passed > 0
@@ -235,7 +234,7 @@ module Cucumber
     public :failure?
 
     require 'cucumber/core/test/filters'
-    def filters
+    def filters # rubocop:disable Metrics/AbcSize
       tag_expressions = @configuration.tag_expressions
       name_regexps = @configuration.name_regexps
       tag_limits = @configuration.tag_limits
@@ -245,17 +244,16 @@ module Cucumber
         filters << Cucumber::Core::Test::NameFilter.new(name_regexps)
         filters << Cucumber::Core::Test::LocationsFilter.new(filespecs.locations)
         filters << Filters::Randomizer.new(@configuration.seed) if @configuration.randomize?
-        # TODO: can we just use Glue::RegistryAndMore's step definitions directly?
+        # TODO: can we just use Glue::RegistryAndMore's step definitions directly?
         step_match_search = StepMatchSearch.new(@support_code.registry.method(:step_matches), @configuration)
         filters << Filters::ActivateSteps.new(step_match_search, @configuration)
-        @configuration.filters.each do |filter|
-          filters << filter
-        end
+        @configuration.filters.each { |filter| filters << filter }
         unless configuration.dry_run?
           filters << Filters::ApplyAfterStepHooks.new(@support_code)
           filters << Filters::ApplyBeforeHooks.new(@support_code)
           filters << Filters::ApplyAfterHooks.new(@support_code)
           filters << Filters::ApplyAroundHooks.new(@support_code)
+          filters << Filters::BroadcastTestCaseReadyEvent.new(@configuration)
           filters << Filters::BroadcastTestRunStartedEvent.new(@configuration)
           filters << Filters::Quit.new
           filters << Filters::Retry.new(@configuration)
@@ -271,13 +269,11 @@ module Cucumber
     end
 
     def install_wire_plugin
-      Cucumber::Wire::Plugin.new(@configuration).install if @configuration.all_files_to_load.any? {|f| f =~ %r{\.wire$} }
+      Cucumber::Wire::Plugin.new(@configuration, @support_code.registry).install if @configuration.all_files_to_load.any? { |f| f =~ /\.wire$/ }
     end
 
     def log
       Cucumber.logger
     end
-
   end
-
 end