cucumber 3.1.2 → 7.1.0

data/lib/cucumber/formatter/usage.rb

@@ -2,10 +2,12 @@
 
 require 'cucumber/formatter/progress'
 require 'cucumber/step_definition_light'
+require 'cucumber/formatter/console'
 
 module Cucumber
   module Formatter
     class Usage < Progress
+      include Console
       class StepDefKey < StepDefinitionLight
         attr_accessor :mean_duration, :status
       end
@@ -17,7 +19,7 @@ module Cucumber
         @matches = {}
         config.on_event :step_activated do |event|
           test_step, step_match = *event.attributes
-          @matches[test_step.source] = step_match
+          @matches[test_step.to_s] = step_match
         end
         config.on_event :step_definition_registered, &method(:on_step_definition_registered)
       end
@@ -28,25 +30,26 @@ module Cucumber
       end
 
       def on_step_match(event)
-        @matches[event.test_step.source] = event.step_match
+        @matches[event.test_step.to_s] = event.step_match
         super
       end
 
       def on_test_step_finished(event)
-        return if HookQueryVisitor.new(event.test_step).hook?
+        return if event.test_step.hook?
 
         test_step = event.test_step
         result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
-        step_match = @matches[test_step.source]
+        step_match = @matches[test_step.to_s]
 
         unless step_match.nil?
           step_definition = step_match.step_definition
           stepdef_key = StepDefKey.new(step_definition.expression.to_s, step_definition.location)
           unless @stepdef_to_match[stepdef_key].map { |key| key[:location] }.include? test_step.location
             duration = DurationExtractor.new(result).result_duration
+            keyword = @ast_lookup.step_source(test_step).step.keyword
 
             @stepdef_to_match[stepdef_key] << {
-              keyword: test_step.source.last.keyword,
+              keyword: keyword,
               step_match: step_match,
               status: result.to_sym,
               location: test_step.location,
@@ -64,9 +67,9 @@ module Cucumber
         aggregate_info
 
         keys = if config.dry_run?
-                 @stepdef_to_match.keys.sort { |a, b| a.regexp_source <=> b.regexp_source }
+                 @stepdef_to_match.keys.sort_by(&:regexp_source)
                else
-                 @stepdef_to_match.keys.sort { |a, b| a.mean_duration <=> b.mean_duration }.reverse
+                 @stepdef_to_match.keys.sort_by(&:mean_duration).reverse
                end
 
         keys.each do |stepdef_key|
@@ -83,11 +86,11 @@ module Cucumber
       end
 
       def print_step_definition(stepdef_key)
-        @io.print format_string(format('%.7f', stepdef_key.mean_duration), :skipped) + ' ' unless config.dry_run?
+        @io.print format_string(format('%<duration>.7f', duration: stepdef_key.mean_duration), :skipped) + ' ' unless config.dry_run?
         @io.print format_string(stepdef_key.regexp_source, stepdef_key.status)
         if config.source?
-          indent = max_length - stepdef_key.regexp_source.unpack('U*').length
-          line_comment = "   # #{stepdef_key.location}".indent(indent)
+          indent_amount = max_length - stepdef_key.regexp_source.unpack('U*').length
+          line_comment = indent("   # #{stepdef_key.location}", indent_amount)
           @io.print(format_string(line_comment, :comment))
         end
         @io.puts
@@ -96,11 +99,11 @@ module Cucumber
       def print_steps(stepdef_key)
         @stepdef_to_match[stepdef_key].each do |step|
           @io.print '  '
-          @io.print format_string(format('%.7f', step[:duration]), :skipped) + ' ' unless config.dry_run?
+          @io.print format_string(format('%<duration>.7f', duration: step[:duration]), :skipped) + ' ' unless config.dry_run?
           @io.print format_step(step[:keyword], step[:step_match], step[:status], nil)
           if config.source?
-            indent = max_length - (step[:keyword].unpack('U*').length + step[:step_match].format_args.unpack('U*').length)
-            line_comment = " # #{step[:location]}".indent(indent)
+            indent_amount = max_length - (step[:keyword].unpack('U*').length + step[:step_match].format_args.unpack('U*').length)
+            line_comment = indent(" # #{step[:location]}", indent_amount)
             @io.print(format_string(line_comment, :comment))
           end
           @io.puts
@@ -135,7 +138,7 @@ module Cucumber
       end
 
       def worst_status(statuses)
-        [:passed, :undefined, :pending, :skipped, :failed].find do |status|
+        %i[passed undefined pending skipped failed].find do |status|
           statuses.include?(status)
         end
       end

data/lib/cucumber/gherkin/data_table_parser.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'gherkin/token_scanner'
-require 'gherkin/parser'
+require 'gherkin'
 require 'gherkin/dialect'
 
 module Cucumber
@@ -12,15 +11,27 @@ module Cucumber
       end
 
       def parse(text)
-        token_scanner = ::Gherkin::TokenScanner.new(feature_header + text)
-        parser = ::Gherkin::Parser.new
-        gherkin_document = parser.parse(token_scanner)
+        gherkin_document = nil
+        messages = ::Gherkin.from_source('dummy', feature_header + text, gherkin_options)
 
-        gherkin_document[:feature][:children][0][:steps][0][:argument][:rows].each do |row|
+        messages.each do |message|
+          gherkin_document = message.gherkin_document.to_h unless message.gherkin_document.nil?
+        end
+
+        return if gherkin_document.nil?
+        gherkin_document[:feature][:children][0][:scenario][:steps][0][:data_table][:rows].each do |row|
           @builder.row(row[:cells].map { |cell| cell[:value] })
         end
       end
 
+      def gherkin_options
+        {
+          include_source: false,
+          include_gherkin_document: true,
+          include_pickles: false
+        }
+      end
+
       def feature_header
         dialect = ::Gherkin::Dialect.for('en')
         %(#{dialect.feature_keywords[0]}:

data/lib/cucumber/gherkin/formatter/ansi_escapes.rb

@@ -51,23 +51,21 @@ module Cucumber
           'white'   => "\e[37m",
           'grey'    => "\e[90m",
           'bold'    => "\e[1m"
-        }
+        }.freeze
 
         ALIASES = Hash.new do |h, k|
