cucumber 3.1.2 → 7.1.0

data/lib/cucumber/runtime/for_programming_languages.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'cucumber/core/ast/doc_string'
+require 'cucumber/core/test/doc_string'
 
 module Cucumber
   class Runtime
@@ -15,11 +15,13 @@ module Cucumber
       attr_reader :support_code
 
       def initialize(support_code, user_interface)
-        @support_code, @user_interface = support_code, user_interface
+        @support_code = support_code
+        @user_interface = user_interface
       end
 
       def_delegators :@user_interface,
                      :embed,
+                     :attach,
                      :ask,
                      :puts,
                      :features_paths,

data/lib/cucumber/runtime/step_hooks.rb

@@ -3,8 +3,10 @@
 module Cucumber
   class Runtime
     class StepHooks
-      def initialize(hooks)
+      def initialize(id_generator, hooks, event_bus)
         @hooks = hooks
+        @id_generator = id_generator
+        @event_bus = event_bus
       end
 
       def apply(test_steps)
@@ -18,7 +20,9 @@ module Cucumber
       def after_step_hooks(test_step)
         @hooks.map do |hook|
           action = ->(*args) { hook.invoke('AfterStep', [args, test_step]) }
-          Hooks.after_step_hook(test_step.source, hook.location, &action)
+          hook_step = Hooks.after_step_hook(@id_generator.new_id, test_step, hook.location, &action)
+          @event_bus.hook_test_step_created(hook_step, hook)
+          hook_step
         end
       end
     end

data/lib/cucumber/runtime/support_code.rb

@@ -22,19 +22,15 @@ module Cucumber
         end
 
         def step(step)
-          location = Core::Ast::Location.of_caller
+          location = Core::Test::Location.of_caller
           @support_code.invoke_dynamic_step(step[:text], multiline_arg(step, location))
         end
 
         def multiline_arg(step, location)
-          argument = step[:argument]
-
-          if argument
-            if argument[:type] == :DocString
-              MultilineArgument.from(argument[:content], location, argument[:content_type])
-            else
-              MultilineArgument::DataTable.from(argument[:rows].map { |row| row[:cells].map { |cell| cell[:value] } })
-            end
+          if !step[:doc_string].nil?
+            MultilineArgument.from(step[:doc_string][:content], location, step[:doc_string][:content_type])
+          elsif !step[:data_table].nil?
+            MultilineArgument::DataTable.from(step[:data_table][:rows].map { |row| row[:cells].map { |cell| cell[:value] } })
           else
             MultilineArgument.from(nil)
           end
@@ -62,8 +58,8 @@ module Cucumber
       #     Given I have 8 cukes in my belly
       #     Then I should not be thirsty
       #   })
-      def invoke_dynamic_steps(steps_text, i18n, _location)
-        parser = Cucumber::Gherkin::StepsParser.new(StepInvoker.new(self), i18n.iso_code)
+      def invoke_dynamic_steps(steps_text, iso_code, _location)
+        parser = Cucumber::Gherkin::StepsParser.new(StepInvoker.new(self), iso_code)
         parser.parse(steps_text)
       end
 
@@ -108,26 +104,28 @@ module Cucumber
       def find_after_step_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:after_step, scenario)
-        StepHooks.new hooks
+        StepHooks.new(@configuration.id_generator, hooks, @configuration.event_bus)
       end
 
       def apply_before_hooks(test_case)
+        return test_case if test_case.test_steps.empty?
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:before, scenario)
-        BeforeHooks.new(hooks, scenario).apply_to(test_case)
+        BeforeHooks.new(@configuration.id_generator, hooks, scenario, @configuration.event_bus).apply_to(test_case)
       end
 
       def apply_after_hooks(test_case)
+        return test_case if test_case.test_steps.empty?
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:after, scenario)
-        AfterHooks.new(hooks, scenario).apply_to(test_case)
+        AfterHooks.new(@configuration.id_generator, hooks, scenario, @configuration.event_bus).apply_to(test_case)
       end
 
       def find_around_hooks(test_case)
         scenario = RunningTestCase.new(test_case)
 
         registry.hooks_for(:around, scenario).map do |hook|
-          Hooks.around_hook(test_case.source) do |run_scenario|
+          Hooks.around_hook do |run_scenario|
             hook.invoke('Around', scenario, &run_scenario)
           end
         end

data/lib/cucumber/runtime/user_interface.rb

