cucumber 3.2.0 → 5.2.0

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_hash 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_hash 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/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,8 @@
 # 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'
 
 module Cucumber
   module Glue
@@ -24,7 +25,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,9 +68,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)
+      def table(text_or_table)
+        MultilineArgument::DataTable.from(text_or_table)
       end
 
       # Print a message to the output.
@@ -80,7 +80,16 @@ module Cucumber
       #
       #   If you'd prefer to see the message immediately, call {Kernel.puts} instead.
       def puts(*messages)
-        super
+        Cucumber.deprecate(
+          'Messages emitted with "puts" will no longer be caught by Cucumber ' \
+          'and sent to the formatter. If you want message to be in the formatted output, ' \
+          "please use log(message) instead.\n" \
+          'If you simply want it in the console, '\
+          'keep using "puts" (or Kernel.puts to avoid this message)',
+          'puts(message)',
+          '6.0.0'
+        )
+        messages.each { |message| log(message.to_s) }
       end
 
       # Pause the tests and ask the operator for input
@@ -89,22 +98,33 @@ module Cucumber
       end
 
       # Embed an image in the output
-      def embed(file, mime_type, label = 'Screenshot')
+      def embed(file, mime_type, _label = 'Screenshot')
+        Cucumber.deprecate(
+          'Please use attach(file, media_type) instead',
+          'embed(file, mime_type, label)',
+          '6.0.0'
+        )
+        attach(file, mime_type)
+      end
+
+      def log(*messages)
+        messages.each { |message| attach(message.to_s.dup, 'text/x.cucumber.log+plain') }
+      end
+
+      def attach(file, media_type)
         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 +143,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 +159,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 +183,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

data/lib/cucumber/glue/registry_and_more.rb

@@ -28,7 +28,7 @@ module Cucumber
     # Raised if there are 2 or more World blocks.
     class MultipleWorld < StandardError
       def initialize(first_proc, second_proc)
-        message = String.new
+        message = String.new # rubocop:disable Style/EmptyLiteral
         message << "You can only pass a proc to #World once, but it's happening\n"
         message << "in 2 places:\n\n"
         message << Glue.backtrace_line(first_proc, 'World') << "\n"
@@ -53,7 +53,8 @@ module Cucumber
       end
 
       def initialize(runtime, configuration)
-        @runtime, @configuration = runtime, configuration
+        @runtime = runtime
+        @configuration = configuration
         @step_definitions = []
         Glue::Dsl.rb_language = self
         @world_proc = @world_modules = nil
@@ -63,27 +64,36 @@ module Cucumber
       end
 
       def step_matches(name_to_match)
-        @step_definitions.reduce([]) do |result, step_definition|
+        @step_definitions.each_with_object([]) do |step_definition, result|
           if (arguments = step_definition.arguments_from(name_to_match))
             result << StepMatch.new(step_definition, name_to_match, arguments)
           end
-          result
         end
       end
 
       def register_rb_hook(phase, tag_expressions, proc)
-        add_hook(phase, Hook.new(self, tag_expressions, proc))
+        hook = add_hook(phase, Hook.new(@configuration.id_generator.new_id, self, tag_expressions, proc))
+        @configuration.notify :envelope, hook.to_envelope
+        hook
       end
 
       def define_parameter_type(parameter_type)
+        @configuration.notify :envelope, parameter_type_envelope(parameter_type)
+
         @parameter_type_registry.define_parameter_type(parameter_type)
       end
 
       def register_rb_step_definition(string_or_regexp, proc_or_sym, options)
-        step_definition = StepDefinition.new(self, string_or_regexp, proc_or_sym, options)
+        step_definition = StepDefinition.new(@configuration.id_generator.new_id, self, string_or_regexp, proc_or_sym, options)
         @step_definitions << step_definition
         @configuration.notify :step_definition_registered, step_definition
+        @configuration.notify :envelope, step_definition.to_envelope
         step_definition
+      rescue Cucumber::CucumberExpressions::UndefinedParameterTypeError => e
+        # TODO: add a way to extract the parameter type directly from the error.
+        type_name = e.message.match(/^Undefined parameter type \{(.*)\}$/)[1]
+
+        @configuration.notify :undefined_parameter_type, type_name, string_or_regexp
       end
 
       def build_rb_world_factory(world_modules, namespaced_world_modules, proc)
@@ -96,15 +106,20 @@ module Cucumber
 
         @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
+          @namespaced_world_modules[namespace] << world_module unless @namespaced_world_modules[namespace].include?(world_module)
         end
       end
 
       def load_code_file(code_file)
         return unless File.extname(code_file) == '.rb'
-        load File.expand_path(code_file) # This will cause self.add_step_definition, self.add_hook, and self.define_parameter_type to be called from Glue::Dsl
+
+        # This will cause self.add_step_definition, self.add_hook, and self.define_parameter_type to be called from Glue::Dsl
+
+        if Cucumber.use_legacy_autoloader
+          load File.expand_path(code_file)
+        else
+          require File.expand_path(code_file)
+        end
       end
 
       def begin_scenario(test_case)
@@ -153,7 +168,7 @@ module Cucumber
       def create_expression(string_or_regexp)
         return CucumberExpressions::CucumberExpression.new(string_or_regexp, @parameter_type_registry) if string_or_regexp.is_a?(String)
         return CucumberExpressions::RegularExpression.new(string_or_regexp, @parameter_type_registry) if string_or_regexp.is_a?(Regexp)
