nanoc 4.9.1 → 4.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab127f94d9ffc710fc374831e36f805e16e1fd1bf1dcadfc65d48ce8009d4f8
-  data.tar.gz: 4f167936c1d475ce4625875ec5788d99d1f0e22fb0499644e5c632d26bfe0ef1
+  metadata.gz: b913559b6a6971b80377035d086779ac7d799a7ffee38289778bec2e8a82cd7c
+  data.tar.gz: 28bb11a9f2146ace9c6a018a69bc11c766bfe29ee08fbce18923f4686bda8379
 SHA512:
-  metadata.gz: 3ce94577815ee770cb5e572d232357a60fd4447ab68c101d0a6215e9b45c1f25866433ac90e478475dbccf92cbbf97d5a01c1b6a40198a715a6e5364f68f6064
-  data.tar.gz: 38dec7119c8a3239ec8ab5a2922fe4aca8857645446100f6601bffebe75c6ff2414d0b0886bebc633b95f7df8c12ef25a6d59926e1101cc63917584ad13170de
+  metadata.gz: 9862f93c33f34a75792f371ff106bfe9119f61c0e052e648ef8caa66364e81adc91ec36d015b22f8f9faea4479839fe013edb388886785b7149089428bb57b69
+  data.tar.gz: 75f1f8f4039bc15ba041861696b80ededbf7fb67ed18f57b2c1b4e0cd65efef46a331e5ea6e659de37eb1e8c5f05dfea39a097a2d5f4d25a493410fd77e2ec3b

data/NEWS.md

@@ -1,5 +1,19 @@
 # Nanoc news
 