@@ -7,14 +7,6 @@ module Cucumber
     module UserInterface
       attr_writer :visitor
 
-      # 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)
-      #
-      def puts(*messages)
-        @visitor.puts(*messages)
-      end
-
       # Suspends execution and prompts +question+ to the console (STDOUT).
       # An operator (manual tester) can then enter a line of text and hit
       # <ENTER>. The entered text is returned, and both +question+ and
@@ -48,20 +40,18 @@ module Cucumber
       # be a path to a file, or if it's an image it may also be a Base64 encoded image.
       # The embedded data may or may not be ignored, depending on what kind of formatter(s) are active.
       #
-      def embed(src, mime_type, label)
-        @visitor.embed(src, mime_type, label)
+      def attach(src, media_type)
+        @visitor.attach(src, media_type)
       end
 
       private
 
       def mri_gets(timeout_seconds)
-        begin
-          Timeout.timeout(timeout_seconds) do
-            STDIN.gets
-          end
-        rescue Timeout::Error
-          nil
+        Timeout.timeout(timeout_seconds) do
+          STDIN.gets
         end
+      rescue Timeout::Error
+        nil
       end
 
       def jruby_gets(timeout_seconds)

data/lib/cucumber/runtime.rb

@@ -1,16 +1,19 @@
-# -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'multi_json'
 require 'cucumber/configuration'
+require 'cucumber/create_meta'
+require 'cucumber/deprecate'
 require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'
 require 'cucumber/filters'
 require 'cucumber/formatter/fanout'
 require 'cucumber/gherkin/i18n'
+require 'cucumber/glue/registry_wrapper'
 require 'cucumber/step_match_search'
+require 'cucumber/messages'
+require 'sys/uname'
 
 module Cucumber
   module FixRuby21Bug9285
@@ -19,8 +22,8 @@ module Cucumber
     end
   end
 
-  class FileException < Exception
-    attr :path
+  class FileException < RuntimeError
+    attr_reader :path
 
     def initialize(original_exception, path)
       super(original_exception)
@@ -31,7 +34,7 @@ module Cucumber
   class FileNotFoundException < FileException
   end
 
-  class FeatureFolderNotFoundException < Exception
+  class FeatureFolderNotFoundException < RuntimeError
     def initialize(path)
       @path = path
     end
@@ -54,7 +57,6 @@ module Cucumber
     def initialize(configuration = Configuration.default)
       @configuration = Configuration.new(configuration)
       @support_code = SupportCode.new(self, @configuration)
-      @results = Formatter::LegacyApi::Results.new
     end
 
     # Allows you to take an existing runtime and change its configuration
@@ -65,15 +67,23 @@ module Cucumber
 
     require 'cucumber/wire/plugin'
     def run!
+      @configuration.notify :envelope, Cucumber::Messages::Envelope.new(
+        meta: Cucumber::CreateMeta.create_meta('cucumber-ruby', Cucumber::VERSION)
+      )
+
       load_step_definitions
-      install_wire_plugin
       fire_after_configuration_hook
+      fire_install_plugin_hook
+      install_wire_plugin
+      fire_before_all_hook unless dry_run?
       # TODO: can we remove this state?
       self.visitor = report
 
       receiver = Test::Runner.new(@configuration.event_bus)
-      compile features, receiver, filters
+      compile features, receiver, filters, @configuration.event_bus
       @configuration.notify :test_run_finished
+
+      fire_after_all_hook unless dry_run?
     end
 
     def features_paths
@@ -84,14 +94,6 @@ module Cucumber
       @configuration.dry_run?
     end
 
-    def scenarios(status = nil)
-      @results.scenarios(status)
-    end
-
-    def steps(status = nil)
-      @results.steps(status)
-    end
-
     def unmatched_step_definitions
       @support_code.unmatched_step_definitions
     end
@@ -107,16 +109,27 @@ module Cucumber
     # Returns Ast::DocString for +string_without_triple_quotes+.
     #
     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)
+      Core::Test::DocString.new(string_without_triple_quotes, content_type)
     end
 
     private
 
-    def fire_after_configuration_hook #:nodoc
+    def fire_after_configuration_hook #:nodoc:
       @support_code.fire_hook(:after_configuration, @configuration)
     end
 
