cucumber 2.99.0 → 3.0.0

data/lib/cucumber/cli/profile_loader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yaml'
 
 module Cucumber
@@ -10,7 +11,7 @@ module Cucumber
       end
 
       def args_from(profile)
-        unless cucumber_yml.has_key?(profile)
+        unless cucumber_yml.key?(profile)
           raise(ProfileNotFound, <<-END_OF_ERROR)
 Could not find profile: '#{profile}'
 
@@ -21,34 +22,39 @@ Defined profiles in cucumber.yml:
 
         args_from_yml = cucumber_yml[profile] || ''
 
-        case(args_from_yml)
-          when String
-            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml =~ /^\s*$/
-            if(Cucumber::WINDOWS)
-              #Shellwords treats backslash as an escape character so here's a rudimentary approximation of the same code
-              args_from_yml = args_from_yml.split
-              args_from_yml = args_from_yml.collect {|x| x.gsub(/^\"(.*)\"/,'\1') }
-            else
-              require 'shellwords'
-              args_from_yml = Shellwords.shellwords(args_from_yml)
-            end
-          when Array
-            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was empty.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml.empty?
+        require 'shellwords'
+
+        case args_from_yml
+        when String
+          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml =~ /^\s*$/
+          if Cucumber::WINDOWS
+            # Shellwords treats backslash as an escape character so we have to mask it out temporarily
+
+            placeholder = 'pseudo_unique_backslash_placeholder'
+            sanitized_line = args_from_yml.gsub('\\', placeholder)
+
+            args_from_yml = Shellwords.shellwords(sanitized_line).collect { |argument| argument.gsub(placeholder, '\\') }
           else
-            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was a #{args_from_yml.class}. It must be a String or Array"
+            args_from_yml = Shellwords.shellwords(args_from_yml)
+          end
+        when Array
+          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was empty.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml.empty?
+        else
+          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was a #{args_from_yml.class}. It must be a String or Array"
         end
+
         args_from_yml
       end
 
       def has_profile?(profile)
-        cucumber_yml.has_key?(profile)
+        cucumber_yml.key?(profile)
       end
 
       def cucumber_yml_defined?
         cucumber_file && File.exist?(cucumber_file)
       end
 
-    private
+      private
 
       # Loads the profile, processing it through ERB and YAML, and returns it as a hash.
       def cucumber_yml
@@ -61,13 +67,13 @@ Defined profiles in cucumber.yml:
         require 'yaml'
         begin
           @cucumber_erb = ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
-        rescue Exception => e
+        rescue StandardError
           raise(YmlLoadError,"cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$!.inspect}")
         end
 
         begin
-          @cucumber_yml = YAML::load(@cucumber_erb)
-        rescue StandardError => e
+          @cucumber_yml = YAML.load(@cucumber_erb)
+        rescue StandardError
           raise(YmlLoadError,"cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage.\n")
         end
 
@@ -88,4 +94,3 @@ Defined profiles in cucumber.yml:
     end
   end
 end
-

data/lib/cucumber/cli/rerun_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Cli
     class RerunFile

data/lib/cucumber/configuration.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 require 'cucumber/constantize'
 require 'cucumber/cli/rerun_file'
 require 'cucumber/events'
+require 'cucumber/core/event_bus'
+require 'cucumber/core/test/result'
 require 'forwardable'
-require 'cucumber/core/gherkin/tag_expression'
+require 'cucumber'
 
 module Cucumber
   # The base class for configuring settings for a Cucumber run.
@@ -20,27 +23,23 @@ module Cucumber
     #
     # @param event_id [Symbol, Class, String] Identifier for the type of event to subscribe to
     # @param handler_object [Object optional] an object to be called when the event occurs
-    # @yield [Object] Block to be called when th event occurs
+    # @yield [Object] Block to be called when the event occurs
     # @method on_event
-    def_instance_delegator :event_bus, :register, :on_event
+    def_instance_delegator :event_bus, :on, :on_event
 
     # @private
-    def_instance_delegator :event_bus, :notify
+    def notify(message, *args)
+      event_bus.send(message, *args)
+    end
 
     def initialize(user_options = {})
-      @options = default_options.merge(Cucumber::Hash(user_options))
+      @options = default_options.merge(Hash(user_options))
     end
 
     def with_options(new_options)
       self.class.new(@options.merge(new_options))
     end
 
-    # TODO: Actually Deprecate???
-    def options
-      warn("Deprecated: Configuration#options will be removed from the next release of Cucumber. Please use the configuration object directly instead.")
-      Marshal.load(Marhal.dump(@options))
-    end
-
     def out_stream
       @options[:out_stream]
     end
@@ -73,7 +72,7 @@ module Cucumber
       @options[:guess]
     end
 
-    def strict?
+    def strict
       @options[:strict]
     end
 
@@ -85,6 +84,30 @@ module Cucumber
       @options[:expand]
     end
 
+    def source?
+      @options[:source]
+    end
+
+    def duration?
+      @options[:duration]
+    end
+
+    def snippets?
+      @options[:snippets]
+    end
+
+    def skip_profile_information?
+      @options[:skip_profile_information]
+    end
+
+    def profiles
+      @options[:profiles] || []
+    end
+
+    def custom_profiles
+      profiles - [@options[:default_profile]]
+    end
+
     def paths
       @options[:paths]
     end
@@ -107,13 +130,8 @@ module Cucumber
       with_default_features_path(dirs)
     end
 
-    # todo: remove
-    def tag_expression
-      Cucumber::Core::Gherkin::TagExpression.new(@options[:tag_expressions])
-    end
-
     def tag_limits
-      tag_expression.limits.to_hash
+      @options[:tag_limits]
     end
 
     def tag_expressions
@@ -130,7 +148,7 @@ module Cucumber
 
     def feature_files
       potential_feature_files = with_default_features_path(paths).map do |path|
-        path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
+        path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
         path = path.chomp('/')
 
         # TODO: Move to using feature loading strategies stored in
@@ -156,7 +174,7 @@ module Cucumber
 
     def all_files_to_load
       files = require_dirs.map do |path|
-        path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
+        path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
         path = path.gsub(/\/$/, '') # Strip trailing slash.
         File.directory?(path) ? Dir["#{path}/**/*"] : path
       end.flatten.uniq
@@ -172,21 +190,21 @@ module Cucumber
     end
 
     def formatter_factories
-      @options[:formats].map do |format_and_out|
-        format = format_and_out[0]
-        path_or_io = format_and_out[1]
+      formats.map do |format, formatter_options, path_or_io|
         begin
           factory = formatter_class(format)
-          yield factory, path_or_io, Cli::Options.new(STDOUT, STDERR, @options)
+          yield factory,
+                formatter_options,
+                path_or_io,
+                Cli::Options.new(STDOUT, STDERR, @options)
         rescue Exception => e
-          e.message << "\nError creating formatter: #{format}"
-          raise e
+          raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
         end
       end
     end
 
     def formatter_class(format)
-      if(builtin = Cli::Options::BUILTIN_FORMATS[format])
+      if (builtin = Cli::Options::BUILTIN_FORMATS[format])
         constantize(builtin[0])
       else
         constantize(format)
@@ -201,7 +219,7 @@ module Cucumber
     # formatter wants to display snippets to the user.
     #
     # Each proc should take the following arguments:
-    # 
+    #
     #  - keyword
     #  - step text
     #  - multiline argument
@@ -216,13 +234,17 @@ module Cucumber
       self
     end
 
-  private
+    def event_bus
+      @options[:event_bus]
+    end
+
+    private
 
     def default_options
       {
         :autoload_code_paths => ['features/support', 'features/step_definitions'],
         :filters             => [],
-        :strict              => false,
+        :strict              => Cucumber::Core::Test::Result::StrictConfiguration.new,
         :require             => [],
         :dry_run             => false,
         :fail_fast           => false,
@@ -235,17 +257,12 @@ module Cucumber
         :snippets            => true,
         :source              => true,
         :duration            => true,
-        :event_bus           => Events::Bus.new(Cucumber::Events)
+        :event_bus           => Cucumber::Events.make_event_bus
       }
     end
 
-    def event_bus
-      @options[:event_bus]
-    end
-
-
     def default_features_paths
-      ["features"]
+      ['features']
     end
 
     def with_default_features_path(paths)

data/lib/cucumber/constantize.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 module Cucumber
   module Constantize #:nodoc:
@@ -28,7 +29,7 @@ module Cucumber
       camel_cased_word.to_s.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
         gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
+        tr('-', '_').
         downcase
     end
 

data/lib/cucumber/core_ext/string.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 class String #:nodoc:
   def indent(n)
     if n >= 0
       gsub(/^/, ' ' * n)
     else
-      gsub(/^ {0,#{-n}}/, "")
+      gsub(/^ {0,#{-n}}/, '')
     end
   end
 end

data/lib/cucumber/deprecate.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
 
@@ -12,18 +13,18 @@ module Cucumber
     end
 
     module ForDevelopers
-      def self.call(message, method, remove_after_version)
+      def self.call(_message, _method, remove_after_version)
         if Cucumber::VERSION > remove_after_version
           raise "This method is due for removal after version #{remove_after_version}"
         end
       end
     end
 
-    Strategy = $0.match(/rspec$/) ? ForDevelopers : ForUsers
+    STRATEGY = $0.match(/rspec$/) ? ForDevelopers : ForUsers
   end
 
   def self.deprecate(*args)
-    Deprecate::Strategy.call(*args)
+    Deprecate::STRATEGY.call(*args)
   end
 
 end

data/lib/cucumber/encoding.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # See https://github.com/cucumber/cucumber/issues/693
 if defined? Encoding
   Encoding.default_external = 'utf-8'

data/lib/cucumber/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/result'
 
 module Cucumber
@@ -35,7 +36,8 @@ module Cucumber
   # Raised when a step matches 2 or more StepDefinitions
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
-      message = "Ambiguous match of \"#{step_name}\":\n\n"
+      message = String.new
+      message << "Ambiguous match of \"#{step_name}\":\n\n"
       message << step_definitions.map{|sd| sd.backtrace_line}.join("\n")
       message << "\n\n"
       message << "You can run again with --guess to make Cucumber be more smart about it\n" unless used_guess

data/lib/cucumber/events/gherkin_source_read.rb

@@ -0,0 +1,17 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Fired after we've read in the contents of a feature file
+    class GherkinSourceRead < Core::Event.new(:path, :body)
+
+      # The path to the file
+      attr_reader :path
+
+      # The raw Gherkin source
+      attr_reader :body
+    end
+
+  end
+end

data/lib/cucumber/events/{step_match.rb → step_activated.rb}

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
 module Cucumber
   module Events
 
-    # Event fired when a step is matched to a definition
-    class StepMatch
+    # Event fired when a step is activated
+    class StepActivated < Core::Event.new(:test_step, :step_match)
 
       # The test step that was matched.
       #

data/lib/cucumber/events/step_definition_registered.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Event fired after each step definition has been registered
+    class StepDefinitionRegistered < Core::Event.new(:step_definition)
+
+
+      #_The step definition that was just registered.
+      #
+      # @return [RbSupport::RbStepDefinition]
+      attr_reader :step_definition
+
+      #_@private
+      def initialize(step_definition)
+        @step_definition = step_definition
+      end
+
+    end
+
+  end
+end

data/lib/cucumber/events/test_case_finished.rb

@@ -0,0 +1,18 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Case} has finished executing
+    class TestCaseFinished < Core::Events::TestCaseFinished
+
+      # @return [Cucumber::Core::Test::Case] that was executed
+      attr_reader :test_case
+
+      # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Case}
+      attr_reader :result
+
+    end
+
+  end
+end

data/lib/cucumber/events/test_case_started.rb

@@ -0,0 +1,15 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Case} is about to be executed
+    class TestCaseStarted < Core::Events::TestCaseStarted
+
+      # @return [Cucumber::Core::Test::Case] the test case to be executed
+      attr_reader :test_case
+
+    end
+
+  end
+end

data/lib/cucumber/events/test_run_finished.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Event fired after all test cases have finished executing
+    class TestRunFinished < Core::Event.new
+    end
+
+  end
+end

data/lib/cucumber/events/test_run_started.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Event fired once all test cases have been filtered before
+    # the first one is executed.
+    class TestRunStarted < Core::Event.new(:test_cases)
+
+      # @return [Array<Cucumber::Core::Test::Case>] the test cases to be executed
+      attr_reader :test_cases
+    end
+
+  end
+end

data/lib/cucumber/events/test_step_finished.rb

@@ -0,0 +1,20 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Step} has finished executing
+    class TestStepFinished < Core::Events::TestStepFinished
+
+      # @return [Cucumber::Core::Test::Step] the test step that was executed
+      attr_reader :test_step
+
+      # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Step}
+      attr_reader :result
+
+    end
+
+  end
+end
+
+

data/lib/cucumber/events/test_step_started.rb

@@ -0,0 +1,17 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Step} is about to be executed
+    class TestStepStarted < Core::Events::TestStepStarted
+
+      # @return [Cucumber::Core::Test::Step] the test step to be executed
+      attr_reader :test_step
+
+    end
+
+  end
+end
+
+

data/lib/cucumber/events.rb

@@ -1,20 +1,40 @@
+# frozen_string_literal: true
+Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))
+
 module Cucumber
 
   # Events tell you what's happening while Cucumber runs your features.
   #
   # They're designed to be read-only, appropriate for writing formatters and other