-          if k.to_s =~ /(.*)_arg/
-            h[$1] + ',bold'
-          end
-        end.merge({
-                    'undefined' => 'yellow',
-                    'pending'   => 'yellow',
-                    'executing' => 'grey',
-                    'failed'    => 'red',
-                    'passed'    => 'green',
-                    'outline'   => 'cyan',
-                    'skipped'   => 'cyan',
-                    'comments'  => 'grey',
-                    'tag'       => 'cyan'
-                  })
+          h[Regexp.last_match(1)] + ',bold' if k.to_s =~ /(.*)_arg/
+        end.merge(
+          'undefined' => 'yellow',
+          'pending'   => 'yellow',
+          'executing' => 'grey',
+          'failed'    => 'red',
+          'passed'    => 'green',
+          'outline'   => 'cyan',
+          'skipped'   => 'cyan',
+          'comments'  => 'grey',
+          'tag'       => 'cyan'
+        )
 
         if ENV['GHERKIN_COLORS'] # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
           ENV['GHERKIN_COLORS'].split(':').each do |pair|
@@ -93,8 +91,6 @@ module Cucumber
         def up(n)
           "\e[#{n}A"
         end
-
-        extend self
       end
     end
   end

data/lib/cucumber/gherkin/formatter/escaping.rb

@@ -10,8 +10,8 @@ module Cucumber
         # * \ becomes \\
         #
         # This is used in the pretty formatter.
-        def escape_cell(s)
-          s.gsub(/\\(?!\|)/, '\\\\\\\\').gsub(/\n/, '\\n').gsub(/\|/, '\\|')
+        def escape_cell(sym)
+          sym.gsub(/\\(?!\|)/, '\\\\\\\\').gsub(/\n/, '\\n').gsub(/\|/, '\\|')
         end
       end
     end

data/lib/cucumber/gherkin/steps_parser.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'gherkin/token_scanner'
-require 'gherkin/token_matcher'
-require 'gherkin/parser'
+require 'gherkin'
 require 'gherkin/dialect'
 
 module Cucumber
@@ -15,12 +13,23 @@ module Cucumber
 
       def parse(text)
         dialect = ::Gherkin::Dialect.for(@language)
