cucumber 2.99.0 → 3.0.0

data/lib/cucumber/runtime/for_programming_languages.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 require 'forwardable'
 require 'cucumber/core/ast/doc_string'
-require 'cucumber/core/ast/data_table'
 
 module Cucumber
   class Runtime
@@ -26,41 +26,7 @@ module Cucumber
 
       def_delegators :@support_code,
         :invoke_dynamic_steps,
-        :invoke_dynamic_step,
-        :load_programming_language
-
-      # Returns a Cucumber::MultilineArgument::DataTable for +text_or_table+, which can either
-      # be a String:
-      #
-      #   table(%{
-      #     | account | description | amount |
-      #     | INT-100 | Taxi        | 114    |
-      #     | CUC-101 | Peeler      | 22     |
-      #   })
-      #
-      # or a 2D Array:
-      #
-      #   table([
-      #     %w{ account description amount },
-      #     %w{ INT-100 Taxi        114    },
-      #     %w{ CUC-101 Peeler      22     }
-      #   ])
-      #
-      def table(text_or_table, file=nil, line=0)
-        if !file
-          location = Core::Ast::Location.of_caller
-        else
-          location = Core::Ast::Location.new(file, line)
-        end
-        MultilineArgument::DataTable.from(text_or_table, location)
-      end
-
-      # Returns a Cucumber::MultilineArgument::DocString for +body+.
-      #
-      def doc_string(body, content_type='', line_offset=0)
-        location = Core::Ast::Location.of_caller
-        MultilineArgument.doc_string(body, content_type, location)
-      end
+        :invoke_dynamic_step
     end
   end
 end

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,9 +1,9 @@
+# frozen_string_literal: true
 require 'cucumber/constantize'
 require 'cucumber/runtime/for_programming_languages'
 require 'cucumber/runtime/step_hooks'
 require 'cucumber/runtime/before_hooks'
 require 'cucumber/runtime/after_hooks'
-require 'cucumber/events/step_match'
 require 'cucumber/gherkin/steps_parser'
 require 'cucumber/step_match_search'
 
@@ -30,9 +30,11 @@ module Cucumber
         end
 
         def multiline_arg(step, location)
-          if argument = step[:argument]
+          argument = step[:argument]
+
+          if argument
             if argument[:type] == :DocString
-              MultilineArgument.doc_string(argument[:content], argument[:content_type], location)
+              MultilineArgument.from(argument[:content], location, argument[:content_type])
             else
               MultilineArgument::DataTable.from(argument[:rows].map { |row| row[:cells].map { |cell| cell[:value] } })
             end
@@ -44,11 +46,13 @@ module Cucumber
 
       include Constantize
 
-      attr_reader :ruby
+      attr_reader :registry
+
       def initialize(user_interface, configuration=Configuration.default)
         @configuration = configuration
+        # TODO: needs a better name, or inlining its methods
         @runtime_facade = Runtime::ForProgrammingLanguages.new(self, user_interface)
-        @ruby = Cucumber::RbSupport::RbLanguage.new(@runtime_facade, @configuration)
+        @registry = Cucumber::Glue::RegistryAndMore.new(@runtime_facade, @configuration)
       end
 
       def configure(new_configuration)
@@ -61,7 +65,7 @@ module Cucumber
       #     Given I have 8 cukes in my belly
       #     Then I should not be thirsty
       #   })
-      def invoke_dynamic_steps(steps_text, i18n, location)
+      def invoke_dynamic_steps(steps_text, i18n, _location)
         parser = Cucumber::Gherkin::StepsParser.new(StepInvoker.new(self), i18n.iso_code)
         parser.parse(steps_text)
       end
@@ -72,7 +76,7 @@ module Cucumber
       # steps which are compiled into test steps before execution.
       #
       # These are commonly called nested steps.
-      def invoke_dynamic_step(step_name, multiline_argument, location=nil)
+      def invoke_dynamic_step(step_name, multiline_argument, _location=nil)
         matches = step_matches(step_name)
         raise UndefinedDynamicStep, step_name if matches.empty?
         matches.first.invoke(multiline_argument)
@@ -92,39 +96,40 @@ module Cucumber
       end
 
       def unmatched_step_definitions
-        @ruby.unmatched_step_definitions
+        registry.unmatched_step_definitions
       end
 
       def fire_hook(name, *args)
-        @ruby.send(name, *args)
+        # TODO: kill with fire
+        registry.send(name, *args)
       end
 
       def step_definitions
-        @ruby.step_definitions
+        registry.step_definitions
       end
 
       def find_after_step_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