-  # output tools. If you need to be able to influence the result of a scenario, use a hook instead.
+  # output tools. If you need to be able to influence the result of a scenario, use a {RbSupport::RbDsl hook} instead.
   #
   # To subscribe to an event, use {Cucumber::Configuration#on_event}
   #
   # @example
   #   AfterConfiguration do |config|
-  #     config.on_event :after_test_step do |event|
+  #     config.on_event :test_case_finished do |event|
   #       puts event.result
   #     end
   #   end
+  #
   module Events
+    def self.make_event_bus
+      Core::EventBus.new(registry)
+    end
+
+    def self.registry
+      Core::Events.build_registry(
+        TestCaseStarted,
+        TestCaseFinished,
+        TestStepFinished,
+        TestStepStarted,
+        StepDefinitionRegistered,
+        StepActivated,
+        TestRunFinished,
+        GherkinSourceRead,
+        TestRunStarted
+      )
+    end
   end
 end
 
-Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))

data/lib/cucumber/file_specs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber'
 require 'cucumber/core/ast/location'
 

data/lib/cucumber/filters/activate_steps.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 require 'cucumber/step_match'
 require 'cucumber/events'
@@ -42,8 +43,12 @@ module Cucumber
           end
 
           def result
-            return NoStepMatch.new(test_step.source.last, test_step.name) unless matches.any?
-            configuration.notify Events::StepMatch.new(test_step, match)
+            begin
+              return NoStepMatch.new(test_step.source.last, test_step.text) unless matches.any?
+            rescue Cucumber::Ambiguous => e
+              return AmbiguousStepMatch.new(e)
+            end
+            configuration.notify :step_activated, test_step, match
             return SkippingStepMatch.new if configuration.dry_run?
             match
           end
