cucumber 4.0.0.rc.1 → 4.0.0.rc.2

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -10,13 +10,16 @@ module Cucumber
       bin/cucumber:
       lib/rspec
       gems/
+      site_ruby/
       minitest
       test/unit
       .gem/ruby
-      lib/ruby/
       bin/bundle
     ]
 
+    @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_FILTER_PATTERNS = Regexp.new(@backtrace_filters.join('|'))

data/lib/cucumber/formatter/console.rb

@@ -143,7 +143,7 @@ module Cucumber
         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]
+          keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
           linebreaks("#{test_case.location.on_line(test_case.location.lines.max)}:in `#{keyword}: #{test_case.name}'", ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
         end
         do_print_passing_wip(messages)

data/lib/cucumber/formatter/console_issues.rb

@@ -37,7 +37,7 @@ module Cucumber
         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]
+          keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
           source = @config.source? ? format_string(" # #{keyword}: #{test_case.name}", :comment) : ''
           format_string("cucumber #{profiles_string}#{test_case.location.file}:#{test_case.location.lines.max}", type) + source
         end

data/lib/cucumber/formatter/duration.rb

@@ -8,7 +8,7 @@ module Cucumber
       # <tt>time</tt> format.
       def format_duration(seconds)
         m, s = seconds.divmod(60)
-        "#{m}m#{format('%.3f', s)}s"
+        "#{m}m#{format('%<seconds>.3f', seconds: s)}s"
       end
     end
   end

data/lib/cucumber/formatter/duration_extractor.rb

@@ -24,6 +24,8 @@ module Cucumber
       def duration(duration, *)
         duration.tap { |dur| @result_duration = dur.nanoseconds / 10**9.0 }
       end
+
+      def embed(*) end
     end
   end
 end

data/lib/cucumber/formatter/interceptor.rb

@@ -18,19 +18,6 @@ module Cucumber
           end
         end
 
-        # @deprecated use #buffer_string
-        def buffer
-          require 'cucumber/deprecate.rb'
-          Cucumber.deprecate(
-            'Use Cucumber::Formatter::Interceptor::Pipe#buffer_string instead',
-            'Cucumber::Formatter::Interceptor::Pipe#buffer',
-            '3.99'
-          )
-          lock.synchronize do
-            return @buffer.string.lines
-          end
-        end
-
         def buffer_string
           lock.synchronize do
             return @buffer.string.dup

data/lib/cucumber/formatter/json.rb

@@ -163,33 +163,34 @@ module Cucumber
       def create_step_hash(test_step)
         step_source = @ast_lookup.step_source(test_step).step
         step_hash = {
-          keyword: step_source[:keyword],
+          keyword: step_source.keyword,
           name: test_step.text,
           line: test_step.location.lines.min
         }
-        step_hash[:doc_string] = create_doc_string_hash(step_source[:doc_string]) unless step_source[:doc_string].nil?
-        step_hash[:rows] = create_data_table_value(step_source[:data_table]) unless step_source[:data_table].nil?
+        step_hash[:doc_string] = create_doc_string_hash(step_source.doc_string) unless step_source.doc_string.nil?
+        step_hash[:rows] = create_data_table_value(step_source.data_table) unless step_source.data_table.nil?
         step_hash
       end
 
       def create_doc_string_hash(doc_string)
-        content_type = doc_string[:content_type] || ''
+        content_type = doc_string.content_type || ''
         {
-          value: doc_string[:content],
+          value: doc_string.content,
           content_type: content_type,
-          line: doc_string[:location][:line]
+          line: doc_string.location.line
         }
       end
 
       def create_data_table_value(data_table)
-        data_table[:rows].map do |row|
-          { cells: row[:cells].map { |cell| cell[:value] } }
+        data_table.rows.map do |row|
+          { cells: row.cells.map(&:value) }
         end
       end
 
       def add_match_and_result(test_step, result)
         @step_or_hook_hash[:match] = create_match_hash(test_step, result)
         @step_or_hook_hash[:result] = create_result_hash(result)
+        result.embeddings.each { |e| embed(e['src'], e['mime_type'], e['label']) } if result.respond_to?(:embeddings)
       end
 
       def add_failed_around_hook(result)
@@ -230,9 +231,9 @@ module Cucumber
         def initialize(test_case, ast_lookup)
           @background_hash = nil
           uri = test_case.location.file
-          feature = ast_lookup.gherkin_document(uri)[:feature]
+          feature = ast_lookup.gherkin_document(uri).feature
           feature(feature, uri)