-        raise ArgumentError.new('Expression must be a String or Regexp')
+        raise ArgumentError, 'Expression must be a String or Regexp'
       end
 
       def self.cli_snippet_type_options
@@ -166,6 +181,21 @@ module Cucumber
 
       private
 
+      def parameter_type_envelope(parameter_type)
+        # TODO: should me moved to Cucumber::Expression::ParameterType#to_envelope ?
+        # Note: that would mean that cucumber-expression would depend on cucumber-messages
+
+        Cucumber::Messages::Envelope.new(
+          parameter_type: Cucumber::Messages::ParameterType.new(
+            id: @configuration.id_generator.new_id,
+            name: parameter_type.name,
+            regular_expressions: parameter_type.regexps.map(&:to_s),
+            prefer_for_regular_expression_match: parameter_type.prefer_for_regexp_match?,
+            use_for_snippets: parameter_type.use_for_snippets?
+          )
+        )
+      end
+
       def available_step_definition_hash
         @available_step_definition_hash ||= {}
       end
@@ -180,7 +210,7 @@ module Cucumber
     end
 
     def self.backtrace_line(proc, name)
-      location = Cucumber::Core::Ast::Location.from_source_location(*proc.source_location)
+      location = Cucumber::Core::Test::Location.from_source_location(*proc.source_location)
       "#{location}:in `#{name}'"
     end
   end

data/lib/cucumber/glue/snippet.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Glue
     module Snippet
-      ARGUMENT_PATTERNS = ['"([^"]*)"', '(\d+)']
+      ARGUMENT_PATTERNS = ['"([^"]*)"', '(\d+)'].freeze
 
       class Generator
         def self.register_on(configuration)
@@ -42,7 +42,7 @@ module Cucumber
         end
 
         def self.cli_option_string(type, cucumber_expression_generator)
-          format('%-7s: %-28s e.g. %s', type, description, example(cucumber_expression_generator))
+          format('%<type>-7s: %<description>-28s e.g. %<example>s', type: type, description: description, example: example(cucumber_expression_generator))
         end
 
         private
@@ -61,7 +61,7 @@ module Cucumber
         end
 
         def do_block
-          do_block = String.new
+          do_block = String.new # rubocop:disable Style/EmptyLiteral
           do_block << "do#{parameters}\n"
           multiline_argument.append_comment_to(do_block)
           do_block << "  pending # Write code here that turns the phrase above into concrete actions\n"
@@ -72,11 +72,15 @@ module Cucumber
         def parameters
           block_args = (0...number_of_arguments).map { |n| "arg#{n + 1}" }
           multiline_argument.append_block_parameter_to(block_args)
-          block_args.empty? ? '' : " |#{block_args.join(", ")}|"
+          block_args.empty? ? '' : " |#{block_args.join(', ')}|"
         end
 
-        def self.example(cucumber_expression_generator)
-          new(cucumber_expression_generator, 'Given', 'I have 2 cukes', MultilineArgument::None.new).step
+        class << self
+          private
+
+          def example(cucumber_expression_generator)
+            new(cucumber_expression_generator, 'Given', 'I have 2 cukes', MultilineArgument::None.new).step
+          end
         end
       end
 
@@ -87,11 +91,11 @@ module Cucumber
 
         def to_s
           header = generated_expressions.each_with_index.map do |expr, i|
-            prefix = i == 0 ? '' : '# '
-            "#{prefix}#{code_keyword}(\"#{expr.source}\") do#{parameters(expr)}"
+            prefix = i.zero? ? '' : '# '
+            "#{prefix}#{code_keyword}('#{expr.source}') do#{parameters(expr)}"
           end.join("\n")
 
-          body = String.new
+          body = String.new # rubocop:disable Style/EmptyLiteral
           multiline_argument.append_comment_to(body)
           body << "  pending # Write code here that turns the phrase above into concrete actions\n"
           body << 'end'
@@ -102,7 +106,7 @@ module Cucumber
         def parameters(expr)
           parameter_names = expr.parameter_names
           multiline_argument.append_block_parameter_to(parameter_names)
-          parameter_names.empty? ? '' : " |#{parameter_names.join(", ")}|"
+          parameter_names.empty? ? '' : " |#{parameter_names.join(', ')}|"
         end
 
         def self.description
@@ -141,11 +145,11 @@ module Cucumber
       end
 
       SNIPPET_TYPES = {
-        :cucumber_expression => CucumberExpression,
-        :regexp => Regexp,
-        :classic => Classic,
-        :percent => Percent
-      }
+        cucumber_expression: CucumberExpression,
+        regexp: Regexp,
+        classic: Classic,
+        percent: Percent
+      }.freeze
 
       module MultilineArgumentSnippet
         def self.new(multiline_argument)
@@ -170,11 +174,10 @@ module Cucumber
 
         class DocString
           def append_block_parameter_to(array)
-            array << 'string'
+            array << 'doc_string'
           end
 
-          def append_comment_to(string)
-          end
+          def append_comment_to(string); end
         end
 
         class DataTable
@@ -192,11 +195,9 @@ module Cucumber
         end
 
         class None
-          def append_block_parameter_to(array)
-          end
+          def append_block_parameter_to(array); end
 
-          def append_comment_to(string)
-          end
+          def append_comment_to(string); end
         end
       end
     end