cucumber 3.2.0 → 5.2.0

data/lib/cucumber/rake/task.rb

@@ -5,9 +5,7 @@ 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
@@ -38,8 +36,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
@@ -65,11 +63,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
@@ -98,9 +96,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
@@ -113,9 +109,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
@@ -134,12 +130,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
@@ -154,18 +154,16 @@ 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)

data/lib/cucumber/rspec/disable_option_parser.rb

@@ -9,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

@@ -13,9 +13,7 @@ Before do
 end
 
 After do
-  begin
-    RSpec::Mocks.verify
-  ensure
-    RSpec::Mocks.teardown
-  end
+  RSpec::Mocks.verify
+ensure
+  RSpec::Mocks.teardown
 end

data/lib/cucumber/running_test_case.rb

@@ -15,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
+      TestCase.new(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
-    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
@@ -85,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/after_hooks.rb

@@ -3,23 +3,27 @@
 module Cucumber
   class Runtime
     class AfterHooks
-      def initialize(hooks, scenario)
+      def initialize(id_generator, hooks, scenario, event_bus)
         @hooks = hooks
         @scenario = scenario
+        @id_generator = id_generator
+        @event_bus = event_bus
       end
 
       def apply_to(test_case)
         test_case.with_steps(
-          test_case.test_steps + after_hooks(test_case.source).reverse
+          test_case.test_steps + after_hooks.reverse
         )
       end
 
       private
 
-      def after_hooks(source)
+      def after_hooks
         @hooks.map do |hook|
           action = ->(result) { hook.invoke('After', @scenario.with_result(result)) }
-          Hooks.after_hook(source, hook.location, &action)
+          hook_step = Hooks.after_hook(@id_generator.new_id, hook.location, &action)
+          @event_bus.hook_test_step_created(hook_step, hook)
+          hook_step
         end
       end
     end

data/lib/cucumber/runtime/before_hooks.rb

@@ -5,23 +5,27 @@ require 'cucumber/hooks'
 module Cucumber
   class Runtime
     class BeforeHooks
-      def initialize(hooks, scenario)
+      def initialize(id_generator, hooks, scenario, event_bus)
         @hooks = hooks
         @scenario = scenario
+        @id_generator = id_generator
+        @event_bus = event_bus
       end
 
       def apply_to(test_case)
         test_case.with_steps(
-          before_hooks(test_case.source) + test_case.test_steps
+          before_hooks + test_case.test_steps
         )
       end
 
       private
 
-      def before_hooks(source)
+      def before_hooks
         @hooks.map do |hook|
           action_block = ->(result) { hook.invoke('Before', @scenario.with_result(result)) }
-          Hooks.before_hook(source, hook.location, &action_block)
+          hook_step = Hooks.before_hook(@id_generator.new_id, hook.location, &action_block)
+          @event_bus.hook_test_step_created(hook_step, hook)
+          hook_step
         end
       end
     end

data/lib/cucumber/runtime/for_programming_languages.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'cucumber/core/ast/doc_string'
+require 'cucumber/core/test/doc_string'
 
 module Cucumber
   class Runtime
@@ -15,11 +15,13 @@ module Cucumber
       attr_reader :support_code
 
       def initialize(support_code, user_interface)
-        @support_code, @user_interface = support_code, user_interface
+        @support_code = support_code
+        @user_interface = user_interface
       end
 
       def_delegators :@user_interface,
                      :embed,
+                     :attach,
                      :ask,
                      :puts,
                      :features_paths,

data/lib/cucumber/runtime/step_hooks.rb

@@ -3,8 +3,10 @@
 module Cucumber
   class Runtime
     class StepHooks
-      def initialize(hooks)
+      def initialize(id_generator, hooks, event_bus)
         @hooks = hooks
+        @id_generator = id_generator
+        @event_bus = event_bus
       end
 
       def apply(test_steps)
@@ -18,7 +20,9 @@ module Cucumber
       def after_step_hooks(test_step)
         @hooks.map do |hook|
           action = ->(*args) { hook.invoke('AfterStep', [args, test_step]) }
-          Hooks.after_step_hook(test_step.source, hook.location, &action)
+          hook_step = Hooks.after_step_hook(@id_generator.new_id, test_step, hook.location, &action)
+          @event_bus.hook_test_step_created(hook_step, hook)
+          hook_step
         end
       end
     end

data/lib/cucumber/runtime/support_code.rb

@@ -22,19 +22,15 @@ module Cucumber
         end
 
         def step(step)
-          location = Core::Ast::Location.of_caller
+          location = Core::Test::Location.of_caller
           @support_code.invoke_dynamic_step(step[:text], multiline_arg(step, location))
         end
 
         def multiline_arg(step, location)
-          argument = step[:argument]
-
-          if argument
-            if argument[:type] == :DocString
-              MultilineArgument.from(argument[:content], location, argument[:content_type])
-            else
-              MultilineArgument::DataTable.from(argument[:rows].map { |row| row[:cells].map { |cell| cell[:value] } })
-            end
+          if !step[:doc_string].nil?
+            MultilineArgument.from(step[:doc_string][:content], location, step[:doc_string][:content_type])
+          elsif !step[:data_table].nil?
+            MultilineArgument::DataTable.from(step[:data_table][:rows].map { |row| row[:cells].map { |cell| cell[:value] } })
           else
             MultilineArgument.from(nil)
           end
@@ -62,8 +58,8 @@ module Cucumber
       #     Given I have 8 cukes in my belly
       #     Then I should not be thirsty
       #   })
-      def invoke_dynamic_steps(steps_text, i18n, _location)
-        parser = Cucumber::Gherkin::StepsParser.new(StepInvoker.new(self), i18n.iso_code)
+      def invoke_dynamic_steps(steps_text, iso_code, _location)
+        parser = Cucumber::Gherkin::StepsParser.new(StepInvoker.new(self), iso_code)
         parser.parse(steps_text)
       end
 
@@ -108,26 +104,28 @@ module Cucumber
       def find_after_step_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:after_step, scenario)