-          background(feature[:children].first[:background]) unless feature[:children].first[:background].nil?
+          background(feature.children.first.background) unless feature.children.first.background.nil?
           scenario(ast_lookup.scenario_source(test_case), test_case)
         end
 
@@ -242,23 +243,23 @@ module Cucumber
 
         def feature(feature, uri)
           @feature_hash = {
-            id: create_id(feature[:name]),
+            id: create_id(feature.name),
             uri: uri,
-            keyword: feature[:keyword],
-            name: feature[:name],
-            description: value_or_empty_string(feature[:description]),
-            line: feature[:location][:line]
+            keyword: feature.keyword,
+            name: feature.name,
+            description: value_or_empty_string(feature.description),
+            line: feature.location.line
           }
-          return if feature[:tags].empty?
-          @feature_hash[:tags] = create_tags_array_from_hash_array(feature[:tags])
+          return if feature.tags.empty?
+          @feature_hash[:tags] = create_tags_array_from_hash_array(feature.tags)
         end
 
         def background(background)
           @background_hash = {
-            keyword: background[:keyword],
-            name: background[:name],
-            description: value_or_empty_string(background[:description]),
-            line: background[:location][:line],
+            keyword: background.keyword,
+            name: background.name,
+            description: value_or_empty_string(background.description),
+            line: background.location.line,
             type: 'background'
           }
         end
@@ -267,9 +268,9 @@ module Cucumber
           scenario = scenario_source.type == :Scenario ? scenario_source.scenario : scenario_source.scenario_outline
           @test_case_hash = {
             id: "#{@feature_hash[:id]};#{create_id_from_scenario_source(scenario_source)}",
-            keyword: scenario[:keyword],
-            name: scenario[:name],
-            description: value_or_empty_string(scenario[:description]),
+            keyword: scenario.keyword,
+            name: test_case.name,
+            description: value_or_empty_string(scenario.description),
             line: test_case.location.lines.max,
             type: 'scenario'
           }
@@ -288,24 +289,24 @@ module Cucumber
 
         def create_id_from_scenario_source(scenario_source)
           if scenario_source.type == :Scenario
-            create_id(scenario_source.scenario[:name])
+            create_id(scenario_source.scenario.name)
           else
-            scenario_outline_name = scenario_source.scenario_outline[:name]
-            examples_name = scenario_source.examples[:name]
+            scenario_outline_name = scenario_source.scenario_outline.name
+            examples_name = scenario_source.examples.name
             row_number = calculate_row_number(scenario_source)
             "#{create_id(scenario_outline_name)};#{create_id(examples_name)};#{row_number}"
           end
         end
 
         def calculate_row_number(scenario_source)
-          scenario_source.examples[:table_body].each_with_index do |row, index|
+          scenario_source.examples.table_body.each_with_index do |row, index|
             return index + 2 if row == scenario_source.row
           end
         end
 
         def create_tags_array_from_hash_array(tags)
           tags_array = []
-          tags.each { |tag| tags_array << { name: tag[:name], line: tag[:location][:line] } }
+          tags.each { |tag| tags_array << { name: tag.name, line: tag.location.line } }
           tags_array
         end
 

data/lib/cucumber/formatter/junit.rb

@@ -82,8 +82,8 @@ module Cucumber
 
       def start_feature(test_case)
         uri = test_case.location.file
-        feature = @ast_lookup.gherkin_document(uri)[:feature]
-        raise UnNamedFeatureError, uri if feature[:name].empty?
+        feature = @ast_lookup.gherkin_document(uri).feature
+        raise UnNamedFeatureError, uri if feature.name.empty?
         @current_feature_data = @features_data[uri]
         @current_feature_data[:uri] = uri unless @current_feature_data[:uri]
         @current_feature_data[:feature] = feature unless @current_feature_data[:feature]
@@ -97,8 +97,8 @@ module Cucumber
           errors: feature_data[:errors],
           skipped: feature_data[:skipped],
           tests: feature_data[:tests],
-          time: format('%.6f', feature_data[:time]),
-          name: feature_data[:feature][:name]
+          time: format('%<time>.6f', time: feature_data[:time]),
+          name: feature_data[:feature].name
         ) do
           @testsuite << feature_data[:builder].target!
         end
@@ -108,7 +108,7 @@ module Cucumber
 
       def create_output_string(test_case, scenario, result, row_name) # rubocop:disable Metrics/PerceivedComplexity
         scenario_source = @ast_lookup.scenario_source(test_case)
-        keyword = scenario_source.type == :Scenario ? scenario_source.scenario[:keyword] : scenario_source.scenario_outline[:keyword]
+        keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
         output = "#{keyword}: #{scenario}\n\n"
         return output if result.ok?(@config.strict)
         if scenario_source.type == :Scenario
@@ -117,7 +117,7 @@ module Cucumber
               output += "#{@failing_test_step.text} at #{@failing_test_step.location}\n"
             else
               step_source = @ast_lookup.step_source(@failing_test_step).step
-              output += "#{step_source[:keyword]}#{@failing_test_step.text}\n"
+              output += "#{step_source.keyword}#{@failing_test_step.text}\n"
             end
           else # An Around hook has failed
             output += "Around hook\n"
@@ -131,10 +131,10 @@ module Cucumber
       def build_testcase(result, scenario_designation, output)
         duration = ResultBuilder.new(result).test_case_duration
         @current_feature_data[:time] += duration
-        classname = @current_feature_data[:feature][:name]
+        classname = @current_feature_data[:feature].name
         name = scenario_designation
 
-        @current_feature_data[:builder].testcase(classname: classname, name: name, time: format('%.6f', duration)) do
+        @current_feature_data[:builder].testcase(classname: classname, name: name, time: format('%<duration>.6f', duration: duration)) do
           if !result.passed? && result.ok?(@config.strict)
             @current_feature_data[:builder].skipped
             @current_feature_data[:skipped] += 1
@@ -203,15 +203,15 @@ module Cucumber
       end
 
       def scenario(scenario)
-        @scenario_name = scenario[:name].empty? ? 'Unnamed scenario' : scenario[:name]
+        @scenario_name = scenario.name.empty? ? 'Unnamed scenario' : scenario.name
       end
 
       def scenario_outline(outline)
-        @scenario_name = outline[:name].empty? ? 'Unnamed scenario outline' : outline[:name]
+        @scenario_name = outline.name.empty? ? 'Unnamed scenario outline' : outline.name
       end
 
       def examples_table_row(row)
-        @row_name = '| ' + row[:cells].map { |cell| cell[:value] }.join(' | ') + ' |'
+        @row_name = '| ' + row.cells.map(&:value).join(' | ') + ' |'
         @name_suffix = " (outline example : #{@row_name})"
       end
     end
@@ -238,6 +238,8 @@ module Cucumber
       def duration(duration, *)
         duration.tap { |dur| @test_case_duration = dur.nanoseconds / 10**9.0 }
       end
+
+      def embed(*) end
     end
   end
 end

data/lib/cucumber/formatter/pretty.rb

@@ -19,7 +19,7 @@ module Cucumber
     #
     # If the output is STDOUT (and not a file), there are bright colours to watch too.
     #
-    class Pretty
+    class Pretty # rubocop:disable Metrics/ClassLength
       include FileUtils
       include Console
       include Io
@@ -101,13 +101,11 @@ module Cucumber
         print_step_header(current_test_case) if first_step_after_printing_background_steps?(event.test_step)
       end
 
-      def on_test_step_finished(event) # rubocop:disable Metrics/PerceivedComplexity
+      def on_test_step_finished(event)
         collect_snippet_data(event.test_step, @ast_lookup) if event.result.undefined?
         return if in_scenario_outline && !options[:expand]
         exception_to_be_printed = find_exception_to_be_printed(event.result)
-        # rubocop:disable Metrics/LineLength
-        print_step_data(event.test_step, event.result) if !event.test_step.hook? && (print_background_steps || event.test_step.location.lines.max >= current_test_case.location.lines.max || exception_to_be_printed)
-        # rubocop:enable Metrics/LineLength
+        print_step_data(event.test_step, event.result) if print_step_data?(event, exception_to_be_printed)
         print_step_output
         return unless exception_to_be_printed
         print_exception(exception_to_be_printed, event.result.to_sym, 6)
@@ -155,10 +153,10 @@ module Cucumber
       end
 
       def calculate_source_indent_for_ast_node(ast_node)
-        indent = 4 + ast_node[:keyword].length
-        indent += 1 + ast_node[:name].length
-        ast_node[:steps].each do |step|
-          step_indent = 5 + step[:keyword].length + step[:text].length
+        indent = 4 + ast_node.keyword.length
+        indent += 1 + ast_node.name.length
+        ast_node.steps.each do |step|
+          step_indent = 5 + step.keyword.length + step.text.length
           indent = step_indent if step_indent > indent
         end
         indent
