cucumber 11.1.0 → 11.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41a92bddb6a0e5cdf8a69b28abfc455f4d77516e3f4abd8283cd6a222d1f5bd9
-  data.tar.gz: 743067172c8d6e732e86a2417dfa43b809ecff66ad772477460af2b1e217c234
+  metadata.gz: 859f6f5538d072ccaff43df1dc5e3b2f0a35ea3f755a35aedd2af1e9586e8b8e
+  data.tar.gz: 023a90d837722c080abc31d0e31621498225986eabe82e11231779819c47e7f2
 SHA512:
-  metadata.gz: b26e638126d5f0d7846390ed1ddbf2b38c76d92c19e43aa859ba8432b04a017e509a018e55abb590ad523e31f295daeec9e210506b862a310e996b138cb113ab
-  data.tar.gz: 5360ce612562f89839f87cf568f8a0adc3d732e224f99900653e8c58a0b4c51892932c9568b10e58365f2652fe867023d7bd32f05df7a95860583167b52cfd55
+  metadata.gz: ff9685e425c6adf6150d85218d2e1cf13e418800917cdcdf4a68f2a51b1a267a8d47735b38b5aced3b6e22a91346d081fa2412e9fd3de2f8b1c40b5411c802a4
+  data.tar.gz: 5af3d569e9e0ce0ced379d414c961f1fa94bd96f54e0c41dcac9b09a507c504c6e4701d2a162e326bfcfd30a4f40ae6bcdeeed8ecc45e18f1925408a78dd9f46

data/VERSION

@@ -1 +1 @@
-11.1.0
+11.1.1

data/lib/cucumber/events/attach_called.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Fired when attach is called in a step definition
+    class AttachCalled < Core::Event.new(:src, :media_type, :filename)
+      # The attachment body
+      attr_reader :src
+
+      # The content media type
+      attr_reader :media_type
+
+      # An optional filename
+      attr_reader :filename
+    end
+  end
+end

data/lib/cucumber/events.rb

@@ -24,6 +24,7 @@ module Cucumber
 
     def self.registry
       Core::Events.build_registry(
+        AttachCalled,
         GherkinSourceParsed,
         GherkinSourceRead,
         HookTestStepCreated,

data/lib/cucumber/formatter/console.rb

@@ -169,15 +169,15 @@ module Cucumber
         end
       end
 
-      def attach(src, media_type, filename, _streamed_file)
-        return unless media_type == 'text/x.cucumber.log+plain'
+      def on_attach_called(event)
+        return unless event.media_type == 'text/x.cucumber.log+plain'
         return unless @io
 
         @io.puts
-        if filename
-          @io.puts("#{filename}: #{format_string(src, :tag)}")
+        if event.filename
+          @io.puts("#{event.filename}: #{format_string(event.src, :tag)}")
         else
-          @io.puts(format_string(src, :tag))
+          @io.puts(format_string(event.src, :tag))
         end
 
         @io.flush

data/lib/cucumber/formatter/duration_extractor.rb

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

data/lib/cucumber/formatter/html.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'cucumber/formatter/io'
 require 'cucumber/html_formatter'
-require 'cucumber/formatter/message_builder'
+
+require_relative 'message_builder'
 
 module Cucumber
   module Formatter
@@ -14,9 +14,11 @@ module Cucumber
         super(config)
       end
 
-      def output_envelope(envelope)
-        @repository.update(envelope)
+      def on_envelope(event)
+        super(event)
+        envelope = event.envelope
         @html_formatter.write_message(envelope)
+        # TODO: Move this conditional logic into the HTML formatter proper
         @html_formatter.write_post_message if envelope.test_run_finished
       end
     end

data/lib/cucumber/formatter/json.rb

@@ -22,6 +22,7 @@ module Cucumber
         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)
+        config.on_event :attach_called, &method(:on_attach_called)
       end
 
       def on_test_case_started(event)
@@ -87,18 +88,19 @@ module Cucumber
         @io.write(JSON.pretty_generate(@feature_hashes))
       end
 