-        hooks = @ruby.hooks_for(:after_step, scenario)
+        hooks = registry.hooks_for(:after_step, scenario)
         StepHooks.new hooks
       end
 
       def apply_before_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
-        hooks = @ruby.hooks_for(:before, scenario)
+        hooks = registry.hooks_for(:before, scenario)
         BeforeHooks.new(hooks, scenario).apply_to(test_case)
       end
 
       def apply_after_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
-        hooks = @ruby.hooks_for(:after, scenario)
+        hooks = registry.hooks_for(:after, scenario)
         AfterHooks.new(hooks, scenario).apply_to(test_case)
       end
 
       def find_around_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
 
-        @ruby.hooks_for(:around, scenario).map do |hook|
+        registry.hooks_for(:around, scenario).map do |hook|
           Hooks.around_hook(test_case.source) do |run_scenario|
             hook.invoke('Around', scenario, &run_scenario)
           end
@@ -134,12 +139,12 @@ module Cucumber
       private
 
       def step_matches(step_name)
-        StepMatchSearch.new(@ruby.method(:step_matches), @configuration).call(step_name)
+        StepMatchSearch.new(registry.method(:step_matches), @configuration).call(step_name)
       end
 
       def load_file(file)
         log.debug("  * #{file}\n")
-        @ruby.load_code_file(file)
+        registry.load_code_file(file)
       end
 
       def log

data/lib/cucumber/runtime/user_interface.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'timeout'
 
 module Cucumber
@@ -6,10 +7,6 @@ module Cucumber
     module UserInterface
       attr_writer :visitor
 
-      def visitor=(visitor)
-        @visitor = visitor
-      end
-
       # 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)
@@ -36,18 +33,15 @@ module Cucumber
         STDOUT.flush
         puts(question)
 
-        if(Cucumber::JRUBY)
-          answer = jruby_gets(timeout_seconds)
-        else
-          answer = mri_gets(timeout_seconds)
-        end
+        answer = if(Cucumber::JRUBY)
+                   jruby_gets(timeout_seconds)
+                 else
+                   mri_gets(timeout_seconds)
+                 end
 
-        if(answer)
-          puts(answer)
-          answer
-        else
-          raise("Waited for input for #{timeout_seconds} seconds, then timed out.")
-        end
+        raise("Waited for input for #{timeout_seconds} seconds, then timed out.") unless answer
+        puts(answer)
+        answer
       end
 
       # Embed +src+ of MIME type +mime_type+ into the output. The +src+ argument may
@@ -58,7 +52,7 @@ module Cucumber
         @visitor.embed(src, mime_type, label)
       end
 
-    private
+      private
 
       def mri_gets(timeout_seconds)
         begin

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,14 +8,13 @@ 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'
 
 module Cucumber
   module FixRuby21Bug9285
     def message
-      String(super).gsub("@ rb_sysopen ", "")
+      String(super).gsub('@ rb_sysopen ', '')
     end
   end
 
@@ -30,8 +30,14 @@ module Cucumber
   class FileNotFoundException < FileException
   end
 
-  class FeatureFolderNotFoundException < FileException
-    include FixRuby21Bug9285 if Cucumber::RUBY_2_1 || Cucumber::RUBY_2_2 || Cucumber::RUBY_2_3
+  class FeatureFolderNotFoundException < Exception
+    def initialize(path)
+      @path = path
+    end
+
+    def message
+      "No such file or directory - #{@path}"
+    end
   end
 
   require 'cucumber/core'
@@ -61,10 +67,12 @@ module Cucumber
       load_step_definitions
       install_wire_plugin
       fire_after_configuration_hook
+      # TODO: can we remove this state?
       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
@@ -87,22 +95,22 @@ module Cucumber
       @support_code.unmatched_step_definitions
     end
 
-    def begin_scenario(scenario)
-      @support_code.fire_hook(:begin_scenario, scenario)
+    def begin_scenario(test_case)
+      @support_code.fire_hook(:begin_scenario, test_case)
     end
 
-    def end_scenario(scenario)
+    def end_scenario(_scenario)
       @support_code.fire_hook(:end_scenario)
     end
 
     # Returns Ast::DocString for +string_without_triple_quotes+.
     #
-    def doc_string(string_without_triple_quotes, content_type='', line_offset=0)
+    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)
     end
 
-  private
+    private
 
     def fire_after_configuration_hook #:nodoc
       @support_code.fire_hook(:after_configuration, @configuration)
@@ -112,6 +120,7 @@ module Cucumber
     def features
       @features ||= feature_files.map do |path|
         source = NormalisedEncodingFile.read(path)
+        @configuration.notify :gherkin_source_read, path, source
         Cucumber::Core::Gherkin::Document.new(path, source)
       end
     end
@@ -138,13 +147,13 @@ module Cucumber
           set_encoding
         rescue Errno::EACCES => e
           raise FileNotFoundException.new(e, File.expand_path(path))
-        rescue Errno::ENOENT => e
-          raise FeatureFolderNotFoundException.new(e, path)
+        rescue Errno::ENOENT
+          raise FeatureFolderNotFoundException.new(path)
         end
       end
 
       def read
-        @file.read.encode("UTF-8")
+        @file.read.encode('UTF-8')
       end
 
       private
@@ -169,17 +178,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
@@ -187,34 +192,44 @@ module Cucumber
     end
 
     def formatters
-      @formatters ||= @configuration.formatter_factories { |factory, path_or_io, options|
-        create_formatter(factory, path_or_io, options)
-      }
+      @formatters ||=
+        @configuration.formatter_factories do |factory, formatter_options, path_or_io, options|
+          create_formatter(factory, formatter_options, path_or_io, options)
+        end
     end
 
-    def create_formatter(factory, path_or_io, options)
+    def create_formatter(factory, formatter_options, path_or_io, cli_options)
       if !legacy_formatter?(factory)
-        return factory.new(@configuration) if path_or_io.nil?
-        return factory.new(@configuration.with_options(out_stream: path_or_io))
+        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
       end
       results = Formatter::LegacyApi::Results.new
       runtime_facade = Formatter::LegacyApi::RuntimeFacade.new(results, @support_code, @configuration)
-      formatter = factory.new(runtime_facade, path_or_io, options)
+      formatter = factory.new(runtime_facade, path_or_io, cli_options)
       Formatter::LegacyApi::Adapter.new(
         Formatter::IgnoreMissingMessages.new(formatter),
         results, @configuration)
     end
 
-    def legacy_formatter?(factory)
+    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
       else
-        summary_report.test_cases.total_failed > 0 || summary_report.test_steps.total_failed > 0 ||
-          (@configuration.strict? && (summary_report.test_steps.total_undefined > 0 || summary_report.test_steps.total_pending > 0))
+        !summary_report.ok?(@configuration.strict)
       end
     end
     public :failure?
@@ -230,9 +245,8 @@ module Cucumber
         filters << Cucumber::Core::Test::NameFilter.new(name_regexps)
         filters << Cucumber::Core::Test::LocationsFilter.new(filespecs.locations)
         filters << Filters::Randomizer.new(@configuration.seed) if @configuration.randomize?
-        filters << Filters::Quit.new
-        # TODO: can we just use RbLanguages's step definitions directly?
-        step_match_search = StepMatchSearch.new(@support_code.ruby.method(:step_matches), @configuration)
+        # 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
@@ -242,6 +256,9 @@ module Cucumber
           filters << Filters::ApplyBeforeHooks.new(@support_code)
           filters << Filters::ApplyAfterHooks.new(@support_code)
           filters << Filters::ApplyAroundHooks.new(@support_code)
+          filters << Filters::BroadcastTestRunStartedEvent.new(@configuration)
+          filters << Filters::Quit.new
+          filters << Filters::Retry.new(@configuration)
           # need to do this last so it becomes the first test step
           filters << Filters::PrepareWorld.new(self)
         end

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
@@ -11,8 +12,6 @@ module Cucumber
           offset = match.offset(n)[0]
           new(offset, val)
         end
-      else
-        nil
       end
     end
 

data/lib/cucumber/step_definition_light.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 module Cucumber
+  # TODO: pointless, ancient, kill with fire.
   # Only used for keeping track of available and invoked step definitions
   # in a way that also works for other programming languages (i.e. cuke4duke)
   # Used for reporting purposes only (usage formatter).

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
@@ -12,7 +13,7 @@ module Cucumber
     end
 
     def args
-      @step_arguments.map{|g| g.val }
+      @step_arguments.map{|g| g.value }
     end
 
     def activate(test_step)
@@ -55,30 +56,31 @@ module Cucumber
     end
 
     def backtrace_line
-      "#{file_colon_line}:in `#{@step_definition.regexp_source}'"
+      "#{file_colon_line}:in `#{@step_definition.expression}'"
     end
 
     def text_length
-      @step_definition.regexp_source.unpack('U*').length
+      @step_definition.expression.source.to_s.unpack('U*').length
     end
 
     def replace_arguments(string, step_arguments, format, &proc)
       s = string.dup
       offset = past_offset = 0
       step_arguments.each do |step_argument|