@@ -190,9 +188,9 @@ module Cucumber
       end
 
       def feature_has_background?
-        feature_children = gherkin_document[:feature][:children]
+        feature_children = gherkin_document.feature.children
         return false if feature_children.empty?
-        !feature_children.first[:background].nil?
+        !feature_children.first.background.nil?
       end
 
       def print_step_header(test_case)
@@ -240,12 +238,12 @@ module Cucumber
       end
 
       def print_feature_data
-        feature = gherkin_document[:feature]
-        print_language_comment(feature[:location][:line])
-        print_comments(feature[:location][:line], 0)
-        print_tags(feature[:tags], 0)
+        feature = gherkin_document.feature
+        print_language_comment(feature.location.line)
+        print_comments(feature.location.line, 0)
+        print_tags(feature.tags, 0)
         print_feature_line(feature)
-        print_description(feature[:description])
+        print_description(feature.description)
         @io.flush
       end
 
@@ -256,11 +254,11 @@ module Cucumber
       end
 
       def print_comments(up_to_line, indent)
-        comments = gherkin_document[:comments]
+        comments = gherkin_document.comments
         return if comments.empty? || comments.length <= @next_comment_to_be_printed
         comments[@next_comment_to_be_printed..-1].each do |comment|
-          if comment[:location][:line] <= up_to_line
-            @io.puts(format_string(comment[:text].strip, :comment).indent(indent))
+          if comment.location.line <= up_to_line
+            @io.puts(format_string(comment.text.strip, :comment).indent(indent))
             @next_comment_to_be_printed += 1
           end
           break if @next_comment_to_be_printed >= comments.length
@@ -269,11 +267,11 @@ module Cucumber
 
       def print_tags(tags, indent)
         return if !tags || tags.empty?
-        @io.puts(tags.map { |tag| format_string(tag[:name], :tag) }.join(' ').indent(indent))
+        @io.puts(tags.map { |tag| format_string(tag.name, :tag) }.join(' ').indent(indent))
       end
 
       def print_feature_line(feature)
-        print_keyword_name(feature[:keyword], feature[:name], 0)
+        print_keyword_name(feature.keyword, feature.name, 0)
       end
 
       def print_keyword_name(keyword, name, indent, location = nil)
@@ -296,29 +294,37 @@ module Cucumber
 
       def print_background_data
         @io.puts
-        background = gherkin_document[:feature][:children].first[:background]
+        background = gherkin_document.feature.children.first.background
         @source_indent = calculate_source_indent_for_ast_node(background) if options[:source]
-        print_comments(background[:location][:line], 2)
+        print_comments(background.location.line, 2)
         print_background_line(background)
-        print_description(background[:description])
+        print_description(background.description)
         @io.flush
       end
 
       def print_background_line(background)
-        print_keyword_name(background[:keyword], background[:name], 2, "#{current_feature_uri}:#{background[:location][:line]}")
+        print_keyword_name(background.keyword, background.name, 2, "#{current_feature_uri}:#{background.location.line}")
       end
 
       def print_scenario_data(test_case)
         scenario = scenario_source(test_case).scenario
-        print_comments(scenario[:location][:line], 2)
-        print_tags(scenario[:tags], 2)
+        print_comments(scenario.location.line, 2)
+        print_tags(scenario.tags, 2)
         print_scenario_line(scenario, test_case.location)
-        print_description(scenario[:description])
+        print_description(scenario.description)
         @io.flush
       end
 
       def print_scenario_line(scenario, location = nil)
-        print_keyword_name(scenario[:keyword], scenario[:name], 2, location)
+        print_keyword_name(scenario.keyword, scenario.name, 2, location)
+      end
+
+      def print_step_data?(event, exception_to_be_printed)
+        !event.test_step.hook? && (
+          print_background_steps ||
+          event.test_step.location.lines.max >= current_test_case.location.lines.max ||
+          exception_to_be_printed
+        )
       end
 
       def print_step_data(test_step, result)
@@ -334,7 +340,7 @@ module Cucumber
 
       def test_step_keyword(test_step)
         step = step_source(test_step).step
-        step[:keyword]
+        step.keyword
       end
 
       def step_source(test_step)
@@ -355,38 +361,38 @@ module Cucumber
 
       def print_multiline_argument(test_step, result, indent)
         step = step_source(test_step).step
