cucumber 4.0.0.rc.5 → 5.0.0

data/lib/cucumber/formatter/interceptor.rb

@@ -5,21 +5,23 @@ module Cucumber
     module Interceptor
       class Pipe
         attr_reader :pipe
+
         def initialize(pipe)
           @pipe = pipe
           @buffer = StringIO.new
           @wrapped = true
+          @lock = Mutex.new
         end
 
         def write(str)
-          lock.synchronize do
+          @lock.synchronize do
             @buffer << str if @wrapped
             return @pipe.write(str)
           end
         end
 
         def buffer_string
-          lock.synchronize do
+          @lock.synchronize do
             return @buffer.string.dup
           end
         end
@@ -30,7 +32,7 @@ module Cucumber
         end
 
         def method_missing(method, *args, &blk)
-          @pipe.send(method, *args, &blk) || super
+          @pipe.respond_to?(method) ? @pipe.send(method, *args, &blk) : super
         end
 
         def respond_to_missing?(method, include_private = false)
@@ -67,12 +69,6 @@ module Cucumber
             return $stdout
           end
         end
-
-        private
-
-        def lock
-          @lock ||= Mutex.new
-        end
       end
     end
   end

data/lib/cucumber/formatter/io.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'cucumber/formatter/http_io'
+require 'cucumber/formatter/url_reporter'
+require 'cucumber/cli/options'
 
 module Cucumber
   module Formatter
@@ -9,19 +11,53 @@ module Cucumber
 
       def ensure_io(path_or_url_or_io)
         return nil if path_or_url_or_io.nil?
