nanoc 4.8.19 → 4.9.0

data/lib/nanoc/checking/dsl.rb

@@ -3,17 +3,15 @@
 module Nanoc::Checking
   # @api private
   class DSL
-    attr_reader :deploy_checks
-
-    def self.from_file(filename)
-      dsl = new
+    def self.from_file(filename, enabled_checks:)
+      dsl = new(enabled_checks: enabled_checks)
       absolute_filename = File.expand_path(filename)
       dsl.instance_eval(File.read(filename), absolute_filename)
       dsl
     end
 
-    def initialize
-      @deploy_checks = []
+    def initialize(enabled_checks:)
+      @enabled_checks = enabled_checks
     end
 
     def check(identifier, &block)
@@ -23,7 +21,7 @@ module Nanoc::Checking
     end
 
     def deploy_check(*identifiers)
-      identifiers.each { |i| @deploy_checks << i }
+      identifiers.each { |i| @enabled_checks << i }
     end
   end
 end

data/lib/nanoc/checking/loader.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Nanoc::Checking
+  # @api private
+  class Loader
+    CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb'].freeze
+
+    def initialize(config:)
+      @config = config
+    end
+
+    def run
+      dsl
+    end
+
+    def enabled_checks
+      (enabled_checks_from_dsl + enabled_checks_from_config).uniq
+    end
+
+    private
+
+    def dsl_present?
+      checks_filename && File.file?(checks_filename)
+    end
+
+    def enabled_checks_from_dsl
+      dsl
+      @enabled_checks_from_dsl
+    end
+
+    def enabled_checks_from_config
+      @config.fetch(:checking, {}).fetch(:enabled_checks, []).map(&:to_sym)
+    end
+
+    def dsl
+      @enabled_checks_from_dsl ||= []
+
+      @dsl ||=
+        if dsl_present?
+          Nanoc::Checking::DSL.from_file(checks_filename, enabled_checks: @enabled_checks_from_dsl)
+        else
+          Nanoc::Checking::DSL.new(enabled_checks: @enabled_checks_from_dsl)
+        end
+    end
+
+    def checks_filename
+      @_checks_filename ||= CHECKS_FILENAMES.find { |f| File.file?(f) }
+    end
+  end
+end

data/lib/nanoc/checking/runner.rb

@@ -5,29 +5,20 @@ module Nanoc::Checking
   #
   # @api private
   class Runner
-    CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb'].freeze
-
     # @param [Nanoc::Int::Site] site The Nanoc site this runner is for
     def initialize(site)
       @site = site
     end
 
-    # @return [String] The name of the Checks file
-    def checks_filename
-      @_checks_filename ||= CHECKS_FILENAMES.find { |f| File.file?(f) }
-    end
-
-    # @return [Boolean] true if a Checks file exists, false otherwise
-    def dsl_present?
-      checks_filename && File.file?(checks_filename)
+    def any_enabled_checks?
+      enabled_checks.any?
     end
-    alias has_dsl? dsl_present?
 
     # Lists all available checks on stdout.
     #
     # @return [void]
     def list_checks
-      load_dsl_if_available
+      load_all
 
       puts 'Available checks:'
       puts
@@ -38,8 +29,7 @@ module Nanoc::Checking
     #
     # @return [Boolean] true if successful, false otherwise
     def run_all
-      load_dsl_if_available
-
+      load_all
       run_check_classes(all_check_classes)
     end
 
@@ -47,10 +37,9 @@ module Nanoc::Checking
     #
     # @return [Boolean] true if successful, false otherwise
     def run_for_deploy
-      require_dsl
-
-      return true if dsl.nil?
-      run_check_classes(check_classes_named(dsl.deploy_checks))
+      # TODO: rename to #run_enabled
+      load_all
+      run_check_classes(check_classes_named(enabled_checks))
     end
 
     # Runs the checks with the given names.
@@ -59,33 +48,22 @@ module Nanoc::Checking
     #
     # @return [Boolean] true if successful, false otherwise
     def run_specific(check_class_names)
-      load_dsl_if_available
-
+      load_all
       run_check_classes(check_classes_named(check_class_names))
     end
 
-    def load_dsl_if_available
-      @dsl_loaded ||= false
-      unless @dsl_loaded
-        @dsl =
-          if dsl_present?
-            Nanoc::Checking::DSL.from_file(checks_filename)
-          else
-            nil
-          end
-        @dsl_loaded = true
-      end
+    private
+
+    def loader
+      @loader ||= Nanoc::Checking::Loader.new(config: @site.config)
     end
 
-    def require_dsl
-      load_dsl_if_available
-      if dsl.nil?
-        raise Nanoc::Int::Errors::GenericTrivial, "No checks defined (no #{CHECKS_FILENAMES.first} file present)"
-      end
+    def load_all
+      loader.run
     end
 