-      def attach(src, mime_type, _filename, _streamed_file)
-        if mime_type == 'text/x.cucumber.log+plain'
-          test_step_output << src
+      def on_attach_called(event)
+        if event.media_type == 'text/x.cucumber.log+plain'
+          test_step_output << event.src
           return
         end
-        if mime_type =~ /;base64$/
-          mime_type = mime_type[0..-8]
-          data = src
+        if event.media_type =~ /;base64$/
+          media_type = event.media_type[0..-8]
+          data = event.src
         else
-          data = encode64(src)
+          data = encode64(event.src)
+          media_type = event.media_type
         end
-        test_step_embeddings << { mime_type: mime_type, data: data }
+        test_step_embeddings << { mime_type: media_type, data: data }
       end
 
       private

data/lib/cucumber/formatter/message.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'cucumber/formatter/io'
-require 'cucumber/query'
+require_relative 'io'
 
 module Cucumber
   module Formatter
@@ -11,14 +10,11 @@ module Cucumber
 
       def initialize(config)
         @io = ensure_io(config.out_stream, config.error_stream)
-        @repository = Cucumber::Repository.new
-        @query = Cucumber::Query.new(@repository)
         config.on_event :envelope, &method(:output_envelope)
       end
 
       def output_envelope(event)
         envelope = event.envelope
-        @repository.update(envelope)
         @io.write(envelope.to_json)
         @io.write("\n")
       end

data/lib/cucumber/formatter/message_builder.rb

@@ -6,11 +6,14 @@ require 'json'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/query'
 
+require_relative 'message_handlers'
+
 module Cucumber
   module Formatter
     class MessageBuilder
       include Cucumber::Messages::Helpers::TimeConversion
       include Io
+      include MessageHandlers
       include Console
 
       def initialize(config)
@@ -48,38 +51,41 @@ module Cucumber
         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 :attach_called, &method(:on_attach_called)
         config.on_event :envelope, &method(:on_envelope)
       end
 
       def on_envelope(event)
-        @current_test_run_hook_started_id = event.envelope.test_run_hook_started.id if event.envelope.test_run_hook_started
+        store_current_test_run_hook_started_id(event)
       end
 
-      def attach(src, media_type, filename, streamed_file)
+      def on_attach_called(event)
         attachment_data =
           if @current_test_run_hook_started_id.nil?
             {
               test_step_id: @current_test_step_id,
               test_case_started_id: @current_test_case_started_id,
-              media_type: media_type,
-              file_name: filename,
+              media_type: event.media_type,
+              file_name: event.filename,
               timestamp: time_to_timestamp(Time.now)
             }
           else
             {
               test_run_hook_started_id: @current_test_run_hook_started_id,
-              media_type: media_type,
-              file_name: filename,
+              media_type: event.media_type,
+              file_name: event.filename,
               timestamp: time_to_timestamp(Time.now)
             }
           end
 
+        streamed_file = event.src.encoding == Encoding::BINARY
+
         if streamed_file
           attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::BASE64
-          attachment_data[:body] = Base64.strict_encode64(src)
+          attachment_data[:body] = Base64.strict_encode64(event.src)
         else
           attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::IDENTITY
-          attachment_data[:body] = src.is_a?(Hash) ? src.to_json : src
+          attachment_data[:body] = event.src.is_a?(Hash) ? event.src.to_json : event.src
         end
 
         message = Cucumber::Messages::Envelope.new(attachment: Cucumber::Messages::Attachment.new(**attachment_data))

data/lib/cucumber/formatter/message_handlers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Formatter
+    # Common Message Handlers to be used across all message-based formatters
+    # Designed to work solely with events of type `Envelope`
+    module MessageHandlers
+      def store_current_test_run_hook_started_id(event)
+        @current_test_run_hook_started_id = event.envelope.test_run_hook_started.id if event.envelope.test_run_hook_started
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/pretty.rb

@@ -64,6 +64,7 @@ module Cucumber
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
         config.on_event :undefined_parameter_type, &method(:collect_undefined_parameter_type_names)
+        config.on_event :attach_called, &method(:on_attach_called)
       end
 
       def on_gherkin_source_read(event)
@@ -137,13 +138,13 @@ module Cucumber
         print_summary
       end
 
