cucumber-html-formatter 21.0.0 → 21.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: decd0a43a471f3a0d27bdedee6d3ddc50c70099198d6541075f5bf6a8c27b9bb
-  data.tar.gz: 4e409d7c9791f0c10f5b6357f008397a34d60f08490742b05ffca40776f4459e
+  metadata.gz: 2f34cc3f6521d85b2da0bef2ced3a3b77f382caac0cac9467f6fad96a1b68e09
+  data.tar.gz: fc71dc0cea23cc00873d5ad2ab13ec1e7e26bc4c317adef092b1b2843839c216
 SHA512:
-  metadata.gz: a348d49353a0b57966f211699e303412207b5c15e9ebf11d3fc91b7f928cec164efbda14ca34f3544e19fc3e36b7393bb8fd07a80e3b44703cac218e323c3762
-  data.tar.gz: 73821befdd2aa99ac9ad7bc0797766e49bd652319e708eb25ccb1b1696fc2c9ad795a9500a265e5962522bb8918f37929a28eddb4357f7677e559b4ee3660a14
+  metadata.gz: 9853ab9218ac5417c6dd5e32011914d66ce2d1d787a90c58ec3001339771e26b26087b3bccdcb8b7c6e817f761385b1439063148fd5b3631e64b583bc24d6db8
+  data.tar.gz: a572697d7893c6859132cdc62d5a3591dd2618a04038fd2f235055abcc63c4f353b47b8a1998397492d113f2cb444799013d4ca90265af5b5b9e4bc8d734c59b

data/bin/cucumber-html-formatter

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optparse'
 require 'cucumber/messages'
@@ -7,7 +8,7 @@ require 'cucumber/html_formatter'
 formatter = Cucumber::HTMLFormatter::Formatter.new(STDOUT)
 
 option_parser = OptionParser.new do |opts|
-  opts.on_tail("-h", "--help", "Show this message") do
+  opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit
   end

data/lib/cucumber/html_formatter/assets_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module HTMLFormatter
     class AssetsLoader
@@ -28,7 +30,6 @@ module Cucumber
       rescue
         '.'
       end
-
     end
   end
 end

data/lib/cucumber/html_formatter/formatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'cucumber/messages'
+require 'cucumber/html_formatter/template_writer'
+require 'cucumber/html_formatter/assets_loader'
+
+module Cucumber
+  module HTMLFormatter
+    class Formatter
+      attr_reader :out
+
+      def initialize(out)
+        @out = out
+        @pre_message_written = false
+        @first_message = true
+      end
+
+      def process_messages(messages)
+        write_pre_message
+        messages.each { |message| write_message(message) }
+        write_post_message
+      end
+
+      def write_message(message)
+        unless @first_message
+          out.puts(',')
+        end
+        out.print(message.to_json)
+
+        @first_message = false
+      end
+
+      def write_pre_message
+        return if @pre_message_written
+
+        out.puts(pre_message)
+        @pre_message_written = true
+      end
+
+      def write_post_message
+        out.print(post_message)
+      end
+
+      private
+
+      def assets_loader
+        @assets_loader ||= AssetsLoader.new
+      end
+
+      def pre_message
+        [
+          template_writer.write_between(nil, '{{css}}'),
+          assets_loader.css,
+          template_writer.write_between('{{css}}', '{{messages}}')
+        ].join("\n")
+      end
+
+      def post_message
+        [
+          template_writer.write_between('{{messages}}', '{{script}}'),
+          assets_loader.script,
+          template_writer.write_between('{{script}}', nil)
+        ].join("\n")
+      end
+
+      def template_writer
+        @template_writer ||= TemplateWriter.new(assets_loader.template)
+      end
+    end
+  end
+end

data/lib/cucumber/html_formatter/template_writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module HTMLFormatter
     class TemplateWriter
@@ -11,9 +13,7 @@ module Cucumber
         from_exists = !from.nil? && template.include?(from)
 
         after_from = from_exists ? template.split(from)[1] : template
-        before_to = to.nil? ? after_from : after_from.split(to)[0]
-
-        return before_to
+        to.nil? ? after_from : after_from.split(to)[0]
       end
     end
   end

data/lib/cucumber/html_formatter.rb

@@ -1,69 +1,6 @@
+# frozen_string_literal: true
+
 require 'cucumber/messages'
-require 'cucumber/html_formatter/template_writer'
 require 'cucumber/html_formatter/assets_loader'
