jekyll-logger-tap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e72991f7e1e96c3e072ef9628035b6965e6d42770e186a817a8e89ff011745c
-  data.tar.gz: ae1014594b9ea6b14d5baa8d4e0731b9031246d344441add49f2381669d5dbf2
+  metadata.gz: dabd346de26f90f60ea7429e2eb4c53837684c61eff99acd4f835a155b334265
+  data.tar.gz: 6ddb6f4c0af62a0e2951139d05903885806738139a2e130d138b8b8b45ff1ec8
 SHA512:
-  metadata.gz: 03d38bccab4e6ac090f8b33ead7d1a05cfe723719feccae2cb94e277b82b929156c43e679c9e657c586612da5e7cbc7996b0c013c8386e5d0a3338f8ac2f4deb
-  data.tar.gz: 279ee232090e7013df2070e00227dca6d1cfbbe5c61e7e6831a533181f09188341809cd56a0a8a98e101110144f5b53dbea8b81bce99a4fcdb13f56c272a5631
+  metadata.gz: ce49f25cebdcefd82619a8aeb0cdd733b83ad4350f92f889cb54e5238cd95de477ca47257ea630b94a27bc22d71d974c1737082208802c15c71486f6fd953cc2
+  data.tar.gz: 7b534424d49e17ef4711c9764d73a748975759c4e43c89a5d0f722ac8040a2d89106e480b82a31e46569fe104055f204b19af7290b3c32ffbe8ff6281c82e668

data/CHANGELOG.md

@@ -5,7 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## v0.1.0 - 2023-10-02
+## [0.2.0] - 2023-10-02
+
+### Changed
+
+- Color is removed when the output is piped
+- Add TAP version header
+- Print test plan at the end
+
+## [0.1.0] - 2023-10-02
 
 ### Added
 

data/lib/jekyll/log_adapters/tap.rb

@@ -10,15 +10,30 @@ module Jekyll
       class Logger < Jekyll::Stevenson
         # TAP doesn't have that many levels, so we differentiate errors
         # from warnings by color and prefix.
+        #
+        # @see Logger::Severity
         SEVERITY_FORMAT = {
           'DEBUG' => '#',
-          'INFO'  => 'ok -'.green,
-          'WARN'  => 'not ok - Warning:'.yellow,
-          'ERROR' => 'not ok - Error:'.red,
-          'FATAL' => 'Bail out!'.red,
+          'INFO'  => 'ok -',
+          'WARN'  => 'not ok - Warning:',
+          'ERROR' => 'not ok - Error:',
+          'FATAL' => 'Bail out!',
           'ANY'   => ''
         }
 
+        SEVERITY_COLOR = {
+          'DEBUG' => [],
+          'INFO'  => %i[green],
+          'WARN'  => %i[yellow],
+          'ERROR' => %i[red],
+          'FATAL' => %i[red bold],
+          'ANY'   => []
+        }
+
+        COUNT_TESTS = (1..3)
+
+        attr_reader :test_counter
+
         # Replace the formatter with a proc
         #
         # Multi-line messages are assumed to be debug level, like the
@@ -26,6 +41,11 @@ module Jekyll
         def initialize
           super
 
+          logdevice(1).puts('TAP version 14')
+
+          # Initialize counter
+          @test_counter = 0
+          # At this point, severity is an Integer
           @formatter = proc do |severity, _, _, msg|
             msg = msg.to_s.strip_ansi.strip
 
@@ -33,13 +53,52 @@ module Jekyll
 
             if msg.lines.size > 1
               msg.lines.map do |line|
-                "#{SEVERITY_FORMAT['DEBUG']} #{line}"
+                "#{tap_format(0)} #{line}"
               end.join
             else
-              "#{SEVERITY_FORMAT[severity]} #{msg}"
+              "#{tap_format(severity)} #{msg}"
             end
           end
         end
+
+        def close
+          logdevice(0).puts("1..#{@test_counter}")
+        end
+
+        private
+
+        # Don't convert severity level to string
+        #
+        # @see Logger#format_severity
+        # @return [Integer]
+        def format_severity(severity)
+          severity
+        end
+
+        # Test if logdevice is a TTY
+        #
+        # @param :severity [Integer]
+        def tty?(severity)
+          !!logdevice(severity)&.isatty
+        end
+
+        # At this point, severity is an Integer.  Skips colorizing if it
+        # detects we're piping output.
+        #
+        # @param :severity [Integer]
+        # @return [String]
+        def tap_format(severity)
+          @test_counter += 1 if COUNT_TESTS.include? severity
+          tap_formatted = SEVERITY_FORMAT.values[severity]
+
+          return tap_formatted unless tty?(severity)
+
+          colors = SEVERITY_COLOR.values[severity]
+
+          colors.reduce(tap_formatted) do |aggregated, color|
+            aggregated.public_send(color)
+          end
+        end
       end
     end
   end

data/lib/jekyll-logger-tap.rb

@@ -3,3 +3,13 @@
 require_relative 'jekyll/log_adapters/tap'
 
 Jekyll.logger = Jekyll::LogAdapters::Tap::Logger.new
+
+module JekyllCommandDecorator
+  def process_with_graceful_fail(cmd, options, *klass)
+    super
+  ensure
+    Jekyll.logger.instance_variable_get(:@writer).close
+  end
+end
+
+Jekyll::Command.singleton_class.prepend JekyllCommandDecorator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-logger-tap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - f