nanoc 4.11.14 → 4.11.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f542b39fb4659e2567bffcd64e9d1ae1e75d1eb482c432eaff0a2ee9a2912d1
-  data.tar.gz: c4a88763e2ef6262c1aab94de7ddd6e5f891cdab23b9ce07f44e5369c764af68
+  metadata.gz: 4095705ee984152d7ecf6d5a30be0ca2a924c3c5133587ac84a054fa0fc46e9d
+  data.tar.gz: 160e3dae99c1e08af2a04d51dc9b65ec7a5222e0cf8281e8103c787290c29a22
 SHA512:
-  metadata.gz: '088c1d6d14fe2bb6451c0ab246bbe3b763126b257730eba7fff4788661ba07f4d4344fb76559b1daccd71e61825dc1b7f60e8a4a91b81a5e648884b577912ec7'
-  data.tar.gz: 795e7850fdff1d75734cd17ad226cbdbb935b6c5803f8d7eb93d6f5397cdd6620f818bf6fb64fda8e8384842072e9de85eab995c61d57cf4080554df34ae4097
+  metadata.gz: f76a9bd9dc02e98c8c095073d1ec6a584ec260f1b92c859590183b67c3233d88f2ee7ef790812df6b830e7d0d70db6c79301de11d0eed91c8636062a65826215
+  data.tar.gz: ea3e1ce531452ddf3b8c8aceac582f8019d10ad0668a65fab99bb56f487bff7fbc0abb427b87a4f87e46304bf1ca78026510c03ba890f424dd00accdab5d9ba5

data/NEWS.md

@@ -1,5 +1,21 @@
 # Nanoc news
 