-
-module Cucumber
-  module HTMLFormatter
-    class Formatter
-      attr_reader :out
-
-      def initialize(out)
-        @out = out
-        @pre_message_written = false
-        @first_message = true
-      end
-
-      def process_messages(messages)
-        write_pre_message
-        messages.each { |message| write_message(message) }
-        write_post_message
-      end
-
-      def write_pre_message
-        return if @pre_message_written
-
-        out.puts(pre_message)
-        @pre_message_written = true
-      end
-
-      def write_message(message)
-        unless @first_message
-          out.puts(',')
-        end
-        out.print(message.to_json)
-
-        @first_message = false
-      end
-
-      def write_post_message
-        out.print(post_message)
-      end
-
-      private
-
-      def assets_loader
-        @assets_loader ||= AssetsLoader.new
-      end
-
-      def pre_message
-        [
-          template_writer.write_between(nil, '{{css}}'),
-          assets_loader.css,
-          template_writer.write_between('{{css}}', '{{messages}}')
-        ].join("\n")
-      end
-
-      def post_message
-        [
-          template_writer.write_between('{{messages}}', '{{script}}'),
-          assets_loader.script,
-          template_writer.write_between('{{script}}', nil)
-        ].join("\n")
-      end
-
-      def template_writer
-        @template_writer ||= TemplateWriter.new(assets_loader.template)
-      end
-    end
-  end
-end
+require 'cucumber/html_formatter/formatter'
+require 'cucumber/html_formatter/template_writer'

data/spec/acceptance_spec.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'cucumber-compatibility-kit'
-require 'cucumber/html_formatter'
 
 describe Cucumber::HTMLFormatter.name do
 

data/spec/html_formatter/assets_loader_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+describe Cucumber::HTMLFormatter::AssetsLoader do
+  subject(:assets_loader) { described_class.new }
+
+  before do
+    allow(File).to receive(:read).and_return('whatever content')
+  end
+
+  describe '#template' do
+    it 'reads the content of assets/index.mustache.html' do
+      expect(File).to receive(:read).with(/.*\/assets\/index\.mustache\.html$/)
+
+      assets_loader.template
+    end
+  end
+
+  describe '#css' do
+    it 'reads the content of assets/main.css' do
+      expect(File).to receive(:read).with(/.*\/assets\/main\.css$/)
+
+      assets_loader.css
+    end
+  end
+
+  describe '#script' do
+    it 'reads the content of assets/main.js' do
+      expect(File).to receive(:read).with(/.*\/assets\/main\.js$/)
+
+      assets_loader.script
+    end
+  end
+end

data/spec/html_formatter/formatter_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'cucumber/messages'
+
+describe Cucumber::HTMLFormatter::Formatter do
+  subject(:formatter) do
+    formatter = Cucumber::HTMLFormatter::Formatter.new(out)
+    allow(formatter).to receive(:assets_loader).and_return(assets)
+    formatter
+  end
+
+  let(:out) { StringIO.new }
+  let(:fake_assets) do
+    Class.new do
+      def template
+        '<html>{{css}}<body>{{messages}}</body>{{script}}</html>'
+      end
+
+      def css
+        '<style>div { color: red }</style>'
+      end
+
+      def script
+        "<script>alert('Hi')</script>"
+      end
+    end
+  end
+  let(:assets) { fake_assets.new }
+
+  describe '#process_messages' do
+    let(:message) { Cucumber::Messages::Envelope.new(pickle: Cucumber::Messages::Pickle.new(id: 'some-random-uid')) }
+
+    it 'produces the full html report' do
+      formatter.process_messages([message])
+      expect(out.string).to eq(
+        [
+          '<html>',
+          '<style>div { color: red }</style>',
+          '<body>',
+          "#{message.to_json}</body>",
+          "<script>alert('Hi')</script>",
+          '</html>'
+        ].join("\n")
+      )
+    end
+  end
+
+  describe '#write_pre_message' do
+    it 'outputs the content of the template up to {{messages}}' do
+      formatter.write_pre_message
+
+      expect(out.string).to eq("<html>\n<style>div { color: red }</style>\n<body>\n")
+    end
+
+    it 'does not write the content twice' do
+      formatter.write_pre_message
+      formatter.write_pre_message
+
+      expect(out.string).to eq("<html>\n<style>div { color: red }</style>\n<body>\n")
+    end
+  end
+
+  describe '#write_message' do
+    let(:message) { Cucumber::Messages::Envelope.new(pickle: Cucumber::Messages::Pickle.new(id: 'some-random-uid')) }
+
+    it 'appends the message to out' do
+      formatter.write_message(message)
+
+      expect(out.string).to eq(message.to_json)
+    end
+
+    it 'adds commas between the messages' do
+      formatter.write_message(message)
+      formatter.write_message(message)
+
+      expect(out.string).to eq("#{message.to_json},\n#{message.to_json}")
+    end
+  end
+
+  describe '#write_post_message' do
+    it 'outputs the template end' do
+      formatter.write_post_message
+
+      expect(out.string).to eq("</body>\n<script>alert('Hi')</script>\n</html>")
+    end
+  end
+end