-    def dsl
-      @dsl
+    def enabled_checks
+      loader.enabled_checks
     end
 
     def run_check_classes(classes)
@@ -132,8 +110,8 @@ module Nanoc::Checking
       issues
     end
 
-    def subject_to_s(s)
-      s || '(global)'
+    def subject_to_s(str)
+      str || '(global)'
     end
 
     def print_issues(issues)

data/lib/nanoc/cli.rb

@@ -230,7 +230,7 @@ module Nanoc::CLI
 
   # @return [Boolean] true if color support is present, false if not
   def self.enable_ansi_colors?(io)
-    io.tty?
+    io.tty? && !ENV.key?('NO_COLOR')
   end
 
   def self.after_setup_procs

data/lib/nanoc/cli/ansi_string_colorizer.rb

@@ -15,14 +15,14 @@ module Nanoc::CLI
       blue: "\e[34m",
     }.freeze
 
-    # @param [String] s The string to colorize
+    # @param [String] str The string to colorize
     #
-    # @param [Array] as An array of attributes from `MAPPING` to colorize the
+    # @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(s, *as)
-      as.map { |a| MAPPING[a] }.join('') + s + "\e[0m"
+    def self.c(str, *attrs)
+      attrs.map { |a| MAPPING[a] }.join('') + str + "\e[0m"
     end
   end
 end

data/lib/nanoc/cli/cleaning_stream.rb

@@ -40,16 +40,16 @@ module Nanoc::CLI
     # @group IO proxy methods
 
     # @see IO#write
-    def write(s)
+    def write(str)
       _nanoc_swallow_broken_pipe_errors_while do
-        @stream.write(_nanoc_clean(s))
+        @stream.write(_nanoc_clean(str))
       end
     end
 
     # @see IO#<<
-    def <<(s)
+    def <<(str)
       _nanoc_swallow_broken_pipe_errors_while do
-        @stream.<<(_nanoc_clean(s))
+        @stream.<<(_nanoc_clean(str))
       end
     end
 
@@ -76,16 +76,16 @@ module Nanoc::CLI
     end
 
     # @see IO#print
-    def print(s)
+    def print(str)
       _nanoc_swallow_broken_pipe_errors_while do
-        @stream.print(_nanoc_clean(s))
+        @stream.print(_nanoc_clean(str))
       end
     end
 
     # @see IO#puts
-    def puts(*s)
+    def puts(*str)
       _nanoc_swallow_broken_pipe_errors_while do
-        @stream.puts(*s.map { |ss| _nanoc_clean(ss) })
+        @stream.puts(*str.map { |ss| _nanoc_clean(ss) })
       end
     end
 
@@ -95,8 +95,8 @@ module Nanoc::CLI
     end
 
     # @see IO#reopen
-    def reopen(*a)
-      @stream.reopen(*a)
+    def reopen(*args)
+      @stream.reopen(*args)
     end
 
     # @see IO#close
@@ -148,8 +148,8 @@ module Nanoc::CLI
 
     protected
 
-    def _nanoc_clean(s)
-      @stream_cleaners.reduce(s.to_s.scrub) { |acc, elem| elem.clean(acc) }
+    def _nanoc_clean(str)
+      @stream_cleaners.reduce(str.to_s.scrub) { |acc, elem| elem.clean(acc) }
     end
 
     def _nanoc_swallow_broken_pipe_errors_while

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

@@ -3,17 +3,16 @@
 usage 'check [options] [names]'
 summary 'run issue checks'
 description "
-Run issue checks on the current site. If the `--all` option is passed, all available issue checks will be run. If the `--deploy` option is passed, the issue checks marked for deployment will be run.
+Run issue checks on the current site. If the `--all` option is passed, all available issue checks will be run. By default, the issue checks marked for deployment will be run.
 "
 
 flag :a, :all,    'run all checks'
 flag :L, :list,   'list all checks'
-flag :d, :deploy, 'run checks for deployment'
+flag :d, :deploy, '(deprecated)'
 
 module Nanoc::CLI::Commands
   class Check < ::Nanoc::CLI::CommandRunner
     def run
-      validate_options_and_arguments
       site = load_site
 
       runner = Nanoc::Checking::Runner.new(site)
@@ -28,25 +27,16 @@ module Nanoc::CLI::Commands
           runner.run_all
         elsif options[:deploy]
           runner.run_for_deploy
-        else
+        elsif arguments.any?
           runner.run_specific(arguments)
+        else
+          runner.run_for_deploy
         end
 
       unless success
         raise Nanoc::Int::Errors::GenericTrivial, 'One or more checks failed'
       end
     end
