closer 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b625623a1f35935806a9bb599580458493ae5e4548bc2bcd58b4a3c47df3a87f
-  data.tar.gz: '09d8fcb96c6119cdb1f3f4e68c373de923ec61d30325b2dab3fad93f002c5b66'
+  metadata.gz: c5c8127b7871c95d6b79f5be5a9034bdc0275f759b7e6a8111797cc836ac0d1a
+  data.tar.gz: af47e23f5c6c6e328c61b9fc914692d1e0d7837ac01ed425e5e22944090cc94d
 SHA512:
-  metadata.gz: d5088995d29993749ad54ff89cb70ff6ec292a13b8699d225dae6f2474cbac794856892db4a65e5b085dd0e450dc49e68d48ac2508ead691d0dc56220e8d2b6e
-  data.tar.gz: 8be384eae2da7cad8ebc3f6edcccf27d0b1f43781e2ffde36729265a6d56cc02ecc2e990c53d03ac8003d42abf099bc790fa29bdeea4d8f6dd9d95dbdf9119d0
+  metadata.gz: 1b0f79b3cb25a32c990d3c62d56cd058323f7f59071c013ef817ac0f4798392738ced226987916fcb7f9c2dae62229ef14a9bca2dd84923e7167422ab7450752
+  data.tar.gz: 83530d41db510502c5201018ebd9c369759d4c5410dda5e2c552e924df6a2820ba3f2a0fce77b803e4016d6bd13d60c29614f9e59bbcf9ff79e03c99eabe585e

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 0.13.0
+Release Date: 2024-11-10
+* add support for cucumber-4
+* drop support for cucumber-3
+
 # 0.11.0
 Release Date: 2023-09-01
 

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-

data/closer.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.7'
 
-  spec.add_runtime_dependency 'cucumber', '>= 3.0', '< 9.0'
-  spec.add_runtime_dependency 'capybara', '>= 3.0'
-  spec.add_runtime_dependency 'selenium-webdriver', '>= 4.8', '<= 5.0'
+  spec.add_dependency 'cucumber', '>= 4.0', '< 9.0'
+  spec.add_dependency 'capybara', '>= 3.0'
+  spec.add_dependency 'selenium-webdriver', '>= 4.8', '<= 5.0'
 
   spec.add_development_dependency 'minitest', '~> 5.10'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/closer/coverage/rcov_formatter.rb

@@ -3,11 +3,11 @@ require 'simplecov-rcov'
 module Closer
   module Coverage
     class RcovFormatter < SimpleCov::Formatter::RcovFormatter
-    
+
       private
-    
+
       def write_file(template, output_filename, binding)
-        rcov_result = template.result( binding ).force_encoding('UTF-8')
+        rcov_result = template.result(binding).force_encoding('UTF-8')
     
         File.open( output_filename, "w" ) do |file_result|
          file_result.write rcov_result

data/lib/closer/formatter/html.rb

@@ -1,620 +1,14 @@
-require 'erb'
-require 'cucumber/formatter/duration'
-require 'cucumber/formatter/io'
-require 'cucumber/core/report/summary'
-require 'cucumber/core/test/result'
-require 'pathname'
-require_relative 'html_builder'
-require_relative 'closer_html'
+require 'cucumber/formatter/html'
 
 module Closer
   module Formatter
-    class Html
-      include CloserHtml
+    class HTML < ::Cucumber::Formatter::HTML
 
