cucumber 2.99.0 → 3.0.0.pre.1

data/lib/cucumber/rb_support/rb_dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module RbSupport
     # This module defines the methods you can use to define pure Ruby
@@ -11,8 +12,8 @@ module Cucumber
           alias_method adverb, :register_rb_step_definition
         end
 
-        def build_rb_world_factory(world_modules, proc)
-          @rb_language.build_rb_world_factory(world_modules, proc)
+        def build_rb_world_factory(world_modules, namespaced_world_modules, proc)
+          @rb_language.build_rb_world_factory(world_modules, namespaced_world_modules, proc)
         end
 
         def register_rb_hook(phase, tag_names, proc)
@@ -33,6 +34,10 @@ module Cucumber
       # Object that the scenario's steps will run within. Any +world_modules+
       # will be mixed into this Object (via Object#extend).
       #
+      # By default the +world modules+ are added to a global namespace. It is
+      # possible to create a namespaced World by using an hash, where the
+      # symbols are the namespaces.
+      #
       # This method is typically called from one or more Ruby scripts under
       # <tt>features/support</tt>. You can call this method as many times as you
       # like (to register more modules), but if you try to register more than
@@ -46,8 +51,10 @@ module Cucumber
       #
       #    World(MyModule)
       #
-      def World(*world_modules, &proc)
-        RbDsl.build_rb_world_factory(world_modules, proc)
+      #    World(my_module: MyModule)
+      #
+      def World(*world_modules, **namespaced_world_modules, &proc)
+        RbDsl.build_rb_world_factory(world_modules, namespaced_world_modules, proc)
       end
 
       # Registers a proc that will run before each Scenario. You can register as many
@@ -83,11 +90,6 @@ module Cucumber
       # provided proc. The return value of the proc is consequently yielded to the
       # step definition.
       def Transform(regexp, &proc)
-        Cucumber.deprecate(
-          "\n         Please follow the upgrade instructions at https://cucumber.io/blog/2017/09/21/upgrading-to-cucumber-3",
-          "Transform",
-          "3.0.0"
-        )
         RbDsl.register_rb_transform(regexp, proc)
       end
 

data/lib/cucumber/rb_support/rb_hook.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module RbSupport
     # Wrapper for Before, After and AfterStep hooks

data/lib/cucumber/rb_support/rb_language.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core_ext/instance_exec'
 require 'cucumber/rb_support/rb_dsl'
 require 'cucumber/rb_support/rb_world'
@@ -9,6 +10,7 @@ require 'cucumber/gherkin/i18n'
 require 'multi_test'
 require 'cucumber/step_match'
 require 'cucumber/step_definition_light'
+require 'cucumber/events/step_definition_registered'
 
 module Cucumber
   module RbSupport
@@ -22,7 +24,8 @@ module Cucumber
     # Raised if there are 2 or more World blocks.
     class MultipleWorld < StandardError
       def initialize(first_proc, second_proc)
-        message = "You can only pass a proc to #World once, but it's happening\n"
+        message = String.new
+        message << "You can only pass a proc to #World once, but it's happening\n"
         message << "in 2 places:\n\n"
         message << RbSupport.backtrace_line(first_proc, 'World') << "\n"
         message << RbSupport.backtrace_line(second_proc, 'World') << "\n\n"
@@ -46,11 +49,11 @@ module Cucumber
       end
 
       def initialize(runtime, configuration)
-        @runtime = runtime
+        @runtime, @configuration = runtime, configuration
         @step_definitions = []
         RbDsl.rb_language = self
         @world_proc = @world_modules = nil
-        configuration.register_snippet_generator(Snippet::Generator.new)
+        @configuration.register_snippet_generator(Snippet::Generator.new)
       end
 
       def step_matches(name_to_match)
@@ -79,16 +82,24 @@ module Cucumber
       def register_rb_step_definition(regexp, proc_or_sym, options)
         step_definition = RbStepDefinition.new(self, regexp, proc_or_sym, options)
         @step_definitions << step_definition
+        @configuration.notify :step_definition_registered, step_definition
         step_definition
       end
 
-      def build_rb_world_factory(world_modules, proc)
-        if(proc)
+      def build_rb_world_factory(world_modules, namespaced_world_modules, proc)
+        if proc
           raise MultipleWorld.new(@world_proc, proc) if @world_proc
           @world_proc = proc
         end
         @world_modules ||= []
         @world_modules += world_modules