+    def fire_install_plugin_hook #:nodoc:
+      @support_code.fire_hook(:install_plugin, @configuration, registry_wrapper)
+    end
+
+    def fire_before_all_hook #:nodoc:
+      @support_code.fire_hook(:before_all)
+    end
+
+    def fire_after_all_hook #:nodoc:
+      @support_code.fire_hook(:after_all)
+    end
+
     require 'cucumber/core/gherkin/document'
     def features
       @features ||= feature_files.map do |path|
@@ -143,14 +156,12 @@ module Cucumber
       end
 
       def initialize(path)
-        begin
-          @file = File.new(path)
-          set_encoding
-        rescue Errno::EACCES => e
-          raise FileNotFoundException.new(e, File.expand_path(path))
-        rescue Errno::ENOENT
-          raise FeatureFolderNotFoundException.new(path)
-        end
+        @file = File.new(path)
+        set_encoding
+      rescue Errno::EACCES => e
+        raise FileNotFoundException.new(e, File.expand_path(path))
+      rescue Errno::ENOENT
+        raise FeatureFolderNotFoundException, path
       end
 
       def read
@@ -162,7 +173,7 @@ module Cucumber
       def set_encoding
         @file.each do |line|
           if ENCODING_PATTERN =~ line
-            @file.set_encoding $1
+            @file.set_encoding Regexp.last_match(1)
             break
           end
           break unless COMMENT_OR_EMPTY_LINE_PATTERN =~ line
@@ -171,16 +182,16 @@ module Cucumber
       end
     end
 
-    require 'cucumber/formatter/legacy_api/adapter'
-    require 'cucumber/formatter/legacy_api/runtime_facade'
-    require 'cucumber/formatter/legacy_api/results'
     require 'cucumber/formatter/ignore_missing_messages'
     require 'cucumber/formatter/fail_fast'
+    require 'cucumber/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
+
     def report
       return @report if @report
       reports = [summary_report] + formatters
       reports << fail_fast_report if @configuration.fail_fast?
+      reports << publish_banner_printer unless @configuration.publish_quiet?
       @report ||= Formatter::Fanout.new(reports)
     end
 
@@ -192,41 +203,32 @@ module Cucumber
       @fail_fast_report ||= Formatter::FailFast.new(@configuration)
     end
 
+    def publish_banner_printer
+      @publish_banner_printer ||= Formatter::PublishBannerPrinter.new(@configuration)
+    end
+
     def formatters
       @formatters ||=
-        @configuration.formatter_factories do |factory, formatter_options, path_or_io, options|
-          create_formatter(factory, formatter_options, path_or_io, options)
+        @configuration.formatter_factories do |factory, formatter_options, path_or_io|
+          create_formatter(factory, formatter_options, path_or_io)
         end
     end
 
-    def create_formatter(factory, formatter_options, path_or_io, cli_options)
-      if !legacy_formatter?(factory)
-        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
+    def create_formatter(factory, formatter_options, path_or_io)
+      if accept_options?(factory)
+        return factory.new(@configuration, formatter_options) if path_or_io.nil?
+        factory.new(@configuration.with_options(out_stream: path_or_io),
+                    formatter_options)
+      else
+        return factory.new(@configuration) if path_or_io.nil?
+        factory.new(@configuration.with_options(out_stream: path_or_io))
       end
-      results = Formatter::LegacyApi::Results.new
-      runtime_facade = Formatter::LegacyApi::RuntimeFacade.new(results, @support_code, @configuration)
-      formatter = factory.new(runtime_facade, path_or_io, cli_options)
-      Formatter::LegacyApi::Adapter.new(
-        Formatter::IgnoreMissingMessages.new(formatter),
-        results, @configuration
-      )
     end
 
     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
@@ -237,7 +239,7 @@ module Cucumber
     public :failure?
 
     require 'cucumber/core/test/filters'
-    def filters
+    def filters # rubocop:disable Metrics/AbcSize
       tag_expressions = @configuration.tag_expressions
       name_regexps = @configuration.name_regexps
       tag_limits = @configuration.tag_limits
@@ -250,14 +252,18 @@ module Cucumber
         # 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
-        end
+        @configuration.filters.each { |filter| filters << filter }
+
         unless configuration.dry_run?
           filters << Filters::ApplyAfterStepHooks.new(@support_code)
           filters << Filters::ApplyBeforeHooks.new(@support_code)
           filters << Filters::ApplyAfterHooks.new(@support_code)
           filters << Filters::ApplyAroundHooks.new(@support_code)
