nanoc 4.8.19 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b1cd3570e8e94e5d17d18bf9954f0ac8d8a45e48f4e3d2f7d39cbdc8a2e3ff
-  data.tar.gz: a5a95e6ab7be8df7c016fdd659bac76734965ed9aed677110647ae7d0cfa19b8
+  metadata.gz: ed74af636c6e396ec74288c853dca19336227108e99d4db697f83a655c50d3fc
+  data.tar.gz: 9e38014cee26d2f3f88e4e77ea1d9f2c493c78f5613e6e7ea6867d3d0828ce94
 SHA512:
-  metadata.gz: 5860e580a17a5ed72590cb7c81eb6b6e1649e5c2973a322ed1ca544af0faa4a37de23343151a6dbbe730cd022b9d58f54feae6546c7f243e7c359bc2e3f1ea2a
-  data.tar.gz: e8642774bd3d54418ae6c78392dedca7eecbc80b2d06d7e83aa9a579ab35074a06de192420476b1ca7dfb48e29f2c7fc3b809925faedb23cb5522b89f170b9f0
+  metadata.gz: 44254d1810d3d2bfbbf12b9155035c968d641cdf1880fef342baee260cc4e0fc2fd17731df76b7108292917becb1b2c48902aa87feee47422b33b3941ada97ea
+  data.tar.gz: 271d3c575afbf515409eb5d635eaf53b0a387e97bea37eaf18a8a424d522a961a2138d36d85cb49b988cfdaae782ab5145b2bc596744b3ef5c3b24853a191f59

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2017 Denis Defreyne and contributors
+Copyright (c) 2007-2018 Denis Defreyne and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -1,5 +1,26 @@
 # Nanoc news
 