@@ -58,7 +63,7 @@ module Cucumber
           end
 
           def matches
-            step_match_search.call(test_step.name)
+            step_match_search.call(test_step.text)
           end
         end
       end

data/lib/cucumber/filters/apply_after_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class ApplyAfterHooks < Core::Filter.new(:hooks)

data/lib/cucumber/filters/apply_after_step_hooks.rb

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

data/lib/cucumber/filters/apply_around_hooks.rb

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

data/lib/cucumber/filters/apply_before_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class ApplyBeforeHooks < Core::Filter.new(:hooks)

data/lib/cucumber/filters/broadcast_test_run_started_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Cucumber
+  module Filters
+    # Added at the end of the filter chain to broadcast a list of
+    # all of the test cases that have made it through the filters.
+    class BroadcastTestRunStartedEvent < Core::Filter.new(:config)
+      def initialize(config, receiver=nil)
+        super
+        @test_cases = []
+      end
+
+      def test_case(test_case)
+        @test_cases << test_case
+        self
+      end
+
+      def done
+        config.notify :test_run_started, @test_cases
+        @test_cases.map do |test_case|
+          test_case.describe_to(@receiver)
+        end
+        super
+        self
+      end
+    end
+  end
+end

data/lib/cucumber/filters/gated_receiver.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters