nanoc-cli 4.13.3 → 4.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcada517e4874119a77e3432f9a32636b5b09084120add17d54ee874e97589af
-  data.tar.gz: f90bb2d03348db9ca9d1c006e19d30fbd4ba203eb41950e6a072f6a845c5172a
+  metadata.gz: f3bd4dd2ef4c00e4777abda52b2488a9911d3236cf24fe203db2f16d16f4380e
+  data.tar.gz: fc20f13d539d506b2127574346a9e476d957ade555614c2e2624035b78ab41cd
 SHA512:
-  metadata.gz: 60d48ca209a3afccbd0abf09790f7b0f05cff1a6736b81f20d3e2f8daafe6bdd4d164e8806673c169512142b9a426d23fbad739e365abba6e43d941822e738f7
-  data.tar.gz: 817636b142ed16c92cefb98abf31344efb5a3821cb1a78e0bd92389f9d2f0e97331aab5990ed99ecc9e0968efca86bbe56111a4db3ab6d26e094a3afc53d9f55
+  metadata.gz: d1da4beb366ff2e6ff05c6e5a145ed24f6316cc63a4fd179086c07aaf1be1d45d340fb246187c4d3f2e99ff69540d5a5be741c51a052c0fbe2ce834253139554
+  data.tar.gz: affb0d75ba7112bf3d4e5291289dcb59676bdb223365e8f34b7a477d671e9606e8ce6c8cc0921148f5db2e688973f532a95a594fda0b140a14517e3832afaa41

data/lib/nanoc/cli/ansi_string_colorizer.rb

@@ -6,24 +6,44 @@ module Nanoc
     # attributes, it returns a colorized string.
     #
     # @api private
-    module ANSIStringColorizer
-      # TODO: complete mapping
+    class ANSIStringColorizer
+      CLEAR = "\e[0m"
+
       MAPPING = {
         bold: "\e[1m",
+
+        black: "\e[30m",
         red: "\e[31m",
         green: "\e[32m",
         yellow: "\e[33m",
         blue: "\e[34m",
+        magenta: "\e[35m",
+        cyan: "\e[36m",
+        white: "\e[37m",
       }.freeze
 
+      def initialize(io)
+        @io = io
+      end
+
+      def enabled?
+        return @_enabled if defined?(@_enabled)
+
+        @_enabled = Nanoc::CLI.enable_ansi_colors?(@io)
+      end
+
       # @param [String] str The string to colorize
       #
       # @param [Array] attrs An array of attributes from `MAPPING` to colorize the
       #   string with
       #
       # @return [String] A string colorized using the given attributes
-      def self.c(str, *attrs)
-        attrs.map { |a| MAPPING[a] }.join('') + str + "\e[0m"
+      def c(str, *attrs)
+        if enabled?
+          attrs.map { |a| MAPPING[a] }.join('') + str + CLEAR
+        else
+          str
+        end
       end
     end
   end

data/lib/nanoc/cli/cleaning_stream.rb

@@ -5,6 +5,23 @@ module Nanoc
     # An output stream that passes output through stream cleaners. This can be
     # used to strip ANSI color sequences, for instance.
     class CleaningStream
+      extend Forwardable
+
+      def_delegator :@stream, :close
+      def_delegator :@stream, :closed?
+      def_delegator :@stream, :exist?
+      def_delegator :@stream, :exists?
+      def_delegator :@stream, :external_encoding
+      def_delegator :@stream, :printf
+      def_delegator :@stream, :reopen
+      def_delegator :@stream, :set_encoding
+      def_delegator :@stream, :string
+      def_delegator :@stream, :sync
+      def_delegator :@stream, :sync=
+      def_delegator :@stream, :tell
+      def_delegator :@stream, :winsize
+      def_delegator :@stream, :winsize=
+
       # @param [IO, StringIO] stream The stream to wrap
       def initialize(stream)
         @stream = stream
@@ -69,11 +86,6 @@ module Nanoc
         end
       end
 
-      # @see IO#tell
-      def tell
-        @stream.tell
-      end
-
       # @see IO#print
       def print(str)
         _nanoc_swallow_broken_pipe_errors_while do
@@ -81,11 +93,6 @@ module Nanoc
         end
       end
 
-      # @see IO#printf
-      def printf(*args)
-        @stream.printf(*args)
-      end
-
       # @see IO#puts
       def puts(*str)
         _nanoc_swallow_broken_pipe_errors_while do
@@ -93,66 +100,6 @@ module Nanoc
         end
       end
 
-      # @see StringIO#string
-      def string
-        @stream.string
-      end
-
-      # @see IO#reopen
-      def reopen(*args)
-        @stream.reopen(*args)
-      end
-
-      # @see IO#close
-      def close
-        @stream.close
-      end
-
-      # @see IO#closed?
-      def closed?
-        @stream.closed?
-      end
-
-      # @see File#exist?
-      def exist?
-        @stream.exist?
-      end
-
-      # @see File.exists?
-      def exists?
-        @stream.exists?
-      end
-
-      # @see IO.winsize
-      def winsize
-        @stream.winsize
-      end
-
-      # @see IO.winsize=
-      def winsize=(arg)
-        @stream.winsize = arg
-      end
-
-      # @see IO.sync
-      def sync
-        @stream.sync
-      end
-
-      # @see IO.sync=
-      def sync=(arg)
-        @stream.sync = arg
-      end
-
-      # @see IO.sync=
-      def external_encoding
-        @stream.external_encoding
-      end
-
-      # @see ARGF.set_encoding
-      def set_encoding(*args)
-        @stream.set_encoding(*args)
-      end
-
       protected
 
       def _nanoc_clean(str)

data/lib/nanoc/cli/commands/nanoc.rb

@@ -5,8 +5,7 @@ summary 'Nanoc, a static site compiler written in Ruby'
 default_subcommand 'compile'
 
 opt :l, :color, 'enable color' do
-  $stdout.remove_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
-  $stderr.remove_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+  Nanoc::CLI.force_color = Nanoc::CLI::FORCE_COLOR_ENABLED
 end
 
 opt :d, :debug, 'enable debugging' do
@@ -23,8 +22,7 @@ opt :h, :help, 'show the help message and quit' do |_value, cmd|
 end
 
 opt :C, :'no-color', 'disable color' do
-  $stdout.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
-  $stderr.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+  Nanoc::CLI.force_color = Nanoc::CLI::FORCE_COLOR_DISABLED
 end
 
 opt :V, :verbose, 'make output more detailed', multiple: true do |val|

data/lib/nanoc/cli/commands/show-data.rb

@@ -120,7 +120,7 @@ module Nanoc::CLI::Commands
           if pred
             print "  [ #{format '%7s', type} ] (#{dep.props})"
 
-            if details.any?
+            unless details.empty?
               print ' '
             end
 
@@ -139,7 +139,7 @@ module Nanoc::CLI::Commands
       case dep.props.raw_content
       when true
         outcome << 'matching any identifier'
-      when Set
+      when Set, Array
         dep.props.raw_content.sort.each do |x|
           outcome << "matching identifier #{x}"
         end
@@ -149,7 +149,7 @@ module Nanoc::CLI::Commands
         case dep.props.attributes
         when true
           outcome << 'matching any attribute'
-        when Set
+        when Set, Array
           dep.props.attributes.each do |elem|
             case elem
             when Symbol
@@ -214,13 +214,13 @@ module Nanoc::CLI::Commands
 
     def print_outdatedness_reasons_for(obj, outdatedness_checker)
       reasons = outdatedness_checker.outdatedness_reasons_for(obj)
-      if reasons.any?
+      if reasons.empty?
+        puts '  is not outdated'
+      else
         puts '  is outdated:'
         reasons.each do |reason|
           puts "    - #{reason.message}"
         end
-      else
-        puts '  is not outdated'
       end
     end
   end

data/lib/nanoc/cli/compile_listeners/debug_printer.rb

@@ -8,12 +8,12 @@ module Nanoc::CLI::CompileListeners
     end
 
     COLOR_MAP = {
-      'compilation' => "\e[31m",
-      'content' => "\e[32m",
-      'filtering' => "\e[33m",
-      'dependency_tracking' => "\e[34m",
-      'phase' => "\e[35m",
-      'stage' => "\e[36m",
+      'compilation' => :red,
+      'content' => :green,
+      'filtering' => :yellow,
+      'dependency_tracking' => :blue,
+      'phase' => :magenta,
+      'stage' => :cyan,
     }.freeze
 
     # @see Listener#start
@@ -92,9 +92,13 @@ module Nanoc::CLI::CompileListeners
       @_logger ||=
         Logger.new($stdout).tap do |l|
           l.formatter = proc do |_severity, datetime, progname, msg|
-            "*** #{datetime.strftime('%H:%M:%S.%L')} #{COLOR_MAP[progname]}#{msg}\e[0m\n"
+            "*** #{datetime.strftime('%H:%M:%S.%L')} #{colorizer.c(msg, COLOR_MAP[progname])}\n"
           end
         end
     end
+
+    def colorizer
+      @_colorizer ||= Nanoc::CLI::ANSIStringColorizer.new($stdout)
+    end
   end
 end

data/lib/nanoc/cli/error_handler.rb

@@ -107,9 +107,7 @@ module Nanoc::CLI
       write_compact_error(error, $stderr)
 
       File.open('crash.log', 'w') do |io|
-        cio = Nanoc::CLI.wrap_in_cleaning_stream(io)
-        cio.add_stream_cleaner(::Nanoc::CLI::StreamCleaners::ANSIColors)
-        write_verbose_error(error, cio)
+        write_verbose_error(error, io)
       end
     end
 
@@ -289,7 +287,7 @@ module Nanoc::CLI
 
       message = "#{error.class}: #{message_for_error(error)}"
       unless verbose
-        message = "\e[1m\e[31m" + message + "\e[0m"
+        message = colorizer_for(stream).c(message, :bold, :red)
       end
       stream.puts message
       resolution = resolution_for(error)
@@ -363,6 +361,10 @@ module Nanoc::CLI
       end
     end
 
+    def colorizer_for(io)
+      Nanoc::CLI::ANSIStringColorizer.new(io)
+    end
+
     def unwrap_error(e)
       case e
       when Nanoc::Core::Errors::CompilationError

data/lib/nanoc/cli/logger.rb

@@ -7,15 +7,13 @@ module Nanoc
     #
     # @api private
     class Logger
-      # Maps actions (`:create`, `:update`, `:identical`, `:cached`, `:skip` and `:delete`)
-      # onto their ANSI color codes.
       ACTION_COLORS = {
-        create: "\e[32m", # green
-        update: "\e[33m", # yellow
-        identical: '',    # (nothing)
-        cached: '',       # (nothing)
-        skip: '',         # (nothing)
-        delete: "\e[31m", # red
+        create: [:green],
+        update: [:yellow],
+        identical: [],
+        cached: [],
+        skip: [],
+        delete: [:red],
       }.freeze
 
       include Singleton
@@ -42,17 +40,17 @@ module Nanoc
       #
       # @return [void]
       def file(level, action, name, duration = nil)
-        log(
-          level,
-          format(
-            '%s%12s%s  %s%s',
-            ACTION_COLORS[action.to_sym],
-            action,
-            "\e[0m",
-            duration.nil? ? '' : format('[%2.2fs]  ', duration),
-            name,
-          ),
+        colorizer = Nanoc::CLI::ANSIStringColorizer.new($stdout)
+        colored_action = colorizer.c(action.to_s, *ACTION_COLORS[action.to_sym])
+
+        message = format(
+          '%12s  %s%s',
+          colored_action,
+          duration.nil? ? '' : format('[%2.2fs]  ', duration),
+          name,
         )
+
+        log(level, message)
       end
 
       # Logs a message.
@@ -61,15 +59,13 @@ module Nanoc
       #
       # @param [String] message The message to be logged
       #
-      # @param [#puts] io The stream to which the message should be written
-      #
       # @return [void]
-      def log(level, message, io = $stdout)
+      def log(level, message)
         return if @level == :off
         return if @level != :low && @level != level
 
         @mutex.synchronize do
-          io.puts(message)
+          puts(message)
         end
       end
     end

data/lib/nanoc/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module CLI
-    VERSION = '4.13.3'
+    VERSION = '4.13.4'
   end
 end

data/lib/nanoc/cli.rb

@@ -16,27 +16,25 @@ end
 module Nanoc
   # @api private
   module CLI
-    # @return [Boolean] true if debug output is enabled, false if not
-    def self.debug?
-      @debug || false
-    end
+    FORCE_COLOR_ENABLED = :enabled
+    FORCE_COLOR_DISABLED = :disabled
 
-    # @param [Boolean] boolean true if debug output should be enabled,
-    #   false if it should not
-    #
-    # @return [void]
-    def self.debug=(boolean)
-      @debug = boolean
-    end
+    class << self
+      attr_accessor :force_color
 
-    def self.verbosity
-      @verbosity || 0
-    end
+      # true if debug output is enabled, false if not
+      attr_accessor :debug
 
-    def self.verbosity=(val)
-      @verbosity = val
+      attr_accessor :verbosity
+
+      def debug? = debug
     end
 
+    # Set default singleton attributes
+    self.force_color = nil
+    self.debug = false
+    self.verbosity = 0
+
     # Wraps `$stdout` and `$stderr` in appropriate cleaning streams.
     #
     # @return [void]
@@ -58,10 +56,6 @@ module Nanoc
         cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::UTF8)
       end
 
-      unless enable_ansi_colors?(io)
-        cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
-      end
-
       cio
     end
 
@@ -74,7 +68,14 @@ module Nanoc
 
     # @return [Boolean] true if color support is present, false if not
     def self.enable_ansi_colors?(io)
-      io.tty? && !ENV.key?('NO_COLOR')
+      case force_color
+      when FORCE_COLOR_ENABLED
+        true
+      when FORCE_COLOR_DISABLED
+        false
+      else
+        io.tty? && !ENV.key?('NO_COLOR')
+      end
     end
 
     # Invokes the Nanoc command-line tool with the given arguments.
@@ -166,7 +167,7 @@ module Nanoc
       if Nanoc::Core::SiteLoader.cwd_is_nanoc_site?
         config = Nanoc::Core::ConfigLoader.new.new_from_cwd
         config[:commands_dirs].each do |path|
-          load_commands_at(path)
+          load_commands_at(File.expand_path(path))
         end
       end
     end
@@ -218,8 +219,6 @@ inflector_class = Class.new(Zeitwerk::Inflector) do
     case basename
     when 'version', 'cli', 'utf8'
       basename.upcase
-    when 'ansi_colors'
-      'ANSIColors'
     when 'ansi_string_colorizer'
       'ANSIStringColorizer'
     else

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-cli
 version: !ruby/object:Gem::Version
-  version: 4.13.3
+  version: 4.13.4
 platform: ruby
 authors:
 - Denis Defreyne
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -38,20 +37,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: nanoc-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.13.3
+        version: 4.13.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.13.3
+        version: 4.13.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +124,6 @@ files:
 - lib/nanoc/cli/logger.rb
 - lib/nanoc/cli/stack_trace_writer.rb
 - lib/nanoc/cli/stream_cleaners/abstract.rb
-- lib/nanoc/cli/stream_cleaners/ansi_colors.rb
 - lib/nanoc/cli/stream_cleaners/utf8.rb
 - lib/nanoc/cli/transform.rb
 - lib/nanoc/cli/version.rb
@@ -120,8 +132,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/nanoc/nanoc/tree/nanoc-cli-v4.13.3/nanoc-cli
-post_install_message:
+  source_code_uri: https://github.com/nanoc/nanoc/tree/nanoc-cli-v4.13.4/nanoc-cli
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: CLI for Nanoc
 test_files: []

data/lib/nanoc/cli/stream_cleaners/ansi_colors.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module CLI
-    module StreamCleaners
-      # Removes ANSI color escape sequences.
-      class ANSIColors < Abstract
-        # @see Nanoc::CLI::StreamCleaners::Abstract#clean
-        def clean(str)
-          str.gsub(/\e\[.+?m/, '')
-        end
-      end
-    end
-  end
-end