cucumber 3.1.2 → 8.0.0

data/lib/cucumber/cli/profile_loader.rb

@@ -16,26 +16,19 @@ Could not find profile: '#{profile}'
 
 Defined profiles in cucumber.yml:
   * #{cucumber_yml.keys.sort.join("\n  * ")}
-        END_OF_ERROR
+          END_OF_ERROR
         end
 
         args_from_yml = cucumber_yml[profile] || ''
 
-        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
-            args_from_yml = Shellwords.shellwords(args_from_yml)
+          if args_from_yml =~ /^\s*$/
+            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank." \
+            "  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n"
           end
+
+          args_from_yml = processed_shellwords(args_from_yml)
         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
@@ -45,7 +38,7 @@ Defined profiles in cucumber.yml:
         args_from_yml
       end
 
-      def has_profile?(profile)
+      def profile?(profile)
         cucumber_yml.key?(profile)
       end
 
@@ -58,29 +51,43 @@ Defined profiles in cucumber.yml:
       # Loads the profile, processing it through ERB and YAML, and returns it as a hash.
       def cucumber_yml
         return @cucumber_yml if @cucumber_yml
-        unless cucumber_yml_defined?
-          raise(ProfilesNotDefinedError, "cucumber.yml was not found.  Current directory is #{Dir.pwd}.  Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
+
+        ensure_configuration_file_exists
+        process_configuration_file_with_erb
+        load_configuration
+
+        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
+          raise(YmlLoadError, 'cucumber.yml was found, but was blank or malformed. ' \
+          "Please refer to cucumber's documentation on correct profile usage.\n")
         end
 
+        @cucumber_yml
+      end
+
+      def ensure_configuration_file_exists
+        return if cucumber_yml_defined?
+
+        raise(ProfilesNotDefinedError, "cucumber.yml was not found.  Current directory is #{Dir.pwd}." \
+                                       "Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define" \
+                                       "a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
+      end
+
+      def process_configuration_file_with_erb
         require 'erb'
-        require 'yaml'
         begin
-          @cucumber_erb = ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
+          @cucumber_erb = ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
         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}")
+          raise(YmlLoadError, "cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$ERROR_INFO.inspect}")
         end
+      end
 
+      def load_configuration
+        require 'yaml'
         begin
-          @cucumber_yml = YAML.load(@cucumber_erb)
+          @cucumber_yml = YAML.load(@cucumber_erb) # rubocop:disable Security/YAMLLoad
         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
-
-        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
-          raise(YmlLoadError, "cucumber.yml was found, but was blank or malformed. Please refer to cucumber's documentation on correct profile usage.\n")
-        end
-
-        return @cucumber_yml
       end
 
       # Locates cucumber.yml file. The file can end in .yml or .yaml,
@@ -89,6 +96,18 @@ Defined profiles in cucumber.yml:
       def cucumber_file
         @cucumber_file ||= Dir.glob('{,.config/,config/}cucumber{.yml,.yaml}').first
       end
+
+      def processed_shellwords(args_from_yml)
+        require 'shellwords'
+
+        return Shellwords.shellwords(args_from_yml) unless 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)
+
+        Shellwords.shellwords(sanitized_line).collect { |argument| argument.gsub(placeholder, '\\') }
+      end
     end
   end
 end

data/lib/cucumber/cli/rerun_file.rb

@@ -10,7 +10,7 @@ module Cucumber
       end
 
       def self.real_path(path)
-        path[1..-1] # remove leading @
+        path[1..]
       end
 
       def initialize(path)

data/lib/cucumber/configuration.rb

@@ -3,6 +3,7 @@
 require 'cucumber/constantize'
 require 'cucumber/cli/rerun_file'
 require 'cucumber/events'
+require 'cucumber/messages'
 require 'cucumber/core/event_bus'
 require 'cucumber/core/test/result'
 require 'forwardable'
@@ -54,13 +55,21 @@ module Cucumber
     end
 
     def seed
-      Integer(@options[:seed] || rand(0xFFFF))
+      @options[:seed]
     end
 
     def dry_run?
       @options[:dry_run]
     end
 
+    def publish_enabled?
+      @options[:publish_enabled]
+    end
+
+    def publish_quiet?
+      @options[:publish_quiet]
+    end
+
     def fail_fast?
       @options[:fail_fast]
     end
@@ -167,10 +176,14 @@ module Cucumber
     end
 
     def support_to_load