+## 4.9.0 (2018-01-31)
+
+Features:
+
+* Added `Identifier#match?` (#1305)
+* Added `Nanoc::Check.define`
+* Made Nanoc read checks configuration from `nanoc.yaml` (#1296)
+
+Enhancements:
+
+* Made Nanoc write out files asynchronously (#1288)
+* Made the filesystem data source ignore an initial blank line after the frontmatter (#1292, #1293)
+* Made the `check` command run deploy checks by default (#1304)
+* Made Nanoc honor the `NO_COLOR` environment variable (#1306)
+
+Bugs:
+
+* Fixed a potential deadlock in the `external_links` check (#1294, #1295)
+* Fixed the `external_links` check’s handling of redirects without a `Location` header (#1297, #1302)
+* Fixed the `external_links` check’s handling of URLs with invalid components (#1303)
+
 ## 4.8.19 (2018-01-01)
 
 Enhancements:

data/lib/nanoc.rb

@@ -2,14 +2,15 @@
 
 # Load external dependencies
 require 'addressable'
+require 'ddmemoize'
+require 'ddmetrics'
 require 'ddplugin'
 require 'hamster'
+require 'parallel'
 require 'ref'
 require 'slow_enumerator_tools'
-require 'ddmemoize'
-require 'ddtelemetry'
 
-DDMemoize.enable_telemetry
+DDMemoize.enable_metrics
 
 module Nanoc
   # @return [String] A string containing information about this Nanoc version
@@ -17,7 +18,7 @@ module Nanoc
   #
   # @api private
   def self.version_information
-    "Nanoc #{Nanoc::VERSION} © 2007-2017 Denis Defreyne.\n" \
+    "Nanoc #{Nanoc::VERSION} © 2007-2018 Denis Defreyne.\n" \
     "Running #{RUBY_ENGINE} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} with RubyGems #{Gem::VERSION}.\n"
   end
 

data/lib/nanoc/base/entities/directed_graph.rb

@@ -88,13 +88,13 @@ module Nanoc::Int
 
     # Adds the given vertex to the graph.
     #
-    # @param v The vertex to add to the graph
+    # @param vertex The vertex to add to the graph
     #
     # @return [void]
-    def add_vertex(v)
-      return if @vertices.key?(v)
+    def add_vertex(vertex)
+      return if @vertices.key?(vertex)
 
-      @vertices[v] = @next_vertex_idx.tap { @next_vertex_idx += 1 }
+      @vertices[vertex] = @next_vertex_idx.tap { @next_vertex_idx += 1 }
     end
 
     # Deletes all edges going to the given vertex.

data/lib/nanoc/base/entities/identifier.rb

@@ -101,6 +101,11 @@ module Nanoc
       Nanoc::Int::Pattern.from(other).match?(to_s) ? 0 : nil
     end
 
+    contract C::Any => C::Bool
+    def match?(other)
+      Nanoc::Int::Pattern.from(other).match?(to_s)
+    end
+
     contract C::Any => C::Num
     def <=>(other)
       to_s <=> other.to_s

data/lib/nanoc/base/feature.rb

@@ -91,5 +91,4 @@ module Nanoc
   end
 end
 
-Nanoc::Feature.define('live_cmd', version: '4.8')
-Nanoc::Feature.define('sensible_stack_traces', version: '4.8')
+Nanoc::Feature.define('live_cmd', version: '4.9')

data/lib/nanoc/base/repos/dependency_store.rb

@@ -120,8 +120,8 @@ module Nanoc::Int
       @graph.add_edge(dst_ref, src_ref, props: props.to_h)
     end
 
-    def add_vertex_for(o)
-      @refs2objs[obj2ref(o)] = o
+    def add_vertex_for(obj)
+      @refs2objs[obj2ref(obj)] = obj
     end
 
     # Empties the list of dependencies for the given object. This is necessary
@@ -159,8 +159,8 @@ module Nanoc::Int
       refs.map { |r| ref2obj(r) }
     end
 
-    def props_for(a, b)
-      props = @graph.props_for(obj2ref(a), obj2ref(b)) || {}
+    def props_for(from, to)
+      props = @graph.props_for(obj2ref(from), obj2ref(to)) || {}
 
       if props.values.any? { |v| v }
         props

data/lib/nanoc/base/services/compiler/phases/abstract.rb

@@ -8,6 +8,14 @@ module Nanoc::Int::Compiler::Phases
       @wrapped = wrapped
     end
 
+    def start
+      @wrapped&.start
+    end
+
+    def stop
+      @wrapped&.stop
+    end
+
     def call(rep, is_outdated:)
       notify(:phase_started, rep)
       run(rep, is_outdated: is_outdated) do

data/lib/nanoc/base/services/compiler/phases/write.rb

@@ -4,17 +4,74 @@ module Nanoc::Int::Compiler::Phases
   class Write < Abstract
     include Nanoc::Int::ContractsSupport
 
+    class Worker
+      def initialize(queue:, snapshot_repo:)
+        @queue = queue
+        @snapshot_repo = snapshot_repo
+      end
+
+      def start
+        @thread = Thread.new do
+          Thread.current.abort_on_exception = true
+          Thread.current.priority = -1 # schedule I/O work ASAP
+
+          writer = Nanoc::Int::ItemRepWriter.new
+
+          while rep = @queue.pop # rubocop:disable Lint/AssignmentInCondition
+            writer.write_all(rep, @snapshot_repo)
+          end
+        end
+      end
+
+      def join
+        @thread.join
+      end
+    end
+
+    class WorkerPool
+      def initialize(queue:, size:, snapshot_repo:)
+        @workers = Array.new(size) { Worker.new(queue: queue, snapshot_repo: snapshot_repo) }
+      end
+
+      def start
+        @workers.each(&:start)
+      end
+
+      def join
+        @workers.each(&:join)
+      end
+    end
+
+    QUEUE_SIZE = 40
+    WORKER_POOL_SIZE = 5
+
     def initialize(snapshot_repo:, wrapped:)
       super(wrapped: wrapped)
 
       @snapshot_repo = snapshot_repo
+
+      @queue = SizedQueue.new(QUEUE_SIZE)
+      @worker_pool = WorkerPool.new(queue: @queue, size: WORKER_POOL_SIZE, snapshot_repo: @snapshot_repo)
+    end
+
+    def start
+      super
+      @worker_pool.start
+    end
+
+    def stop
+      super
+      @queue.close
+      @worker_pool.join
     end
 
     contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
     def run(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
       yield
 
-      Nanoc::Int::ItemRepWriter.new.write_all(rep, @snapshot_repo)
+      @queue << rep
+
+      Nanoc::Int::NotificationCenter.post(:rep_write_enqueued, rep)
     end
   end
 end

data/lib/nanoc/base/services/compiler/stages/compile_reps.rb

@@ -14,8 +14,12 @@ module Nanoc::Int::Compiler::Stages
     def run
       outdated_reps = @reps.select { |r| @outdatedness_store.include?(r) }
       selector = Nanoc::Int::ItemRepSelector.new(outdated_reps)
-      selector.each do |rep|
-        handle_errors_while(rep) { compile_rep(rep, is_outdated: @outdatedness_store.include?(rep)) }
+      run_phase_stack do |phase_stack|
+        selector.each do |rep|
+          handle_errors_while(rep) do
+            compile_rep(rep, phase_stack: phase_stack, is_outdated: @outdatedness_store.include?(rep))
+          end
+        end
       end
     ensure
       @outdatedness_store.store
@@ -30,40 +34,46 @@ module Nanoc::Int::Compiler::Stages
       raise Nanoc::Int::Errors::CompilationError.new(e, item_rep)
     end
 
-    def compile_rep(rep, is_outdated:)
-      item_rep_compiler.call(rep, is_outdated: is_outdated)
+    def compile_rep(rep, phase_stack:, is_outdated:)
+      phase_stack.call(rep, is_outdated: is_outdated)
     end
 
-    def item_rep_compiler
-      @_item_rep_compiler ||= begin
-        recalculate_phase = Nanoc::Int::Compiler::Phases::Recalculate.new(
-          action_sequences: @action_sequences,
-          dependency_store: @dependency_store,
-          compilation_context: @compilation_context,
-        )
+    def run_phase_stack
+      phase_stack = build_phase_stack
+      phase_stack.start
+      yield(phase_stack)
+    ensure
+      phase_stack.stop
+    end
 
-        cache_phase = Nanoc::Int::Compiler::Phases::Cache.new(
-          compiled_content_cache: @compiled_content_cache,
-          snapshot_repo: @compilation_context.snapshot_repo,
-          wrapped: recalculate_phase,
-        )
+    def build_phase_stack
+      recalculate_phase = Nanoc::Int::Compiler::Phases::Recalculate.new(
+        action_sequences: @action_sequences,
+        dependency_store: @dependency_store,
+        compilation_context: @compilation_context,
+      )
 
-        resume_phase = Nanoc::Int::Compiler::Phases::Resume.new(
-          wrapped: cache_phase,
-        )
+      cache_phase = Nanoc::Int::Compiler::Phases::Cache.new(
+        compiled_content_cache: @compiled_content_cache,
+        snapshot_repo: @compilation_context.snapshot_repo,
+        wrapped: recalculate_phase,
+      )
 
-        write_phase = Nanoc::Int::Compiler::Phases::Write.new(
-          snapshot_repo: @compilation_context.snapshot_repo,
-          wrapped: resume_phase,
-        )
+      resume_phase = Nanoc::Int::Compiler::Phases::Resume.new(
+        wrapped: cache_phase,
+      )
 
-        mark_done_phase = Nanoc::Int::Compiler::Phases::MarkDone.new(
-          wrapped: write_phase,
-          outdatedness_store: @outdatedness_store,
-        )
+      write_phase = Nanoc::Int::Compiler::Phases::Write.new(
+        snapshot_repo: @compilation_context.snapshot_repo,
+        wrapped: resume_phase,
+      )
 
-        mark_done_phase
-      end
+      mark_done_phase = Nanoc::Int::Compiler::Phases::MarkDone.new(
+        wrapped: write_phase,
+        outdatedness_store: @outdatedness_store,
+      )
+
+      mark_done_phase
     end
   end
 end

data/lib/nanoc/base/services/compiler/stages/determine_outdatedness.rb

@@ -38,8 +38,8 @@ module Nanoc::Int::Compiler::Stages
       Set.new(items.flat_map { |i| @reps[i] })
     end
 
-    def outdated?(r)
-      @outdatedness_store.include?(r) || @outdatedness_checker.outdated?(r)
+    def outdated?(rep)
+      @outdatedness_store.include?(rep) || @outdatedness_checker.outdated?(rep)
     end
   end
 end

data/lib/nanoc/base/services/instrumentor.rb

@@ -4,7 +4,7 @@ module Nanoc::Int
   # @api private
   class Instrumentor
     def self.call(key, *args)
-      stopwatch = DDTelemetry::Stopwatch.new
+      stopwatch = DDMetrics::Stopwatch.new
       stopwatch.start
       yield
     ensure

data/lib/nanoc/base/services/item_rep_writer.rb

@@ -33,7 +33,7 @@ module Nanoc::Int
 
       # Notify
       Nanoc::Int::NotificationCenter.post(
-        :will_write_rep, item_rep, raw_path
+        :rep_write_started, item_rep, raw_path
       )
 
       content = snapshot_repo.get(item_rep, snapshot_name)
@@ -54,7 +54,7 @@ module Nanoc::Int
 
       # Notify
       Nanoc::Int::NotificationCenter.post(
-        :rep_written, item_rep, content.binary?, raw_path, is_created, is_modified
+        :rep_write_ended, item_rep, content.binary?, raw_path, is_created, is_modified
       )
     end
 

data/lib/nanoc/base/views/compilation_item_rep_view.rb

@@ -23,6 +23,13 @@ module Nanoc
         Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(@item_rep))
       end
 
+      # Wait for file to exist
+      if res
+        start = Time.now
+        sleep 0.05 until File.file?(res) || Time.now - start > 1.0
+        raise Nanoc::Int::Errors::InternalInconsistency, "File did not apear in time: #{res}" unless File.file?(res)
+      end
+
       res
     end
 

data/lib/nanoc/checking.rb

@@ -7,5 +7,8 @@ end
 require_relative 'checking/check'
 require_relative 'checking/checks'
 require_relative 'checking/dsl'
-require_relative 'checking/runner.rb'
+require_relative 'checking/runner'
+require_relative 'checking/loader'
 require_relative 'checking/issue'
+
+Nanoc::Check = Nanoc::Checking::Check

data/lib/nanoc/checking/check.rb

@@ -14,6 +14,13 @@ module Nanoc::Checking
 
     attr_reader :issues
 
+    def self.define(ident, &block)
+      klass = Class.new(::Nanoc::Checking::Check) { identifier(ident) }
+      klass.send(:define_method, :run) do
+        instance_exec(&block)
+      end
+    end
+
     def self.create(site)
       output_dir = site.config[:output_dir]
       unless File.exist?(output_dir)

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

@@ -37,8 +37,7 @@ module ::Nanoc::Checking::Checks
     end
 
     def select_invalid(hrefs)
-      col = Nanoc::Extra::ParallelCollection.new(hrefs, parallelism: 10)
-      col.map { |href| validate(href) }.compact
+      ::Parallel.map(hrefs, in_threads: 10) { |href| validate(href) }.compact
     end
 
     def validate(href)
@@ -46,7 +45,7 @@ module ::Nanoc::Checking::Checks
       url = nil
       begin
         url = URI.parse(href)
-      rescue URI::InvalidURIError
+      rescue URI::Error
         return Result.new(href, 'invalid URI')
       end
 
@@ -75,15 +74,8 @@ module ::Nanoc::Checking::Checks
             return Result.new(href, 'too many redirects')
           end
 
-          # Find proper location
-          location = res['Location']
-          if location !~ /^https?:\/\//
-            base_url = url.dup
-            base_url.path = (location =~ /^\// ? '' : '/')
-            base_url.query = nil
-            base_url.fragment = nil
-            location = base_url.to_s + location
-          end
+          location = extract_location(res, url)
+          return Result.new(href, 'redirection without a target location') if location.nil?
 
           url = URI.parse(location)
         elsif res.code == '200'
@@ -99,6 +91,23 @@ module ::Nanoc::Checking::Checks
       end
     end
 
+    def extract_location(res, url)
+      location = res['Location']
+
+      case location
+      when nil
+        nil
+      when /^https?:\/\//
+        location
+      else
+        base_url = url.dup
+        base_url.path = (location =~ /^\// ? '' : '/')
+        base_url.query = nil
+        base_url.fragment = nil
+        base_url.to_s + location
+      end
+    end
+
     def path_for_url(url)
       path =
         if url.path.nil? || url.path.empty?