-
-    protected
-
-    def validate_options_and_arguments
-      if arguments.empty? && !options[:all] && !options[:deploy] && !options[:list]
-        raise(
-          Nanoc::Int::Errors::GenericTrivial,
-          'nothing to do (pass either --all, --deploy or --list or a list of checks)',
-        )
-      end
-    end
   end
 end
 

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

@@ -11,10 +11,10 @@ module Nanoc::CLI::Commands::CompileListeners
     def start
       setup_diffs
       old_contents = {}
-      Nanoc::Int::NotificationCenter.on(:will_write_rep, self) do |rep, path|
+      Nanoc::Int::NotificationCenter.on(:rep_write_started, self) do |rep, path|
         old_contents[rep] = File.file?(path) ? File.read(path) : nil
       end
-      Nanoc::Int::NotificationCenter.on(:rep_written, self) do |rep, binary, path, _is_created, _is_modified|
+      Nanoc::Int::NotificationCenter.on(:rep_write_ended, self) do |rep, binary, path, _is_created, _is_modified|
         unless binary
           new_contents = File.file?(path) ? File.read(path) : nil
           if old_contents[rep] && new_contents
@@ -29,8 +29,8 @@ module Nanoc::CLI::Commands::CompileListeners
     def stop
       super
 
-      Nanoc::Int::NotificationCenter.remove(:will_write_rep, self)
-      Nanoc::Int::NotificationCenter.remove(:rep_written, self)
+      Nanoc::Int::NotificationCenter.remove(:rep_write_started, self)
+      Nanoc::Int::NotificationCenter.remove(:rep_write_ended, self)
 
       teardown_diffs
     end
@@ -63,14 +63,14 @@ module Nanoc::CLI::Commands::CompileListeners
       end
     end
 
-    def diff_strings(a, b)
+    def diff_strings(str_a, str_b)
       # Create files
       Tempfile.open('old') do |old_file|
         Tempfile.open('new') do |new_file|
           # Write files
-          old_file.write(a)
+          old_file.write(str_a)
           old_file.flush
-          new_file.write(b)
+          new_file.write(str_b)
           new_file.flush
 
           # Diff

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

@@ -25,7 +25,15 @@ module Nanoc::CLI::Commands::CompileListeners
         cached_reps << rep
       end
 
-      Nanoc::Int::NotificationCenter.on(:rep_written, self) do |rep, _binary, path, is_created, is_modified|
+      Nanoc::Int::NotificationCenter.on(:rep_write_enqueued, self) do |rep|
+        @acc_durations[rep] += Time.now - @start_times[rep]
+      end
+
+      Nanoc::Int::NotificationCenter.on(:rep_write_started, self) do |rep, _raw_path|
+        @start_times[rep] = Time.now
+      end
+
+      Nanoc::Int::NotificationCenter.on(:rep_write_ended, self) do |rep, _binary, path, is_created, is_modified|
         @acc_durations[rep] += Time.now - @start_times[rep]
         duration = @acc_durations[rep]
 
@@ -50,7 +58,9 @@ module Nanoc::CLI::Commands::CompileListeners
 
       Nanoc::Int::NotificationCenter.remove(:compilation_started, self)
       Nanoc::Int::NotificationCenter.remove(:compilation_suspended, self)
-      Nanoc::Int::NotificationCenter.remove(:rep_written, self)
+      Nanoc::Int::NotificationCenter.remove(:rep_write_enqueued, self)
+      Nanoc::Int::NotificationCenter.remove(:rep_write_started, self)
+      Nanoc::Int::NotificationCenter.remove(:rep_write_ended, self)
 
       @reps.reject(&:compiled?).each do |rep|
         raw_paths = rep.raw_paths.values.flatten.uniq

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

@@ -16,28 +16,28 @@ module Nanoc::CLI::Commands::CompileListeners
     def initialize(reps:)
       @reps = reps
 
-      @stages_summary = DDTelemetry::Summary.new
-      @phases_summary = DDTelemetry::Summary.new
-      @outdatedness_rules_summary = DDTelemetry::Summary.new
-      @filters_summary = DDTelemetry::Summary.new
-      @load_stores_summary = DDTelemetry::Summary.new
+      @stages_summary = DDMetrics::Summary.new
+      @phases_summary = DDMetrics::Summary.new
+      @outdatedness_rules_summary = DDMetrics::Summary.new
+      @filters_summary = DDMetrics::Summary.new
+      @load_stores_summary = DDMetrics::Summary.new
     end
 
     # @see Listener#start
     def start
       on(:stage_ran) do |duration, klass|
-        @stages_summary.observe(duration, klass.to_s.sub(/.*::/, ''))
+        @stages_summary.observe(duration, name: klass.to_s.sub(/.*::/, ''))
       end
 
       on(:outdatedness_rule_ran) do |duration, klass|