-      support_files = all_files_to_load.select { |f| f =~ %r{/support/} }
-      env_files = support_files.select { |f| f =~ %r{/support/env\..*} }
+      support_files = all_files_to_load.select { |f| f =~ /\/support\// }
+
+      # env_files are separated from other_files so we can ensure env files
+      # load first.
+      #
+      env_files = support_files.select { |f| f =~ /\/support\/env\..*/ }
       other_files = support_files - env_files
-      @options[:dry_run] ? other_files : env_files + other_files
+      env_files.reverse + other_files.reverse
     end
 
     def all_files_to_load
@@ -180,27 +193,24 @@ module Cucumber
         File.directory?(path) ? Dir["#{path}/**/*"] : path
       end.flatten.uniq
       remove_excluded_files_from(files)
-      files.reject! { |f| !File.file?(f) }
+      files.select! { |f| File.file?(f) }
       files.reject! { |f| File.extname(f) == '.feature' }
       files.reject! { |f| f =~ /^http/ }
       files.sort
     end
 
     def step_defs_to_load
-      all_files_to_load.reject { |f| f =~ %r{/support/} }
+      all_files_to_load.reject { |f| f =~ /\/support\// }
     end
 
     def formatter_factories
       formats.map do |format, formatter_options, path_or_io|
-        begin
-          factory = formatter_class(format)
-          yield factory,
-                formatter_options,
-                path_or_io,
-                Cli::Options.new(STDOUT, STDERR, @options)
-        rescue Exception => e
-          raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
-        end
+        factory = formatter_class(format)
+        yield factory,
+              formatter_options,
+              path_or_io
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
       end
     end
 
@@ -239,26 +249,31 @@ module Cucumber
       @options[:event_bus]
     end
 
+    def id_generator
+      @id_generator ||= Cucumber::Messages::IdGenerator::UUID.new
+    end
+
     private
 
     def default_options
       {
-        :autoload_code_paths => ['features/support', 'features/step_definitions'],
-        :filters             => [],
-        :strict              => Cucumber::Core::Test::Result::StrictConfiguration.new,
-        :require             => [],
-        :dry_run             => false,
-        :fail_fast           => false,
-        :formats             => [],
-        :excludes            => [],
-        :tag_expressions     => [],
-        :name_regexps        => [],
-        :env_vars            => {},
-        :diff_enabled        => true,
-        :snippets            => true,
-        :source              => true,
-        :duration            => true,
-        :event_bus           => Cucumber::Events.make_event_bus
+        autoload_code_paths: ['features/support', 'features/step_definitions'],
+        filters: [],
+        strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
+        require: [],
+        dry_run: false,
+        publish_quiet: false,
+        fail_fast: false,
+        formats: [],
+        excludes: [],
+        tag_expressions: [],
+        name_regexps: [],
+        env_vars: {},
+        diff_enabled: true,
+        snippets: true,
+        source: true,
+        duration: true,
+        event_bus: Cucumber::Events.make_event_bus
       }
     end
 
@@ -268,6 +283,7 @@ module Cucumber
 
     def with_default_features_path(paths)
       return default_features_paths if paths.empty?
+
       paths
     end
 

data/lib/cucumber/constantize.rb

@@ -2,7 +2,7 @@
 
 require 'cucumber/platform'
 module Cucumber
-  module Constantize #:nodoc:
+  module Constantize # :nodoc:
     def constantize(camel_cased_word)
       try = 0
       begin
@@ -17,11 +17,8 @@ module Cucumber
         constant
       rescue NameError => e
         require underscore(camel_cased_word)
-        if try < 2
-          retry
-        else
-          raise e
-        end
+        retry if try < 2
+        raise e
       end
     end
 

data/lib/cucumber/deprecate.rb

@@ -5,23 +5,48 @@ require 'cucumber/gherkin/formatter/ansi_escapes'
 
 module Cucumber
   module Deprecate
-    module ForUsers
-      AnsiEscapes = Cucumber::Gherkin::Formatter::AnsiEscapes
+    class AnsiString
+      include Cucumber::Gherkin::Formatter::AnsiEscapes
+
+      def self.failure_message(message)
+        AnsiString.new.failure_message(message)
+      end
+
+      def failure_message(message)
+        failed + message + reset
+      end
+    end
 
+    class CliOption
+      def self.deprecate(stream, option, message, remove_after_version)
+        return if stream.nil?
+
+        stream.puts(
+          AnsiString.failure_message(
+            "\nWARNING: #{option} is deprecated" \
+            " and will be removed after version #{remove_after_version}.\n#{message}.\n"
+          )
+        )
+      end
+    end
+
+    module ForUsers
       def self.call(message, method, remove_after_version)
-        STDERR.puts AnsiEscapes.failed + "\nWARNING: ##{method} is deprecated and will be removed after version #{remove_after_version}. #{message}.\n(Called from #{caller[2]})" + AnsiEscapes.reset
+        $stderr.puts AnsiString.failure_message(
+          "\nWARNING: ##{method} is deprecated" \
+          " and will be removed after version #{remove_after_version}. #{message}.\n" \
+          "(Called from #{caller(3..3).first})"
+        )
       end
     end
 
     module ForDevelopers
       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
+        raise "This method is due for removal after version #{remove_after_version}" if Cucumber::VERSION >= remove_after_version
       end
     end
 
-    STRATEGY = $0.match(/rspec$/) ? ForDevelopers : ForUsers
+    STRATEGY = $PROGRAM_NAME =~ /rspec$/ ? ForDevelopers : ForUsers
   end
 
   def self.deprecate(*args)

data/lib/cucumber/errors.rb

@@ -6,14 +6,12 @@ module Cucumber
   # Raised when there is no matching StepDefinition for a step.
   class Undefined < Core::Test::Result::Undefined
     def self.from(result, step_name)
-      if result.is_a?(self)
-        return result.with_message(with_prefix(result.message))
-      end
+      return result.with_message(with_prefix(result.message)) if result.is_a?(self)
 
       begin
-        raise self.new(with_prefix(step_name))
-      rescue => exception
-        return exception
+        raise self, with_prefix(step_name)
+      rescue StandardError => e
+        e
       end
     end
 
@@ -37,7 +35,7 @@ module Cucumber
   # Raised when a step matches 2 or more StepDefinitions
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
-      message = String.new
+      message = String.new # rubocop:disable Style/EmptyLiteral
       message << "Ambiguous match of \"#{step_name}\":\n\n"
       message << step_definitions.map(&:backtrace_line).join("\n")
       message << "\n\n"

data/lib/cucumber/events/envelope.rb

@@ -0,0 +1,9 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    class Envelope < Core::Event.new(:envelope)
+      attr_reader :envelope
+    end
+  end
+end

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -0,0 +1,11 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Fired after we've parsed the contents of a feature file
+    class GherkinSourceParsed < Core::Event.new(:gherkin_document)
+      # The Gherkin Ast
+      attr_reader :gherkin_document
+    end
+  end
+end

data/lib/cucumber/events/hook_test_step_created.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a step is created from a hook
+    class HookTestStepCreated < Core::Event.new(:test_step, :hook)
+      attr_reader :test_step, :hook
+    end
+  end
+end

data/lib/cucumber/events/step_activated.rb

@@ -15,11 +15,6 @@ module Cucumber
       #
       # @return [Cucumber::StepMatch]
       attr_reader :step_match
-
-      # @private
-      def initialize(test_step, step_match)
-        @test_step, @step_match = test_step, step_match
-      end
     end
   end
 end

data/lib/cucumber/events/step_definition_registered.rb

@@ -10,11 +10,6 @@ module Cucumber
       #
       # @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_created.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a Test::Case is created from a Pickle
+    class TestCaseCreated < Core::Event.new(:test_case, :pickle)
+      attr_reader :test_case, :pickle
+    end
+  end
+end

data/lib/cucumber/events/test_case_ready.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a Test::Case is ready to be ran (matching has been done, hooks added etc)
+    class TestCaseReady < Core::Event.new(:test_case)
+      attr_reader :test_case
+    end
+  end
+end

data/lib/cucumber/events/test_run_finished.rb

@@ -5,7 +5,8 @@ require 'cucumber/core/events'
 module Cucumber
   module Events
     # Event fired after all test cases have finished executing
-    class TestRunFinished < Core::Event.new
+    class TestRunFinished < Core::Event.new(:success)
+      attr_reader :success
     end
   end
 end

data/lib/cucumber/events/test_step_created.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a TestStep is created from a PickleStep
+    class TestStepCreated < Core::Event.new(:test_step, :pickle_step)
+      attr_reader :test_step, :pickle_step
+    end
+  end
+end

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -0,0 +1,9 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    class UndefinedParameterType < Core::Event.new(:type_name, :expression)
+      attr_reader :type_name, :expression
+    end
+  end
+end

data/lib/cucumber/events.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))
+Dir["#{File.dirname(__FILE__)}/events/*.rb"].map(&method(:require))
 
 module Cucumber
   # Events tell you what's happening while Cucumber runs your features.