-      def attach(src, media_type, filename, _streamed_file)
-        return unless media_type == 'text/x.cucumber.log+plain'
+      def on_attach_called(event)
+        return unless event.media_type == 'text/x.cucumber.log+plain'
 
-        if filename
-          @test_step_output.push("#{filename}: #{src}")
+        if event.filename
+          @test_step_output.push("#{event.filename}: #{event.src}")
         else
-          @test_step_output.push(src)
+          @test_step_output.push(event.src)
         end
       end
 

data/lib/cucumber/formatter/progress.rb

@@ -36,6 +36,7 @@ module Cucumber
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
         config.on_event :undefined_parameter_type, &method(:collect_undefined_parameter_type_names)
+        config.on_event :attach_called, &method(:on_attach_called)
       end
 
       def on_step_activated(event)

data/lib/cucumber/formatter/rerun.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'cucumber/formatter/io'
 require 'cucumber/query'
 
+require_relative 'io'
+
 module Cucumber
   module Formatter
     class Rerun

data/lib/cucumber/formatter/summary.rb

@@ -4,12 +4,13 @@ require 'cucumber/formatter/io'
 require 'cucumber/formatter/console'
 require 'cucumber/formatter/console_counts'
 require 'cucumber/formatter/console_issues'
+require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/core/test/result'
 require 'cucumber/formatter/ast_lookup'
 
 module Cucumber
   module Formatter
-    # Summary formatter, outputting only feature / scenario titles
+    # Summary formatter, outputting feature / scenario titles plus failure details
     class Summary
       include Io
       include Console
@@ -20,6 +21,7 @@ module Cucumber
         @ast_lookup = AstLookup.new(config)
         @counts = ConsoleCounts.new(@config)
         @issues = ConsoleIssues.new(@config, @ast_lookup)
+        @failed_results = []
         @start_time = Time.now
 
         @config.on_event :test_case_started do |event|
@@ -31,9 +33,14 @@ module Cucumber
           print_result event.result
         end
 
+        @config.on_event :test_step_finished do |event|
+          collect_failed_result(event.test_step, event.result)
+        end
+
         @config.on_event :test_run_finished do |_event|
           duration = Time.now - @start_time
           @io.puts
+          print_elements(@failed_results, :failed, 'steps')
           print_statistics(duration, @config, @counts, @issues)
         end
       end
@@ -61,6 +68,13 @@ module Cucumber
       def print_result(result)
         @io.puts format_string(result, result.to_sym)
       end
+
+      def collect_failed_result(test_step, result)
+        return if test_step.hook?
+
+        result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
+        @failed_results << result if result.failed?
+      end
     end
   end
 end

data/lib/cucumber/glue/proto_world.rb

@@ -93,12 +93,11 @@ module Cucumber
         if File.file?(file)
           media_type = MiniMime.lookup_by_filename(file)&.content_type if media_type.nil?
           file = File.read(file, mode: 'rb')
-          streamed_file = true
         end
         # We pass in the concept of whether the file is streamed to ensure that the envelope encoding is correct
-        super(file, media_type, filename, streamed_file)
+        super(file, media_type, filename)
       rescue StandardError
-        super(file, media_type, filename, streamed_file)
+        super(file, media_type, filename)
       end
 
       # Mark the matched step as pending.
@@ -155,8 +154,8 @@ module Cucumber
             runtime.ask(question, timeout_seconds)
           end
 
-          define_method(:attach) do |file, media_type, filename, streamed_file|
-            runtime.attach(file, media_type, filename, streamed_file)
+          define_method(:attach) do |file, media_type, filename|
+            runtime.attach(file, media_type, filename)
           end
 
           # Prints the list of modules that are included in the World

data/lib/cucumber/runtime/user_interface.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'timeout'
+require 'cucumber/events/attach_called'
 
 module Cucumber
   class Runtime
     module UserInterface
-      attr_writer :visitor
+      attr_writer :configuration
 
       # Suspends execution and prompts +question+ to the console (STDOUT).
       # An operator (manual tester) can then enter a line of text and hit
@@ -41,8 +42,9 @@ module Cucumber
       # be a path to a file, or if it's an image it may also be a Base64 encoded image.
       # The embedded data may or may not be ignored, depending on what kind of formatter(s) are active.
       #