-        @outdatedness_rules_summary.observe(duration, klass.to_s.sub(/.*::/, ''))
+        @outdatedness_rules_summary.observe(duration, name: klass.to_s.sub(/.*::/, ''))
       end
 
       filter_stopwatches = {}
 
       on(:filtering_started) do |rep, _filter_name|
         stopwatch_stack = filter_stopwatches.fetch(rep) { filter_stopwatches[rep] = [] }
-        stopwatch_stack << DDTelemetry::Stopwatch.new
+        stopwatch_stack << DDMetrics::Stopwatch.new
         stopwatch_stack.last.start
       end
 
@@ -45,11 +45,11 @@ module Nanoc::CLI::Commands::CompileListeners
         stopwatch = filter_stopwatches.fetch(rep).pop
         stopwatch.stop
 
-        @filters_summary.observe(stopwatch.duration, filter_name.to_s)
+        @filters_summary.observe(stopwatch.duration, name: filter_name.to_s)
       end
 
       on(:store_loaded) do |duration, klass|
-        @load_stores_summary.observe(duration, klass.to_s)
+        @load_stores_summary.observe(duration, name: klass.to_s)
       end
 
       on(:compilation_suspended) do |rep, _exception|
@@ -64,14 +64,14 @@ module Nanoc::CLI::Commands::CompileListeners
 
       on(:phase_started) do |phase_name, rep|
         stopwatches = phase_stopwatches.fetch(rep) { phase_stopwatches[rep] = {} }
-        stopwatches[phase_name] = DDTelemetry::Stopwatch.new.tap(&:start)
+        stopwatches[phase_name] = DDMetrics::Stopwatch.new.tap(&:start)
       end
 
       on(:phase_ended) do |phase_name, rep|
         stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
         stopwatch.stop
 
-        @phases_summary.observe(stopwatch.duration, phase_name)
+        @phases_summary.observe(stopwatch.duration, name: phase_name)
       end
 
       on(:phase_yielded) do |phase_name, rep|
@@ -88,7 +88,7 @@ module Nanoc::CLI::Commands::CompileListeners
         stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
         stopwatch.stop if stopwatch.running?
 
-        @phases_summary.observe(stopwatch.duration, phase_name)
+        @phases_summary.observe(stopwatch.duration, name: phase_name)
       end
     end
 
@@ -103,7 +103,9 @@ module Nanoc::CLI::Commands::CompileListeners
     def table_for_summary(name, summary)
       headers = [name.to_s, 'count', 'min', '.50', '.90', '.95', 'max', 'tot']
 
-      rows = summary.map do |filter_name, stats|
+      rows = summary.map do |label, stats|
+        name = label.fetch(:name)
+
         count = stats.count
         min   = stats.min
         p50   = stats.quantile(0.50)
@@ -112,7 +114,7 @@ module Nanoc::CLI::Commands::CompileListeners
         tot   = stats.sum
         max   = stats.max
 
-        [filter_name, count.to_s] + [min, p50, p90, p95, max, tot].map { |r| "#{format('%4.2f', r)}s" }
+        [name, count.to_s] + [min, p50, p90, p95, max, tot].map { |r| "#{format('%4.2f', r)}s" }
       end
 
       [headers] + rows
@@ -121,8 +123,9 @@ module Nanoc::CLI::Commands::CompileListeners
     def table_for_summary_durations(name, summary)
       headers = [name.to_s, 'tot']
 
-      rows = summary.map do |stage_name, stats|
-        [stage_name, "#{format('%4.2f', stats.sum)}s"]
+      rows = summary.map do |label, stats|
+        name = label.fetch(:name)
+        [name, "#{format('%4.2f', stats.sum)}s"]
       end
 
       [headers] + rows
@@ -134,7 +137,7 @@ module Nanoc::CLI::Commands::CompileListeners
       print_table_for_summary_duration(:stages, @stages_summary) if Nanoc::CLI.verbosity >= 2
       print_table_for_summary(:outdatedness_rules, @outdatedness_rules_summary) if Nanoc::CLI.verbosity >= 2
       print_table_for_summary_duration(:load_stores, @load_stores_summary) if Nanoc::CLI.verbosity >= 2
-      DDMemoize.print_telemetry if Nanoc::CLI.verbosity >= 2
+      print_ddmemoize_metrics if Nanoc::CLI.verbosity >= 2
     end
 
     def print_table_for_summary(name, summary)
@@ -151,8 +154,13 @@ module Nanoc::CLI::Commands::CompileListeners
       print_table(table_for_summary_durations(name, summary))
     end
 
+    def print_ddmemoize_metrics
+      puts
+      DDMemoize.print_metrics
+    end
+
     def print_table(rows)
-      puts DDTelemetry::Table.new(rows).to_s
+      puts DDMetrics::Table.new(rows).to_s
     end
   end
 end