cucumber 3.0.1 → 3.2.0

data/lib/cucumber/formatter/html.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erb'
 require 'cucumber/formatter/duration'
 require 'cucumber/formatter/io'
@@ -8,8 +9,7 @@ require 'pathname'
 module Cucumber
   module Formatter
     class Html
-
-      # TODO: remove coupling to types
+      # TODO: remove coupling to types
       AST_CLASSES = {
         Cucumber::Core::Ast::Scenario        => 'scenario',
         Cucumber::Core::Ast::ScenarioOutline => 'scenario outline'
@@ -42,13 +42,13 @@ module Cucumber
       def embed(src, mime_type, label)
         if image?(mime_type)
           src = src_is_file_or_data?(src) ? src : "data:#{standardize_mime_type(mime_type)},#{src}"
-          builder.embed(type: :image, src: set_path(src), label: label, id: next_id(:img))
+          builder.embed(type: :image, src: path(src), label: label, id: next_id(:img))
         else
           builder.embed(type: :text, src: src, label: label, id: next_id(:text))
         end
       end
 
-      def set_path(src)
+      def path(src)
         if @io.respond_to?(:path) && File.file?(src)
           out_dir = Pathname.new(File.dirname(File.absolute_path(@io.path)))
           src = Pathname.new(File.absolute_path(src)).relative_path_from(out_dir)
@@ -70,7 +70,7 @@ module Cucumber
       end
 
       def before_features(features)
-        @step_count = features && features.step_count || 0 #TODO: Make this work with core!
+        @step_count = features && features.step_count || 0 # TODO: Make this work with core!
 
         builder.build_document!
         builder.format_features! features
@@ -153,7 +153,7 @@ module Cucumber
       end
 
       def before_feature_element(feature_element)
-        @scenario_number+=1
+        @scenario_number += 1
         @scenario_red = false
         css_class = AST_CLASSES[feature_element.class]
         builder << "<div class='#{css_class}'>"
@@ -251,7 +251,7 @@ module Cucumber
         end
         @status = status
         return if @hide_this_step
-        set_scenario_color(status)
+        scenario_color(status)
         builder << "<li id='#{@step_id}' class='step #{status}'>"
       end
 
@@ -266,7 +266,7 @@ module Cucumber
           builder.pre do |pre|
             # TODO: snippet text should be an event sent to the formatter so we don't
             # have this couping to the runtime.
-            pre << @runtime.snippet_text(keyword,step_match.instance_variable_get('@name') || '', @step.multiline_arg)
+            pre << @runtime.snippet_text(keyword, step_match.instance_variable_get('@name') || '', @step.multiline_arg)
           end
         end
         builder << '</li>'
@@ -353,25 +353,22 @@ module Cucumber
         attributes = {:id => "#{@row_id}_#{@col_index}", :class => 'step'}
         attributes[:class] += " #{status}" if status
         build_cell(@cell_type, value, attributes)
-        set_scenario_color(status) if @inside_outline
+        scenario_color(status) if @inside_outline
         @col_index += 1
       end
 
       def puts(message)
         @delayed_messages << message
-        #builder.pre(message, :class => 'message')
       end
 
       def print_messages
         return if @delayed_messages.empty?
 
-          #builder.ol do
-          @delayed_messages.each do |ann|
-            builder.li(:class => 'step message') do
-              builder << ann
-            end
+        @delayed_messages.each do |ann|
+          builder.li(:class => 'step message') do
+            builder << ann
           end
-        #end
+        end
         empty_messages
       end
 
@@ -399,7 +396,7 @@ module Cucumber
       def next_id(type)
         @indices ||= Hash.new { 0 }
         @indices[type] += 1
-        "#{type}_#{@indices[:type]}"
+        "#{type}_#{@indices[type]}"
       end
 
       def build_exception_detail(exception)
@@ -436,7 +433,7 @@ module Cucumber
         builder << extra unless extra == ''
       end
 
-      def set_scenario_color(status)
+      def scenario_color(status)
         if status.nil? || status == :undefined || status == :pending
           set_scenario_color_pending
         end
@@ -467,7 +464,7 @@ module Cucumber
       end
 
       def build_step(keyword, step_match, _status)
-        step_name = step_match.format_args(lambda{|param| %{<span class="param">#{param}</span>}})
+        step_name = step_match.format_args(lambda { |param| %{<span class="param">#{param}</span>} })
         builder.div(:class => 'step_name') do |div|
           builder.span(keyword, :class => 'keyword')
           builder.span(:class => 'step val') do |name|
@@ -492,7 +489,7 @@ module Cucumber
       def build_cell(cell_type, value, attributes)
         builder.__send__(cell_type, attributes) do
           builder.div do
-            builder.span(value,:class => 'step param')
+            builder.span(value, :class => 'step param')
           end
         end
       end
@@ -531,11 +528,11 @@ module Cucumber
       def print_stat_string(_features)
         string = String.new
         string << dump_count(@runtime.scenarios.length, 'scenario')
-        scenario_count = print_status_counts{|status| @runtime.scenarios(status)}
+        scenario_count = print_status_counts { |status| @runtime.scenarios(status) }
         string << scenario_count if scenario_count
         string << '<br />'
         string << dump_count(@runtime.steps.length, 'step')
-        step_count = print_status_counts{|status| @runtime.steps(status)}
+        step_count = print_status_counts { |status| @runtime.steps(status) }
         string << step_count if step_count
       end
 
@@ -547,7 +544,7 @@ module Cucumber
         return " (#{counts.join(', ')})" if counts.any?
       end
 
-      def dump_count(count, what, state=nil)
+      def dump_count(count, what, state = nil)
         [count, state, "#{what}#{count == 1 ? '' : 's'}"].compact.join(' ')
       end
 
@@ -568,7 +565,7 @@ module Cucumber
         def snippet(error)
           raw_code, line = snippet_for(error[0])
           highlighted = @@converter.convert(raw_code, false)
-          highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
+          highlighted += "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
           post_process(highlighted, line)
         end
 
@@ -585,12 +582,12 @@ module Cucumber
         def lines_around(file, line)
           if File.file?(file)
             begin
-            lines = File.open(file).read.split("\n")
-          rescue ArgumentError
-            return "# Couldn't get snippet for #{file}"
-          end
-          min = [0, line-3].max
-            max = [line+1, lines.length-1].min
+              lines = File.open(file).read.split("\n")
+            rescue ArgumentError
+              return "# Couldn't get snippet for #{file}"
+            end
+            min = [0, line - 3].max
+            max = [line + 1, lines.length - 1].min
             selected_lines = []
             selected_lines.join("\n")
             lines[min..max].join("\n")
@@ -602,13 +599,12 @@ module Cucumber
         def post_process(highlighted, offending_line)
           new_lines = []
           highlighted.split("\n").each_with_index do |line, i|
-            new_line = "<span class=\"linenum\">#{offending_line+i-2}</span>#{line}"
+            new_line = "<span class=\"linenum\">#{offending_line + i - 2}</span>#{line}"
             new_line = "<span class=\"offending\">#{new_line}</span>" if i == 2
             new_lines << new_line
           end
           new_lines.join("\n")
         end
-
       end
     end
   end

data/lib/cucumber/formatter/html_builder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'builder'
 require 'pathname'
 
@@ -10,7 +11,7 @@ module Cucumber
       class InvalidEmbedTypeError < ::StandardError
         MESSAGE = 'Invalid embed type. Valid types are :text and :image.'.freeze
 
-        def initialize(message=MESSAGE)
+        def initialize(message = MESSAGE)
           super(message)
         end
       end
@@ -117,4 +118,4 @@ module Cucumber
       end
     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] ? header[1].strip : header[1]
+        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/ignore_missing_messages.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Cucumber
   module Formatter
-
     class IgnoreMissingMessages < BasicObject
       def initialize(receiver)
         @receiver = receiver
@@ -15,7 +15,5 @@ module Cucumber
         @receiver.respond_to?(name, include_private)
       end
     end
-
   end
 end
-

data/lib/cucumber/formatter/interceptor.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'thread'
 
 module Cucumber
   module Formatter
@@ -8,7 +7,7 @@ module Cucumber
         attr_reader :pipe
         def initialize(pipe)
           @pipe = pipe
-          @buffer = []
+          @buffer = StringIO.new
           @wrapped = true
         end
 
@@ -19,9 +18,22 @@ module Cucumber
           end
         end
 
+        # @deprecated use #buffer_string
         def buffer
+          require 'cucumber/deprecate.rb'
+          Cucumber.deprecate(
+            'Use Cucumber::Formatter::Interceptor::Pipe#buffer_string instead',
+            'Cucumber::Formatter::Interceptor::Pipe#buffer',
+            '3.99'
+          )
           lock.synchronize do
-            return @buffer.dup
+            return @buffer.string.lines
+          end
+        end
+
+        def buffer_string
+          lock.synchronize do
+            return @buffer.string.dup
           end
         end
 
@@ -34,7 +46,7 @@ module Cucumber
           @pipe.send(method, *args, &blk)
         end
 
-        def respond_to?(method, include_private=false)
+        def respond_to?(method, include_private = false)
           super || @pipe.respond_to?(method, include_private)
         end
 
@@ -72,8 +84,9 @@ module Cucumber
         end
 
         private
+
         def lock
-          @lock||=Mutex.new
+          @lock ||= Mutex.new
         end
       end
     end

data/lib/cucumber/formatter/io.rb

@@ -1,31 +1,38 @@
 # frozen_string_literal: true
+
+require 'cucumber/formatter/http_io'
+
 module Cucumber
   module Formatter
     module Io
       module_function
 
-      def ensure_io(path_or_io)
-        return nil if path_or_io.nil?
-        return path_or_io if path_or_io.respond_to?(:write)
-        file = File.open(path_or_io, Cucumber.file_mode('w'))
+      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 =~ %r{^https?://}
+               HTTPIO.open(path_or_url_or_io)
+             else
+               File.open(path_or_url_or_io, Cucumber.file_mode('w'))
+             end
         at_exit do
-          unless file.closed?
-            file.flush
-            file.close
+          unless io.closed?
+            io.flush
+            io.close
           end
         end
-        file
+        io
       end
 
       def ensure_file(path, name)
-        raise "You *must* specify --out FILE for the #{name} formatter" unless String === path
+        raise "You *must* specify --out FILE for the #{name} formatter" unless String == path.class
         raise "I can't write #{name} to a directory - it has to be a file" if File.directory?(path)
-        raise "I can't write #{name} to a file in the non-existing directory #{File.dirname(path)}" if !File.directory?(File.dirname(path))
+        raise "I can't write #{name} to a file in the non-existing directory #{File.dirname(path)}" unless File.directory?(File.dirname(path))
         ensure_io(path)
       end
 
       def ensure_dir(path, name)
-        raise "You *must* specify --out DIR for the #{name} formatter" unless String === path
+        raise "You *must* specify --out DIR for the #{name} formatter" unless String == path.class
         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)
         File.absolute_path path