-      # TODO: remove coupling to types
-      AST_CLASSES = {
-        Cucumber::Core::Ast::Scenario        => 'scenario',
-        Cucumber::Core::Ast::ScenarioOutline => 'scenario outline'
-      }
-
-      AST_DATA_TABLE = ::Cucumber::Formatter::LegacyApi::Ast::MultilineArg::DataTable
-
-      include ERB::Util # for the #h method
-      include ::Cucumber::Formatter::Duration
-      include ::Cucumber::Formatter::Io
-
-      attr_reader :builder
-      private :builder
-
-      def initialize(runtime, path_or_io, options)
-        @io = ensure_io(path_or_io)
-        @runtime = runtime
-        @options = options
-        @buffer = {}
-        @builder = HtmlBuilder.new(target: @io, indent: 0)
-        @feature_number = 0
-        @scenario_number = 0
-        @step_number = 0
-        @header_red = nil
-        @delayed_messages = []
-        @inside_outline        = false
-        @previous_step_keyword = nil
-        @summary = ::Cucumber::Core::Report::Summary.new(runtime.configuration.event_bus)
-      end
-
-      def before_features(features)
-        @step_count = features && features.step_count || 0 #TODO: Make this work with core!
-
-        builder.build_document!
-        builder.format_features! features
-      end
-
-      def after_features(features)
-        print_stats(features)
-        builder << '</div>'
-        builder << '</body>'
-        builder << '</html>'
-      end
-
-      def before_feature(_feature)
-        dir = feature_dir(_feature)
-        unless dir.empty?
-          if @feature_dir != dir
-            builder << '<div class="feature_dir"><span class="val" onclick="toggle_feature_dir(this);">'
-            builder << dir
-            builder << '</span></div>'
-          end
-
-          @feature_dir = dir
-        end
-
-        @feature = _feature
-        @exceptions = []
-        builder << "<div id=\"#{feature_id}\" class=\"feature\">"
-      end
-
-      def after_feature(_feature)
-        builder << '</div>'
-      end
-
-      def before_comment(_comment)
-        return if  magic_comment?(_comment)
-
-        builder << '<pre class="comment">'
-      end
-
-      def after_comment(_comment)
-        return if  magic_comment?(_comment)
-
-        builder << '</pre>'
-      end
-
-      def comment_line(comment_line)
-        return if  magic_comment?(comment_line)
-
-        builder.text!(comment_line)
-        builder.br
-      end
-
-      def after_tags(_tags)
-        @tag_spacer = nil
-      end
-
-      def tag_name(tag_name)
-        builder.text!(@tag_spacer) if @tag_spacer
-        @tag_spacer = ' '
-        builder.span(tag_name, :class => 'tag')
-      end
-
-      def feature_name(keyword, name)
-        title = feature_dir(@feature, true) + @feature.file.split('/').last.gsub(/\.feature/, '')
-        lines = name.split(/\r?\n/)
-        return if lines.empty?
-        builder.h2 do |h2|
-          builder.span(:class => 'val') do
-            builder << title
-          end
-        end
-
-        if lines.size > 1
-          builder.div(:class => 'narrative') do
-            builder << lines[1..-1].join("\n")
-          end
-        end
-      end
-
-      def before_test_case(_test_case)
-        @previous_step_keyword = nil
-      end
-
-      def before_background(_background)
-        @in_background = true
-        builder << '<div class="background">'
-      end
-
-      def after_background(_background)
-        @in_background = nil
-        builder << '</div>'
+      def output_envelope(envelope)
+        @html_formatter.write_message(envelope)
+        @html_formatter.write_post_message if envelope.test_run_finished
       end
 