@@ -11,7 +11,7 @@ module Cucumber
   # To subscribe to an event, use {Cucumber::Configuration#on_event}
   #
   # @example
-  #   AfterConfiguration do |config|
+  #   InstallPlugin do |config|
   #     config.on_event :test_case_finished do |event|
   #       puts event.result
   #     end
@@ -24,15 +24,22 @@ module Cucumber
 
     def self.registry
       Core::Events.build_registry(
-        TestCaseStarted,
+        GherkinSourceParsed,
+        GherkinSourceRead,
+        HookTestStepCreated,
+        StepActivated,
+        StepDefinitionRegistered,
+        TestCaseCreated,
         TestCaseFinished,
+        TestCaseStarted,
+        TestCaseReady,
+        TestRunFinished,
+        TestRunStarted,
+        TestStepCreated,
         TestStepFinished,
         TestStepStarted,
-        StepDefinitionRegistered,
-        StepActivated,
-        TestRunFinished,
-        GherkinSourceRead,
-        TestRunStarted
+        Envelope,
+        UndefinedParameterType
       )
     end
   end

data/lib/cucumber/file_specs.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 require 'cucumber'
-require 'cucumber/core/ast/location'
+require 'cucumber/core/test/location'
 
 module Cucumber
   class FileSpecs