-        next if step_argument.offset.nil? || step_argument.offset < past_offset
+        group = step_argument.group
+        next if group.value.nil? || group.start < past_offset
 
         replacement = if block_given?
-          proc.call(step_argument.val)
-        elsif Proc === format
-          format.call(step_argument.val)
-        else
-          format % step_argument.val
-        end
-
-        s[step_argument.offset + offset, step_argument.val.length] = replacement
-        offset += replacement.unpack('U*').length - step_argument.val.unpack('U*').length
-        past_offset = step_argument.offset + step_argument.val.length
+                        proc.call(group.value)
+                      elsif Proc === format
+                        format.call(group.value)
+                      else
+                        format % group.value
+                      end
+
+        s[group.start + offset, group.value.length] = replacement
+        offset += replacement.unpack('U*').length - group.value.unpack('U*').length
+        past_offset = group.start + group.value.length
       end
       s
     end
@@ -107,7 +109,7 @@ module Cucumber
       @name = name
     end
 
-    def format_args(*args)
+    def format_args(*_args)
       @name
     end
 
@@ -138,4 +140,17 @@ module Cucumber
       return test_step
     end
   end
+
+  class AmbiguousStepMatch
+
+    def initialize(error)
+      @error = error
+    end
+
+    def activate(test_step)
+      return test_step.with_action { raise @error }
+    end
+
+  end
+
 end

data/lib/cucumber/step_match_search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module StepMatchSearch
     def self.new(search, configuration)
@@ -32,8 +33,8 @@ module Cucumber
 
       private
 
-      def best_matches(step_name, step_matches) #:nodoc:
-        no_groups      = step_matches.select {|step_match| step_match.args.length == 0}
+      def best_matches(_step_name, step_matches) #:nodoc:
+        no_groups      = step_matches.select {|step_match| step_match.args.empty?}
         max_arg_length = step_matches.map {|step_match| step_match.args.length }.max
         top_groups     = step_matches.select {|step_match| step_match.args.length == max_arg_length }
 
@@ -64,4 +65,3 @@ module Cucumber
 
   end
 end
-

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
@@ -32,7 +33,7 @@ module Cucumber
         [ :on_blue      ,  44 ],
         [ :on_magenta   ,  45 ],
         [ :on_cyan      ,  46 ],
-        [ :on_white     ,  47 ],
+        [ :on_white     ,  47 ]
       ]
 
       ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first

data/lib/cucumber/unit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   class Unit
     def initialize(step_collection)

data/lib/cucumber/version

@@ -1 +1 @@
-2.99.0
+3.0.0

data/lib/cucumber.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yaml'
 require 'cucumber/encoding'
 require 'cucumber/platform'
@@ -20,18 +21,5 @@ module Cucumber
     def logger=(logger)
       @log = logger
     end
-
-    if Cucumber::RUBY_1_9
-      # Backported from Ruby 2.0 to 1.9
-      def Hash(other)
-        return {} if other.nil? || other == []
-        raise TypeError, "can't convert #{other.class} into Hash" unless other.respond_to?(:to_hash)
-        other.to_hash
-      end
-    else
-      def Hash(other)
-        Kernel::Hash(other)
-      end
-    end
   end
 end

data/lib/simplecov_setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if ENV['SIMPLECOV']
   begin
     # Suppress warnings in order not to pollute stdout which tests expectations rely on
@@ -13,6 +14,6 @@ if ENV['SIMPLECOV']
       add_filter '/features/'
     end
   rescue LoadError
-    warn("Unable to load simplecov")
+    warn('Unable to load simplecov')
   end
 end

data/scripts/invite-collaborator

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'octokit'
+
+class Team
+  attr_reader :gh, :name
+
+  def initialize(gh, name)
+    @gh = gh
+    @name = name
+  end
+
+  def add_member(login)
+    gh.add_team_membership(id, login)
+  end
+
+  def id
+    team['id']
+  end
+
+  def team
+    @team ||= gh.organization_teams('cucumber').
+      find { |team| team['name'] == name } || raise("Unable to find a team named #{name}")
+  end
+end
+
+begin
+  token = ENV['GITHUB_TOKEN'] || raise('You need to set GITHUB_TOKEN')
+  login = (ARGV[0] || raise("syntax: #{$0} <COLLABORATOR_LOGIN>")).to_s
+
+  gh = Octokit::Client.new(access_token: token)
+  [
+    Team.new(gh, 'cucumber-ruby'),
+    Team.new(gh, 'collaborators')
+  ].each { |team|
+    team.add_member(login)
+  }
+
+rescue StandardError => error
+  abort error.message
+end