cucumber 3.0.0.pre.2 → 4.0.0.rc.5

data/lib/cucumber/cli/profile_loader.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
+
 require 'yaml'
 
 module Cucumber
   module Cli
-
     class ProfileLoader
-
       def initialize
         @cucumber_yml = nil
       end
@@ -17,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
@@ -46,7 +38,7 @@ Defined profiles in cucumber.yml:
         args_from_yml
       end
 
-      def has_profile?(profile)
+      def profile?(profile)
         cucumber_yml.key?(profile)
       end
 
@@ -59,29 +51,47 @@ 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 = if RUBY_VERSION >= '2.6'
+                            ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
+                          else
+                            ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
+                          end
         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")
+          raise(YmlLoadError, "cucumber.yml was found, but could not be parsed. 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,
@@ -91,6 +101,17 @@ Defined profiles in cucumber.yml:
         @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

@@ -1,4 +1,5 @@
 # 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/messages'
 require 'cucumber/core/event_bus'
+require 'cucumber/core/test/result'
 require 'forwardable'
 require 'cucumber'
 
@@ -52,7 +55,7 @@ module Cucumber
     end
 
     def seed
-      Integer(@options[:seed] || rand(0xFFFF))
+      @options[:seed]
     end
 
     def dry_run?
@@ -71,7 +74,7 @@ module Cucumber
       @options[:guess]
     end
 
-    def strict?
+    def strict
       @options[:strict]
     end
 
@@ -165,27 +168,31 @@ 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 =~ %r{/support/} }
+
+      # env_files are separated from other_files so we can ensure env files
+      # load first.
+      #
+      env_files = support_files.select { |f| f =~ %r{/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
       files = require_dirs.map do |path|
         path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
-        path = path.gsub(/\/$/, '') # Strip trailing slash.
+        path = path.gsub(/\/$/, '') # Strip trailing slash. # rubocop:disable Style/RegexpLiteral
         File.directory?(path) ? Dir["#{path}/**/*"] : path
       end.flatten.uniq
       remove_excluded_files_from(files)
-      files.reject! {|f| !File.file?(f)}
-      files.reject! {|f| File.extname(f) == '.feature' }
-      files.reject! {|f| f =~ /^http/}
+      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 =~ %r{/support/} }
     end
 
     def formatter_factories
@@ -194,9 +201,8 @@ module Cucumber
           factory = formatter_class(format)
           yield factory,
                 formatter_options,
-                path_or_io,
-                Cli::Options.new(STDOUT, STDERR, @options)
-        rescue Exception => e
+                path_or_io
+        rescue Exception => e # rubocop:disable Lint/RescueException
           raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
         end
       end
@@ -237,26 +243,30 @@ 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              => false,
-        :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,
+        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
 
@@ -270,7 +280,7 @@ module Cucumber
     end
 
     def remove_excluded_files_from(files)
-      files.reject! {|path| @options[:excludes].detect {|pattern| path =~ pattern } }
+      files.reject! { |path| @options[:excludes].detect { |pattern| path =~ pattern } }
     end
 
     def require_dirs

data/lib/cucumber/constantize.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'cucumber/platform'
 module Cucumber
   module Constantize #:nodoc:
@@ -16,21 +17,18 @@ 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
 
     # Snagged from active_support
     def underscore(camel_cased_word)
-      camel_cased_word.to_s.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr('-', '_').
-        downcase
+      camel_cased_word.to_s.gsub(/::/, '/')
+                      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                      .tr('-', '_')
+                      .downcase
     end
 
     private

data/lib/cucumber/core_ext/string.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class String #:nodoc:
   def indent(n)
     if n >= 0

data/lib/cucumber/deprecate.rb

@@ -1,30 +1,54 @@
 # frozen_string_literal: true
+
 require 'cucumber/platform'
 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)
-    Deprecate::Strategy.call(*args)
+    Deprecate::STRATEGY.call(*args)
   end
-
 end

data/lib/cucumber/encoding.rb

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

data/lib/cucumber/errors.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/test/result'
 
 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 new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
+      rescue StandardError => e
+        return e
       end
     end
 
@@ -36,9 +35,9 @@ 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{|sd| sd.backtrace_line}.join("\n")
+      message << step_definitions.map(&: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
       super(message)
@@ -50,4 +49,7 @@ module Cucumber
       super(messages.join("\n"))
     end
   end
+
+  class LogTypeInvalid < StandardError
+  end
 end

data/lib/cucumber/events.rb

@@ -1,8 +1,8 @@
 # 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
@@ -24,17 +24,22 @@ module Cucumber
 
     def self.registry
       Core::Events.build_registry(
-        TestCaseStarting,
-        TestCaseFinished,
-        TestStepFinished,
-        TestStepStarting,
-        StepDefinitionRegistered,
+        GherkinSourceParsed,
+        GherkinSourceRead,
+        HookTestStepCreated,
         StepActivated,
+        StepDefinitionRegistered,
+        TestCaseCreated,
+        TestCaseFinished,
+        TestCaseStarted,
+        TestCaseReady,
         TestRunFinished,
-        GherkinSourceRead,
-        TestRunStarting
+        TestRunStarted,
+        TestStepCreated,
+        TestStepFinished,
+        TestStepStarted,
+        Envelope
       )
     end
   end
 end
-