-        StepHooks.new hooks
+        StepHooks.new(@configuration.id_generator, hooks, @configuration.event_bus)
       end
 
       def apply_before_hooks(test_case)
+        return test_case if test_case.test_steps.empty?
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:before, scenario)
-        BeforeHooks.new(hooks, scenario).apply_to(test_case)
+        BeforeHooks.new(@configuration.id_generator, hooks, scenario, @configuration.event_bus).apply_to(test_case)
       end
 
       def apply_after_hooks(test_case)
+        return test_case if test_case.test_steps.empty?
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:after, scenario)
-        AfterHooks.new(hooks, scenario).apply_to(test_case)
+        AfterHooks.new(@configuration.id_generator, hooks, scenario, @configuration.event_bus).apply_to(test_case)
       end
 
       def find_around_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
 
         registry.hooks_for(:around, scenario).map do |hook|
-          Hooks.around_hook(test_case.source) do |run_scenario|
+          Hooks.around_hook do |run_scenario|
             hook.invoke('Around', scenario, &run_scenario)
           end
         end

data/lib/cucumber/runtime/user_interface.rb

@@ -7,14 +7,6 @@ module Cucumber
     module UserInterface
       attr_writer :visitor
 
-      # Output +messages+ alongside the formatted output.
-      # This is an alternative to using Kernel#puts - it will display
-      # nicer, and in all outputs (in case you use several formatters)
-      #
-      def puts(*messages)
-        @visitor.puts(*messages)
-      end
-
       # Suspends execution and prompts +question+ to the console (STDOUT).
       # An operator (manual tester) can then enter a line of text and hit
       # <ENTER>. The entered text is returned, and both +question+ and
@@ -48,20 +40,18 @@ module Cucumber
       # be a path to a file, or if it's an image it may also be a Base64 encoded image.
       # The embedded data may or may not be ignored, depending on what kind of formatter(s) are active.
       #
-      def embed(src, mime_type, label)
-        @visitor.embed(src, mime_type, label)
+      def attach(src, media_type)
+        @visitor.attach(src, media_type)
       end
 
       private
 
       def mri_gets(timeout_seconds)
-        begin
-          Timeout.timeout(timeout_seconds) do
-            STDIN.gets
-          end
-        rescue Timeout::Error
-          nil
+        Timeout.timeout(timeout_seconds) do
+          STDIN.gets
         end
+      rescue Timeout::Error
+        nil
       end
 
       def jruby_gets(timeout_seconds)

data/lib/cucumber/runtime.rb

@@ -1,9 +1,8 @@
-# -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'multi_json'
 require 'cucumber/configuration'
+require 'cucumber/create_meta'
 require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'
@@ -11,6 +10,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
@@ -19,8 +20,8 @@ module Cucumber
     end
   end
 
-  class FileException < Exception
-    attr :path
+  class FileException < RuntimeError
+    attr_reader :path
 
     def initialize(original_exception, path)
       super(original_exception)
@@ -31,7 +32,7 @@ module Cucumber
   class FileNotFoundException < FileException
   end
 
-  class FeatureFolderNotFoundException < Exception
+  class FeatureFolderNotFoundException < RuntimeError
     def initialize(path)
       @path = path
     end
@@ -54,7 +55,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
@@ -65,6 +65,10 @@ module Cucumber
 
     require 'cucumber/wire/plugin'
     def run!
+      @configuration.notify :envelope, Cucumber::Messages::Envelope.new(
+        meta: Cucumber::CreateMeta.create_meta('cucumber-ruby', Cucumber::VERSION)
+      )
+
       load_step_definitions
       install_wire_plugin
       fire_after_configuration_hook
@@ -72,7 +76,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
 
@@ -84,14 +88,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
@@ -107,13 +103,12 @@ 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)
+      Core::Test::DocString.new(string_without_triple_quotes, content_type)
     end
 
     private
 
-    def fire_after_configuration_hook #:nodoc
+    def fire_after_configuration_hook #:nodoc:
       @support_code.fire_hook(:after_configuration, @configuration)
     end
 
@@ -143,14 +138,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
@@ -162,7 +155,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
@@ -171,16 +164,16 @@ 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/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
+
     def report
       return @report if @report
       reports = [summary_report] + formatters
       reports << fail_fast_report if @configuration.fail_fast?
+      reports << publish_banner_printer unless @configuration.publish_quiet?
       @report ||= Formatter::Fanout.new(reports)
     end
 
@@ -192,41 +185,32 @@ module Cucumber
       @fail_fast_report ||= Formatter::FailFast.new(@configuration)
     end
 
+    def publish_banner_printer
+      @publish_banner_printer ||= Formatter::PublishBannerPrinter.new(@configuration)
+    end
+
     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
@@ -237,7 +221,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
@@ -250,14 +234,13 @@ module Cucumber
         # 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)
@@ -273,7 +256,7 @@ 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