cucumber 4.1.0 → 9.2.0

data/lib/cucumber/formatter/ansicolor.rb

@@ -3,28 +3,48 @@
 require 'cucumber/platform'
 require 'cucumber/term/ansicolor'
 
-if Cucumber::WINDOWS_MRI
-  unless ENV['ANSICON']
-    STDERR.puts %{*** WARNING: You must use ANSICON 1.31 or higher (https://github.com/adoxa/ansicon/) to get coloured output on Windows}
-    Cucumber::Term::ANSIColor.coloring = false
-  end
-end
-
-Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
+Cucumber::Term::ANSIColor.coloring = false unless $stdout.tty?
 
 module Cucumber
   module Formatter
-    # Defines aliases for coloured output. You don't invoke any methods from this
-    # module directly, but you can change the output colours by defining
-    # a <tt>CUCUMBER_COLORS</tt> variable in your shell, very much like how you can
-    # tweak the familiar POSIX command <tt>ls</tt> with
-    # <a href="http://mipsisrisc.com/rambling/2008/06/27/lscolorsls_colors-now-with-linux-support/">$LSCOLORS/$LS_COLORS</a>
+    # This module allows to format cucumber related outputs using ANSI escape sequences.
+    #
+    # For example, it provides a `passed` method which returns the string with
+    # the ANSI escape sequence to format it green per default.
+    #
+    # To use this, include or extend it in your class.
+    #
+    # Example:
+    #
+    #   require 'cucumber/formatter/ansicolor'
+    #
+    #   class MyFormatter
+    #     extend Cucumber::Term::ANSIColor
+    #
+    #     def on_test_step_finished(event)
+    #       $stdout.puts undefined(event.test_step) if event.result.undefined?
+    #       $stdout.puts passed(event.test_step) if event.result.passed?
+    #     end
+    #   end
+    #
+    # This module also allows the user to customize the format of cucumber outputs
+    # using environment variables.
+    #
+    # For instance, if your shell has a black background and a green font (like the
+    # "Homebrew" settings for OS X' Terminal.app), you may want to override passed
+    # steps to be white instead of green.
+    #
+    # Example:
+    #
+    #   export CUCUMBER_COLORS="passed=white,bold:passed_param=white,bold,underline"
     #
     # The colours that you can change are:
     #
     # * <tt>undefined</tt>     - defaults to <tt>yellow</tt>
     # * <tt>pending</tt>       - defaults to <tt>yellow</tt>
     # * <tt>pending_param</tt> - defaults to <tt>yellow,bold</tt>
+    # * <tt>flaky</tt>         - defaults to <tt>yellow</tt>
+    # * <tt>flaky_param</tt>   - defaults to <tt>yellow,bold</tt>
     # * <tt>failed</tt>        - defaults to <tt>red</tt>
     # * <tt>failed_param</tt>  - defaults to <tt>red,bold</tt>
     # * <tt>passed</tt>        - defaults to <tt>green</tt>
@@ -36,46 +56,39 @@ module Cucumber
     # * <tt>comment</tt>       - defaults to <tt>grey</tt>
     # * <tt>tag</tt>           - defaults to <tt>cyan</tt>
     #
-    # For instance, if your shell has a black background and a green font (like the
-    # "Homebrew" settings for OS X' Terminal.app), you may want to override passed
-    # steps to be white instead of green.
-    #
-    # Although not listed, you can also use <tt>grey</tt>.
-    #
-    # Examples: (On Windows, use SET instead of export.)
-    #
-    #   export CUCUMBER_COLORS="passed=white"
-    #   export CUCUMBER_COLORS="passed=white,bold:passed_param=white,bold,underline"
-    #
     # To see what colours and effects are available, just run this in your shell:
     #
-    #   ruby -e "require 'rubygems'; require 'term/ansicolor'; puts Cucumber::Term::ANSIColor.attributes"
+    #   ruby -e "require 'rubygems'; require 'cucumber/term/ansicolor'; puts Cucumber::Term::ANSIColor.attributes"
     #
     module ANSIColor
       include Cucumber::Term::ANSIColor
 
       ALIASES = Hash.new do |h, k|
-        h[Regexp.last_match(1)] + ',bold' if k.to_s =~ /(.*)_param/
+        next unless k.to_s =~ /(.*)_param/
+
+        "#{h[Regexp.last_match(1)]},bold"
       end.merge(
         'undefined' => 'yellow',
-        'pending'   => 'yellow',
-        'flaky'     => 'yellow',
-        'failed'    => 'red',
-        'passed'    => 'green',
-        'outline'   => 'cyan',
-        'skipped'   => 'cyan',
-        'comment'   => 'grey',
-        'tag'       => 'cyan'
+        'pending' => 'yellow',
+        'flaky' => 'yellow',
+        'failed' => 'red',
+        'passed' => 'green',
+        'outline' => 'cyan',
+        'skipped' => 'cyan',
+        'comment' => 'grey',
+        'tag' => 'cyan'
       )
 
-      if ENV['CUCUMBER_COLORS'] # Example: export CUCUMBER_COLORS="passed=red:failed=yellow"
-        ENV['CUCUMBER_COLORS'].split(':').each do |pair|
+      # Apply the custom color scheme -> i.e. apply_custom_colors('passed=white')
+      def self.apply_custom_colors(colors)
+        colors.split(':').each do |pair|
           a = pair.split('=')
           ALIASES[a[0]] = a[1]
         end
       end
+      apply_custom_colors(ENV['CUCUMBER_COLORS']) if ENV['CUCUMBER_COLORS']
 
-      # Eval to define the color-named methods required by Term::ANSIColor.
+      # Define the color-named methods required by Term::ANSIColor.
       #
       # Examples:
       #
@@ -87,67 +100,39 @@ module Cucumber
       #     red(bold(string, &proc)) + red
       #   end
       ALIASES.each_key do |method_name|
-        next if method_name =~ /.*_param/
-        code = <<-COLOR
-          def #{method_name}(string=nil, &proc)
-            #{ALIASES[method_name].split(',').join('(') + '(string, &proc' + ')' * ALIASES[method_name].split(',').length}
-          end
-          # This resets the colour to the non-param colour
-          def #{method_name}_param(string=nil, &proc)
-            #{ALIASES[method_name + '_param'].split(',').join('(') + '(string, &proc' + ')' * ALIASES[method_name + '_param'].split(',').length} + #{ALIASES[method_name].split(',').join(' + ')}
-          end
-        COLOR
-        eval(code) # rubocop:disable Security/Eval
-      end
+        next if method_name.end_with?('_param')
 
-      def self.define_grey #:nodoc:
-        gem 'genki-ruby-terminfo'
-        require 'terminfo'
-        case TermInfo.default_object.tigetnum('colors')
-        when 0
-          raise "Your terminal doesn't support colours."
-        when 1
-          ::Cucumber::Term::ANSIColor.coloring = false
-          alias_method :grey, :white
-        when 2..8
-          alias_method :grey, :white # rubocop:disable Lint/DuplicateMethods
-        else
-          define_real_grey
-        end
-      rescue Exception => e # rubocop:disable Lint/RescueException
-        if e.class.name == 'TermInfo::TermInfoError'
-          STDERR.puts '*** WARNING ***'
-          STDERR.puts "You have the genki-ruby-terminfo gem installed, but you haven't set your TERM variable."
-          STDERR.puts 'Try setting it to TERM=xterm-256color to get grey colour in output.'
-          STDERR.puts "\n"
-          alias_method :grey, :white
-        else
-          define_real_grey
+        define_method(method_name) do |text = nil, &proc|
+          apply_styles(ALIASES[method_name], text, &proc)
         end
-      end
 
-      def self.define_real_grey #:nodoc:
-        define_method :grey do |string|
-          ::Cucumber::Term::ANSIColor.coloring? ? "\e[90m#{string}\e[0m" : string
+        define_method("#{method_name}_param") do |text = nil, &proc|
+          apply_styles(ALIASES["#{method_name}_param"], text, &proc) + apply_styles(ALIASES[method_name])
         end
       end
 
-      define_grey
+      def cukes(amount)
+        ('(::) ' * amount).strip
+      end
 
-      def cukes(n)
-        ('(::) ' * n).strip
+      def green_cukes(amount)
+        blink(green(cukes(amount)))
       end
 
-      def green_cukes(n)
-        blink(green(cukes(n)))
+      def red_cukes(amount)
+        blink(red(cukes(amount)))
       end
 
-      def red_cukes(n)
-        blink(red(cukes(n)))
+      def yellow_cukes(amount)
+        blink(yellow(cukes(amount)))
       end
 
-      def yellow_cukes(n)
-        blink(yellow(cukes(n)))
+      private
+
+      def apply_styles(styles, text = nil, &proc)
+        styles.split(',').reverse.reduce(text) do |result, method_name|
+          send(method_name, result, &proc)
+        end
       end
     end
   end

data/lib/cucumber/formatter/ast_lookup.rb

@@ -45,11 +45,11 @@ module Cucumber
             break
           end
           break if node.previous_node.nil?
+
           node = node.previous_node
         end
         keyword = dialect.given_keywords.reject { |kw| kw == '* ' }[0] if keyword.nil?
-        keyword = Cucumber::Gherkin::I18n.code_keyword_for(keyword)
-        keyword
+        Cucumber::Gherkin::I18n.code_keyword_for(keyword)
       end
 
       ScenarioSource = Struct.new(:type, :scenario)
@@ -112,16 +112,24 @@ module Cucumber
             if child.respond_to?(:rule) && child.rule
               process_scenario_container(child.rule)
             elsif child.respond_to?(:scenario) && child.scenario
-              child.scenario.steps.each do |step|
-                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
-              end
+              store_scenario_source_steps(child.scenario)
             elsif !child.background.nil?
-              child.background.steps.each do |step|
-                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
-              end
+              store_background_source_steps(child.background)
             end
           end
         end
+
+        def store_scenario_source_steps(scenario)
+          scenario.steps.each do |step|
+            @lookup_hash[step.location.line] = StepSource.new(:Step, step)
+          end
+        end
+
+        def store_background_source_steps(background)
+          background.steps.each do |step|
+            @lookup_hash[step.location.line] = StepSource.new(:Step, step)
+          end
+        end
       end
 
       KeywordSearchNode = Struct.new(:keyword, :previous_node)
@@ -136,7 +144,6 @@ module Cucumber
 
         private
 
-        # rubocop:disable Metrics/PerceivedComplexity
         def process_scenario_container(container, original_previous_node)
           container.children.each do |child|
             previous_node = original_previous_node
@@ -158,7 +165,6 @@ module Cucumber
             end
           end
         end
-        # rubocop:enable Metrics/PerceivedComplexity
       end
     end
   end

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -15,12 +15,14 @@ module Cucumber
       test/unit
       .gem/ruby
       bin/bundle
+      rdebug-ide
     ]
 
     @backtrace_filters << RbConfig::CONFIG['rubyarchdir'] if RbConfig::CONFIG['rubyarchdir']
     @backtrace_filters << RbConfig::CONFIG['rubylibdir'] if RbConfig::CONFIG['rubylibdir']
 
     @backtrace_filters << 'org/jruby/' if ::Cucumber::JRUBY
+    @backtrace_filters << '<internal:' if RUBY_ENGINE == 'truffleruby'
 
     BACKTRACE_FILTER_PATTERNS = Regexp.new(@backtrace_filters.join('|'))
 
@@ -32,7 +34,7 @@ module Cucumber
       def exception
         return @exception if ::Cucumber.use_full_backtrace
 
-        pwd_pattern = /#{::Regexp.escape(::Dir.pwd)}\//m # rubocop:disable Style/RegexpLiteral
+        pwd_pattern = /#{::Regexp.escape(::Dir.pwd)}\//m
         backtrace = @exception.backtrace.map { |line| line.gsub(pwd_pattern, './') }
 
         filtered = (backtrace || []).reject do |line|

data/lib/cucumber/formatter/console.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ModuleLength
-
 require 'cucumber/formatter/ansicolor'
 require 'cucumber/formatter/duration'
 require 'cucumber/gherkin/i18n'
@@ -34,7 +32,7 @@ module Cucumber
 
       def format_step(keyword, step_match, status, source_indent)
         comment = if source_indent
-                    c = ('# ' + step_match.location.to_s).indent(source_indent)
+                    c = indent("# #{step_match.location}", source_indent)
                     format_string(c, :comment)
                   else
                     ''
@@ -45,10 +43,10 @@ module Cucumber
         format_string(line, status)
       end
 
-      def format_string(o, status)
+      def format_string(input, status)
         fmt = format_for(status)
-        o.to_s.split("\n").map do |line|
-          if Proc == fmt.class
+        input.to_s.split("\n").map do |line|
+          if fmt.instance_of?(Proc)
             fmt.call(line)
           else
             fmt % line
@@ -94,22 +92,25 @@ module Cucumber
         @io.flush
       end
 
-      def print_exception(e, status, indent)
-        string = exception_message_string(e, indent)
+      def print_exception(exception, status, indent)
+        string = exception_message_string(exception, indent)
         @io.puts(format_string(string, status))
       end
 
-      def exception_message_string(e, indent)
-        message = "#{e.message} (#{e.class})".dup.force_encoding('UTF-8')
+      def exception_message_string(exception, indent_amount)
+        message = "#{exception.message} (#{exception.class})".dup.force_encoding('UTF-8')
         message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
 
-        "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
+        indent("#{message}\n#{exception.backtrace.join("\n")}", indent_amount)
       end
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
       def linebreaks(msg, max)
-        return msg unless max && max > 0
-        msg.gsub(/.{1,#{max}}(?:\s|\Z)/) { ($& + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n") }.rstrip
+        return msg unless max.positive?
+
+        msg.gsub(/.{1,#{max}}(?:\s|\Z)/) do
+          (Regexp.last_match(0) + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n")
+        end.rstrip
       end
 
       def collect_snippet_data(test_step, ast_lookup)
@@ -150,6 +151,7 @@ module Cucumber
 
       def print_passing_wip(config, passed_test_cases, ast_lookup)
         return unless config.wip?
+
         messages = passed_test_cases.map do |test_case|
           scenario_source = ast_lookup.scenario_source(test_case)
           keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
@@ -167,16 +169,23 @@ module Cucumber
         end
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         return unless media_type == 'text/x.cucumber.log+plain'
         return unless @io
+
         @io.puts
-        @io.puts(format_string(src, :tag))
+        if filename
+          @io.puts("#{filename}: #{format_string(src, :tag)}")
+        else
+          @io.puts(format_string(src, :tag))
+        end
+
         @io.flush
       end
 
       def print_profile_information
         return if @options[:skip_profile_information] || @options[:profiles].nil? || @options[:profiles].empty?
+
         do_print_profile_information(@options[:profiles])
       end
 
@@ -208,6 +217,14 @@ module Cucumber
         ].join("\n")
       end
 
+      def indent(string, padding)
+        if padding >= 0
+          string.gsub(/^/, ' ' * padding)
+        else
+          string.gsub(/^ {0,#{-padding}}/, '')
+        end
+      end
+
       private
 
       FORMATS = Hash.new { |hash, format| hash[format] = method(format).to_proc }
@@ -216,6 +233,7 @@ module Cucumber
         key = keys.join('_').to_sym
         fmt = FORMATS[key]
         raise "No format for #{key.inspect}: #{FORMATS.inspect}" if fmt.nil?
+
         fmt
       end
 
@@ -238,6 +256,7 @@ module Cucumber
 
       class SnippetData
         attr_reader :actual_keyword, :step
+
         def initialize(actual_keyword, step)
           @actual_keyword = actual_keyword
           @step = step
@@ -246,4 +265,3 @@ module Cucumber
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength

data/lib/cucumber/formatter/console_counts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/console'
 
 module Cucumber
@@ -30,7 +32,7 @@ module Cucumber
 
       def status_counts(summary)
         counts = Core::Test::Result::TYPES.map { |status| [status, summary.total(status)] }
-        counts = counts.select { |_status, count| count > 0 }
+        counts = counts.select { |_status, count| count.positive? }
         counts = counts.map { |status, count| format_string("#{count} #{status}", status) }
         "(#{counts.join(', ')})" if counts.any?
       end

data/lib/cucumber/formatter/console_issues.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/console'
 
 module Cucumber
@@ -12,9 +14,9 @@ module Cucumber
         @config.on_event(:test_case_finished) do |event|
           if event.test_case != @previous_test_case
             @previous_test_case = event.test_case
-            @issues[event.result.to_sym] << event.test_case unless event.result.ok?(@config.strict)
+            @issues[event.result.to_sym] << event.test_case unless event.result.ok?(strict: @config.strict)
           elsif event.result.passed?
-            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?(@config.strict.strict?(:flaky))
+            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?(strict: @config.strict.strict?(:flaky))
             @issues[:failed].delete(event.test_case)
           end
         end
@@ -23,6 +25,7 @@ module Cucumber
 
       def to_s
         return if @issues.empty?
+
         result = Core::Test::Result::TYPES.map { |type| scenario_listing(type, @issues[type]) }
         result.flatten.join("\n")
       end
@@ -35,6 +38,7 @@ module Cucumber
 
       def scenario_listing(type, test_cases)
         return [] if test_cases.empty?
+
         [format_string("#{type_heading(type)} Scenarios:", type)] + test_cases.map do |test_case|
           scenario_source = @ast_lookup.scenario_source(test_case)
           keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
@@ -54,7 +58,10 @@ module Cucumber
 
       def profiles_string
         return if @config.custom_profiles.empty?
-        @config.custom_profiles.map { |profile| "-p #{profile}" }.join(' ') + ' '
+
+        profiles = @config.custom_profiles.map { |profile| "-p #{profile}" }.join(' ')
+
+        "#{profiles} "
       end
     end
   end

data/lib/cucumber/formatter/curl_option_parser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+
+module Cucumber
+  module Formatter
+    class CurlOptionParser
+      def self.parse(options)
+        args = Shellwords.split(options)
+
+        url = nil
+        http_method = 'PUT'
+        headers = {}
+
+        until args.empty?
+          arg = args.shift
+          case arg
+          when '-X', '--request'
+            http_method = remove_arg_for(args, arg)
+          when '-H'
+            header_arg = remove_arg_for(args, arg)
+            headers = headers.merge(parse_header(header_arg))
+          else
+            raise StandardError, "#{options} was not a valid curl command. Can't set url to #{arg} it is already set to #{url}" if url
+
+            url = arg
+          end
+        end
+        raise StandardError, "#{options} was not a valid curl command" unless url
+
+        [url, http_method, headers]
+      end
+
+      # TODO: [LH] -> Switch below methods to private
+      def self.remove_arg_for(args, arg)
+        return args.shift unless args.empty?
+
+        raise StandardError, "Missing argument for #{arg}"
+      end
+
+      def self.parse_header(header_arg)
+        parts = header_arg.split(':', 2)
+        raise StandardError, "#{header_arg} was not a valid header" unless parts.length == 2
+
+        { parts[0].strip => parts[1].strip }
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/duration_extractor.rb

@@ -4,6 +4,7 @@ module Cucumber
   module Formatter
     class DurationExtractor
       attr_reader :result_duration
+
       def initialize(result)
         @result_duration = 0
         result.describe_to(self)

data/lib/cucumber/formatter/errors.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Formatter
     class TestCaseUnknownError < StandardError; end
+
     class TestStepUnknownError < StandardError; end
   end
 end

data/lib/cucumber/formatter/fail_fast.rb

@@ -12,7 +12,7 @@ module Cucumber
           test_case, result = *event.attributes
           if test_case != @previous_test_case
             @previous_test_case = event.test_case
-            Cucumber.wants_to_quit = true unless result.ok?(configuration.strict)
+            Cucumber.wants_to_quit = true unless result.ok?(strict: configuration.strict)
           elsif result.passed?
             Cucumber.wants_to_quit = false
           end

data/lib/cucumber/formatter/fanout.rb

@@ -21,7 +21,7 @@ module Cucumber
       end
 
       def respond_to_missing?(name, include_private = false)
-        recipients.any? { |recipient| recipient.respond_to?(name, include_private) }
+        recipients.any? { |recipient| recipient.respond_to?(name, include_private) } || super(name, include_private)
       end
     end
   end

data/lib/cucumber/formatter/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/io'
 require 'cucumber/html_formatter'
 require 'cucumber/formatter/message_builder'
@@ -8,7 +10,7 @@ module Cucumber
       include Io
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @html_formatter = Cucumber::HTMLFormatter::Formatter.new(@io)
         @html_formatter.write_pre_message