cucumber 4.0.0.rc.6 → 5.1.0

data/lib/cucumber/formatter/http_io.rb

@@ -6,10 +6,12 @@ module Cucumber
     class HTTPIO
       class << self
         # Returns an IO that will write to a HTTP request's body
-        def open(url, https_verify_mode = nil)
+        # https_verify_mode can be set to OpenSSL::SSL::VERIFY_NONE
+        # to ignore unsigned certificate - setting to nil will verify the certificate
+        def open(url, https_verify_mode = nil, reporter = nil)
           @https_verify_mode = https_verify_mode
           uri, method, headers = CurlOptionParser.parse(url)
-          IOHTTPBuffer.new(uri, method, headers, https_verify_mode)
+          IOHTTPBuffer.new(uri, method, headers, https_verify_mode, reporter)
         end
       end
     end
@@ -64,16 +66,19 @@ module Cucumber
     class IOHTTPBuffer
       attr_reader :uri, :method, :headers
 
-      def initialize(uri, method, headers = {}, https_verify_mode = nil)
+      def initialize(uri, method, headers = {}, https_verify_mode = nil, reporter = nil)
         @uri = URI(uri)
         @method = method
         @headers = headers
         @write_io = Tempfile.new('cucumber', encoding: 'UTF-8')
         @https_verify_mode = https_verify_mode
+        @reporter = reporter || NoReporter.new
       end
 
       def close
-        post_content(@uri, @method, @headers)
+        resource_uri = send_content(@uri, @method, @headers)
+
+        @reporter.report(resource_uri)
         @write_io.close
       end
 
@@ -91,8 +96,8 @@ module Cucumber
 
       private
 
-      def post_content(uri, method, headers, attempt = 10)
-        content = @write_io
+      def send_content(uri, method, headers, attempt = 10)
+        content = (method == 'GET' ? StringIO.new : @write_io)
         http = build_client(uri, @https_verify_mode)
 
         raise StandardError, "request to #{uri} failed (too many redirections)" if attempt <= 0
@@ -115,10 +120,14 @@ module Cucumber
         end
 
         case response
+        when Net::HTTPAccepted
+          return uri unless response['Location']
+
+          send_content(URI(response['Location']), 'PUT', headers, attempt - 1)
         when Net::HTTPSuccess
-          response
+          uri
         when Net::HTTPRedirection
-          post_content(URI(response['Location']), method, headers, attempt - 1)
+          send_content(URI(response['Location']), method, headers, attempt - 1)
         else
           raise StandardError, "request to #{uri} failed with status #{response.code}"
         end

data/lib/cucumber/formatter/interceptor.rb

@@ -5,6 +5,7 @@ module Cucumber
     module Interceptor
       class Pipe
         attr_reader :pipe
+
         def initialize(pipe)
           @pipe = pipe
           @buffer = StringIO.new
@@ -31,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)
@@ -62,10 +63,10 @@ module Cucumber
           case pipe
           when :stderr
             $stderr = new($stderr)
-            return $stderr
+            $stderr
           when :stdout
             $stdout = new($stdout)
-            return $stdout
+            $stdout
           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($stderr) : 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/json.rb

@@ -19,7 +19,7 @@ module Cucumber
           '--format=json',
           "Please use --format=message and stand-alone json-formatter.\n" \
           'json-formatter homepage: https://github.com/cucumber/cucumber/tree/master/json-formatter#cucumber-json-formatter',
-          '5.0.0'
+          '6.0.0'
         )
 
         @io = ensure_io(config.out_stream)

data/lib/cucumber/formatter/junit.rb

@@ -106,7 +106,7 @@ module Cucumber
         write_file(feature_result_filename(feature_data[:uri]), @testsuite.target!)
       end
 
-      def create_output_string(test_case, scenario, result, row_name) # rubocop:disable Metrics/PerceivedComplexity
+      def create_output_string(test_case, scenario, result, row_name)
         scenario_source = @ast_lookup.scenario_source(test_case)
         keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
         output = "#{keyword}: #{scenario}\n\n"

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
@@ -235,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/rerun.rb

@@ -7,7 +7,7 @@ module Cucumber
     class Rerun
       include Formatter::Io
 
-      def initialize(config) # rubocop:disable Metrics/PerceivedComplexity
+      def initialize(config)
         @io = ensure_io(config.out_stream)
         @config = config
         @failures = {}

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

@@ -87,7 +87,7 @@ module Cucumber
           'If you simply want it in the console, '\
           'keep using "puts" (or Kernel.puts to avoid this message)',
           'puts(message)',
-          '5.0.0'
+          '6.0.0'
         )
         messages.each { |message| log(message.to_s) }
       end
@@ -102,14 +102,13 @@ module Cucumber
         Cucumber.deprecate(
           'Please use attach(file, media_type) instead',
           'embed(file, mime_type, label)',
-          '5.0.0'
+          '6.0.0'
         )
         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)
@@ -144,7 +143,7 @@ module Cucumber
       end
 
       # Dynamially generate the API module, closuring the dependencies
-      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength
+      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
         Module.new do # rubocop:disable Metrics/BlockLength
           def self.extended(object)
             # wrap the dynamically generated module so that we can document the methods

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)

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/rake/task.rb

@@ -5,9 +5,7 @@ require 'cucumber/gherkin/formatter/ansi_escapes'
 begin
   # Support Rake > 0.8.7
   require 'rake/dsl_definition'
-  # rubocop:disable Lint/HandleExceptions
 rescue LoadError
-  # rubocop:enable Lint/HandleExceptions
 end
 
 module Cucumber
@@ -156,7 +154,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