-    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/ #:nodoc:
+    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/ # :nodoc:
 
     def initialize(file_specs)
       Cucumber.logger.debug("Features:\n")
-      @file_specs = file_specs.map { |s| FileSpec.new(s) }
+      @file_specs = file_specs.map { |spec| FileSpec.new(spec) }
       Cucumber.logger.debug("\n")
     end
 
@@ -22,8 +22,8 @@ module Cucumber
     end
 
     class FileSpec
-      def initialize(s)
-        @file, @lines = *FILE_COLON_LINE_PATTERN.match(s).captures
+      def initialize(spec)
+        @file, @lines = *FILE_COLON_LINE_PATTERN.match(spec).captures
         Cucumber.logger.debug("  * #{@file}\n")
         @lines = String(@lines).split(':').map { |line| Integer(line) }
       end
@@ -31,8 +31,9 @@ module Cucumber
       attr_reader :file
 
       def locations
-        return [Core::Ast::Location.new(@file)] if @lines.empty?
-        @lines.map { |line| Core::Ast::Location.new(@file, line) }
+        return [Core::Test::Location.new(@file)] if @lines.empty?
+
+        @lines.map { |line| Core::Test::Location.new(@file, line) }
       end
     end
   end

data/lib/cucumber/filters/activate_steps.rb

@@ -26,7 +26,7 @@ module Cucumber
         private
 
         def new_test_steps
-          @original_test_case.test_steps.map(&self.method(:attempt_to_activate))
+          @original_test_case.test_steps.map(&method(:attempt_to_activate))
         end
 
         def attempt_to_activate(test_step)
@@ -39,17 +39,20 @@ module Cucumber
 
         class FindMatch
           def initialize(step_match_search, configuration, test_step)
-            @step_match_search, @configuration, @test_step = step_match_search, configuration, test_step
+            @step_match_search = step_match_search
+            @configuration = configuration
+            @test_step = test_step
           end
 
           def result
             begin
-              return NoStepMatch.new(test_step.source.last, test_step.text) unless matches.any?
+              return NoStepMatch.new(test_step, 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
 

data/lib/cucumber/filters/broadcast_test_case_ready_event.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Filters
+    class BroadcastTestCaseReadyEvent < Core::Filter.new(:config)
+      def test_case(test_case)
+        config.notify :test_case_ready, test_case
+        test_case.describe_to(receiver)
+      end
+    end
+  end
+end

data/lib/cucumber/filters/prepare_world.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'cucumber/core/filter'
-require 'cucumber/core/ast/location'
+require 'cucumber/core/test/location'
 require 'cucumber/running_test_case'
 
 module Cucumber
@@ -13,23 +13,19 @@ module Cucumber
 
       class CaseFilter
         def initialize(runtime, original_test_case)
-          @runtime, @original_test_case = runtime, original_test_case
+          @runtime = runtime
+          @original_test_case = original_test_case
         end
 
         def test_case
-          init_scenario = Cucumber::Hooks.around_hook(@original_test_case.source) do |continue|
+          init_scenario = Cucumber::Hooks.around_hook do |continue|
             @runtime.begin_scenario(scenario)
             continue.call
             @runtime.end_scenario(scenario)
           end
           around_hooks = [init_scenario] + @original_test_case.around_hooks
 
-          empty_hook = proc {} # no op - legacy format adapter expects a before hooks
-          empty_hook_location = Cucumber::Core::Ast::Location.from_source_location(*empty_hook.source_location)
-          default_hook = Cucumber::Hooks.before_hook(@original_test_case.source, empty_hook_location, &empty_hook)
-          steps = [default_hook] + @original_test_case.test_steps
-
-          @original_test_case.with_around_hooks(around_hooks).with_steps(steps)
+          @original_test_case.with_around_hooks(around_hooks).with_steps(@original_test_case.test_steps)
         end
 
         private