cucumber 3.0.0.pre.2 → 3.0.1

data/lib/cucumber/formatter/html_builder.rb

@@ -5,20 +5,18 @@ require 'pathname'
 module Cucumber
   module Formatter
     class HtmlBuilder < Builder::XmlMarkup
-      def embed_text(src: nil, label: nil, id: nil)
-        raise ArgumentError, 'missing required argument' unless src && label && id # for Ruby 2.0 compatibility
+      VALID_EMBED_TYPES = [:text, :image].freeze
 
-        prepend_to_span('embed', %{<a id="#{id}" href="#{src}" title="#{label}">#{label}</a>})
-      end
+      class InvalidEmbedTypeError < ::StandardError
+        MESSAGE = 'Invalid embed type. Valid types are :text and :image.'.freeze
 
-      def embed_image(src: nil, label: nil, id: nil)
-        raise ArgumentError, 'missing required argument' unless src && label && id # for Ruby 2.0 compatibility
+        def initialize(message=MESSAGE)
+          super(message)
+        end
+      end
 
-        prepend_to_span(
-          'embed',
-          %{<a href="" onclick="img=document.getElementById('#{id}'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');return false">#{label}</a><br>&nbsp;
-            <img id="#{id}" style="display: none" src="#{src}"/>}
-        )
+      def embed(type: nil, src: nil, label: nil, id: nil)
+        prepend_to_span('embed', string_to_embed(type: type, src: src, label: label, id: id))
       end
 
       def declare!
@@ -51,6 +49,18 @@ module Cucumber
 
       private
 
+      def string_to_embed(type: nil, src: nil, label: nil, id: nil)
+        raise ::ArgumentError, 'missing required argument' unless type && src && label && id # for Ruby 2.0 compatibility
+        raise InvalidEmbedTypeError unless VALID_EMBED_TYPES.include?(type)
+
+        if type == :image
+          %{<a href="" onclick="img=document.getElementById('#{id}'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');return false">#{label}</a><br>&nbsp;
+          <img id="#{id}" style="display: none" src="#{src}"/>}
+        else
+          %{<a id="#{id}" href="#{src}" title="#{label}">#{label}</a>}
+        end
+      end
+
       def summary_div
         div(id: 'summary') do
           p('', id: 'totals')

data/lib/cucumber/formatter/io.rb

@@ -28,7 +28,7 @@ module Cucumber
         raise "You *must* specify --out DIR for the #{name} formatter" unless String === path
         raise "I can't write #{name} reports to a file - it has to be a directory" if File.file?(path)
         FileUtils.mkdir_p(path) unless File.directory?(path)
-        path
+        File.absolute_path path
       end
     end
   end

data/lib/cucumber/formatter/json.rb

@@ -14,14 +14,15 @@ module Cucumber
       def initialize(config)
         @io = ensure_io(config.out_stream)
         @feature_hashes = []
-        config.on_event :test_case_starting, &method(:on_test_case_starting)
+        @step_or_hook_hash = {}
+        config.on_event :test_case_started, &method(:on_test_case_started)
         config.on_event :test_case_finished, &method(:on_test_case_finished)
-        config.on_event :test_step_starting, &method(:on_test_step_starting)
+        config.on_event :test_step_started, &method(:on_test_step_started)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
       end
 
-      def on_test_case_starting(event)
+      def on_test_case_started(event)
         test_case = event.test_case
         builder = Builder.new(test_case)
         unless same_feature_as_previous_test_case?(test_case.feature)
@@ -39,7 +40,7 @@ module Cucumber
         @any_step_failed = false
       end
 
-      def on_test_step_starting(event)
+      def on_test_step_started(event)
         test_step = event.test_step
         return if internal_hook?(test_step)
         hook_query = HookQueryVisitor.new(test_step)
@@ -101,7 +102,7 @@ module Cucumber
       end
 
       def first_step_after_background?(test_step)
-        test_step.source[1].name != @element_hash[:name]
+        test_step.source[1].to_s != @element_hash[:name]
       end
 
       def internal_hook?(test_step)
@@ -129,7 +130,7 @@ module Cucumber
         when :after_step
           return after_step_hooks
         else
-          fail 'Unkown hook type ' + hook_query.type.to_s
+          fail 'Unknown hook type ' + hook_query.type.to_s
         end
       end
 
@@ -160,7 +161,7 @@ module Cucumber
       def create_step_hash(step_source)
         step_hash = {
           keyword: step_source.keyword,
-          name: step_source.name,
+          name: step_source.to_s,
           line: step_source.location.line
         }
         step_hash[:comments] = Formatter.create_comments_array(step_source.comments) unless step_source.comments.empty?
@@ -239,7 +240,7 @@ module Cucumber
             uri: feature.file,
             id: create_id(feature),
             keyword: feature.keyword,
-            name: feature.name,
+            name: feature.to_s,
             description: feature.description,
             line: feature.location.line
           }
@@ -258,7 +259,7 @@ module Cucumber
         def background(background)
           @background_hash = {
             keyword: background.keyword,
-            name: background.name,
+            name: background.to_s,
             description: background.description,
             line: background.location.line,
             type: 'background'
@@ -270,7 +271,7 @@ module Cucumber
           @test_case_hash = {
             id: create_id(scenario),
             keyword: scenario.keyword,
-            name: scenario.name,
+            name: scenario.to_s,
             description: scenario.description,
             line: scenario.location.line,
             type: 'scenario'
@@ -283,7 +284,7 @@ module Cucumber
           @test_case_hash = {
             id: create_id(scenario) + ';' + @example_id,
             keyword: scenario.keyword,
-            name: scenario.name,
+            name: scenario.to_s,
             description: scenario.description,
             line: @row.location.line,
             type: 'scenario'
@@ -316,7 +317,7 @@ module Cucumber
         private
 
         def create_id(element)
-          element.name.downcase.tr(' ', '-')
+          element.to_s.downcase.tr(' ', '-')
         end
 
         def create_tags_array(tags)

data/lib/cucumber/formatter/junit.rb

@@ -19,7 +19,7 @@ module Cucumber
       end
 
       def initialize(config)
-        config.on_event :test_case_starting, &method(:on_test_case_starting)
+        config.on_event :test_case_started, &method(:on_test_case_started)
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
@@ -36,7 +36,7 @@ module Cucumber
         }}
       end
 
-      def on_test_case_starting(event)
+      def on_test_case_started(event)
         test_case = event.test_case
         unless same_feature_as_previous_test_case?(test_case.feature)
           start_feature(test_case.feature)
@@ -52,7 +52,7 @@ module Cucumber
         test_step, result = *event.attributes
         return if @failing_step_source
 
-        @failing_step_source = test_step.source.last unless result.ok?(@config.strict?)
+        @failing_step_source = test_step.source.last unless result.ok?(@config.strict)
       end
 
       def on_test_case_finished(event)
@@ -102,10 +102,10 @@ module Cucumber
 
       def create_output_string(test_case, scenario, result, row_name)
         output = "#{test_case.keyword}: #{scenario}\n\n"
-        return output if result.ok?(@config.strict?)
+        return output if result.ok?(@config.strict)
         if test_case.keyword == 'Scenario'
           output += @failing_step_source.keyword.to_s unless hook?(@failing_step_source)
-          output += "#{@failing_step_source.name}\n"
+          output += "#{@failing_step_source}\n"
         else
           output += "Example row: #{row_name}\n"
         end
@@ -113,7 +113,7 @@ module Cucumber
       end
 
       def hook?(step)
-        ['Before hook', 'After hook', 'AfterStep hook'].include? step.name
+        ['Before hook', 'After hook', 'AfterStep hook'].include? step.text
       end
 
       def build_testcase(result, scenario_designation, output)
@@ -123,7 +123,7 @@ module Cucumber
         name = scenario_designation
 
         @current_feature_data[:builder].testcase(:classname => classname, :name => name, :time => format('%.6f', duration)) do
-          if !result.passed? && result.ok?(@config.strict?)
+          if !result.passed? && result.ok?(@config.strict)
             @current_feature_data[:builder].skipped
             @current_feature_data[:skipped] += 1
           elsif !result.passed?

data/lib/cucumber/formatter/legacy_api/adapter.rb

@@ -15,12 +15,14 @@ module Cucumber
 
         def initialize(*)
           super
+          emit_deprecation_warning
+
           @matches = collect_matches
-          config.on_event(:test_case_starting) do |event|
+          config.on_event(:test_case_started) do |event|
             formatter.before_test_case(event.test_case)
             printer.before_test_case(event.test_case)
           end
-          config.on_event(:test_step_starting) do |event|
+          config.on_event(:test_step_started) do |event|
             formatter.before_test_step(event.test_step)
             printer.before_test_step(event.test_step)
           end
@@ -50,6 +52,20 @@ module Cucumber
 
         private
 
+        def emit_deprecation_warning
+          parent_name = formatter_class_name =~ /::[^:]+\Z/ ? $`.freeze : nil
+          return if parent_name == 'Cucumber::Formatter'
+          return if !config.out_stream # some unit tests don't set it
+          config.out_stream.puts "WARNING: The formatter #{formatter.class.name} is using the deprecated formatter API which will be removed in v4.0 of Cucumber."
+          config.out_stream.puts
+        end
+
+        def formatter_class_name
+          formatter.class.name
+        rescue NoMethodError # when we use the Fanout, things get gnarly
+          formatter.class[0].class.name
+        end
+
         def printer
           @printer ||= FeaturesPrinter.new(formatter, results, config, @matches).before
         end
@@ -185,7 +201,7 @@ module Cucumber
           class StepSource < OpenStruct
             def build_step_invocation(indent, matches, config, messages, embeddings)
               step_result.step_invocation(
-                matches.fetch(step) { NoStepMatch.new(step, step.name) },
+                matches.fetch(step) { NoStepMatch.new(step, step.text) },
                 step,
                 indent,
                 background,
@@ -330,7 +346,7 @@ module Cucumber
             elsif source.scenario
               ScenarioPrinter.new(formatter, source.scenario, before_hook_results)
             elsif source.scenario_outline
-              if same_scenario_outline_as_previous_test_case?(source) and @previous_outline_child
+              if same_scenario_outline_as_previous_test_case?(source) && @previous_outline_child
                 @previous_outline_child
               else
                 ScenarioOutlinePrinter.new(formatter, config, source.scenario_outline)
@@ -388,19 +404,19 @@ module Cucumber
                   @previous_outline_child.after unless same_scenario_outline_as_previous_test_case?(source)
                 end
               end
-              if from_scenario_outline_to_hidden_backgroud(@child, child)
+              if from_scenario_outline_to_hidden_background(@child, child)
                 @previous_outline_child = @child
               else
                 @child.after
                 @previous_outline_child = nil
               end
             end
-            child.before unless to_scenario_outline(child) and same_scenario_outline_as_previous_test_case?(source)
+            child.before unless to_scenario_outline(child) && same_scenario_outline_as_previous_test_case?(source)
             @child = child
           end
 
-          def from_scenario_outline_to_hidden_backgroud(from, to)
-            from.class.name == ScenarioOutlinePrinter.name and
+          def from_scenario_outline_to_hidden_background(from, to)
+            from.class.name == ScenarioOutlinePrinter.name &&
             to.class.name == HiddenBackgroundPrinter.name
           end
 
@@ -612,7 +628,7 @@ module Cucumber
 
           def after
             @child.after if @child
-            # TODO - the last step result might not accurately reflect the
+            # TODO: the last step result might not accurately reflect the
             # overall scenario result.
             scenario_outline = last_step_result.scenario_outline(node.name, node.location)
             formatter.after_feature_element(scenario_outline)
@@ -641,7 +657,7 @@ module Cucumber
           end
 
           def outline_step(step)
-            step_match = NoStepMatch.new(step, step.name)
+            step_match = NoStepMatch.new(step, step.text)
             step_invocation = LegacyResultBuilder.new(Core::Test::Result::Skipped.new).
               step_invocation(step_match, step, indent, nil, configuration, [], [])
             steps_printer.step_invocation step_invocation
@@ -914,11 +930,11 @@ module Cucumber
           def of(node)
             # The length of the instantiated steps in --expand mode are currently
             # not included in the calculation of max => make sure to return >= 1
-            [1, max - node.name.length - node.keyword.length].max
+            [1, max - node.to_s.length - node.keyword.length].max
           end
 
           def record_width_of(node)
-            @widths << node.keyword.length + node.name.length + 1
+            @widths << node.keyword.length + node.to_s.length + 1
           end
 
           private
@@ -989,8 +1005,8 @@ module Cucumber
 
           def step_exception(step, configuration)
             return filtered_step_exception(step) if @exception
-            return nil unless @status == :undefined && configuration.strict?
-            @exception = Cucumber::Undefined.from(@result, step.name)
+            return nil unless @status == :undefined && configuration.strict.strict?(:undefined)
+            @exception = Cucumber::Undefined.from(@result, step.text)
             @exception.backtrace << step.backtrace_line
             filtered_step_exception(step)
           end

data/lib/cucumber/formatter/legacy_api/ast.rb

@@ -103,7 +103,7 @@ module Cucumber
                                     :embeddings) do
           extend Forwardable
 
-          def_delegators :step, :keyword, :name, :multiline_arg, :location
+          def_delegators :step, :keyword, :text, :multiline_arg, :location
 
           def accept(formatter)
             formatter.before_step(self)
@@ -119,7 +119,7 @@ module Cucumber
           end
 
           def step_result_attributes
-            legacy_multiline_arg = if multiline_arg.kind_of?(Core::Ast::EmptyMultilineArgument)
+            legacy_multiline_arg = if multiline_arg.is_a?(Core::Ast::EmptyMultilineArgument)
                                      nil
                                    else
                                      step.multiline_arg
@@ -155,6 +155,10 @@ module Cucumber
             self
           end
 
+          def to_s
+            text
+          end
+
           private
 
           def source_indent
@@ -240,6 +244,10 @@ module Cucumber
             '| ' + cells.join(' | ') + ' |'
           end
 
+          def to_s
+            name
+          end
+
           def failed?
             status == :failed
           end

data/lib/cucumber/formatter/progress.rb

@@ -31,7 +31,7 @@ module Cucumber
         @counts = ConsoleCounts.new(config)
         @issues = ConsoleIssues.new(config)
         config.on_event :step_activated, &method(:on_step_activated)
-        config.on_event :test_case_starting, &method(:on_test_case_starting)
+        config.on_event :test_case_started, &method(:on_test_case_started)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
@@ -41,7 +41,7 @@ module Cucumber
         @matches[event.test_step.source] = event.step_match
       end
 
-      def on_test_case_starting(_event)
+      def on_test_case_started(_event)
         unless @profile_information_printed
           do_print_profile_information(config.profiles) unless config.skip_profile_information? || config.profiles.nil? || config.profiles.empty?
           @profile_information_printed = true

data/lib/cucumber/formatter/rerun.rb

@@ -12,7 +12,7 @@ module Cucumber
         @failures = {}
         config.on_event :test_case_finished do |event|
           test_case, result = *event.attributes
-          next if result.ok?(@config.strict?)
+          next if result.ok?(@config.strict)
           @failures[test_case.location.file] ||= []
           @failures[test_case.location.file] << test_case.location.line
         end

data/lib/cucumber/formatter/summary.rb

@@ -19,7 +19,7 @@ module Cucumber
         @issues = ConsoleIssues.new(@config)
         @start_time = Time.now
 
-        @config.on_event :test_case_starting do |event|
+        @config.on_event :test_case_started do |event|
           print_feature event.test_case
           print_test_case event.test_case
         end

data/lib/cucumber/glue/dsl.rb

@@ -86,40 +86,26 @@ module Cucumber
         Dsl.register_rb_hook('after_step', tag_expressions, proc)
       end
 
-      # Registers a proc that will be called with a step definition argument if it
-      # matches the pattern passed as the first argument to Transform. Alternatively, if
-      # the pattern contains captures then they will be yielded as arguments to the
-      # provided proc. The return value of the proc is consequently yielded to the
-      # step definition.
-      def Transform(regexp, &proc)
-        Cucumber.deprecate(
-          'Use ParameterType(...) instead',
-          'Transform',
-          '2.6.0'
-        )
-        parameter_type = CucumberExpressions::ParameterType.new(
-          regexp.to_s,
-          regexp,
-          Object,
-          proc,
-          false,
-          true
-        )
-        Dsl.define_parameter_type(parameter_type)
-      end
-
       def ParameterType(options)
+        type = options[:type] || Object
+        use_for_snippets = if_nil(options[:use_for_snippets], true)
+        prefer_for_regexp_match = if_nil(options[:prefer_for_regexp_match], false)
+
         parameter_type = CucumberExpressions::ParameterType.new(
           options[:name],
           options[:regexp],
-          options[:type],
+          type,
           options[:transformer],
-          options[:use_for_snippets],
-          options[:prefer_for_regexp_match]
+          use_for_snippets,
+          prefer_for_regexp_match
         )
         Dsl.define_parameter_type(parameter_type)
       end
 
+      def if_nil(value, default)
+        value.nil? ? default : value
+      end
+
       # 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>).
       def AfterConfiguration(&proc)