cucumber 4.0.0.rc.4 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf95e63d73ffec417fa0dfc1f13e208355e78783a9f092d8e143dc5ca26d636
-  data.tar.gz: 869fe72a5dd449be55d00e2e72d8f78c236961141bf1cc85a7919bca426ec299
+  metadata.gz: a1f051aade812ee4bb28ab3670734b189ade8bc0cd0150a686e21874594ae62f
+  data.tar.gz: 80c272791953dc442492c0571acffc628cb7b1f37a28a00adeef413bc7f76e1b
 SHA512:
-  metadata.gz: 37c240a47d8127723e75c33051ff4e546a7e5a084a22400bb55e6d00d6d578ab7d5d7daf905259cba6625a512986fcacd4076810202e6f63dbffea16b366e9f5
-  data.tar.gz: 4556b216164535c0c2b39a1f2116b511f0cb1cccfee41cddb513073d0d887014edb38a632978347d1c127e228f1bd683317fbc62588bd4b497cdd51e10a3c550
+  metadata.gz: 5026e105060af702f3b0adf50f3925ce04fdee7de79c2482093831cab838e2a605d69c056733d7820b6592c7229ee93e1ce64b80ae373ac7acd29f11d113d3a8
+  data.tar.gz: c66fe1effa60270eb430bc2c381252e5c3da5dec524e49c58a7e508febaeb0b1398791f75eba5542395672b2431dafcfb820da2870410a52474ebc157bfbe333

data/CHANGELOG.md

@@ -10,8 +10,83 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ----
 
