nanoc 4.9.6 → 4.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8491f07ee37d39dae6c84cb13f3cde0ec967a2fa723d3c6c0ae21283c13d205d
-  data.tar.gz: 57984873a1fd8f9ecde937539b98e19689d6f08e819e30bc76e328e61807531f
+  metadata.gz: 78dad20b688911c787f63c6ff03fd27873eae890508e6c44fdacedecd1eaedc4
+  data.tar.gz: 0c8d223657f6655d1833d226e5c597a507a3124cc32ff587ccce4923c441af69
 SHA512:
-  metadata.gz: 411feb568085bee7a5d28d8941f1b84dc0d573f8f52684c9067035dc7a50e3844a757df62e7f89b874f0a7ee84d111c46de3c4310695f51ea28733d95400bf0f
-  data.tar.gz: 1397fbc30d9a1c717c9932174428baa7804b1460efdba033767b5f9efd83b1b6bd048bf9c04719d86c049559451667d6a10ce57a70b4b3d05e2132af43cade74
+  metadata.gz: b7e7711db31a5518188be605ef1165515fc41e3d3664c5e2f61cf2687a60ec23f9adc549fec7f119f86360a604d53ba8dcb07d97385174a6bfc7c85dc7aac69b
+  data.tar.gz: 3d6557c67ca0999e80f879c89e8784eb849f77a7e6502701a30c4e80829968042cc6e9f40079e8b63457fc252c4aae19e9d6c6e0bbae24652c0e57d0ceab407d

data/NEWS.md

@@ -1,5 +1,13 @@
 # Nanoc news
 