+        end
+
+        filters << Filters::BroadcastTestCaseReadyEvent.new(@configuration)
+
+        unless configuration.dry_run?
           filters << Filters::BroadcastTestRunStartedEvent.new(@configuration)
           filters << Filters::Quit.new
           filters << Filters::Retry.new(@configuration)
@@ -273,7 +279,19 @@ module Cucumber
     end
 
     def install_wire_plugin
-      Cucumber::Wire::Plugin.new(@configuration).install if @configuration.all_files_to_load.any? { |f| f =~ %r{\.wire$} }
+      return if Cucumber::Wire::Plugin.installed?
+      return unless @configuration.all_files_to_load.any? { |f| f =~ /\.wire$/ }
+
+      Cucumber::Wire::Plugin.new(@configuration, registry_wrapper).install
+      Cucumber.deprecate(
+        'See https://github.com/cucumber/cucumber-ruby/blob/main/UPGRADING.md#upgrading-to-710 for more info',
+        ' built-in usage of the wire protocol',
+        '8.0.0'
+      )
+    end
+
+    def registry_wrapper
+      Cucumber::Glue::RegistryWrapper.new(@support_code.registry)
     end
 
     def log

data/lib/cucumber/step_definition_light.rb

@@ -9,11 +9,12 @@ module Cucumber
     attr_reader :regexp_source, :location
 
     def initialize(regexp_source, location)
-      @regexp_source, @location = regexp_source, location
+      @regexp_source = regexp_source
+      @location = location
     end
 
-    def eql?(o)
-      regexp_source == o.regexp_source && location == o.location
+    def eql?(other)
+      regexp_source == other.regexp_source && location == other.location
     end
 
     def hash

data/lib/cucumber/step_definitions.rb

@@ -8,8 +8,8 @@ module Cucumber
       @support_code.load_files_from_paths(configuration.autoload_code_paths)
     end
 
-    def to_json
-      @support_code.step_definitions.map(&:to_hash).to_json
+    def to_json(obj = nil)
+      @support_code.step_definitions.map(&:to_hash).to_json(obj)
     end
   end
 end

data/lib/cucumber/step_match.rb

@@ -9,7 +9,9 @@ module Cucumber
 
     def initialize(step_definition, step_name, step_arguments)
       raise "step_arguments can't be nil (but it can be an empty array)" if step_arguments.nil?
-      @step_definition, @name_to_match, @step_arguments = step_definition, step_name, step_arguments
+      @step_definition = step_definition
+      @name_to_match = step_name
+      @step_arguments = step_arguments
     end
 
     def args
@@ -21,12 +23,12 @@ module Cucumber
 
     def activate(test_step)
       test_step.with_action(@step_definition.location) do
-        invoke(MultilineArgument.from_core(test_step.source.last.multiline_arg))
+        invoke(MultilineArgument.from_core(test_step.multiline_arg))
       end
     end
 
     def invoke(multiline_arg)
-      all_args = deep_clone_args
+      all_args = args
       multiline_arg.append_to(all_args)
       @step_definition.invoke(all_args)
     end
@@ -46,7 +48,7 @@ module Cucumber
     #
     #   lambda { |param| "[#{param}]" }
     #
-    def format_args(format = lambda { |a| a }, &proc)
+    def format_args(format = ->(a) { a }, &proc)
       replace_arguments(@name_to_match, @step_arguments, format, &proc)
     end
 
@@ -75,7 +77,7 @@ module Cucumber
 
         replacement = if block_given?
                         yield(group.value)
-                      elsif Proc === format
+                      elsif Proc == format.class
                         format.call(group.value)
                       else
                         format % group.value
@@ -91,17 +93,11 @@ module Cucumber
     def inspect #:nodoc:
       "#<#{self.class}: #{location}>"
     end
-
-    private
-
-    def deep_clone_args
-      Marshal.load( Marshal.dump( args ) )
-    end
   end
 
   class SkippingStepMatch
     def activate(test_step)
-      return test_step.with_action { raise Core::Test::Result::Skipped.new }
+      test_step.with_action { raise Core::Test::Result::Skipped }
     end
   end
 
@@ -123,8 +119,7 @@ module Cucumber
     end
 
     def file_colon_line
-      raise "No file:line for #{@step}" unless @step.file_colon_line
-      @step.file_colon_line
+      location.to_s
     end
 
     def backtrace_line
@@ -132,7 +127,7 @@ module Cucumber
     end
 
     def text_length