+## 4.11.15 (2020-03-07)
+
+Enhancements:
+
+* Made `prune` print files to delete when using dry run (#1474, #1476)
+* Made Nanoc emit a warning when the `contracts` library is loaded, as it can cause severe slowdowns (#1483, #1489)
+* Made the default Rules handle `index.*` files (#1485, #1490)
+
+Fixes:
+
+* Fixed warnings on Ruby 2.7
+* Made `@rep` (not just `@item_rep`) available in the Rendering helper (#1484, #1488)
+* Made the `:relativize_paths` filter relativize the `value` attribute, not the `content` one, of the `param` HTML element (#1491)
+* Made the `:relativize_paths` filter support relativizing paths in `srcset` attributes (#1475, #1492)
+* Fixed an issue that could cause items to be marked as outdated when they shouldn’t be (#1471, #1493).
+
 ## 4.11.14 (2019-11-10)
 
 Fixes:

data/lib/nanoc.rb

@@ -34,18 +34,20 @@ require 'uri'
 
 # Load extracted Nanoc dependencies
 require 'nanoc-core'
+require 'nanoc-cli'
+require 'nanoc-checking'
+require 'nanoc-deploying'
 
 # Re-export from Nanoc::Core
 Nanoc::Identifier = Nanoc::Core::Identifier
 Nanoc::DataSource = Nanoc::Core::DataSource
 Nanoc::Filter = Nanoc::Core::Filter
 Nanoc::Error = Nanoc::Core::Error
+Nanoc::Check = Nanoc::Checking::Check
 
 # Load Nanoc
 require 'nanoc/version'
-require 'nanoc/base'
 require 'nanoc/checking'
-require 'nanoc/deploying'
 require 'nanoc/extra'
 require 'nanoc/data_sources'
 require 'nanoc/filters'

data/lib/nanoc/data_sources/filesystem.rb

@@ -48,6 +48,12 @@ module Nanoc::DataSources
   #
   # @api private
   class Filesystem < Nanoc::DataSource
+    class AmbiguousMetadataAssociationError < ::Nanoc::Core::Error
+      def initialize(content_filenames, meta_filename)
+        super("There are multiple content files (#{content_filenames.sort.join(', ')}) that could match the file containing metadata (#{meta_filename}).")
+      end
+    end
+
     identifiers :filesystem, :filesystem_unified
 
     # See {Nanoc::DataSource#up}.
@@ -85,9 +91,9 @@ module Nanoc::DataSources
     def changes_for_dir(dir)
       require 'listen'
 
-      Nanoc::ChangesStream.new do |cl|
+      Nanoc::Core::ChangesStream.new do |cl|
         listener =
-          Listen.to(dir, latency: 0.0, wait_for_delay: 0.0) do |_modifieds, _addeds, _deleteds|
+          Listen.to(dir, latency: 0.1, wait_for_delay: 0.0) do |_modifieds, _addeds, _deleteds|
             cl.unknown
           end
 
@@ -203,7 +209,7 @@ module Nanoc::DataSources
 
         have_possible_ambiguity = meta_filename && content_filenames.size > 1
         if have_possible_ambiguity && content_filenames.count { |fn| !parser.frontmatter?(fn) } != 1
-          raise Nanoc::Int::Errors::AmbiguousMetadataAssociation.new(content_filenames, meta_filename)
+          raise Nanoc::DataSources::Filesystem::AmbiguousMetadataAssociationError.new(content_filenames, meta_filename)
         end
 
         content_filenames.each do |content_filename|

data/lib/nanoc/extra.rb

@@ -17,4 +17,5 @@ end
 
 require_relative 'extra/link_collector'
 require_relative 'extra/jruby_nokogiri_warner'
+require_relative 'extra/srcset_parser'
 require_relative 'extra/core_ext'

data/lib/nanoc/extra/core_ext.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require 'nanoc/extra/core_ext/pathname'
 require 'nanoc/extra/core_ext/time'

data/lib/nanoc/extra/srcset_parser.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Extra
+    # @api private
+    class SrcsetParser
+      class InvalidFormat < ::Nanoc::Core::Error
+        def initialize
+          super('Invalid srcset format')
+        end
+      end
+
+      REGEX_REST =
+        /
+          (               # Zero or one of the following:
+            (             #   A width descriptor, consisting of:
+              \s+         #     ASCII whitespace
+              \d+         #     a valid non-negative integer
+              w           #     a U+0077 LATIN SMALL LETTER W character
+            )
+            |
+            (             #   A pixel density descriptor, consisting of
+              \s+         #     ASCII whitespace
+              (\d*\.)?\d+ #     a valid floating-point number
+              x           #     and a U+0078 LATIN SMALL LETTER X character.
+            )
+          )*
+        /x.freeze
+
+      def initialize(value)
+        @value = value
+      end
+
+      def call
+        matches = []
+
+        loop do
+          match = {}
+
+          scan(/\s*/)
+          match[:url] = scan(/[^, ]+/)
+          match[:rest] = scan(REGEX_REST)
+          scan(/\s*/)
+
+          matches << match
+
+          next if try_scan(/,/)
+          break if eos?
+
+          raise(InvalidFormat)
+        end
+
+        matches
+      rescue InvalidFormat
+        @value
+      end
+
+      private
+
+      def scan(pattern)
+        match = try_scan(pattern)
+
+        match || raise(InvalidFormat)
+      end
+
+      def try_scan(pattern)
+        scanner.scan(pattern)
+      end
+
+      def eos?
+        scanner.eos?
+      end
+
+      def scanner
+        @_scanner ||= StringScanner.new(@value)
+      end
+    end
+  end
+end

data/lib/nanoc/filters/erb.rb

@@ -11,9 +11,6 @@ module Nanoc::Filters
     #
     # @param [String] content The content to filter
     #
-    # @option params [Integer] :safe_level (nil) The safe level (`$SAFE`) to
-    #   use while running this filter
-    #
     # @option params [String] :trim_mode (nil) The trim mode to use
     #
     # @return [String] The filtered content
@@ -29,9 +26,8 @@ module Nanoc::Filters
       assigns_binding = context.get_binding(&proc)
 
       # Get result
-      safe_level = params[:safe_level]
       trim_mode = params[:trim_mode]
-      erb = ::ERB.new(content, safe_level, trim_mode)
+      erb = ::ERB.new(content, nil, trim_mode)
       erb.filename = filename
       erb.result(assigns_binding)
     end

data/lib/nanoc/filters/relativize_paths.rb

@@ -10,7 +10,16 @@ module Nanoc::Filters
 
     DDMemoize.activate(self)
 
-    SELECTORS = ['*/@href', '*/@src', 'object/@data', 'param[@name="movie"]/@content', 'form/@action', 'comment()'].freeze
+    SELECTORS =
+      [
+        '*/@href',
+        '*/@src',
+        'object/@data',
+        'param[@name="movie"]/@value',
+        'form/@action',
+        'comment()',
+        { path: '*/@srcset', type: :srcset },
+      ].freeze
 
     GCSE_SEARCH_WORKAROUND = 'nanoc__gcse_search__f7ac3462f628a053f86fe6563c0ec98f1fe45cee'
 
@@ -135,14 +144,7 @@ module Nanoc::Filters
       content = apply_gcse_search_workaround(content)
 
       doc = /<html[\s>]/.match?(content) ? klass.parse(content) : klass.fragment(content)
-      selector = selectors.map { |sel| "descendant-or-self::#{sel}" }.join('|')
-      doc.xpath(selector, namespaces).each do |node|
-        if node.name == 'comment'
-          nokogiri_process_comment(node, doc, selectors, namespaces, klass, type, params)
-        elsif path_is_relativizable?(node.content, params)
-          node.content = relative_path_to(node.content)
-        end
-      end
+      handle_selectors(selectors, doc, namespaces, klass, type, params)
 
       output =
         case type
@@ -163,6 +165,33 @@ module Nanoc::Filters
       content.gsub(GCSE_SEARCH_WORKAROUND, 'gcse:search')
     end
 
+    def handle_selectors(selectors, doc, namespaces, klass, type, params)
+      selectors_by_type(selectors).each do |selector_type, sub_selectors|
+        selector = sub_selectors.map { |sel| "descendant-or-self::#{sel.fetch(:path)}" }.join('|')
+
+        doc.xpath(selector, namespaces).each do |node|
+          if node.name == 'comment'
+            nokogiri_process_comment(node, doc, sub_selectors, namespaces, klass, type, params)
+          elsif path_is_relativizable?(node.content, params)
+            node.content = relativize_node(node, selector_type)
+          end
+        end
+      end
+    end
+
+    def selectors_by_type(selectors)
+      typed_selectors =
+        selectors.map do |s|
+          if s.respond_to?(:keys)
+            s
+          else
+            { path: s, type: :basic }
+          end
+        end
+
+      typed_selectors.group_by { |s| s.fetch(:type) }
+    end
+
     def nokogiri_process_comment(node, doc, selectors, namespaces, klass, type, params)
       content = node.content.dup.sub(%r{^(\s*\[.+?\]>\s*)(.+?)(\s*<!\[endif\])}m) do |_m|
         beginning = Regexp.last_match[1]
@@ -175,8 +204,31 @@ module Nanoc::Filters
       node.replace(Nokogiri::XML::Comment.new(doc, content))
     end
 
+    def relativize_node(node, selector_type)
+      case selector_type
+      when :basic
+        relative_path_to(node.content)
+      when :srcset
+        handle_srcset_node(node)
+      else
+        raise Nanoc::Core::Errors::InternalInconsistency, "Unsupported selector type #{selector_type.inspect} in #{self.class}"
+      end
+    end
+
+    def handle_srcset_node(node)
+      parsed = Nanoc::Extra::SrcsetParser.new(node.content).call
+
+      if parsed.is_a?(Array)
+        parsed.map do |pair|
+          [relative_path_to(pair[:url]), pair[:rest]].join('')
+        end.join(',')
+      else
+        relative_path_to(parsed)
+      end
+    end
+
     def path_is_relativizable?(path, params)
-      path.start_with?('/') && !exclude?(path, params)
+      path.match?(/\A\s*\//) && !exclude?(path, params)
     end
   end
 end

data/lib/nanoc/helpers/rendering.rb

@@ -8,8 +8,8 @@ module Nanoc::Helpers
     # @param [String] identifier
     # @param [Hash] other_assigns
     #
-    # @raise [Nanoc::Int::Errors::UnknownLayout]
-    # @raise [Nanoc::Int::Errors::CannotDetermineFilter]
+    # @raise [Nanoc::Core::Errors::UnknownLayout]
+    # @raise [Nanoc::Core::Errors::CannotDetermineFilter]
     # @raise [Nanoc::Filter::UnknownFilter]
     #
     # @return [String, nil]
@@ -17,7 +17,7 @@ module Nanoc::Helpers
       # Find layout
       layout_view = @layouts[identifier]
       layout_view ||= @layouts[identifier.__nanoc_cleaned_identifier]
-      raise Nanoc::Int::Errors::UnknownLayout.new(identifier) if layout_view.nil?
+      raise Nanoc::Core::Errors::UnknownLayout.new(identifier) if layout_view.nil?
 
       layout = layout_view._unwrap
 
@@ -33,6 +33,7 @@ module Nanoc::Helpers
         content: captured_content,
         item: @item,
         item_rep: @item_rep,
+        rep: @item_rep,
         items: @items,
         layout: layout_view,
         layouts: @layouts,
@@ -43,7 +44,7 @@ module Nanoc::Helpers
       filter_name_and_args = @config._context.compilation_context.filter_name_and_args_for_layout(layout)
       filter_name = filter_name_and_args.name
       filter_args = filter_name_and_args.args
-      raise Nanoc::Int::Errors::CannotDetermineFilter.new(layout.identifier) if filter_name.nil?
+      raise Nanoc::Core::Errors::CannotDetermineFilter.new(layout.identifier) if filter_name.nil?
 
       # Get filter class
       filter_class = Nanoc::Filter.named!(filter_name)

data/lib/nanoc/orig_cli.rb

@@ -11,10 +11,5 @@ end
 Nanoc::CLI.after_setup do
   root = File.dirname(__FILE__)
   commands_path = File.join(root, 'orig_cli', 'commands')
-  Nanoc::CLI.add_command(Cri::Command.load_file(File.join(commands_path, 'check.rb'), infer_name: true))
-  Nanoc::CLI.add_command(Cri::Command.load_file(File.join(commands_path, 'deploy.rb'), infer_name: true))
   Nanoc::CLI.add_command(Cri::Command.load_file(File.join(commands_path, 'show-rules.rb'), infer_name: true))
-
-  # TODO: move into nanoc-deploying, once that exists as a package
-  Nanoc::CLI::Commands::ShowPlugins.add_plugin_class(Nanoc::Deploying::Deployer, 'Deployers')
 end

data/lib/nanoc/rule_dsl.rb

@@ -6,6 +6,7 @@ module Nanoc
   end
 end
 
+require_relative 'rule_dsl/errors'
 require_relative 'rule_dsl/compiler_dsl'
 require_relative 'rule_dsl/action_provider'
 require_relative 'rule_dsl/action_recorder'

data/lib/nanoc/rule_dsl/action_provider.rb

@@ -29,7 +29,7 @@ module Nanoc::RuleDSL
 
     def rep_names_for(item)
       matching_rules = @rules_collection.item_compilation_rules_for(item)
-      raise Nanoc::Int::Errors::NoMatchingCompilationRuleFound.new(item) if matching_rules.empty?
+      raise Nanoc::RuleDSL::Errors::NoMatchingCompilationRuleFound.new(item) if matching_rules.empty?
 
       matching_rules.map(&:rep_name).uniq
     end

data/lib/nanoc/rule_dsl/compiler_dsl.rb

@@ -231,7 +231,7 @@ module Nanoc::RuleDSL
     #     include_rules 'rules/content'
     def include_rules(name)
       filename = [name.to_s, "#{name}.rb", "./#{name}", "./#{name}.rb"].find { |f| File.file?(f) }
-      raise Nanoc::Int::Errors::NoRulesFileFound.new if filename.nil?
+      raise Nanoc::RuleDSL::Errors::NoRulesFileFound.new if filename.nil?
 
       Nanoc::RuleDSL::RulesLoader.new(@config, @rules_collection).parse(filename)
     end

data/lib/nanoc/rule_dsl/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module RuleDSL
+    module Errors
+      # Error that is raised when no rules file can be found in the current
+      # working directory.
+      class NoRulesFileFound < ::Nanoc::Core::Error
+        def initialize
+          super('This site does not have a rules file, which is required for Nanoc sites.')
+        end
+      end
+
+      # Error that is raised when no compilation rule that can be applied to the
+      # current item can be found.
+      class NoMatchingCompilationRuleFound < ::Nanoc::Core::Error
+        # @param [Nanoc::Core::Item] item The item for which no compilation rule
+        #   could be found
+        def initialize(item)
+          super("No compilation rules were found for the “#{item.identifier}” item.")
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/rule_dsl/rules_loader.rb

@@ -10,7 +10,7 @@ module Nanoc::RuleDSL
       # Find rules file
       rules_filenames = ['Rules', 'rules', 'Rules.rb', 'rules.rb']
       rules_filename = rules_filenames.find { |f| File.file?(f) }
-      raise Nanoc::Int::Errors::NoRulesFileFound.new if rules_filename.nil?
+      raise Nanoc::RuleDSL::Errors::NoRulesFileFound.new if rules_filename.nil?
 
       parse(rules_filename)
     end

data/lib/nanoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.11.14
+  version: 4.11.15
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2020-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,34 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: nanoc-checking
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nanoc-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.14
+        version: 4.11.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.14
+        version: 4.11.15
 - !ruby/object:Gem::Dependency
   name: nanoc-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.14
+        version: 4.11.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.14
+        version: 4.11.15
+- !ruby/object:Gem::Dependency
+  name: nanoc-deploying
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -123,40 +151,17 @@ files:
 - README.md
 - bin/nanoc
 - lib/nanoc.rb
-- lib/nanoc/base.rb
-- lib/nanoc/base/changes_stream.rb
-- lib/nanoc/base/errors.rb
-- lib/nanoc/checking.rb
-- lib/nanoc/checking/check.rb
-- lib/nanoc/checking/checks.rb
-- lib/nanoc/checking/checks/css.rb
-- lib/nanoc/checking/checks/external_links.rb
-- lib/nanoc/checking/checks/html.rb
-- lib/nanoc/checking/checks/internal_links.rb
-- lib/nanoc/checking/checks/mixed_content.rb
-- lib/nanoc/checking/checks/stale.rb
-- lib/nanoc/checking/checks/w3c_validator.rb
-- lib/nanoc/checking/dsl.rb
-- lib/nanoc/checking/issue.rb
-- lib/nanoc/checking/loader.rb
-- lib/nanoc/checking/runner.rb
 - lib/nanoc/data_sources.rb
 - lib/nanoc/data_sources/filesystem.rb
 - lib/nanoc/data_sources/filesystem/errors.rb
 - lib/nanoc/data_sources/filesystem/parser.rb
 - lib/nanoc/data_sources/filesystem/tools.rb
-- lib/nanoc/deploying.rb
-- lib/nanoc/deploying/deployer.rb
-- lib/nanoc/deploying/deployers.rb
-- lib/nanoc/deploying/deployers/fog.rb
-- lib/nanoc/deploying/deployers/git.rb
-- lib/nanoc/deploying/deployers/rsync.rb
 - lib/nanoc/extra.rb
 - lib/nanoc/extra/core_ext.rb
-- lib/nanoc/extra/core_ext/pathname.rb
 - lib/nanoc/extra/core_ext/time.rb
 - lib/nanoc/extra/jruby_nokogiri_warner.rb
 - lib/nanoc/extra/link_collector.rb
+- lib/nanoc/extra/srcset_parser.rb
 - lib/nanoc/filters.rb
 - lib/nanoc/filters/asciidoc.rb
 - lib/nanoc/filters/asciidoctor.rb
@@ -203,8 +208,6 @@ files:
 - lib/nanoc/helpers/text.rb
 - lib/nanoc/helpers/xml_sitemap.rb
 - lib/nanoc/orig_cli.rb
-- lib/nanoc/orig_cli/commands/check.rb
-- lib/nanoc/orig_cli/commands/deploy.rb
 - lib/nanoc/orig_cli/commands/show-rules.rb
 - lib/nanoc/rule_dsl.rb
 - lib/nanoc/rule_dsl/action_provider.rb
@@ -213,6 +216,7 @@ files:
 - lib/nanoc/rule_dsl/compilation_rule.rb
 - lib/nanoc/rule_dsl/compilation_rule_context.rb
 - lib/nanoc/rule_dsl/compiler_dsl.rb
+- lib/nanoc/rule_dsl/errors.rb
 - lib/nanoc/rule_dsl/routing_rule.rb
 - lib/nanoc/rule_dsl/routing_rule_context.rb
 - lib/nanoc/rule_dsl/rule.rb
@@ -239,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A static-site generator with a focus on flexibility.