-        token_matcher = ::Gherkin::TokenMatcher.new(@language)
-        token_scanner = ::Gherkin::TokenScanner.new(feature_header(dialect) + text)
-        parser = ::Gherkin::Parser.new
-        gherkin_document = parser.parse(token_scanner, token_matcher)
+        gherkin_document = nil
+        messages = ::Gherkin.from_source('dummy', feature_header(dialect) + text, gherkin_options)
 
-        @builder.steps(gherkin_document[:feature][:children][0][:steps])
+        messages.each do |message|
+          gherkin_document = message.gherkin_document.to_h unless message.gherkin_document.nil?
+        end
+
+        @builder.steps(gherkin_document[:feature][:children][0][:scenario][:steps])
+      end
+
+      def gherkin_options
+        {
+          default_dialect: @language,
+          include_source: false,
+          include_gherkin_document: true,
+          include_pickles: false
+        }
       end
 
       def feature_header(dialect)

data/lib/cucumber/glue/dsl.rb

@@ -109,10 +109,29 @@ module Cucumber
 
       # Registers a proc that will run after Cucumber is configured. You can register as
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
+      #
+      # DEPRECATED: please use InstallPlugin or BeforeAll instead
       def AfterConfiguration(&proc)
         Dsl.register_rb_hook('after_configuration', [], proc)
       end
 
+      # Registers a proc that will run after Cucumber is configured in order to install an external plugin.
+      def InstallPlugin(&proc)
+        Dsl.register_rb_hook('install_plugin', [], proc)
+      end
+
+      # Registers a proc that will run before the execution of the scenarios.
+      # Use it for your final set-ups
+      def BeforeAll(&proc)
+        Dsl.register_rb_hook('before_all', [], proc)
+      end
+
+      # Registers a proc that will run after the execution of the scenarios.
+      # Use it for your final clean-ups
+      def AfterAll(&proc)
+        Dsl.register_rb_hook('after_all', [], proc)
+      end
+
       # Registers a new Ruby StepDefinition. This method is aliased
       # to <tt>Given</tt>, <tt>When</tt> and <tt>Then</tt>, and
       # also to the i18n translations whenever a feature of a

data/lib/cucumber/glue/hook.rb

@@ -6,14 +6,15 @@ module Cucumber
   module Glue
     # TODO: Kill pointless wrapper for Before, After and AfterStep hooks with fire
     class Hook
-      attr_reader :tag_expressions, :location
+      attr_reader :id, :tag_expressions, :location
 
-      def initialize(registry, tag_expressions, proc)
+      def initialize(id, registry, tag_expressions, proc)
+        @id = id
         @registry = registry
-        @tag_expressions = tag_expressions
+        @tag_expressions = sanitize_tag_expressions(tag_expressions)
         @proc = proc
-        @location = Cucumber::Core::Ast::Location.from_source_location(*@proc.source_location)
-        warn_for_old_style_tag_expressions(tag_expressions)
+        @location = Cucumber::Core::Test::Location.from_source_location(*@proc.source_location)
+        fail_for_old_style_tag_expressions(@tag_expressions)
       end
 
       def invoke(pseudo_method, arguments, &block)
@@ -27,16 +28,38 @@ module Cucumber
         )
       end
 
+      def to_envelope
+        Cucumber::Messages::Envelope.new(
+          hook: Cucumber::Messages::Hook.new(
+            id: id,
+            tag_expression: tag_expressions.join(' '),
+            source_reference: Cucumber::Messages::SourceReference.new(
+              uri: location.file,
+              location: Cucumber::Messages::Location.new(
+                line: location.lines.first
+              )
+            )
+          )
+        )
+      end
+
       private
 
-      def warn_for_old_style_tag_expressions(tag_expressions)
+      def sanitize_tag_expressions(tag_expressions)
+        # TODO: remove when '~@no-clobber' has been changed to 'not @no-clobber' in aruba
+        tag_expressions.map { |tag_expression| tag_expression == '~@no-clobber' ? 'not @no-clobber' : tag_expression }
+      end
+
+      def fail_for_old_style_tag_expressions(tag_expressions)
         tag_expressions.each do |tag_expression|
