nanoc-checking 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b380e10a13a38c13d712399af8308a0cb67b533094287649eb30283fceba9be3
-  data.tar.gz: bd6715348e5527f23bedf1812b56bc49d75e5827b5bb318a5165bf5cf689077f
+  metadata.gz: 8ab6cbdc1bae780d9287e543d5462a6a6683141c0b0d79ec1d5f1f26e4ed228a
+  data.tar.gz: bb4437776e9720dc53935e96d920d2c74cd46b37c6aa020d10203fb64d59212f
 SHA512:
-  metadata.gz: 61e31cc485a14e7a75199c65df33d172dd69caad7d00be40725ec55ca5203f052213846b974dd842be2a33d021d10be184a1266810f9fdcddf89db1a7def572d
-  data.tar.gz: 2472f804af1d3facea1b840d89280070042b27fc03d91475b91db5e41a6783261a84ac62f83d6ea25811112ee85ff045e5a9110bc8ca398f08b4650dcfbc65ae
+  metadata.gz: 3efba36b203db266dec8769472a02dd8c8a08922f003cc1a408ae7d9799f2bf61f2a64c5b278507b36cbe70b13018b5a221ac91f3d31ef9b06485bfca65befc7
+  data.tar.gz: 894aebf4ae02cfccff5a0b37795781f8ffb1c0a0e46d3f4fb3afc46632717279b8a22691da702040000bc4df6c91c3ce12d1a5660058abcfa9063fe04bcfe7af

data/NEWS.md

@@ -1,5 +1,21 @@
 # nanoc-checking news
 