-        return path_or_url_or_io if path_or_url_or_io.respond_to?(:write)
-        io = if path_or_url_or_io.match(%r{^https?://})
-               HTTPIO.open(path_or_url_or_io)
+        return path_or_url_or_io if io?(path_or_url_or_io)
+
+        io = if url?(path_or_url_or_io)
+               url = path_or_url_or_io
+               reporter = url.start_with?(Cucumber::Cli::Options::CUCUMBER_PUBLISH_URL) ? URLReporter.new($stdout) : NoReporter.new
+               HTTPIO.open(url, nil, reporter)
              else
                File.open(path_or_url_or_io, Cucumber.file_mode('w'))
              end
-        at_exit do
-          unless io.closed?
-            io.flush
-            io.close
+        @io_objects_to_close ||= []
+        @io_objects_to_close.push(io)
+        io
+      end
+
+      module ClassMethods
+        def new(*args, &block)
+          instance = super
+
+          config = args[0]
+          if config.respond_to? :on_event
+            config.on_event :test_run_finished do
+              ios = instance.instance_variable_get(:@io_objects_to_close) || []
+              ios.each do |io|
+                at_exit do
+                  unless io.closed?
+                    io.flush
+                    io.close
+                  end
+                end
+              end
+            end
           end
+
+          instance
         end
-        io
+      end
+
+      def self.included(formatter_class)
+        formatter_class.extend(ClassMethods)
+      end
+
+      def io?(path_or_url_or_io)
+        path_or_url_or_io.respond_to?(:write)
+      end
+
+      def url?(path_or_url_or_io)
+        path_or_url_or_io.match(%r{^https?://})
       end
 
       def ensure_file(path, name)

data/lib/cucumber/formatter/message_builder.rb

@@ -29,6 +29,7 @@ module Cucumber
         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)
+        config.on_event :undefined_parameter_type, &method(:on_undefined_parameter_type)
 
         @test_case_by_step_id = {}
         @current_test_case_started_id = nil
@@ -47,11 +48,13 @@ module Cucumber
         }
 
         if media_type.start_with?('text/')
-          attachment_data[:text] = src
-        elsif src.respond_to? :read
-          attachment_data[:binary] = Base64.encode64(src.read)
+          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::IDENTITY
+          attachment_data[:body] = src
         else
-          attachment_data[:binary] = Base64.encode64(src)
+          body = src.respond_to?(:read) ? src.read : src
+
+          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::BASE64
+          attachment_data[:body] = Base64.strict_encode64(body)
         end
 
         message = Cucumber::Messages::Envelope.new(
@@ -124,7 +127,7 @@ module Cucumber
 
       def step_match_arguments(step)
         @step_definitions_by_test_step.step_match_arguments(step).map do |argument|
-          Cucumber::Messages::StepMatchArgument.new(
+          Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument.new(
             group: argument_group_to_message(argument.group),
             parameter_type_name: argument.parameter_type.name
           )
@@ -132,7 +135,7 @@ module Cucumber
       end
 
       def argument_group_to_message(group)
-        Cucumber::Messages::StepMatchArgument::Group.new(
+        Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument::Group.new(
           start: group.start,
           value: group.value,
           children: group.children.map { |child| argument_group_to_message(child) }
@@ -187,7 +190,7 @@ module Cucumber
 
         result_message = result.to_message
         if result.failed? || result.pending?
-          result_message = Cucumber::Messages::TestStepResult.new(
+          result_message = Cucumber::Messages::TestStepFinished::TestStepResult.new(
             status: result_message.status,
             duration: result_message.duration,
             message: create_error_message(result)
@@ -233,6 +236,17 @@ module Cucumber
         output_envelope(message)
       end
 
+      def on_undefined_parameter_type(event)
+        message = Cucumber::Messages::Envelope.new(
+          undefined_parameter_type: Cucumber::Messages::UndefinedParameterType.new(
+            name: event.type_name,
+            expression: event.expression
+          )
+        )
+
+        output_envelope(message)
+      end
+
       def test_case_started_id(test_case)
         @test_case_started_by_test_case.test_case_started_id_by_test_case(test_case)
       end

data/lib/cucumber/formatter/pretty.rb

@@ -36,6 +36,7 @@ module Cucumber
         @config = config
         @options = config.to_hash
         @snippets_input = []
+        @undefined_parameter_types = []
         @total_duration = 0
         @exceptions = []
         @gherkin_sources = {}
@@ -54,6 +55,11 @@ module Cucumber
         @passed_test_cases = []
         @source_indent = 0
         @next_comment_to_be_printed = 0
+
+        bind_events(config)
+      end
+
+      def bind_events(config)
         config.on_event :gherkin_source_read, &method(:on_gherkin_source_read)
         config.on_event :step_activated, &method(:on_step_activated)
         config.on_event :test_case_started, &method(:on_test_case_started)
@@ -61,6 +67,7 @@ module Cucumber
         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)
+        config.on_event :undefined_parameter_type, &method(:collect_undefined_parameter_type_names)
       end
 
       def on_gherkin_source_read(event)

data/lib/cucumber/formatter/progress.rb

@@ -21,6 +21,7 @@ module Cucumber
         @config = config
         @io = ensure_io(config.out_stream)
         @snippets_input = []
+        @undefined_parameter_types = []
         @total_duration = 0
         @matches = {}
         @pending_step_matches = []
@@ -36,6 +37,7 @@ module Cucumber
         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)
+        config.on_event :undefined_parameter_type, &method(:collect_undefined_parameter_type_names)
       end
 
       def on_step_activated(event)

data/lib/cucumber/formatter/publish_banner_printer.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'cucumber/term/banner'
+
+module Cucumber
+  module Formatter
+    class PublishBannerPrinter
+      include Term::Banner
+
+      def initialize(configuration)
+        return if configuration.publish_enabled?
+
+        configuration.on_event :test_run_finished do |_event|
+          display_publish_ad(configuration.error_stream)
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def display_publish_ad(io)
+        display_banner(
+          [
+            [
+              'Share your Cucumber Report with your team at ',
+              link('https://reports.cucumber.io')
+            ],
+            '',
+            [
+              'Command line option:    ',
+              highlight('--publish')
+            ],
+            [
+              'Environment variable:   ',
+              highlight('CUCUMBER_PUBLISH_ENABLED=true')
+            ],
+            [
+              'cucumber.yml:           ',
+              highlight('default: --publish')
+            ],
+            '',
+            [
+              'More information at ',
+              link('https://reports.cucumber.io/docs/cucumber-ruby')
+            ],
+            '',
+            [
+              'To disable this message, specify ',
+              pre('CUCUMBER_PUBLISH_QUIET=true'),
+              ' or use the '
+            ],
+            [
+              pre('--publish-quiet'),
+              ' option. You can also add this to your ',
+              pre('cucumber.yml:')
+            ],
+            [pre('default: --publish-quiet')]
+          ],
+          io
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def highlight(text)
+        [text, :cyan]
+      end
+
+      def link(text)
+        [text, :cyan, :bold, :underline]
+      end
+
+      def pre(text)
+        [text, :bold]
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/url_reporter.rb

@@ -0,0 +1,30 @@
+require 'cucumber/term/banner'
+
+module Cucumber
+  module Formatter
+    class URLReporter
+      include Term::Banner
+
+      def initialize(io)
+        @io = io
+      end
+
+      def report(url)
+        uri = URI(url)
+        display_banner(
+          [
+            'View your Cucumber Report at:',
+            [["https://reports.cucumber.io#{uri.path}", :cyan, :bold, :underline]],
+            '',
+            [['This report will self-destruct in 24h unless it is claimed or deleted.', :green, :bold]]
+          ],
+          @io
+        )
+      end
+    end
+
+    class NoReporter
+      def report(url); end
+    end
+  end
+end

data/lib/cucumber/glue/proto_world.rb

@@ -107,9 +107,8 @@ module Cucumber
         attach(file, mime_type)
       end
 
-      def log(message)
-        raise Cucumber::LogTypeInvalid unless message.is_a?(String)
-        attach(message.dup, 'text/x.cucumber.log+plain')
+      def log(*messages)
+        messages.each { |message| attach(message.to_s.dup, 'text/x.cucumber.log+plain') }
       end
 
       def attach(file, media_type)

data/lib/cucumber/glue/registry_and_more.rb

@@ -93,12 +93,7 @@ module Cucumber
         # TODO: add a way to extract the parameter type directly from the error.
         type_name = e.message.match(/^Undefined parameter type \{(.*)\}$/)[1]
 
-        @configuration.notify :envelope, Cucumber::Messages::Envelope.new(
-          undefined_parameter_type: Cucumber::Messages::UndefinedParameterType.new(
-            name: type_name,
-            expression: string_or_regexp
-          )
-        )
+        @configuration.notify :undefined_parameter_type, type_name, string_or_regexp
       end
 
       def build_rb_world_factory(world_modules, namespaced_world_modules, proc)
@@ -192,6 +187,7 @@ module Cucumber
 
         Cucumber::Messages::Envelope.new(
           parameter_type: Cucumber::Messages::ParameterType.new(
+            id: @configuration.id_generator.new_id,
             name: parameter_type.name,
             regular_expressions: parameter_type.regexps.map(&:to_s),
             prefer_for_regular_expression_match: parameter_type.prefer_for_regexp_match?,

data/lib/cucumber/glue/snippet.rb

@@ -174,7 +174,7 @@ module Cucumber
 
         class DocString
           def append_block_parameter_to(array)
-            array << 'string'
+            array << 'doc_string'
           end
 
           def append_comment_to(string); end

data/lib/cucumber/glue/step_definition.rb

@@ -77,7 +77,7 @@ module Cucumber
         Cucumber::Messages::Envelope.new(
           step_definition: Cucumber::Messages::StepDefinition.new(
             id: id,
-            pattern: Cucumber::Messages::StepDefinitionPattern.new(
+            pattern: Cucumber::Messages::StepDefinition::StepDefinitionPattern.new(
               source: expression.source.to_s,
               type: expression_type
             ),
@@ -92,8 +92,8 @@ module Cucumber
       end
 
       def expression_type
-        return Cucumber::Messages::StepDefinitionPatternType::CUCUMBER_EXPRESSION if expression.is_a?(CucumberExpressions::CucumberExpression)
-        Cucumber::Messages::StepDefinitionPatternType::REGULAR_EXPRESSION
+        return Cucumber::Messages::StepDefinition::StepDefinitionPattern::StepDefinitionPatternType::CUCUMBER_EXPRESSION if expression.is_a?(CucumberExpressions::CucumberExpression)
+        Cucumber::Messages::StepDefinition::StepDefinitionPattern::StepDefinitionPatternType::REGULAR_EXPRESSION
       end
 
       # @api private

data/lib/cucumber/multiline_argument/data_table/diff_matrices.rb

@@ -95,7 +95,7 @@ module Cucumber
         def changes
           require 'diff/lcs'
           diffable_cell_matrix = cell_matrix.dup.extend(::Diff::LCS)
-          diffable_cell_matrix.diff(other_table_cell_matrix).flatten
+          diffable_cell_matrix.diff(other_table_cell_matrix).flatten(1)
         end
 
         def inspect_rows(missing_row, inserted_row)

data/lib/cucumber/platform.rb

@@ -7,7 +7,7 @@ require 'cucumber/core/platform'
 
 module Cucumber
   unless defined?(Cucumber::VERSION)
-    VERSION       = File.read(File.expand_path('version', __dir__))
+    VERSION       = File.read(File.expand_path('version', __dir__)).strip
     BINARY        = File.expand_path(File.dirname(__FILE__) + '/../../bin/cucumber')
     LIBDIR        = File.expand_path(File.dirname(__FILE__) + '/../../lib')
     RAILS         = defined?(Rails)

data/lib/cucumber/rake/task.rb

@@ -156,7 +156,7 @@ module Cucumber
 
       def runner(_task_args = nil) #:nodoc:
         cucumber_opts = [(ENV['CUCUMBER_OPTS'] ? ENV['CUCUMBER_OPTS'].split(/\s+/) : nil) || cucumber_opts_with_profile]
-        return ForkedCucumberRunner.new(libs, binary, cucumber_opts, bundler, feature_files) if @fork
+        return ForkedCucumberRunner.new(libs, binary, cucumber_opts, bundler, feature_files) if fork
         InProcessCucumberRunner.new(libs, cucumber_opts, feature_files)
       end
 

data/lib/cucumber/rspec/doubles.rb

@@ -13,9 +13,7 @@ Before do
 end
 
 After do
-  begin
-    RSpec::Mocks.verify
-  ensure
-    RSpec::Mocks.teardown
-  end
+  RSpec::Mocks.verify
+ensure
+  RSpec::Mocks.teardown
 end

data/lib/cucumber/runtime.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'cucumber/configuration'
+require 'cucumber/create_meta'
 require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'
@@ -9,6 +10,8 @@ require 'cucumber/filters'
 require 'cucumber/formatter/fanout'
 require 'cucumber/gherkin/i18n'
 require 'cucumber/step_match_search'
+require 'cucumber/messages'
+require 'sys/uname'
 
 module Cucumber
   module FixRuby21Bug9285
@@ -62,6 +65,10 @@ module Cucumber
 
     require 'cucumber/wire/plugin'
     def run!
+      @configuration.notify :envelope, Cucumber::Messages::Envelope.new(
+        meta: Cucumber::CreateMeta.create_meta('cucumber-ruby', Cucumber::VERSION)
+      )
+
       load_step_definitions
       install_wire_plugin
       fire_after_configuration_hook
@@ -159,11 +166,14 @@ module Cucumber
 
     require 'cucumber/formatter/ignore_missing_messages'
     require 'cucumber/formatter/fail_fast'
+    require 'cucumber/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
+
     def report
       return @report if @report
       reports = [summary_report] + formatters
       reports << fail_fast_report if @configuration.fail_fast?
+      reports << publish_banner_printer unless @configuration.publish_quiet?
       @report ||= Formatter::Fanout.new(reports)
     end
 
@@ -175,6 +185,10 @@ module Cucumber
       @fail_fast_report ||= Formatter::FailFast.new(@configuration)
     end
 
+    def publish_banner_printer
+      @publish_banner_printer ||= Formatter::PublishBannerPrinter.new(@configuration)
+    end
+
     def formatters
       @formatters ||=
         @configuration.formatter_factories do |factory, formatter_options, path_or_io|