-      def background_name(keyword, name, _file_colon_line, _source_indent)
-        @listing_background = true
-        builder.h3(:id => "background_#{@scenario_number}") do |h3|
-          builder.span(keyword, :class => 'keyword')
-          builder.text!(' ')
-          builder.span(name, :class => 'val')
-        end
-      end
-
-      def before_feature_element(feature_element)
-        @scenario_number+=1
-        @scenario_red = false
-        css_class = AST_CLASSES[feature_element.class]
-        builder << "<div class='#{css_class}'>"
-        @in_scenario_outline = feature_element.class == Cucumber::Core::Ast::ScenarioOutline
-      end
-
-      def after_feature_element(_feature_element)
-        unless @in_scenario_outline
-          print_messages
-          builder << '</ol>'
-        end
-        builder << '</div>'
-        @in_scenario_outline = nil
-      end
-
-      def scenario_name(keyword, name, file_colon_line, _source_indent)
-        builder.span(:class => 'scenario_file hidden') do
-          builder << file_colon_line
-        end
-        @listing_background = false
-        scenario_id = "scenario_#{@scenario_number}"
-        if @inside_outline
-          @outline_row += 1
-          scenario_id += "_#{@outline_row}"
-          @scenario_red = false
-        end
-
-        lines = name.split("\n")
-        title = lines.shift
-        builder.h3(:id => scenario_id) do
-          builder.span(title, :class => 'val pointer')
-        end
-
-        if lines.size > 0
-          builder.pre(:class => 'narrative hidden') do
-            trim_size = indent_size(lines.first)
-            builder << lines.map{|line| line[trim_size..-1] }.join("\n")
-          end
-        end
-      end
-
-      def before_outline_table(_outline_table)
-        @inside_outline = true
-        @outline_row = 0
-        builder << '<table>'
-      end
-
-      def after_outline_table(_outline_table)
-        builder << '</table>'
-        @outline_row = nil
-        @inside_outline = false
-      end
-
-      def before_examples(_examples)
-        builder << '<div class="examples">'
-      end
-
-      def after_examples(_examples)
-        builder << '</div>'
-      end
-
-      def examples_name(keyword, name)
-        builder.h4 do
-          builder.span(keyword, :class => 'keyword')
-          builder.text!(' ')
-          builder.span(name, :class => 'val')
-        end
-      end
-
-      def before_steps(_steps)
-        builder << '<ol class="hidden">'
-      end
-
-      def after_steps(_steps)
-        print_messages
-        builder << '</ol>' if @in_background || @in_scenario_outline
-      end
-
-      def before_step(step)
-        print_messages
-        @step_id = step.dom_id
-        @step_number += 1
-        @step = step
-      end
-
-      def after_step(_step)
-      end
-
-      def before_step_result(_keyword, step_match, _multiline_arg, status, exception, _source_indent, background, _file_colon_line)
-        @step_match = step_match
-        @hide_this_step = false
-        if exception
-          if @exceptions.include?(exception)
-            @hide_this_step = true
-            return
-          end
-          @exceptions << exception
-        end
-        if status != :failed && @in_background ^ background
-          @hide_this_step = true
-          return
-        end
-        @status = status
-        return if @hide_this_step
-        set_scenario_color(status)
-
-        if ! @delayed_messages.empty? and status == :passed
-          builder << "<li id='#{@step_id}' class='step #{status} expand'>"
-        else
-          builder << "<li id='#{@step_id}' class='step #{status}'>"
-        end
-      end
-
-      def after_step_result(keyword, step_match, _multiline_arg, status, _exception, _source_indent, _background, _file_colon_line)
-        return if @hide_this_step
-        # print snippet for undefined steps
-        unless outline_step?(@step)
-          keyword = @step.actual_keyword(@previous_step_keyword)
-          @previous_step_keyword = keyword
-        end
-        if status == :undefined
-          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)
-          end
-        end
-        builder << '</li>'
-
-        unless status == :undefined
-          step_file = step_match.file_colon_line
-          step_contents = "<div class=\"step_contents hidden\"><pre>"
-          step_file.gsub(/^([^:]*\.rb):(\d*)/) do
-            line_index = $2.to_i - 1
-
-            file = $1.force_encoding('UTF-8')
-            file = File.join(gem_dir, file) unless File.exist?(file)
-            File.readlines(file)[line_index..-1].each do |line|
-              step_contents << line
-              break if line.chop == 'end' or line.chop.start_with?('end ')
-            end
-          end
-          step_contents << "</pre></div>"
-          builder << step_contents
-        end
-
-        print_messages
-      end
-
-      def step_name(keyword, step_match, status, _source_indent, background, _file_colon_line)
-        background_in_scenario = background && !@listing_background
-        @skip_step = background_in_scenario
-
-        unless @skip_step
-          build_step(keyword, step_match, status)
-        end
-      end
-
-      def exception(exception, _status)
-        return if @hide_this_step
-        print_messages
-        build_exception_detail(exception)
-      end
-
-      def extra_failure_content(file_colon_line)
-        @snippet_extractor ||= SnippetExtractor.new
-        "<pre class=\"ruby\"><code>#{@snippet_extractor.snippet(file_colon_line)}</code></pre>"
-      end
-
-      def before_multiline_arg(multiline_arg)
-        return if @hide_this_step || @skip_step
-        if AST_DATA_TABLE === multiline_arg
-          builder << '<table>'
-        end
-      end
-
-      def after_multiline_arg(multiline_arg)
-        return if @hide_this_step || @skip_step
-        if AST_DATA_TABLE === multiline_arg
-          builder << '</table>'
-        end
-      end
-
-      def doc_string(string)
-        return if @hide_this_step
-        builder.pre(:class => 'val') do |pre|
-          builder << h(string).gsub("\n", '&#x000A;')
-        end
-      end
-
-      def before_table_row(table_row)
-        @row_id = table_row.dom_id
-        @col_index = 0
-        return if @hide_this_step
-        builder << "<tr class='step' id='#{@row_id}'>"
-      end
-
-      def after_table_row(table_row)
-        return if @hide_this_step
-        print_table_row_messages
-        builder << '</tr>'
-        if table_row.exception
-          builder.tr do
-            builder.td(:colspan => @col_index.to_s, :class => 'failed') do
-              builder.pre do |pre|
-                pre << h(format_exception(table_row.exception))
-              end
-            end
-          end
-          if table_row.exception.is_a? ::Cucumber::Pending
-            set_scenario_color_pending
-          else
-            set_scenario_color_failed
-          end
-        end
-        if @outline_row
-          @outline_row += 1
-        end
-        @step_number += 1
-      end
-
-      def table_cell_value(value, status)
-        return if @hide_this_step
-
-        @cell_type = @outline_row == 0 ? :th : :td
-        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
-        @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 => 'message hidden') do
-              builder << ann
-            end
-          end
-        #end
-        empty_messages
-      end
-
-      def print_table_row_messages
-        return if @delayed_messages.empty?
-
-        builder.td(:class => 'message') do
-          builder << @delayed_messages.join(', ')
-        end
-        empty_messages
-      end
-
-      def empty_messages
-        @delayed_messages = []
-      end
-
-      def after_test_case(_test_case, result)
-        if result.failed? && !@scenario_red
-          set_scenario_color_failed
-        end
-      end
-
-      protected
-
-      def build_exception_detail(exception)
-        backtrace = Array.new
-
-        builder.div(:class => 'message') do
-          message = exception.message
-
-          if defined?(RAILS_ROOT) && message.include?('Exception caught')
-            matches = message.match(/Showing <i>(.+)<\/i>(?:.+) #(\d+)/)
-            backtrace += ["#{RAILS_ROOT}/#{matches[1]}:#{matches[2]}"] if matches
-            matches = message.match(/<code>([^(\/)]+)<\//m)
-            message = matches ? matches[1] : ''
-          end
-
-          unless exception.instance_of?(RuntimeError)
-            message = "#{message} (#{exception.class})"
-          end
-
-          builder.pre do
-            builder.text!(message)
-          end
-        end
-
-        builder.div(:class => 'backtrace') do
-          builder.pre do
-            backtrace = exception.backtrace
-            backtrace.delete_if { |x| x =~ /\/gems\/(cucumber|rspec)/ }
-            builder << backtrace_line(backtrace.join("\n"))
-          end
-        end
-
-        extra = extra_failure_content(backtrace)
-        builder << extra unless extra == ''
-      end
-
-      def set_scenario_color(status)
-        if status.nil? || status == :undefined || status == :pending
-          set_scenario_color_pending
-        end
-        if status == :failed
-          set_scenario_color_failed
-        end
-      end
-
-      def set_scenario_color_failed
-        builder.script do
-          builder.text!("makeRed('cucumber-header');") unless @header_red
-          @header_red = true
-          scenario_or_background = @in_background ? 'background' : 'scenario'
-          builder.text!("makeRed('#{scenario_or_background}_#{@scenario_number}');") unless @scenario_red
-          @scenario_red = true
-          if @options[:expand] && @inside_outline
-            builder.text!("makeRed('#{scenario_or_background}_#{@scenario_number}_#{@outline_row}');")
-          end
-        end
-      end
-
-      def set_scenario_color_pending
-        builder.script do
-          builder.text!("makeYellow('cucumber-header');") unless @header_red
-          scenario_or_background = @in_background ? 'background' : 'scenario'
-          builder.text!("makeYellow('#{scenario_or_background}_#{@scenario_number}');") unless @scenario_red
-        end
-      end
-
-      def build_step(keyword, step_match, _status)
-        keyword = display_keyword(keyword)
-        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|
-            name << h(step_name).gsub(/&lt;span class=&quot;(.*?)&quot;&gt;/, '<span class="\1">').gsub(/&lt;\/span&gt;/, '</span>')
-          end
-        end
-
-        step_file = step_match.file_colon_line
-        step_file.gsub(/^([^:]*\.rb):(\d*)/) do
-          step_file = "<span class=\"pointer\" onclick=\"toggle_step_file(this); return false;\">#{step_file}</span>"
-
-          builder.div(:class => 'step_file') do |div|
-            builder.span do
-              builder << step_file
-            end
-          end
-        end
-      end
-
-      def build_cell(cell_type, value, attributes)
-        builder.__send__(cell_type, attributes) do
-          builder.div do
-            builder.span(value,:class => 'step param')
-          end
-        end
-      end
-
-      def format_exception(exception)
-        ([exception.message.to_s] + exception.backtrace).join("\n")
-      end
-
-      def backtrace_line(line)
-        line.gsub(/^([^:]*\.(?:rb|feature|haml)):(\d*).*$/) do
-          line
-        end
-      end
-
-      def print_stats(features)
-        builder <<  "<script>document.getElementById('duration').innerHTML = \"Finished in <strong>#{format_duration(features.duration)} seconds</strong>\";</script>"
-        builder <<  "<script>document.getElementById('totals').innerHTML = \"#{print_stat_string(features)}\";</script>"
-      end
-
-      def print_stat_string(_features)
-        string = String.new
-        string << dump_count(@summary.test_cases.total, 'scenario')
-        scenario_count = status_counts(@summary.test_cases)
-        string << scenario_count if scenario_count
-        string << '<br />'
-        string << dump_count(@summary.test_steps.total, 'step')
-        step_count = status_counts(@summary.test_steps)
-        string << step_count if step_count
-      end
-
-      def status_counts(summary)
-        counts = ::Cucumber::Core::Test::Result::TYPES.map { |status|
-          count = summary.total(status)
-          [status, count]
-        }.select { |status, count|
-          count > 0
-        }.map { |status, count|
-          "#{count} #{status}"
-        }
-        "(#{counts.join(", ")})" if counts.any?
-      end
-
-      def dump_count(count, what, state=nil)
-        [count, state, "#{what}#{count == 1 ? '' : 's'}"].compact.join(' ')
-      end
-
-      def outline_step?(_step)
-        not @step.step.respond_to?(:actual_keyword)
-      end
-
-      class SnippetExtractor #:nodoc:
-        class NullConverter; def convert(code, _pre); code; end; end #:nodoc:
-
-        begin
-          require 'syntax/convertors/html'
-          @@converter = Syntax::Convertors::HTML.for_syntax 'ruby'
-        rescue LoadError
-          @@converter = NullConverter.new
-        end
-
-        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)
-          post_process(highlighted, line)
-        end
-
-        def snippet_for(error_line)
-          if error_line =~ /(.*):(\d+)/
-            file = $1
-            line = $2.to_i
-            [lines_around(file, line), line]
-          else
-            ["# Couldn't get snippet for #{error_line}", 1]
-          end
-        end
-
-        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
-            selected_lines = []
-            selected_lines.join("\n")
-            lines[min..max].join("\n")
-          else
-            "# Couldn't get snippet for #{file}"
-          end
-        end
-
-        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=\"offending\">#{new_line}</span>" if i == 2
-            new_lines << new_line
-          end
-          new_lines.join("\n")
-        end
-
-      end
     end
   end
 end

data/lib/closer/helpers/capture.rb

@@ -39,7 +39,7 @@ module Closer
         image_tag = "<img #{attrs.map{|k, v| "#{k}=\"#{v}\"" }.join(' ')} />"
 
         if options[:flash]
-          puts image_tag
+          log(image_tag)
         else
           @@_images << image_tag
         end
@@ -68,7 +68,7 @@ module Closer
 
       def flash_image_tags
         if @@_images.size > 0
-          puts @@_images.join("\n")
+          log(@@_images.join("\n"))
           @@_images.clear
         end
       end