data/spec/html_formatter/template_writer_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+describe Cucumber::HTMLFormatter::TemplateWriter do
+  describe '#write_between' do
+    subject(:template_writer) { described_class.new(template) }
+
+    let(:template) { 'Some template {{here}} with content after' }
+
+    it 'outputs content of the template between the given words' do
+      expect(template_writer.write_between('Some', 'content')).to eq(' template {{here}} with ')
+    end
+
+    context 'when the `from` argument is `nil`' do
+      it 'outputs template from the beginning' do
+        expect(template_writer.write_between(nil, '{{here}}')).to eq('Some template ')
+      end
+    end
+
+    context 'when the `to` argument is `nil`' do
+      it 'outputs content of template after the "from" argument value' do
+        expect(template_writer.write_between('{{here}}', nil)).to eq(' with content after')
+      end
+    end
+
+    context 'when the `from` argument is not contained in the template' do
+      it 'renders the template from the beginning' do
+        expect(template_writer.write_between('Unknown start', '{{here}}')).to eq('Some template ')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'cucumber/html_formatter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-html-formatter
 version: !ruby/object:Gem::Version
-  version: 21.0.0
+  version: 21.1.0
 platform: ruby
 authors:
 - Vincent Prêtre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-messages
@@ -19,7 +19,7 @@ dependencies:
         version: '19'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '24'
+        version: '25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '19'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '24'
+        version: '25'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,12 +115,13 @@ files:
 - bin/cucumber-html-formatter
 - lib/cucumber/html_formatter.rb
 - lib/cucumber/html_formatter/assets_loader.rb
+- lib/cucumber/html_formatter/formatter.rb
 - lib/cucumber/html_formatter/template_writer.rb
 - spec/acceptance_spec.rb
-- spec/capture_warnings.rb
-- spec/html-formatter/assets_loader_spec.rb
-- spec/html-formatter/template_writer_spec.rb
-- spec/html_formatter_spec.rb
+- spec/html_formatter/assets_loader_spec.rb
+- spec/html_formatter/formatter_spec.rb
+- spec/html_formatter/template_writer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/cucumber/html-formatter
 licenses:
 - MIT
@@ -150,10 +151,10 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: cucumber-html-formatter-21.0.0
+summary: cucumber-html-formatter-21.1.0
 test_files:
 - spec/acceptance_spec.rb
-- spec/capture_warnings.rb
-- spec/html-formatter/assets_loader_spec.rb
-- spec/html-formatter/template_writer_spec.rb
-- spec/html_formatter_spec.rb
+- spec/html_formatter/assets_loader_spec.rb
+- spec/html_formatter/formatter_spec.rb
+- spec/html_formatter/template_writer_spec.rb
+- spec/spec_helper.rb

data/spec/capture_warnings.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-# With thanks to @myronmarston
-# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
-
-module CaptureWarnings
-  def report_warnings(&block)
-    current_dir = Dir.pwd
-    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
-    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }
-
-    if errors.any?
-      puts errors.join("\n")
-    end
-
-    if other_warnings.any?
-      puts "#{ other_warnings.count } warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
-      print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
-    end
-
-    # Until they fix https://bugs.ruby-lang.org/issues/10661
-    if RUBY_VERSION == "2.2.0"
-      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
-    end
-
-    if project_warnings.any?
-      puts "#{ project_warnings.count } warnings detected"
-      print_warnings('cucumber-expressions', project_warnings)
-      fail "Please remove all cucumber-expressions warnings."
-    end
-
-    ensure_system_exit_if_required
-  end
-
-  def capture_error(&block)
-    old_stderr = STDERR.clone
-    pipe_r, pipe_w = IO.pipe
-    pipe_r.sync    = true
-    error          = String.new
-    reader = Thread.new do
-      begin
-        loop do
-          error << pipe_r.readpartial(1024)
-        end
-      rescue EOFError
-      end
-    end
-    STDERR.reopen(pipe_w)
-    block.call
-  ensure
-    capture_system_exit
-    STDERR.reopen(old_stderr)
-    pipe_w.close
-    reader.join
-    return error.split("\n")
-  end
-
-  def print_warnings(type, warnings)
-    puts
-    puts "-" * 30 + " #{type} warnings: " + "-" * 30
-    puts
-    puts warnings.join("\n")
-    puts
-    puts "-" * 75
-    puts
-  end
-
-  def ensure_system_exit_if_required
-    raise @system_exit if @system_exit
-  end
-
-  def capture_system_exit
-    @system_exit = $!
-  end
-end

data/spec/html-formatter/assets_loader_spec.rb