+## 4.9.2 (2018-03-30)
+
+Fixes:
+
+* Fixed bug which caused `output_dir` not to be ignored when checking for excludes in pruner (#1313, #1324)
+* Fixed bug which caused `Filter#depend_on` not to create a proper dependency when the depended-on item has no representations (#1330)
+
+Enhancements:
+
+* Made Nanoc use hardlinks instead of copying files when possible (#1321) [Antonio Terceiro]
+* Made Nanoc show an understandable error when a filter returns `nil` by accident (#1323, #1326)
+* Made the checks also consider `.xhtml` and `.htm` files (#1328, #1329)
+* Made Nanoc not report thread exceptions, which would freeze Ruby (#1332)
+
 ## 4.9.1 (2018-02-22)
 
 Fixes:

data/lib/nanoc.rb

@@ -54,6 +54,7 @@ require 'stringio'
 require 'tempfile'
 require 'time'
 require 'timeout'
+require 'tomlrb'
 require 'tmpdir'
 require 'uri'
 require 'yaml'

data/lib/nanoc/base/errors.rb

@@ -224,6 +224,18 @@ module Nanoc::Int
       end
     end
 
+    class OutputNotWritten < Generic
+      def initialize(filter_name, output_filename)
+        super("The #{filter_name.inspect} filter did not write anything to the required output file, #{output_filename}.")
+      end
+    end
+
+    class FilterReturnedNil < Generic
+      def initialize(filter_name)
+        super("The #{filter_name.inspect} filter returned nil, but is required to return a String.")
+      end
+    end
+
     class InternalInconsistency < Generic
     end
   end

data/lib/nanoc/base/feature.rb

@@ -91,4 +91,10 @@ module Nanoc
   end
 end
 
+# Tracking issue:
+# https://github.com/nanoc/features/issues/24
 Nanoc::Feature.define('live_cmd', version: '4.9')
+
+# Tracking issue:
+# https://github.com/nanoc/features/issues/40
+Nanoc::Feature.define('toml', version: '4.9')

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

@@ -28,7 +28,12 @@ module Nanoc::Int
 
     # @return [String]
     def self.config_filename_for_cwd
-      filenames = %w[nanoc.yaml config.yaml]
+      filenames =
+        if Nanoc::Feature.enabled?(Nanoc::Feature::TOML)
+          %w[nanoc.yaml config.yaml nanoc.toml]
+        else
+          %w[nanoc.yaml config.yaml]
+        end
       candidate = filenames.find { |f| File.file?(f) }
       candidate && File.expand_path(candidate)
     end
@@ -41,7 +46,7 @@ module Nanoc::Int
       # Read
       config =
         apply_parent_config(
-          Nanoc::Int::Configuration.new(hash: YAML.load_file(filename)),
+          Nanoc::Int::Configuration.new(hash: load_file(filename)),
           [filename],
         ).with_defaults
 
@@ -49,6 +54,17 @@ module Nanoc::Int
       config.with_environment
     end
 
+    def load_file(filename)
+      case File.extname(filename)
+      when '.yaml'
+        YAML.load_file(filename)
+      when '.toml'
+        Tomlrb.load_file(filename)
+      else
+        raise Nanoc::Int::Errors::InternalInconsistency, 'Unhandled config file extension'
+      end
+    end
+
     # @api private
     def apply_parent_config(config, processed_paths = [])
       parent_path = config[:parent_config_file]
@@ -66,7 +82,7 @@ module Nanoc::Int
       end
 
       # Load
-      parent_config = Nanoc::Int::Configuration.new(hash: YAML.load_file(parent_path))
+      parent_config = Nanoc::Int::Configuration.new(hash: load_file(parent_path))
       full_parent_config = apply_parent_config(parent_config, processed_paths + [parent_path])
       full_parent_config.merge(config.without(:parent_config_file))
     end

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

@@ -23,6 +23,8 @@ module Nanoc::Int
       def bounce(_obj, raw_content: false, attributes: false, compiled_content: false, path: false); end
     end
 
+    attr_reader :dependency_store
+
     def initialize(dependency_store)
       @dependency_store = dependency_store
       @stack = []

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

@@ -3,12 +3,6 @@
 module Nanoc
   module Int
     class Executor
-      class OutputNotWrittenError < ::Nanoc::Error
-        def initialize(filter_name, output_filename)
-          super("The #{filter_name.inspect} filter did not write anything to the required output file, #{output_filename}.")
-        end
-      end
-
       def initialize(rep, compilation_context, dependency_tracker)
         @rep = rep
         @compilation_context = compilation_context
@@ -35,11 +29,6 @@ module Nanoc
 
           # Store
           @compilation_context.snapshot_repo.set(@rep, :last, last)
-
-          # Check whether file was written
-          if filter.class.to_binary? && !File.file?(filter.output_filename)
-            raise OutputNotWrittenError.new(filter_name, filter.output_filename)
-          end
         ensure
           Nanoc::Int::NotificationCenter.post(:filtering_ended, @rep, filter_name)
         end

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

@@ -87,6 +87,11 @@ module Nanoc
         (@to || :text) == :binary
       end
 
+      # @api private
+      def to_text?
+        (@to || :text) == :text
+      end
+
       # @return [Boolean]
       #
       # @api private
@@ -149,7 +154,7 @@ module Nanoc
     # @api private
     def setup_and_run(*args)
       self.class.setup
-      run(*args)
+      run(*args).tap { |res| verify(res) }
     end
 
     # Runs the filter on the given content or filename.
@@ -170,6 +175,18 @@ module Nanoc
       raise NotImplementedError.new('Nanoc::Filter subclasses must implement #run')
     end
 
+    def verify(res)
+      if self.class.to_binary?
+        unless File.file?(output_filename)
+          raise Nanoc::Int::Errors::OutputNotWritten.new(self.class.identifier, output_filename)
+        end
+      elsif self.class.to_text?
+        unless res
+          raise Nanoc::Int::Errors::FilterReturnedNil.new(self.class.identifier)
+        end
+      end
+    end
+
     # Returns a filename that is used to write data to. This method is only
     #   used on binary items. When running a binary filter on a file, the
     #   resulting file must end up in the location returned by this method.
@@ -211,6 +228,7 @@ module Nanoc
     # @return [void]
     def depend_on(items)
       items.flat_map(&:reps).flat_map(&:raw_path)
+      items.each(&:raw_filename)
     end
   end
 end

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

@@ -48,7 +48,13 @@ module Nanoc::Int
       is_modified = is_created || !FileUtils.identical?(raw_path, temp_path)
 
       # Write
-      FileUtils.cp(temp_path, raw_path) if is_modified
+      if is_modified
+        begin
+          FileUtils.ln(temp_path, raw_path, force: true)
+        rescue Errno::EXDEV
+          FileUtils.cp(temp_path, raw_path)
+        end
+      end
 
       item_rep.modified = is_modified
 

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

@@ -6,6 +6,8 @@ module Nanoc
   #
   # @api private
   class Pruner
+    include Nanoc::Int::ContractsSupport
+
     # @param [Nanoc::Int::Configuration] config
     #
     # @param [Nanoc::Int::ItemRepRepo] reps
@@ -22,9 +24,6 @@ module Nanoc
       @exclude = Set.new(exclude)
     end
 
-    # Prunes all output files not managed by Nanoc.
-    #
-    # @return [void]
     def run
       return unless File.directory?(@config[:output_dir])
 
@@ -35,18 +34,13 @@ module Nanoc
       remove_empty_directories(present_dirs)
     end
 
-    def exclude?(component)
-      @exclude.include?(component)
-    end
-
-    # @param [String] filename The filename to check
-    #
-    # @return [Boolean] true if the given file is excluded, false otherwise
+    contract String => C::Bool
     def filename_excluded?(filename)
       pathname = Pathname.new(strip_output_dir(filename))
       @exclude.any? { |e| pathname_components(pathname).include?(e) }
     end
 
+    contract String => String
     def strip_output_dir(filename)
       if filename.start_with?(@config[:output_dir])
         filename[@config[:output_dir].size..-1]
@@ -55,6 +49,7 @@ module Nanoc
       end
     end
 
+    contract Pathname => C::ArrayOf[String]
     def pathname_components(pathname)
       components = []
       tmp = pathname
@@ -67,22 +62,27 @@ module Nanoc
       components.reverse
     end
 
+    contract C::ArrayOf[String], C::ArrayOf[String] => self
     # @api private
     def remove_stray_files(present_files, compiled_files)
       (present_files - compiled_files).each do |f|
-        delete_file(f) unless exclude?(f)
+        delete_file(f) unless filename_excluded?(f)
       end
+      self
     end
 
+    contract C::ArrayOf[String] => self
     # @api private
     def remove_empty_directories(present_dirs)
       present_dirs.reverse_each do |dir|
         next if Dir.foreach(dir) { |n| break true if n !~ /\A\.\.?\z/ }
-        next if exclude?(dir)
+        next if filename_excluded?(dir)
         delete_dir(dir)
       end
+      self
     end
 
+    contract String => C::ArrayOf[C::ArrayOf[String]]
     # @api private
     def files_and_dirs_in(dir)
       present_files = []
@@ -91,15 +91,13 @@ module Nanoc
       expanded_dir = File.expand_path(dir)
 
       Find.find(dir) do |f|
-        basename = File.basename(f)
-
         case File.ftype(f)
         when 'file'
-          unless exclude?(basename)
+          unless filename_excluded?(f)
             present_files << f
           end
         when 'directory'
-          if exclude?(basename)
+          if filename_excluded?(f)
             Find.prune
           elsif expanded_dir != File.expand_path(f)
             present_dirs << f

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

@@ -45,6 +45,7 @@ module Nanoc
 
     # @api private
     def raw_filename
+      @context.dependency_tracker.bounce(_unwrap, raw_content: true)
       _unwrap.content.filename
     end
   end

data/lib/nanoc/checking/check.rb

@@ -58,5 +58,10 @@ module Nanoc::Checking
     def add_issue(desc, subject: nil)
       @issues << Issue.new(desc, subject, self.class)
     end
+
+    # @private
+    def output_html_filenames
+      output_filenames.select { |f| File.extname(f) =~ /\A\.x?html?\z/ }
+    end
   end
 end

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

@@ -10,7 +10,7 @@ module ::Nanoc::Checking::Checks
     def run
       # Find all broken external hrefs
       # TODO: de-duplicate this (duplicated in internal links check)
-      filenames = output_filenames.select { |f| File.extname(f) == '.html' && !excluded_file?(f) }
+      filenames = output_html_filenames.reject { |f| excluded_file?(f) }
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :external).filenames_per_href
       results = select_invalid(hrefs_with_filenames.keys)
 

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

@@ -15,7 +15,7 @@ module Nanoc::Checking::Checks
     # @return [void]
     def run
       # TODO: de-duplicate this (duplicated in external links check)
-      filenames = output_filenames.select { |f| File.extname(f) == '.html' }
+      filenames = output_html_filenames
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :internal).filenames_per_href
       resource_uris_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :internal).filenames_per_resource_uri
 

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

@@ -11,7 +11,7 @@ module Nanoc::Checking::Checks
     PROTOCOL_PATTERN = /^(\w+):\/\//
 
     def run
-      filenames = output_filenames.select { |f| File.extname(f) == '.html' }
+      filenames = output_html_filenames
       resource_uris_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames).filenames_per_resource_uri
 
       resource_uris_with_filenames.each_pair do |uri, fns|

data/lib/nanoc/deploying/deployers/fog.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc::Deploying::Deployers
-  # A deployer that deploys a site using [fog](https://github.com/geemus/fog).
+  # A deployer that deploys a site using [fog](https://github.com/fog/fog).
   #
   # @example A deployment configuration with public and staging configurations
   #

data/lib/nanoc/spec.rb

@@ -25,6 +25,12 @@ module Nanoc
         skip "Could not find external command \"#{cmd}\"" unless command?(cmd)
       end
 
+      def skip_unless_gem_available(gem)
+        require gem
+      rescue LoadError
+        skip "Could not load gem \"#{gem}\""
+      end
+
       def sleep_until(max: 3.0)
         start = Time.now
         loop do

data/lib/nanoc/version.rb

@@ -2,5 +2,5 @@
 
 module Nanoc
   # The current Nanoc version.
-  VERSION = '4.9.1'
+  VERSION = '4.9.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.9.1
+  version: 4.9.2
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tomlrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Nanoc is a static-site generator focused on flexibility. It transforms
   content from a format such as Markdown or AsciiDoc into another format, usually
   HTML, and lays out pages consistently to retain the site’s look and feel throughout.