-        if !step[:doc_string].nil?
-          print_doc_string(step[:doc_string][:content], result.to_sym, indent)
-        elsif !step[:data_table].nil?
-          print_data_table(step[:data_table], result.to_sym, indent)
+        if !step.doc_string.nil?
+          print_doc_string(step.doc_string.content, result.to_sym, indent)
+        elsif !step.data_table.nil?
+          print_data_table(step.data_table, result.to_sym, indent)
         end
       end
 
       def print_data_table(data_table, status, indent)
-        data_table[:rows].each do |row|
-          print_comments(row[:location][:line], indent)
-          @io.puts format_string(gherkin_source.split("\n")[row[:location][:line] - 1].strip, status).indent(indent)
+        data_table.rows.each do |row|
+          print_comments(row.location.line, indent)
+          @io.puts format_string(gherkin_source.split("\n")[row.location.line - 1].strip, status).indent(indent)
         end
       end
 
       def print_outline_data(scenario_outline) # rubocop:disable Metrics/AbcSize
-        print_comments(scenario_outline[:location][:line], 2)
-        print_tags(scenario_outline[:tags], 2)
+        print_comments(scenario_outline.location.line, 2)
+        print_tags(scenario_outline.tags, 2)
         @source_indent = calculate_source_indent_for_ast_node(scenario_outline) if options[:source]
-        print_scenario_line(scenario_outline, "#{current_feature_uri}:#{scenario_outline[:location][:line]}")
-        print_description(scenario_outline[:description])
-        scenario_outline[:steps].each do |step|
-          print_comments(step[:location][:line], 4)
-          step_line = "    #{step[:keyword]}#{step[:text]}"
+        print_scenario_line(scenario_outline, "#{current_feature_uri}:#{scenario_outline.location.line}")
+        print_description(scenario_outline.description)
+        scenario_outline.steps.each do |step|
+          print_comments(step.location.line, 4)
+          step_line = "    #{step.keyword}#{step.text}"
           @io.print(format_string(step_line, :skipped))
           if options[:source]
-            comment_line = format_string("# #{current_feature_uri}:#{step[:location][:line]}", :comment)
+            comment_line = format_string("# #{current_feature_uri}:#{step.location.line}", :comment)
             @io.print(comment_line.indent(@source_indent - step_line.length))
           end
           @io.puts
           next if options[:no_multiline]
-          print_doc_string(step[:doc_string][:content], :skipped, 6) unless step[:doc_string].nil?
-          print_data_table(step[:data_table], :skipped, 6) unless step[:data_table].nil?
+          print_doc_string(step.doc_string.content, :skipped, 6) unless step.doc_string.nil?
+          print_data_table(step.data_table, :skipped, 6) unless step.data_table.nil?
         end
         @io.flush
       end
@@ -398,13 +404,13 @@ module Cucumber
       end
 
       def print_examples_data(examples)
-        print_comments(examples[:location][:line], 4)
-        print_tags(examples[:tags], 4)
-        print_keyword_name(examples[:keyword], examples[:name], 4)
-        print_description(examples[:description])
+        print_comments(examples.location.line, 4)
+        print_tags(examples.tags, 4)
+        print_keyword_name(examples.keyword, examples.name, 4)
+        print_description(examples.description)
         unless options[:expand]
-          print_comments(examples[:table_header][:location][:line], 6)
-          @io.puts(gherkin_source.split("\n")[examples[:table_header][:location][:line] - 1].strip.indent(6))
+          print_comments(examples.table_header.location.line, 6)
+          @io.puts(gherkin_source.split("\n")[examples.table_header.location.line - 1].strip.indent(6))
         end
         @io.flush
       end
@@ -427,12 +433,12 @@ module Cucumber
       end
 
       def print_expanded_row_data(test_case)
-        feature = gherkin_document[:feature]
-        language_code = feature[:language] || 'en'
+        feature = gherkin_document.feature
+        language_code = feature.language || 'en'
         language = ::Gherkin::Dialect.for(language_code)
         scenario_keyword = language.scenario_keywords[0]
         row = scenario_source(test_case).row
-        expanded_name = '| ' + row[:cells].map { |cell| cell[:value] }.join(' | ') + ' |'
+        expanded_name = '| ' + row.cells.map(&:value).join(' | ') + ' |'
         @source_indent = calculate_source_indent_for_expanded_test_case(test_case, scenario_keyword, expanded_name)
         @io.puts
         print_keyword_name(scenario_keyword, expanded_name, 6, test_case.location)