-## [4.0.0.rc.4](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.3...4.0.0.rc.4)
+## [4.1.0](https://github.com/cucumber/cucumber-ruby/compare/v4.0.1...v4.1.0)
+
+### Changed
+
+* Use [`cucumber-create-meta`](https://rubygems.org/gems/cucumber-create-meta) to produce the `Meta` message before the run.
+
+* Updated gems:
+  * `cucumber-wire` ~> 3.1.0
+  * `cucumber-core` ~> 7.1.0
+  * `cucumber-gherkin` ~> 14.0.1
+    * Fix issue with empty feature files [#1427](https://github.com/cucumber/cucumber-ruby/issues/1427)
+  * `cucumber-messages` ~> 12.2.0
+  * `cucumber-html-formatter` ~> 7.0.0
+    * Fix issue with Hook attachments [#1420](https://github.com/cucumber/cucumber-ruby/issues/1420)
+
+### Fixed
+
+* `AfterStep` hook do not cause issue when running `message` formatter. [#1433](https://github.com/cucumber/cucumber-ruby/issues/1433) - [#1434](https://github.com/cucumber/cucumber-ruby/pull/1434)
+
+
+## [4.0.1](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0...v4.0.1)
+
+### Fixed
+
+* force reference to `diff-lcs` to 1.3 as 1.4 introduced breaking changes.
+
+## [4.0.0](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.5...v4.0.0)
+
+### Changed
+
+* `log` method can now be called with non-string objects and will run `.to_s` on them. [#1410](https://github.com/cucumber/cucumber-ruby/issues/1410)
+
+### Improved
 
+* Display snippet when using undefined parameter type [#1411](https://github.com/cucumber/cucumber-ruby/issues/1411)
+
+## [4.0.0.rc.6](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.5...4.0.0.rc.6)
+
+### Changed
+
+* Code snippet for an undefined step with a Doc String will ouput `doc_string` instead of `string` in block params
+  ([#1401](https://github.com/cucumber/cucumber-ruby/issues/1401)
+   [#1402](https://github.com/cucumber/cucumber-ruby/pull/1402)
+   [karamosky](https://github.com/karamosky))
+
+* Updated monorepo libraries:
+  - cucumber-gherkin ~> 13
+  - cucumber-html-formatter ~> 6
+  - cucumber-cucumber-expressions ~> 10
+
+* Use `cucumber-ruby-core` 7.0.0
+
+* Use `cucumber-ruby-wire` 3.0.0
+
+* Use `body` field of attachments
+
+### Improved
+
+* `--out url` updates:
+  * supports redirects
+  * use `PUT` method by default
+  * use a cURL like options (for example: `cucumber --out 'http://example.com -X POST -H Content-Type: json`)
+
+## [4.0.0.rc.5](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.4...4.0.0.rc.5)
+
+### Added
+
+* New html formatter enabled by option `--format html --out report.html`.
+
+* Accept `--out URL` to POST results to a web server
+  If a URL is used as output, the output will be sent with a POST request.
+  This can be overridden by specifying e.g. `http-method=PUT` as a query parameter.
+  Other `http-` prefixed query parameters will be converted to request headers
+  (with the `http-` prefix stripped off).
+
+
+## [4.0.0.rc.4](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.3...4.0.0.rc.4)
 
 ### Added
 
@@ -42,7 +117,7 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
    * If you wish to alter this, then you can set a top level config option: `Cucumber.use_legacy_autoloader`
    * Like most config options, setting this inside a `spec_helper.rb` or `env.rb` file is advised
    * For more information on this change, including why it was made. Please read this
-   [Blog Post](www.google.com)
+   [Blog Post](https://cucumber.io/blog/open-source/tweaking-cucumber-rubys-auto-loader/)
    ([#1349](https://github.com/cucumber/cucumber-ruby/pull/1349),
     [#1043](https://github.com/cucumber/cucumber-ruby/issues/1043)
     [luke-hill](https://github.com/luke-hill))

data/README.md

@@ -15,7 +15,7 @@ your team.
 
 Where to get more info:
 
- * The main website: https://cucumber.io/ 
+ * The main website: https://cucumber.io/
  * Documentation: https://cucumber.io/docs
  * Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
  * Support forum: https://groups.google.com/group/cukes
@@ -28,7 +28,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
 * Ruby 2.5
 * Ruby 2.4
 * Ruby 2.3
-* JRuby 9.1
+* JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/master/docs/jruby-limitations.md))
 
 ## Code of Conduct
 

data/lib/cucumber/cli/options.rb

@@ -24,6 +24,7 @@ module Cucumber
         'junit'       => ['Cucumber::Formatter::Junit',       'Generates a report similar to Ant+JUnit.'],
         'json'        => ['Cucumber::Formatter::Json',        '[DEPRECATED] Prints the feature as JSON'],
         'message'     => ['Cucumber::Formatter::Message',     'Outputs protobuf messages'],
+        'html'        => ['Cucumber::Formatter::HTML',        'Outputs HTML report'],
         'summary'     => ['Cucumber::Formatter::Summary',     'Summary output of feature and scenarios']
       }.freeze
       max = BUILTIN_FORMATS.keys.map(&:length).max
@@ -104,7 +105,7 @@ module Cucumber
             add_option :formats, [*parse_formats(v), @out_stream]
           end
           opts.on('--init', *init_msg) { |_v| initialize_project }
-          opts.on('-o', '--out [FILE|DIR]', *out_msg) { |v| out_stream v }
+          opts.on('-o', '--out [FILE|DIR|URL]', *out_msg) { |v| out_stream v }
           opts.on('-t TAG_EXPRESSION', '--tags TAG_EXPRESSION', *tags_msg) { |v| add_tag v }
           opts.on('-n NAME', '--name NAME', *name_msg) { |v| add_option :name_regexps, /#{v}/ }
           opts.on('-e', '--exclude PATTERN', *exclude_msg) { |v| add_option :excludes, Regexp.new(v) }
@@ -295,10 +296,14 @@ Specify SEED to reproduce the shuffling from a previous run.
 
       def out_msg
         [
-          'Write output to a file/directory instead of STDOUT. This option',
+          'Write output to a file/directory/URL instead of STDOUT. This option',
           'applies to the previously specified --format, or the',
           'default format if no format is specified. Check the specific',
-          "formatter's docs to see whether to pass a file or a dir."
+          "formatter's docs to see whether to pass a file, dir or URL.",
+          "\n",
+          'When using a URL, the output of the formatter will be sent as the HTTP request body.',
+          'HTTP headers and request method can be set with cURL like options.',
+          'Example: --out "http://example.com -X POST -H Content-Type:text/json"'
         ]
       end
 

data/lib/cucumber/errors.rb

@@ -49,7 +49,4 @@ module Cucumber
       super(messages.join("\n"))
     end
   end
-
-  class LogTypeInvalid < StandardError
-  end
 end

data/lib/cucumber/events.rb

@@ -38,7 +38,8 @@ module Cucumber
         TestStepCreated,
         TestStepFinished,
         TestStepStarted,
-        Envelope
+        Envelope,
+        UndefinedParameterType
       )
     end
   end

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -0,0 +1,10 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    class UndefinedParameterType < Core::Event.new(:type_name, :expression)
+      attr_reader :type_name
+      attr_reader :expression
+    end
+  end
+end

data/lib/cucumber/formatter/console.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ModuleLength
+
 require 'cucumber/formatter/ansicolor'
 require 'cucumber/formatter/duration'
 require 'cucumber/gherkin/i18n'
@@ -116,14 +118,21 @@ module Cucumber
         @snippets_input << Console::SnippetData.new(keyword, test_step)
       end
 
+      def collect_undefined_parameter_type_names(undefined_parameter_type)
+        @undefined_parameter_types << undefined_parameter_type.type_name
+      end
+
       def print_snippets(options)
         return unless options[:snippets]
-        return if @snippets_input.empty?
 
         snippet_text_proc = lambda do |step_keyword, step_name, multiline_arg|
           snippet_text(step_keyword, step_name, multiline_arg)
         end
-        do_print_snippets(snippet_text_proc)
+        do_print_snippets(snippet_text_proc) unless @snippets_input.empty?
+
+        @undefined_parameter_types.map do |type_name|
+          do_print_undefined_parameter_type_snippet(type_name)
+        end
       end
 
       def do_print_snippets(snippet_text_proc)
@@ -181,6 +190,24 @@ module Cucumber
         @io.puts "Using the #{profiles_sentence} profile#{'s' if profiles.size > 1}..."
       end
 
+      def do_print_undefined_parameter_type_snippet(type_name)
+        camelized = type_name.split(/_|-/).collect(&:capitalize).join
+
+        @io.puts [
+          "The parameter #{type_name} is not defined. You can define a new one with:",
+          '',
+          'ParameterType(',
+          "  name:        '#{type_name}',",
+          '  regexp:      /some regexp here/,',
+          "  type:        #{camelized},",
+          '  # The transformer takes as many arguments as there are capture groups in the regexp,',
+          '  # or just one if there are none.',
+          "  transformer: ->(s) { #{camelized}.new(s) }",
+          ')',
+          ''
+        ].join("\n")
+      end
+
       private
 
       FORMATS = Hash.new { |hash, format| hash[format] = method(format).to_proc }
@@ -219,3 +246,4 @@ module Cucumber
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/cucumber/formatter/html.rb

@@ -0,0 +1,24 @@
+require 'cucumber/formatter/io'
+require 'cucumber/html_formatter'
+require 'cucumber/formatter/message_builder'
+
+module Cucumber
+  module Formatter
+    class HTML < MessageBuilder
+      include Io
+
+      def initialize(config)
+        @io = ensure_io(config.out_stream)
+        @html_formatter = Cucumber::HTMLFormatter::Formatter.new(@io)
+        @html_formatter.write_pre_message
+
+        super(config)
+      end
+
+      def output_envelope(envelope)
+        @html_formatter.write_message(envelope)
+        @html_formatter.write_post_message if envelope.test_run_finished
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/http_io.rb

@@ -0,0 +1,146 @@
+require 'net/http'
+require 'tempfile'
+
+module Cucumber
+  module Formatter
+    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 = https_verify_mode
+          uri, method, headers = CurlOptionParser.parse(url)
+          IOHTTPBuffer.new(uri, method, headers, https_verify_mode)
+        end
+      end
+    end
+
+    class CurlOptionParser
+      def self.parse(options)
+        chunks = options.split(/\s/).compact
+        http_method = 'PUT'
+        url = chunks[0]
+        headers = ''
+
+        last_flag = nil
+        chunks.each do |chunk|
+          if ['-X', '--request'].include?(chunk)
+            last_flag = '-X'
+            next
+          end
+
+          if chunk == '-H'
+            last_flag = '-H'
+            next
+          end
+
+          if last_flag == '-X'
+            http_method = chunk
+            last_flag = nil
+          end
+
+          headers += chunk if last_flag == '-H'
+        end
+
+        [
+          url,
+          http_method,
+          make_headers(headers)
+        ]
+      end
+
+      def self.make_headers(headers)
+        hash_headers = {}
+        str_scanner = /("(?<key>[^":]+)\s*:\s*(?<value>[^":]+)")|('(?<key1>[^':]+)\s*:\s*(?<value1>[^':]+)')/
+
+        headers.scan(str_scanner) do |header|
+          header = header.compact!
+          hash_headers[header[0]] = header[1]&.strip
+        end
+
+        hash_headers
+      end
+    end
+
+    class IOHTTPBuffer
+      attr_reader :uri, :method, :headers
+
+      def initialize(uri, method, headers = {}, https_verify_mode = nil)
+        @uri = URI(uri)
+        @method = method
+        @headers = headers
+        @write_io = Tempfile.new('cucumber', encoding: 'UTF-8')
+        @https_verify_mode = https_verify_mode
+      end
+
+      def close
+        post_content(@uri, @method, @headers)
+        @write_io.close
+      end
+
+      def write(data)
+        @write_io.write(data)
+      end
+
+      def flush
+        @write_io.flush
+      end
+
+      def closed?
+        @write_io.closed?
+      end
+
+      private
+
+      def post_content(uri, method, headers, attempt = 10)
+        content = @write_io
+        http = build_client(uri, @https_verify_mode)
+
+        raise StandardError, "request to #{uri} failed (too many redirections)" if attempt <= 0
+        req = build_request(
+          uri,
+          method,
+          headers.merge(
+            'Content-Length' => content.size.to_s
+          )
+        )
+
+        content.rewind
+        req.body_stream = content
+
+        begin
+          response = http.request(req)
+        rescue SystemCallError
+          # We may get the redirect response before pushing the file.
+          response = http.request(build_request(uri, method, headers))
+        end
+
+        case response
+        when Net::HTTPSuccess
+          response
+        when Net::HTTPRedirection
+          post_content(URI(response['Location']), method, headers, attempt - 1)
+        else
+          raise StandardError, "request to #{uri} failed with status #{response.code}"
+        end
+      end
+
+      def build_request(uri, method, headers)
+        method_class_name = "#{method[0].upcase}#{method[1..-1].downcase}"
+        req = Net::HTTP.const_get(method_class_name).new(uri)
+        headers.each do |header, value|
+          req[header] = value
+        end
+        req
+      end
+
+      def build_client(uri, https_verify_mode)
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = https_verify_mode if https_verify_mode
+        end
+        http
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/interceptor.rb

@@ -9,17 +9,18 @@ module Cucumber
           @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
@@ -67,12 +68,6 @@ module Cucumber
             return $stdout
           end
         end
-
-        private
-
-        def lock
-          @lock ||= Mutex.new
-        end
       end
     end
   end