+
+        @namespaced_world_modules ||= Hash.new { |h, k| h[k] = [] }
+        namespaced_world_modules.each do |namespace, world_module|
+          unless @namespaced_world_modules[namespace].include?(world_module)
+            @namespaced_world_modules[namespace] << world_module
+          end
+        end
       end
 
       def load_code_file(code_file)
@@ -177,9 +188,9 @@ module Cucumber
       def extend_world
         @current_world.extend(RbWorld)
         MultiTest.extend_with_best_assertion_library(@current_world)
-        (@world_modules || []).each do |mod|
-          @current_world.extend(mod)
-        end
+
+        @current_world.add_modules!(@world_modules || [],
+                                    @namespaced_world_modules || {})
       end
 
       def connect_world(scenario)

data/lib/cucumber/rb_support/rb_step_definition.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/step_match'
 require 'cucumber/step_argument'
 require 'cucumber/core_ext/string'

data/lib/cucumber/rb_support/rb_transform.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module RbSupport
     # A Ruby Transform holds a Regexp and a Proc, and is created

data/lib/cucumber/rb_support/rb_world.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/gherkin/formatter/ansi_escapes'
 
 module Cucumber
@@ -20,6 +21,12 @@ module Cucumber
       # @private
       attr_writer :__cucumber_runtime, :__natural_language
 
+      # Extend the World with user-defined modules
+      def add_modules!(world_modules, namespaced_world_modules)
+        add_world_modules!(world_modules)
+        add_namespaced_modules!(namespaced_world_modules)
+      end
+
       # Run a single Gherkin step
       # @example Call another step
       #   step "I am logged in"
@@ -66,26 +73,6 @@ module Cucumber
         @__cucumber_runtime.table(text_or_table, file, line_offset)
       end
 
-      # Create an {Cucumber::Ast::DocString} object
-      #
-      # Useful in conjunction with the #step method, when
-      # want to specify a content type.
-      # @example Create a multiline string
-      #   code = multiline_string(%{
-      #     puts "this is ruby code"
-      #   %}, 'ruby')
-      def doc_string(string_without_triple_quotes, content_type='', line_offset=0)
-        STDERR.puts AnsiEscapes.failed + "WARNING: #doc_string is deprecated. Just pass a regular String instead:" + caller[0] + AnsiEscapes.reset
-        # TODO: rename this method to multiline_string
-        @__cucumber_runtime.doc_string(string_without_triple_quotes, content_type, line_offset)
-      end
-
-      # @deprecated Use {#puts} instead.
-      def announce(*messages)
-        STDERR.puts AnsiEscapes.failed + "WARNING: #announce is deprecated. Use #puts instead:" + caller[0] + AnsiEscapes.reset
-        puts(*messages)
-      end
-
       # Print a message to the output.
       #
       # @note Cucumber might surprise you with the behaviour of this method. Instead
@@ -137,6 +124,7 @@ module Cucumber
         (class << self; self; end).instance_eval do
           modules += included_modules
         end
+        modules << stringify_namespaced_modules
         sprintf("#<%s:0x%x>", modules.join('+'), self.object_id)
       end
 
@@ -144,6 +132,40 @@ module Cucumber
       def to_s
         inspect
       end
+
+      private
+
+      # @private
+      def add_world_modules!(modules)
+        modules.each do |world_module|
+          extend(world_module)
+        end
+      end
+
+      # @private
+      def add_namespaced_modules!(modules)
+        @__namespaced_modules = modules
+        modules.each do |namespace, world_modules|
+          world_modules.each do |world_module|
+            variable_name = "@__#{namespace}_world"
+
+            inner_world = if self.class.respond_to?(namespace)
+                            instance_variable_get(variable_name)
+                          else
+                            Object.new
+                          end
+            instance_variable_set(variable_name,
+                                  inner_world.extend(world_module))
+            self.class.send(:define_method, namespace) do
+              instance_variable_get(variable_name)
+            end
+          end
+        end
+      end
+
+      def stringify_namespaced_modules
+        @__namespaced_modules.map { |k, v| "#{v.join(',')} (as #{k})" }.join('+')
+      end
     end
   end
 end

data/lib/cucumber/rb_support/snippet.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module RbSupport
     module Snippet
@@ -56,7 +57,7 @@ module Cucumber
         end
 
         def do_block
-          do_block = ""
+          do_block = String.new
           do_block << "do#{arguments}\n"
           multiline_argument.append_comment_to(do_block)
           do_block << "  pending # Write code here that turns the phrase above into concrete actions\n"

data/lib/cucumber/rspec/disable_option_parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module Spec #:nodoc:

data/lib/cucumber/rspec/doubles.rb

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

data/lib/cucumber/running_test_case.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 require 'delegate'
-require 'cucumber/deprecate'
 
 module Cucumber
   # Represents the current status of a running test case.
@@ -80,34 +80,10 @@ module Cucumber
         !failed?
       end
 
-      def title
-        Cucumber.deprecate(
-          "Call #name instead",
-          "RunningTestCase#title",
-          "2.9.9")
-        name
-      end
-
-      def source_tags
-        Cucumber.deprecate(
-          "Call #tags instead",
-          "RunningTestCase#source_tags",
-          "2.9.9")
-        tags
-      end
-
       def source_tag_names
         tags.map &:name
       end
 
-      def skip_invoke!
-        Cucumber.deprecate(
-          "Call #skip_this_scenario directly (not on any object)",
-          "RunningTestCase#skip_invoke!",
-          "2.9.9")
-        raise Cucumber::Core::Test::Result::Skipped
-      end
-
       def outline?
         false
       end

data/lib/cucumber/runtime.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'fileutils'
 require 'multi_json'
 require 'cucumber/configuration'
@@ -7,7 +8,6 @@ require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'
 require 'cucumber/filters'
 require 'cucumber/formatter/fanout'
-require 'cucumber/formatter/event_bus_report'
 require 'cucumber/gherkin/i18n'
 require 'cucumber/step_match_search'
 
@@ -58,13 +58,16 @@ module Cucumber
 
     require 'cucumber/wire/plugin'
     def run!
-      load_step_definitions
       install_wire_plugin
+      load_support_files
       fire_after_configuration_hook
+      formatters
+      load_step_definitions
       self.visitor = report
 
-      receiver = Test::Runner.new(report)
+      receiver = Test::Runner.new(@configuration.event_bus)
       compile features, receiver, filters
+      @configuration.notify :test_run_finished
     end
 
     def features_paths
@@ -169,17 +172,13 @@ module Cucumber
     require 'cucumber/core/report/summary'
     def report
       return @report if @report
-      reports = [summary_report, event_bus_report] + formatters
+      reports = [summary_report] + formatters
       reports << fail_fast_report if @configuration.fail_fast?
       @report ||= Formatter::Fanout.new(reports)
     end
 
     def summary_report
-      @summary_report ||= Core::Report::Summary.new
-    end
-
-    def event_bus_report
-      @event_bus_report ||= Formatter::EventBusReport.new(@configuration)
+      @summary_report ||= Core::Report::Summary.new(@configuration.event_bus)
     end
 
     def fail_fast_report
@@ -231,6 +230,7 @@ module Cucumber
         filters << Cucumber::Core::Test::LocationsFilter.new(filespecs.locations)
         filters << Filters::Randomizer.new(@configuration.seed) if @configuration.randomize?
         filters << Filters::Quit.new
+        filters << Filters::Retry.new(@configuration)
         # TODO: can we just use RbLanguages's step definitions directly?
         step_match_search = StepMatchSearch.new(@support_code.ruby.method(:step_matches), @configuration)
         filters << Filters::ActivateSteps.new(step_match_search, @configuration)
@@ -248,8 +248,13 @@ module Cucumber
       end
     end
 
+    def load_support_files
+      files = @configuration.support_to_load
+      @support_code.load_files!(files)
+    end
+
     def load_step_definitions
-      files = @configuration.support_to_load + @configuration.step_defs_to_load
+      files = @configuration.step_defs_to_load
       @support_code.load_files!(files)
     end
 

data/lib/cucumber/runtime/after_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   class Runtime
     class AfterHooks

data/lib/cucumber/runtime/before_hooks.rb

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

data/lib/cucumber/runtime/for_programming_languages.rb

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

data/lib/cucumber/runtime/step_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   class Runtime
     class StepHooks

data/lib/cucumber/runtime/support_code.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/constantize'
 require 'cucumber/runtime/for_programming_languages'
 require 'cucumber/runtime/step_hooks'

data/lib/cucumber/runtime/user_interface.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'timeout'
 
 module Cucumber

data/lib/cucumber/step_argument.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   # Defines the location and value of a captured argument from the step
   # text

data/lib/cucumber/step_definition_light.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   # Only used for keeping track of available and invoked step definitions
   # in a way that also works for other programming languages (i.e. cuke4duke)

data/lib/cucumber/step_definitions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   class StepDefinitions
     def initialize(configuration = Configuration.default)

data/lib/cucumber/step_match.rb

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

data/lib/cucumber/step_match_search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module StepMatchSearch
     def self.new(search, configuration)

data/lib/cucumber/term/ansicolor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Term
     # The ANSIColor module can be used for namespacing and mixed into your own