-      def attach(src, media_type, filename, streamed_file)
-        @visitor.attach(src, media_type, filename, streamed_file)
+      def attach(src, media_type, filename)
+        @configuration.notify(:attach_called, src, media_type, filename)
+        self
       end
 
       private

data/lib/cucumber/runtime.rb

@@ -6,7 +6,6 @@ require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'
 require 'cucumber/filters'
-require 'cucumber/formatter/fanout'
 require 'cucumber/gherkin/i18n'
 require 'cucumber/glue/registry_wrapper'
 require 'cucumber/step_match_search'
@@ -72,8 +71,7 @@ module Cucumber
 
       load_step_definitions
       fire_install_plugin_hook
-      # TODO: can we remove this state?
-      self.visitor = report
+      create_formatters
 
       receiver = Test::Runner.new(@configuration.event_bus)
       compile features, receiver, filters, @configuration.event_bus
@@ -198,13 +196,17 @@ module Cucumber
     require 'cucumber/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
 
-    def report
-      return @report if @report
-
-      reports = [message_builder, summary_report, global_hooks_summary_report] + formatters
-      reports << fail_fast_report if @configuration.fail_fast?
-      reports << publish_banner_printer unless @configuration.publish_quiet?
-      @report ||= Formatter::Fanout.new(reports)
+    def create_formatters
+      # Define all formatters which are specified via cli options
+      formatters
+      # Define the MessageBuilder formatter - Required until all messages are generated at the source
+      #   Skip when a user formatter already inherits from MessageBuilder (e.g. HTML) to avoid sending every event twice.
+      message_builder unless formatters.any? { |f| f.is_a?(Formatter::MessageBuilder) }
+      # `summary_report` and `global_hooks_summary_report` are used to determine the exit code
+      summary_report
+      global_hooks_summary_report
+      fail_fast_report if @configuration.fail_fast?
+      publish_banner_printer unless @configuration.publish_quiet?
     end
 
     def message_builder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber
 version: !ruby/object:Gem::Version
-  version: 11.1.0
+  version: 11.1.1
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -353,6 +353,7 @@ files:
 - lib/cucumber/encoding.rb
 - lib/cucumber/errors.rb
 - lib/cucumber/events.rb
+- lib/cucumber/events/attach_called.rb
 - lib/cucumber/events/base.rb
 - lib/cucumber/events/envelope.rb
 - lib/cucumber/events/gherkin_source_parsed.rb
@@ -402,7 +403,6 @@ files:
 - lib/cucumber/formatter/duration.rb
 - lib/cucumber/formatter/duration_extractor.rb
 - lib/cucumber/formatter/fail_fast.rb
-- lib/cucumber/formatter/fanout.rb
 - lib/cucumber/formatter/global_hooks_summary.rb
 - lib/cucumber/formatter/html.rb
 - lib/cucumber/formatter/http_io.rb
@@ -414,6 +414,7 @@ files:
 - lib/cucumber/formatter/junit.rb
 - lib/cucumber/formatter/message.rb
 - lib/cucumber/formatter/message_builder.rb
+- lib/cucumber/formatter/message_handlers.rb
 - lib/cucumber/formatter/pretty.rb
 - lib/cucumber/formatter/progress.rb
 - lib/cucumber/formatter/publish_banner_printer.rb
@@ -498,5 +499,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: cucumber-11.1.0
+summary: cucumber-11.1.1
 test_files: []

data/lib/cucumber/formatter/fanout.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Cucumber
-  module Formatter
-    # Forwards any messages sent to this object to all recipients
-    # that respond to that message.
-    class Fanout < BasicObject
-      attr_reader :recipients
-      private :recipients
-
-      def initialize(recipients)
-        @recipients = recipients
-      end
-
-      def method_missing(message, *args)
-        super unless recipients
-
-        recipients.each do |recipient|
-          recipient.send(message, *args) if recipient.respond_to?(message)
-        end
-      end
-
-      def respond_to_missing?(name, include_private = false)
-        recipients.any? { |recipient| recipient.respond_to?(name, include_private) } || super(name, include_private)
-      end
-    end
-  end
-end