cucumber 4.0.0.rc.1 → 4.0.0.rc.6

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)
@@ -133,10 +131,9 @@ module Cucumber
         print_summary
       end
 
-      def puts(*messages)
-        messages.each do |message|
-          @test_step_output.push message
-        end
+      def attach(src, media_type)
+        return unless media_type == 'text/x.cucumber.log+plain'
+        @test_step_output.push src
       end
 
       private
@@ -155,10 +152,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 +187,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 +237,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 +253,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 +266,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 +293,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 +339,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 +360,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 +403,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 +432,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)

data/lib/cucumber/formatter/query/hook_by_test_step.rb

@@ -0,0 +1,31 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class HookByTestStep
+        def initialize(config)
+          @hook_id_by_test_step_id = {}
+
+          config.on_event :test_step_created, &method(:on_test_step_created)
+          config.on_event :hook_test_step_created, &method(:on_hook_test_step_created)
+        end
+
+        def hook_id(test_step)
+          return @hook_id_by_test_step_id[test_step.id] if @hook_id_by_test_step_id.key?(test_step.id)
+          raise TestStepUnknownError, "No hook found for #{test_step.id} }. Known: #{@hook_id_by_test_step_id.keys}"
+        end
+
+        private
+
+        def on_test_step_created(event)
+          @hook_id_by_test_step_id[event.test_step.id] = nil
+        end
+
+        def on_hook_test_step_created(event)
+          @hook_id_by_test_step_id[event.test_step.id] = event.hook.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/pickle_by_test.rb

@@ -0,0 +1,26 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class PickleByTest
+        def initialize(config)
+          @pickle_id_by_test_case_id = {}
+          config.on_event :test_case_created, &method(:on_test_case_created)
+        end
+
+        def pickle_id(test_case)
+          return @pickle_id_by_test_case_id[test_case.id] if @pickle_id_by_test_case_id.key?(test_case.id)
+
+          raise TestCaseUnknownError, "No pickle found for #{test_case.id} }. Known: #{@pickle_id_by_test_case_id.keys}"
+        end
+
+        private
+
+        def on_test_case_created(event)
+          @pickle_id_by_test_case_id[event.test_case.id] = event.pickle.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/pickle_step_by_test_step.rb

@@ -0,0 +1,26 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class PickleStepByTestStep
+        def initialize(config)
+          @pickle_id_step_by_test_step_id = {}
+          config.on_event :test_step_created, &method(:on_test_step_created)
+        end
+
+        def pickle_step_id(test_step)
+          return @pickle_id_step_by_test_step_id[test_step.id] if @pickle_id_step_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No pickle step found for #{test_step.id} }. Known: #{@pickle_id_step_by_test_step_id.keys}"
+        end
+
+        private
+
+        def on_test_step_created(event)
+          @pickle_id_step_by_test_step_id[event.test_step.id] = event.pickle_step.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/step_definitions_by_test_step.rb

@@ -0,0 +1,40 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class StepDefinitionsByTestStep
+        def initialize(config)
+          @step_definition_ids_by_test_step_id = {}
+          @step_match_arguments_by_test_step_id = {}
+
+          config.on_event :test_step_created, &method(:on_test_step_created)
+          config.on_event :step_activated, &method(:on_step_activated)
+        end
+
+        def step_definition_ids(test_step)
+          return @step_definition_ids_by_test_step_id[test_step.id] if @step_definition_ids_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No step definition found for #{test_step.id} }. Known: #{@step_definition_ids_by_test_step_id.keys}"
+        end
+
+        def step_match_arguments(test_step)
+          return @step_match_arguments_by_test_step_id[test_step.id] if @step_match_arguments_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No step match arguments found for #{test_step.id} }. Known: #{@step_match_arguments_by_test_step_id.keys}"
+        end
+
+        private
+
+        def on_test_step_created(event)
+          @step_definition_ids_by_test_step_id[event.test_step.id] = []
+        end
+
+        def on_step_activated(event)
+          @step_definition_ids_by_test_step_id[event.test_step.id] << event.step_match.step_definition.id
+          @step_match_arguments_by_test_step_id[event.test_step.id] = event.step_match.step_arguments
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/test_case_started_by_test_case.rb

@@ -0,0 +1,40 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class TestCaseStartedByTestCase
+        def initialize(config)
+          @config = config
+          config.on_event :test_case_created, &method(:on_test_case_created)
+          config.on_event :test_case_started, &method(:on_test_case_started)
+
+          @attempts_by_test_case_id = {}
+          @test_case_started_id_by_test_case_id = {}
+        end
+
+        def attempt_by_test_case(test_case)
+          raise TestCaseUnknownError, "No test case found for #{test_case.id} }. Known: #{@attempts_by_test_case_id.keys}" unless @attempts_by_test_case_id.key?(test_case.id)
+          @attempts_by_test_case_id[test_case.id]
+        end
+
+        def test_case_started_id_by_test_case(test_case)
+          raise TestCaseUnknownError, "No test case found for #{test_case.id} }. Known: #{@test_case_started_id_by_test_case_id.keys}" unless @test_case_started_id_by_test_case_id.key?(test_case.id)
+          @test_case_started_id_by_test_case_id[test_case.id]
+        end
+
+        private
+
+        def on_test_case_created(event)
+          @attempts_by_test_case_id[event.test_case.id] = 0
+          @test_case_started_id_by_test_case_id[event.test_case.id] = nil
+        end
+
+        def on_test_case_started(event)
+          @attempts_by_test_case_id[event.test_case.id] += 1
+          @test_case_started_id_by_test_case_id[event.test_case.id] = @config.id_generator.new_id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/summary.rb

@@ -47,7 +47,7 @@ module Cucumber
       def print_feature(test_case)
         uri = test_case.location.file
         return if @current_feature_uri == uri
-        feature_name = gherkin_document(uri)[:feature][:name]
+        feature_name = gherkin_document(uri).feature.name
         @io.puts unless @current_feature_uri.nil?
         @io.puts feature_name
         @current_feature_uri = uri

data/lib/cucumber/formatter/usage.rb

@@ -44,7 +44,7 @@ module Cucumber
           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]
+            keyword = @ast_lookup.step_source(test_step).step.keyword
 
             @stepdef_to_match[stepdef_key] << {
               keyword: keyword,
@@ -84,7 +84,7 @@ 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
@@ -97,7 +97,7 @@ 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)