+## 1.0.6 (2025-04-20)
+
+Enhancements:
+
+- Made checks be run in parallel (#1735) [Jan M. Faber]
+
+Fixes:
+
+- Restored compatibility with Nanoc 4.13.4
+
+## 1.0.5 (2024-04-21)
+
+Fixes:
+
+- Fixed support for paths with spaces in internal_links check (#1702)
+
 ## 1.0.4 (2024-04-19)
 
 Enhancements:

data/lib/nanoc/checking/check.rb

@@ -39,21 +39,21 @@ module Nanoc
         view_context =
           Nanoc::Core::ViewContextForShell.new(
             items: site.items,
-            reps: reps,
+            reps:,
           )
 
         context = {
           items: Nanoc::Core::PostCompileItemCollectionView.new(site.items, view_context),
           layouts: Nanoc::Core::LayoutCollectionView.new(site.layouts, view_context),
           config: Nanoc::Core::ConfigView.new(site.config, view_context),
-          output_filenames: output_filenames,
+          output_filenames:,
         }
 
         new(context)
       end
 
       def initialize(context)
-        super(context)
+        super
 
         @issues = Set.new
       end

data/lib/nanoc/checking/checks/external_links.rb

@@ -143,7 +143,7 @@ module Nanoc
 
         def request_url_once(url)
           req = Net::HTTP::Get.new(path_for_url(url))
-          req['User-Agent'] = "Mozilla/5.0 Nanoc/#{Nanoc::VERSION} (link rot checker)"
+          req['User-Agent'] = user_agent
           http = Net::HTTP.new(url.host, url.port)
           if url.instance_of? URI::HTTPS
             http.use_ssl = true
@@ -161,6 +161,20 @@ module Nanoc
           excludes = @config.fetch(:checks, {}).fetch(:external_links, {}).fetch(:exclude_files, [])
           excludes.any? { |pattern| Regexp.new(pattern).match(file) }
         end
+
+        def user_agent
+          @_user_agent ||= custom_user_agent || default_user_agent
+        end
+
+        private
+
+        def custom_user_agent
+          @config.dig(:checks, :external_links, :user_agent)
+        end
+
+        def default_user_agent
+          "Mozilla/5.0 Nanoc/#{Nanoc::VERSION} (link rot checker)"
+        end
       end
     end
   end

data/lib/nanoc/checking/checks/internal_links.rb

@@ -43,7 +43,8 @@ module Nanoc
 
           output_dir = @config.output_dir
           output_dir += '/' unless output_dir.end_with?('/')
-          base_uri = URI("file://#{output_dir}")
+          # FIXME: escape is hacky
+          base_uri = URI("file://#{output_dir.gsub(' ', '%20')}")
           path = href.sub(/#{base_uri}/, '').sub(/file:\/{1,3}/, '')
 
           path = "/#{path}" unless path.start_with?('/')

data/lib/nanoc/checking/checks/mixed_content.rb

@@ -10,7 +10,7 @@ module Nanoc
       class MixedContent < ::Nanoc::Checking::Check
         identifier :mixed_content
 
-        PROTOCOL_PATTERN = /^(\w+):\/\//.freeze
+        PROTOCOL_PATTERN = /^(\w+):\/\//
 
         def run
           filenames = output_html_filenames

data/lib/nanoc/checking/checks/stale.rb

@@ -22,7 +22,7 @@ module Nanoc
         protected
 
         def item_rep_paths
-          @item_rep_paths ||=
+          @_item_rep_paths ||=
             Set.new(
               @items
                 .flat_map(&:reps)
@@ -34,10 +34,12 @@ module Nanoc
         end
 
         def pruner
-          exclude_config = @config.fetch(:prune, {}).fetch(:exclude, [])
-          # FIXME: specifying reps this way is icky
-          reps = Nanoc::Core::ItemRepRepo.new
-          @pruner ||= Nanoc::Core::Pruner.new(@config._unwrap, reps, exclude: exclude_config)
+          @_pruner ||= begin
+            exclude_config = @config.fetch(:prune, {}).fetch(:exclude, [])
+            # FIXME: specifying reps this way is icky
+            reps = Nanoc::Core::ItemRepRepo.new
+            Nanoc::Core::Pruner.new(@config._unwrap, reps, exclude: exclude_config)
+          end
         end
       end
     end

data/lib/nanoc/checking/checks/w3c_validator.rb

@@ -7,7 +7,6 @@ module Nanoc
       class W3CValidator < ::Nanoc::Checking::Check
         def run
           require 'w3c_validators'
-          require 'resolv-replace'
 
           Dir[@config.output_dir + '/**/*.' + extension].each do |filename|
             results = validator_class.new.validate_file(filename)

data/lib/nanoc/checking/command_runners/check.rb

@@ -19,7 +19,7 @@ module Nanoc
               runner.run_all
             elsif options[:deploy]
               runner.run_for_deploy
-            elsif arguments.any?
+            elsif !arguments.empty?
               runner.run_specific(arguments)
             else
               runner.run_for_deploy

data/lib/nanoc/checking/dsl.rb

@@ -5,7 +5,7 @@ module Nanoc
     # @api private
     class DSL
       def self.from_file(filename, enabled_checks:)
-        dsl = new(enabled_checks: enabled_checks)
+        dsl = new(enabled_checks:)
         absolute_filename = File.expand_path(filename)
         dsl.instance_eval(File.read(filename), absolute_filename)
         dsl
@@ -15,9 +15,9 @@ module Nanoc
         @enabled_checks = enabled_checks
       end
 
-      def check(identifier, &block)
+      def check(identifier, &)
         klass = Class.new(::Nanoc::Checking::Check)
-        klass.send(:define_method, :run, &block)
+        klass.send(:define_method, :run, &)
         klass.send(:identifier, identifier)
       end
 

data/lib/nanoc/checking/link_collector.rb

@@ -83,7 +83,8 @@ module ::Nanoc
 
       def uris_in_file(filename, tag_names)
         uris = Set.new
-        base_uri = URI("file://#{filename}")
+        # FIXME: escape is hacky
+        base_uri = URI("file://#{filename.gsub(' ', '%20')}")
         doc = Nokogiri::HTML(::File.read(filename))
         doc.traverse do |tag|
           next unless tag_names.nil? || tag_names.include?(tag.name)
@@ -116,7 +117,8 @@ module ::Nanoc
             uri
           else
             begin
-              URI.join(base_uri, uri).to_s
+              # FIXME: escape is hacky
+              URI.join(base_uri, uri.gsub(' ', '%20')).to_s
             rescue
               uri
             end

data/lib/nanoc/checking/loader.rb

@@ -36,7 +36,7 @@ module Nanoc
       def dsl
         @enabled_checks_from_dsl ||= []
 
-        @dsl ||=
+        @_dsl ||=
           if dsl_present?
             Nanoc::Checking::DSL.from_file(checks_filename, enabled_checks: @enabled_checks_from_dsl)
           else

data/lib/nanoc/checking/runner.rb

@@ -6,13 +6,18 @@ module Nanoc
     #
     # @api private
     class Runner
+      # Number of threads to use for running checks.
+      NUM_THREADS = 5
+
       # @param [Nanoc::Core::Site] site The Nanoc site this runner is for
       def initialize(site)
         @site = site
+
+        @log_mutex = Thread::Mutex.new
       end
 
       def any_enabled_checks?
-        enabled_checks.any?
+        !enabled_checks.empty?
       end
 
       # Lists all available checks on stdout.
@@ -56,7 +61,7 @@ module Nanoc
       private
 
       def loader
-        @loader ||= Nanoc::Checking::Loader.new(config: @site.config)
+        @_loader ||= Nanoc::Checking::Loader.new(config: @site.config)
       end
 
       def load_all
@@ -93,32 +98,83 @@ module Nanoc
         # TODO: remove me
         Nanoc::Core::Compiler.new_for(@site).run_until_reps_built
 
-        checks = []
-        issues = Set.new
-        length = classes.map { |c| c.identifier.to_s.length }.max + 18
-        classes.each do |klass|
-          print format("  %-#{length}s", "Running check #{klass.identifier}… ")
+        checks = classes.map { _1.create(@site) }
+        length = classes.map { _1.identifier.to_s.length }.max
+
+        puts 'Running checks…'
+
+        # Create space in terminal to print status of all checks
+        classes.count.times { puts }
+        cursor_up($stdout, classes.count)
+
+        # Print all checks (all “pending” for now)
+        checks.each_with_index do |check, index|
+          log_check(index:, topic: format("  %-#{length}s", check.class.identifier.to_s), state: 'pending')
+        end
+
+        # Run checks in parallel
+        Parallel.each_with_index(checks, in_threads: NUM_THREADS) do |check, index|
+          log_check(index:, topic: format("  %-#{length}s", check.class.identifier.to_s), state: colorizer.c('running', :blue))
 
-          check = klass.create(@site)
           check.run
 
-          checks << check
-          issues.merge(check.issues)
+          state = check.issues.empty? ? colorizer.c('ok', :green) : colorizer.c('error', :red)
+          log_check(index:, topic: format("  %-#{length}s", check.class.identifier.to_s), state:)
+        end
 
-          # TODO: report progress
+        # Move cursor to below list
+        cursor_down($stdout, checks.count)
 
-          puts check.issues.empty? ? 'ok'.green : 'error'.red
+        # Collect issues
+        issues = Set.new
+        checks.each do |check|
+          issues.merge(check.issues)
         end
+
         issues
       end
 
+      def log_check(index:, topic:, state:)
+        @log_mutex.synchronize do
+          cursor_down($stdout, index)
+
+          $stdout << "#{topic}  #{state}"
+          erase_rest_of_line($stdout)
+
+          cursor_up($stdout, index)
+          go_to_start_of_line($stdout)
+        end
+      end
+
+      def cursor_up(io, count)
+        return if count.zero?
+
+        io << "\e[#{count}A"
+      end
+
+      def cursor_down(io, count)
+        return if count.zero?
+
+        io << "\e[#{count}B"
+      end
+
+      def go_to_start_of_line(io)
+        io << "\r"
+      end
+
+      def erase_rest_of_line(io)
+        io << "\e[K"
+      end
+
       def subject_to_s(str)
         str || '(global)'
       end
 
-      def print_issues(issues)
-        require 'colored'
+      def colorizer
+        @_colorizer ||= Nanoc::CLI::ANSIStringColorizer.new($stdout)
+      end
 
+      def print_issues(issues)
         return if issues.empty?
 
         puts 'Issues found!'
@@ -129,7 +185,7 @@ module Nanoc
 
           puts "  #{subject_to_s(subject)}:"
           issues.each do |i|
-            puts "    [ #{'ERROR'.red} ] #{i.check_class.identifier} - #{i.description}"
+            puts "    [ #{colorizer.c('ERROR', :red)} ] #{i.check_class.identifier} - #{i.description}"
           end
         end
       end

data/lib/nanoc/checking/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Checking
-    VERSION = '1.0.4'
+    VERSION = '1.0.6'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-checking
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Denis Defreyne
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc-cli
@@ -83,8 +82,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/nanoc/nanoc/tree/nanoc-checking-v1.0.4/nanoc-checking
-post_install_message:
+  source_code_uri: https://github.com/nanoc/nanoc/tree/nanoc-checking-v1.0.6/nanoc-checking
 rdoc_options: []
 require_paths:
 - lib
@@ -92,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Checking support for Nanoc
 test_files: []