-          if tag_expression.include?('~') && tag_expression != '~@no-clobber' # ~@no-clobber is used in aruba
-            warn("Deprecated: Found tagged hook with '#{tag_expression}'. Support for '~@tag' will be removed from the next release of Cucumber. Please use 'not @tag' instead.")
-          end
-          if tag_expression.include?(',')
-            warn("Deprecated: Found tagged hook with '#{tag_expression}'. Support for '@tag1,@tag2' will be removed from the next release of Cucumber. Please use '@tag or @tag2' instead.")
+          if tag_expression.include?('~')
+            raise("Found tagged hook with '#{tag_expression}'." \
+            "'~@tag' is no longer supported, use 'not @tag' instead.")
           end
+
+          next unless tag_expression.include?(',')
+          warn("Found tagged hook with '#{tag_expression}'." \
+            "'@tag1,@tag2' is no longer supported, use '@tag or @tag2' instead.")
         end
       end
     end

data/lib/cucumber/glue/invoke_in_world.rb

@@ -11,16 +11,15 @@ module Cucumber
         return if Cucumber.use_full_backtrace
 
         instance_exec_pos = backtrace.index(instance_exec_invocation_line)
-        if instance_exec_pos
-          replacement_line = instance_exec_pos + INSTANCE_EXEC_OFFSET
-          backtrace[replacement_line].gsub!(/`.*'/, "`#{pseudo_method}'") if pseudo_method
+        return unless instance_exec_pos
+        replacement_line = instance_exec_pos + INSTANCE_EXEC_OFFSET
+        backtrace[replacement_line].gsub!(/`.*'/, "`#{pseudo_method}'") if pseudo_method
 
-          depth = backtrace.count { |line| line == instance_exec_invocation_line }
-          end_pos = depth > 1 ? instance_exec_pos : -1
+        depth = backtrace.count { |line| line == instance_exec_invocation_line }
+        end_pos = depth > 1 ? instance_exec_pos : -1
 
-          backtrace[replacement_line + 1..end_pos] = nil
-          backtrace.compact!
-        end
+        backtrace[replacement_line + 1..end_pos] = nil
+        backtrace.compact!
       end
 
       def self.cucumber_instance_exec_in(world, check_arity, pseudo_method, *args, &block)
@@ -31,9 +30,7 @@ module Cucumber
               ari = ari < 0 ? (ari.abs - 1).to_s + '+' : ari
               s1 = ari == 1 ? '' : 's'
               s2 = args.length == 1 ? '' : 's'
-              raise ArityMismatchError.new(
-                "Your block takes #{ari} argument#{s1}, but the Regexp matched #{args.length} argument#{s2}."
-              )
+              raise ArityMismatchError, "Your block takes #{ari} argument#{s1}, but the Regexp matched #{args.length} argument#{s2}."
             end
           else
             world.instance_exec(*args, &block)
@@ -50,13 +47,11 @@ module Cucumber
       end
 
       def self.cucumber_run_with_backtrace_filtering(pseudo_method)
-        begin
-          yield
-        rescue Exception => e
-          instance_exec_invocation_line = "#{__FILE__}:#{__LINE__ - 2}:in `cucumber_run_with_backtrace_filtering'"
-          replace_instance_exec_invocation_line!((e.backtrace || []), instance_exec_invocation_line, pseudo_method)
-          raise e
-        end
+        yield
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        instance_exec_invocation_line = "#{__FILE__}:#{__LINE__ - 2}:in `cucumber_run_with_backtrace_filtering'"
+        replace_instance_exec_invocation_line!((e.backtrace || []), instance_exec_invocation_line, pseudo_method)
+        raise e
       end
 
       INSTANCE_EXEC_OFFSET = -3

data/lib/cucumber/glue/proto_world.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'cucumber/gherkin/formatter/ansi_escapes'
-require 'cucumber/core/ast/data_table'
+require 'cucumber/core/test/data_table'
+require 'cucumber/deprecate'
+require 'mime/types'
 
 module Cucumber
   module Glue
@@ -24,7 +26,7 @@ module Cucumber
       # @example Passing a multiline string
       #   step "the email should contain:", "Dear sir,\nYou've won a prize!\n"
       # @param [String] name The name of the step
-      # @param [String,Cucumber::Ast::DocString,Cucumber::Ast::Table] multiline_argument
+      # @param [String,Cucumber::Test::DocString,Cucumber::Ast::Table] multiline_argument
       def step(name, raw_multiline_arg = nil)
         super
       end
@@ -67,20 +69,8 @@ module Cucumber
       #     %w{ CUC-101 Peeler      22     }
       #   ])
       #
-      def table(text_or_table, file = nil, line = 0)
-        location = !file ? Core::Ast::Location.of_caller : Core::Ast::Location.new(file, line)
-        MultilineArgument::DataTable.from(text_or_table, location)
-      end
-
-      # Print a message to the output.
-      #
-      # @note Cucumber might surprise you with the behaviour of this method. Instead
-      #   of sending the output directly to STDOUT, Cucumber will intercept and cache
-      #   the message until the current step has finished, and then display it.
-      #
-      #   If you'd prefer to see the message immediately, call {Kernel.puts} instead.
-      def puts(*messages)
-        super
+      def table(text_or_table)
+        MultilineArgument::DataTable.from(text_or_table)
       end
 
       # Pause the tests and ask the operator for input
@@ -88,23 +78,37 @@ module Cucumber
         super
       end
 
-      # Embed an image in the output
-      def embed(file, mime_type, label = 'Screenshot')
+      def log(*messages)
+        messages.each { |message| attach(message.to_s.dup, 'text/x.cucumber.log+plain') }
+      end
+
+      # Attach a file to the output
+      # @param file [string|io] the file to attach.
+      #   It can be a string containing the file content itself,
+      #   the file path, or an IO ready to be read.
+      # @param media_type [string] the media type. If file is a valid path,
+      #   media_type can be ommitted, it will then be inferred from the file name.
+      def attach(file, media_type = nil)
+        return super unless File.file?(file)
+
+        content = File.read(file, mode: 'rb')
+        media_type = MIME::Types.type_for(file).first if media_type.nil?
+
+        super(content, media_type.to_s)
+      rescue StandardError
         super
       end
 
       # Mark the matched step as pending.
       def pending(message = 'TODO')
-        if block_given?
-          begin
-            yield
-          rescue Exception
-            raise Pending, message
-          end
-          raise Pending, "Expected pending '#{message}' to fail. No Error was raised. No longer pending?"
-        else
+        raise Pending, message unless block_given?
+
+        begin
+          yield
+        rescue Exception # rubocop:disable Lint/RescueException
           raise Pending, message
         end
+        raise Pending, "Expected pending '#{message}' to fail. No Error was raised. No longer pending?"
       end
 
       # Skips this step and the remaining steps in the scenario
@@ -123,8 +127,8 @@ module Cucumber
       end
 
       # Dynamially generate the API module, closuring the dependencies
-      def self.for(runtime, language)
-        Module.new do
+      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+        Module.new do # rubocop:disable Metrics/BlockLength
           def self.extended(object)
             # wrap the dynamically generated module so that we can document the methods
             # for yardoc, which doesn't like define_method.
@@ -139,32 +143,21 @@ module Cucumber
           end
 
           define_method(:step) do |name, raw_multiline_arg = nil|
-            location = Core::Ast::Location.of_caller
+            location = Core::Test::Location.of_caller
             runtime.invoke_dynamic_step(name, MultilineArgument.from(raw_multiline_arg, location))
           end
 
           define_method(:steps) do |steps_text|
-            location = Core::Ast::Location.of_caller
+            location = Core::Test::Location.of_caller
             runtime.invoke_dynamic_steps(steps_text, language, location)
           end
 
-          # rubocop:disable UnneededInterpolation
-          define_method(:puts) do |*messages|
-            # Even though they won't be output until later, converting the messages to
-            # strings right away will protect them from modifications to their original
-            # objects in the mean time
-            messages.collect! { |message| "#{message}" }
-
-            runtime.puts(*messages)
-          end
-          # rubocop:enable UnneededInterpolation
-
           define_method(:ask) do |question, timeout_seconds = 60|
             runtime.ask(question, timeout_seconds)
           end
 
-          define_method(:embed) do |file, mime_type, label = 'Screenshot'|
-            runtime.embed(file, mime_type, label)
+          define_method(:attach) do |file, media_type|
+            runtime.attach(file, media_type)
           end
 
           # Prints the list of modules that are included in the World
@@ -174,7 +167,7 @@ module Cucumber
               modules += included_modules
             end
             modules << stringify_namespaced_modules
-            format('#<%s:0x%x>', modules.join('+'), self.object_id)
+            format('#<%<modules>s:0x%<object_id>x>', modules: modules.join('+'), object_id: object_id)
           end
 
           private