+## 4.9.7 (2018-10-05)
+
+Enhancements:
+
+* Added `title_proc:` option to the blogging helper (#1362, #1363) [Thomas Hochstein]
+* Dropped Ruby 2.3 support, as it is no longer maintained (#1361)
+* Added static configuration file verification (#1360)
+
 ## 4.9.6 (2018-09-19)
 
 Fixes:

data/lib/nanoc.rb

@@ -6,6 +6,8 @@ require 'ddmemoize'
 require 'ddmetrics'
 require 'ddplugin'
 require 'hamster'
+require 'json'
+require 'json_schema'
 require 'parallel'
 require 'ref'
 require 'slow_enumerator_tools'

data/lib/nanoc/base/core_ext/array.rb

@@ -15,6 +15,14 @@ module Nanoc::ArrayExtensions
     array
   end
 
+  def __nanoc_stringify_keys_recursively
+    array = []
+    each do |element|
+      array << (element.respond_to?(:__nanoc_stringify_keys_recursively) ? element.__nanoc_stringify_keys_recursively : element)
+    end
+    array
+  end
+
   # Freezes the contents of the array, as well as all array elements. The
   # array elements will be frozen using {#__nanoc_freeze_recursively} if they respond
   # to that message, or #freeze if they do not.

data/lib/nanoc/base/core_ext/hash.rb

@@ -17,6 +17,16 @@ module Nanoc::HashExtensions
     hash
   end
 
+  def __nanoc_stringify_keys_recursively
+    hash = {}
+    each_pair do |key, value|
+      new_key   = key.is_a?(Symbol) ? key.to_s : key
+      new_value = value.respond_to?(:__nanoc_stringify_keys_recursively) ? value.__nanoc_stringify_keys_recursively : value
+      hash[new_key] = new_value
+    end
+    hash
+  end
+
   # Freezes the contents of the hash, as well as all hash values. The hash
   # values will be frozen using {#__nanoc_freeze_recursively} if they respond to
   # that message, or #freeze if they do not.

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

@@ -40,8 +40,12 @@ module Nanoc::Int
       snapshot_actions.map { |a| [a.snapshot_names, a.paths] }
     end
 
-    # TODO: Add contract
     memoized def serialize
+      serialize_uncached
+    end
+
+    contract C::None => Array
+    def serialize_uncached
       to_a.map(&:serialize)
     end
 

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

@@ -52,6 +52,8 @@ module Nanoc::Int
       @env_name = env_name
       @wrapped = hash.__nanoc_symbolize_keys_recursively
       @dir = dir
+
+      validate
     end
 
     contract C::None => self
@@ -192,5 +194,13 @@ module Nanoc::Int
         end
       end
     end
+
+    def validate
+      dir = File.dirname(__FILE__)
+      schema_data = JSON.parse(File.read(dir + '/configuration-schema.json'))
+      schema = JsonSchema.parse!(schema_data)
+      schema.expand_references!
+      schema.validate!(@wrapped.__nanoc_stringify_keys_recursively)
+    end
   end
 end

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

@@ -89,12 +89,12 @@ module Nanoc
         false
       end
 
-      # TODO: Add contract
+      contract C::None => Array
       def marshal_dump
         [filename, string]
       end
 
-      # TODO: Add contract
+      contract Array => C::Any
       def marshal_load(array)
         @filename = array[0]
         @string = Nanoc::Int::LazyValue.new(array[1])

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

@@ -138,7 +138,7 @@ module Nanoc
     contract String => self
     # @return [Nanoc::Identifier]
     def prefix(string)
-      if string !~ /\A\//
+      unless /\A\//.match?(string)
         raise InvalidPrefixError.new(string)
       end
 

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

@@ -80,6 +80,10 @@ module Nanoc::Int
       "item_rep:#{item.identifier}:#{name}"
     end
 
+    def to_s
+      "#{item.identifier} (rep name #{name.inspect})"
+    end
+
     def inspect
       "<#{self.class} name=\"#{name}\" raw_path=\"#{raw_path}\" item.identifier=\"#{item.identifier}\">"
     end

data/lib/nanoc/base/entities/processing_actions/filter.rb

@@ -20,5 +20,17 @@ module Nanoc::Int::ProcessingActions
     def to_s
       "filter #{@filter_name.inspect}, #{@params.inspect}"
     end
+
+    def hash
+      self.class.hash ^ filter_name.hash ^ params.hash
+    end
+
+    def ==(other)
+      self.class == other.class && filter_name == other.filter_name && params == other.params
+    end
+
+    def eql?(other)
+      self == other
+    end
   end
 end

data/lib/nanoc/base/entities/processing_actions/layout.rb

@@ -20,5 +20,17 @@ module Nanoc::Int::ProcessingActions
     def to_s
       "layout #{@layout_identifier.inspect}, #{@params.inspect}"
     end
+
+    def hash
+      self.class.hash ^ layout_identifier.hash ^ params.hash
+    end
+
+    def ==(other)
+      self.class == other.class && layout_identifier == other.layout_identifier && params == other.params
+    end
+
+    def eql?(other)
+      self == other
+    end
   end
 end

data/lib/nanoc/base/entities/processing_actions/snapshot.rb

@@ -30,5 +30,17 @@ module Nanoc::Int::ProcessingActions
     def to_s
       "snapshot #{@snapshot_names.inspect}, paths: #{@paths.inspect}"
     end
+
+    def hash
+      self.class.hash ^ snapshot_names.hash ^ paths.hash
+    end
+
+    def ==(other)
+      self.class == other.class && snapshot_names == other.snapshot_names && paths == other.paths
+    end
+
+    def eql?(other)
+      self == other
+    end
   end
 end

data/lib/nanoc/base/errors.rb

@@ -192,7 +192,7 @@ module Nanoc::Int
       # @param [Symbol] snapshot The name of the snapshot that was attempted to
       #   be made
       def initialize(rep, snapshot)
-        super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep “#{rep.inspect}”")
+        super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep #{rep}")
       end
     end
 
@@ -200,7 +200,7 @@ module Nanoc::Int
     class CannotGetCompiledContentOfBinaryItem < Generic
       # @param [Nanoc::Int::ItemRep] rep The binary item representation whose compiled content was attempted to be accessed
       def initialize(rep)
-        super("You cannot access the compiled content of a binary item representation (but you can access the path). The offending item rep is #{rep.inspect}.")
+        super("You cannot access the compiled content of a binary item representation (but you can access the path). The offending item rep is #{rep}.")
       end
     end
 

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

@@ -5,6 +5,8 @@ module Nanoc::Int::Compiler::Phases
   class Resume < Abstract
     include Nanoc::Int::ContractsSupport
 
+    DONE = Object.new
+
     def initialize(wrapped:)
       super(wrapped: wrapped)
     end
@@ -22,8 +24,12 @@ module Nanoc::Int::Compiler::Phases
           raise(res)
         when Proc
           fiber.resume(res.call)
+        when DONE # rubocop:disable Lint/EmptyWhen
+          # ignore
         else
-          # TODO: raise
+          raise Nanoc::Int::Errors::InternalInconsistency.new(
+            "Fiber yielded object of unexpected type #{res.class}",
+          )
         end
       end
 
@@ -40,6 +46,7 @@ module Nanoc::Int::Compiler::Phases
         Fiber.new do
           yield
           @fibers.delete(rep)
+          DONE
         end
 
       @fibers[rep]

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

@@ -9,13 +9,13 @@ module Nanoc::Int
 
     class IdenticalRoutesError < ::Nanoc::Error
       def initialize(output_path, rep_a, rep_b)
-        super("The item representations #{rep_a.inspect} and #{rep_b.inspect} are both routed to #{output_path}.")
+        super("The item representations #{rep_a} and #{rep_b} are both routed to #{output_path}.")
       end
     end
 
     class RouteWithoutSlashError < ::Nanoc::Error
       def initialize(output_path, rep)
-        super("The item representation #{rep.inspect} is routed to #{output_path}, which does not start with a slash, as required.")
+        super("The item representation #{rep} is routed to #{output_path}, which does not start with a slash, as required.")
       end
     end
 
@@ -66,7 +66,8 @@ module Nanoc::Int
       paths.each do |path|
         if assigned_paths.include?(path)
           # TODO: Include snapshot names in error message
-          raise IdenticalRoutesError.new(path, assigned_paths[path], rep)
+          reps = [assigned_paths[path], rep].sort_by { |r| [r.item.identifier, r.name] }
+          raise IdenticalRoutesError.new(path, *reps)
         end
       end
       paths.each do |path|

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

@@ -69,7 +69,7 @@ module ::Nanoc::Checking::Checks
           next
         end
 
-        if res.code =~ /^3..$/
+        if /^3..$/.match?(res.code)
           if i == 4
             return Result.new(href, 'too many redirects')
           end
@@ -101,7 +101,7 @@ module ::Nanoc::Checking::Checks
         location
       else
         base_url = url.dup
-        base_url.path = (location =~ /^\// ? '' : '/')
+        base_url.path = (/^\//.match?(location) ? '' : '/')
         base_url.query = nil
         base_url.fragment = nil
         base_url.to_s + location

data/lib/nanoc/cli/error_handler.rb

@@ -246,7 +246,7 @@ module Nanoc::CLI
           end
         end
       when RuntimeError
-        if error.message =~ /^can't modify frozen/
+        if /^can't modify frozen/.match?(error.message)
           'You attempted to modify immutable data. Some data cannot ' \
           'be modified once compilation has started. Such data includes ' \
           'content and attributes of items and layouts, and filter arguments.'
@@ -286,7 +286,7 @@ module Nanoc::CLI
 
       error = unwrap_error(error)
 
-      message = "#{error.class}: #{error.message}"
+      message = "#{error.class}: #{message_for_error(error)}"
       unless verbose
         message = "\e[1m\e[31m" + message + "\e[0m"
       end
@@ -295,6 +295,15 @@ module Nanoc::CLI
       stream.puts resolution.to_s if resolution
     end
 
+    def message_for_error(error)
+      case error
+      when JsonSchema::AggregateError
+        "\n" + error.errors.map { |e| "  * #{e.pointer}: #{e.message}" }.join("\n")
+      else
+        error.message
+      end
+    end
+
     def write_item_rep(stream, error, verbose: false)
       return unless error.is_a?(Nanoc::Int::Errors::CompilationError)
 

data/lib/nanoc/data_sources/filesystem.rb

@@ -336,7 +336,7 @@ module Nanoc::DataSources
       end
 
       regex =
-        if filename =~ /(^|\/)index(\.[^\/]+)?$/
+        if /(^|\/)index(\.[^\/]+)?$/.match?(filename)
           allow_periods_in_identifiers? ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/
         else
           allow_periods_in_identifiers? ? /\.[^\/\.]+$/ : /\.[^\/]+$/

data/lib/nanoc/data_sources/filesystem/parser.rb

@@ -42,7 +42,7 @@ class Nanoc::DataSources::Filesystem
     def parse_with_frontmatter(content_filename)
       data = Tools.read_file(content_filename, config: @config)
 
-      if data !~ /\A#{SEPARATOR}\s*$/
+      unless /\A#{SEPARATOR}\s*$/.match?(data)
         return ParseResult.new(content: data, attributes: {}, attributes_data: '')
       end
 

data/lib/nanoc/filters/colorize_syntax.rb

@@ -118,7 +118,7 @@ module Nanoc::Filters
         parse_fragment(klass, content)
       end
     rescue => e
-      if e.message =~ /can't modify frozen string/
+      if /can't modify frozen string/.match?(e.message)
         parse(content.dup, klass, is_fullpage)
       else
         raise e

data/lib/nanoc/filters/less.rb

@@ -32,7 +32,7 @@ module Nanoc::Filters
       imports.concat(content.scan(/^@import\s+(["'])([^\1]+?)\1;/))
       imports.concat(content.scan(/^@import\s+url\((["']?)([^)]+?)\1\);/))
 
-      imports.map { |i| i[1] =~ /\.(less|css)$/ ? i[1] : i[1] + '.less' }
+      imports.map { |i| /\.(less|css)$/.match?(i[1]) ? i[1] : i[1] + '.less' }
     end
 
     def imported_filenames_to_items(imported_filenames)

data/lib/nanoc/filters/relativize_paths.rb

@@ -134,7 +134,7 @@ module Nanoc::Filters
 
       content = apply_gcse_search_workaround(content)
 
-      doc = content =~ /<html[\s>]/ ? klass.parse(content) : klass.fragment(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'

data/lib/nanoc/helpers/blogging.rb

@@ -36,6 +36,7 @@ module Nanoc::Helpers
       attr_accessor :preserve_order
       attr_accessor :content_proc
       attr_accessor :excerpt_proc
+      attr_accessor :title_proc
       attr_accessor :title
       attr_accessor :author_name
       attr_accessor :author_uri
@@ -147,7 +148,7 @@ module Nanoc::Helpers
         xml.entry do
           # Add primary attributes
           xml.id atom_tag_for(article)
-          xml.title article[:title], type: 'html'
+          xml.title title_proc.call(article), type: 'html'
 
           # Add dates
           xml.published attribute_to_time(article[:created_at]).__nanoc_to_iso8601_time
@@ -177,6 +178,7 @@ module Nanoc::Helpers
     # @option params [Boolean] :preserve_order
     # @option params [Proc] :content_proc
     # @option params [Proc] :excerpt_proc
+    # @option params [Proc] :title_proc
     # @option params [String] :alt_link
     # @option params [String] :id
     # @option params [String] :title
@@ -200,6 +202,7 @@ module Nanoc::Helpers
       builder.preserve_order    = params.fetch(:preserve_order, false)
       builder.content_proc      = params[:content_proc] || ->(a) { a.compiled_content(snapshot: :pre) }
       builder.excerpt_proc      = params[:excerpt_proc] || ->(a) { a[:excerpt] }
+      builder.title_proc        = params[:title_proc] || ->(a) { a[:title] }
       builder.title             = params[:title] || @item[:title] || @config[:title]
       builder.author_name       = params[:author_name] || @item[:author_name] || @config[:author_name]
       builder.author_uri        = params[:author_uri] || @item[:author_uri] || @config[:author_uri]

data/lib/nanoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.9.6
+  version: 4.9.7
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -431,7 +445,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="