@@ -1,30 +0,0 @@
-require 'cucumber/html_formatter/assets_loader'
-
-describe Cucumber::HTMLFormatter::AssetsLoader do
-  let(:subject) { Cucumber::HTMLFormatter::AssetsLoader.new }
-
-  before do
-    allow(File).to receive(:read).and_return('whatever content')
-  end
-
-  context '.template' do
-    it 'reads the content of assets/index.mustache.html' do
-      expect(subject.template).to eq('whatever content')
-      expect(File).to have_received(:read).with(/.*\/assets\/index\.mustache\.html$/)
-    end
-  end
-
-  context '.css' do
-    it 'reads the content of assets/main.css' do
-      expect(subject.css).to eq('whatever content')
-      expect(File).to have_received(:read).with(/.*\/assets\/main\.css$/)
-    end
-  end
-
-  context '.script' do
-    it 'reads the content of assets/main.js' do
-      expect(subject.script).to eq('whatever content')
-      expect(File).to have_received(:read).with(/.*\/assets\/main\.js$/)
-    end
-  end
-end

data/spec/html-formatter/template_writer_spec.rb

@@ -1,30 +0,0 @@
-require 'cucumber/html_formatter/template_writer'
-
-describe Cucumber::HTMLFormatter::TemplateWriter do
-  context 'write_between' do
-    let(:subject) { writer = Cucumber::HTMLFormatter::TemplateWriter.new(template) }
-    let(:template) { 'Some template {{here}} with content after' }
-
-    it 'outputs content of the template between the given words' do
-      expect(subject.write_between('Some', 'content')).to eq(' template {{here}} with ')
-    end
-
-    context 'when "from" argument is nil' do
-      it 'outputs template from the beginning' do
-        expect(subject.write_between(nil, '{{here}}')).to eq('Some template ')
-      end
-    end
-
-    context 'when "to" argument is nil' do
-      it 'outputs content of template after the "from" argument value' do
-        expect(subject.write_between('{{here}}', nil)).to eq(' with content after')
-      end
-    end
-
-    context 'when "from" argument is missing from the template' do
-      it 'renders the template from the beginning' do
-        expect(subject.write_between('Unknown start', '{{here}}')).to eq('Some template ')
-      end
-    end
-  end
-end

data/spec/html_formatter_spec.rb

@@ -1,87 +0,0 @@
-require 'cucumber/messages'
-require 'cucumber/html_formatter'
-
-class FakeAssets
-  def template
-    "<html>{{css}}<body>{{messages}}</body>{{script}}</html>"
-  end
-
-  def css
-    "<style>div { color: red }</style>"
-  end
-
-  def script
-    "<script>alert('Hi')</script>"
-  end
-end
-
-describe Cucumber::HTMLFormatter::Formatter do
-  let(:subject) {
-    formatter = Cucumber::HTMLFormatter::Formatter.new(out)
-    allow(formatter).to receive(:assets_loader).and_return(assets)
-    formatter
-  }
-  let(:out) { StringIO.new }
-  let(:assets) { FakeAssets.new }
-
-  context '.write_pre_message' do
-    it 'outputs the content of the template up to {{messages}}' do
-      subject.write_pre_message()
-      expect(out.string).to eq("<html>\n<style>div { color: red }</style>\n<body>\n")
-    end
-
-    it 'does not write the content twice' do
-      subject.write_pre_message()
-      subject.write_pre_message()
-
-      expect(out.string).to eq("<html>\n<style>div { color: red }</style>\n<body>\n")
-    end
-  end
-
-  context '.write_message' do
-    let(:message) do
-      ::Cucumber::Messages::Envelope.new(
-        pickle: ::Cucumber::Messages::Pickle.new(id: 'some-random-uid')
-      )
-    end
-
-    it 'appends the message to out' do
-      subject.write_message(message)
-      expect(out.string).to eq(message.to_json)
-    end
-
-    it 'adds commas between the messages' do
-      subject.write_message(message)
-      subject.write_message(message)
-
-      expect(out.string).to eq("#{message.to_json},\n#{message.to_json}")
-    end
-  end
-
-  context '.write_post_message' do
-    it 'outputs the template end' do
-      subject.write_post_message()
-      expect(out.string).to eq("</body>\n<script>alert('Hi')</script>\n</html>")
-    end
-  end
-
-  context '.process_messages' do
-    let(:message) do
-      ::Cucumber::Messages::Envelope.new(
-        pickle: ::Cucumber::Messages::Pickle.new(id: 'some-random-uid')
-      )
-    end
-
-    it 'produces the full html report' do
-      subject.process_messages([message])
-      expect(out.string).to eq([
-        '<html>',
-        '<style>div { color: red }</style>',
-        '<body>',
-        "#{message.to_json}</body>",
-        "<script>alert('Hi')</script>",
-        '</html>'
-      ].join("\n"))
-    end
-  end
-end