-      @step.text_length
+      @step.text.length
     end
 
     def step_arguments
@@ -141,7 +136,7 @@ module Cucumber
 
     def activate(test_step)
       # noop
-      return test_step
+      test_step
     end
   end
 
@@ -151,7 +146,7 @@ module Cucumber
     end
 
     def activate(test_step)
-      return test_step.with_action { raise @error }
+      test_step.with_action { raise @error }
     end
   end
 end

data/lib/cucumber/step_match_search.rb

@@ -13,7 +13,8 @@ module Cucumber
 
     class AssertUnambiguousMatch
       def initialize(search, configuration)
-        @search, @configuration = search, configuration
+        @search = search
+        @configuration = configuration
       end
 
       def call(step_name)

data/lib/cucumber/term/ansicolor.rb

@@ -35,7 +35,7 @@ module Cucumber
         [:on_magenta,    45],
         [:on_cyan,       46],
         [:on_white,      47]
-      ]
+      ].freeze
 
       ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
       # :startdoc:
@@ -54,8 +54,9 @@ module Cucumber
       end
       self.coloring = true
 
+      # rubocop:disable Security/Eval
       ATTRIBUTES.each do |c, v|
-        eval %Q{
+        eval <<-END_EVAL, binding, __FILE__, __LINE__ + 1
             def #{c}(string = nil)
               result = String.new
               result << "\e[#{v}m" if Cucumber::Term::ANSIColor.coloring?
@@ -71,23 +72,23 @@ module Cucumber
               result << "\e[0m" if Cucumber::Term::ANSIColor.coloring?
               result
             end
-        }
+        END_EVAL
       end
+      # rubocop:enable Security/Eval
 
       # Regular expression that is used to scan for ANSI-sequences while
       # uncoloring strings.
       COLORED_REGEXP = /\e\[(?:[34][0-7]|[0-9])?m/
 
       def self.included(klass)
-        if klass == String
-          ATTRIBUTES.delete(:clear)
-          ATTRIBUTE_NAMES.delete(:clear)
-        end
+        return unless klass == String
+        ATTRIBUTES.delete(:clear)
+        ATTRIBUTE_NAMES.delete(:clear)
       end
 
       # Returns an uncolored version of the string, that is all
       # ANSI-sequences are stripped from the string.
-      def uncolored(string = nil) # :yields:
+      def uncolored(string = nil)
         if block_given?
           yield.gsub(COLORED_REGEXP, '')
         elsif string
@@ -105,7 +106,6 @@ module Cucumber
       def attributes
         ATTRIBUTE_NAMES
       end
-      extend self
     end
   end
 end

data/lib/cucumber/term/banner.rb

@@ -0,0 +1,56 @@
+require 'cucumber/term/ansicolor'
+
+module Cucumber
+  module Term
+    module Banner
+      def display_banner(lines, io, border_modifiers = nil)
+        BannerMaker.new.display_banner(lines, io, border_modifiers || %i[green bold])
+      end
+
+      class BannerMaker
+        include Term::ANSIColor
+
+        def display_banner(lines, io, border_modifiers)
+          lines = lines.split("\n") if lines.is_a? String
+          longest_line_length = lines.map { |line| line_length(line) }.max
+
+          io.puts apply_modifiers("┌#{'─' * (longest_line_length + 2)}┐", border_modifiers)
+          lines.map do |line|
+            padding = ' ' * (longest_line_length - line_length(line))
+            io.puts "#{apply_modifiers('│', border_modifiers)} #{display_line(line)}#{padding} #{apply_modifiers('│', border_modifiers)}"
+          end
+          io.puts apply_modifiers("└#{'─' * (longest_line_length + 2)}┘", border_modifiers)
+        end
+
+        private
+
+        def display_line(line)
+          line.is_a?(Array) ? line.map { |span| display_span(span) }.join : line
+        end
+
+        def display_span(span)
+          return apply_modifiers(span.shift, span) if span.is_a?(Array)
+          span
+        end
+
+        def apply_modifiers(str, modifiers)
+          display = str
+          modifiers.each { |modifier| display = send(modifier, display) }
+          display
+        end
+
+        def line_length(line)
+          if line.is_a?(Array)
+            line.map { |span| span_length(span) }.sum
+          else
+            line.length
+          end
+        end
+
+        def span_length(span)
+          span.is_a?(Array) ? span[0].length : span.length
+        end
+      end
+    end
+  end
+end