nanoc 4.4.4 → 4.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8f94a3171ddf9ebc26963938e4399d7075b1e5a
-  data.tar.gz: 81f10a1af119995497a8a11ff564ecc0408c3703
+  metadata.gz: 863abf7fed2e1998046a921fe61e76d21bc0d4d3
+  data.tar.gz: 03a50e4fc4e75f74e0505c0664c352e5b2821d09
 SHA512:
-  metadata.gz: 78b10318c7b1160ce58257201d03f82295db7cd027bf6cb1e5265c0bbcde0cacbf9907ee140166c51d572c1b8ca1a4c53ed93af8dfafdba3ff37f322b4110cf2
-  data.tar.gz: 67260b141c829d973f341bf469a0fae490232d628265a9e55bc6e89a73a672b8811505702b8c0327694ea6e098db5b8d16462580b920e319ddea141510df3521
+  metadata.gz: 5efd6d09aef769a17e8a1d66ee9557ca8b70dbdca303b36e2142e331d133904caf4b902b246d65d9b22ead0cb152746684bf0ae52436ce7c7bfa6de670a537af
+  data.tar.gz: 62b27f158e7d10f8faf730df0ce02bb931fc15d665e5ad4960ca006c2f917333dcc74ff8cd49532245b47f65648313095819c4bda84e4657e515585ea20a6686

data/Gemfile

@@ -21,6 +21,7 @@ group :devel do
   gem 'vcr'
   gem 'webmock'
   gem 'yard'
+  gem 'yard-contracts'
 end
 
 group :plugins do

data/Gemfile.lock

@@ -1,15 +1,14 @@
 GIT
   remote: git://github.com/tmm1/pygments.rb.git
-  revision: fc7e79ef1a5c215abe5f3e5ac7d5fdd12dd8b73d
+  revision: a988d127d3270d21685d2ac2e586060bf43709f3
   specs:
-    pygments.rb (1.0.0)
-      posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.2)
+    pygments.rb (1.1.0)
+      multi_json (>= 1.0.0)
 
 PATH
   remote: .
   specs:
-    nanoc (4.4.4)
+    nanoc (4.4.5)
       cri (~> 2.3)
       hamster (~> 3.0)
       parallel (~> 1.9)
@@ -257,7 +256,6 @@ GEM
     parallel (1.10.0)
     parser (2.3.3.1)
       ast (~> 2.2)
-    posix-spawn (0.3.12)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
@@ -304,7 +302,7 @@ GEM
     ruby_dep (1.5.0)
     rubypants (0.6.0)
     safe_yaml (1.0.4)
-    sass (3.4.22)
+    sass (3.4.23)
     shellany (0.0.1)
     simplecov (0.12.0)
       docile (~> 1.1.0)
@@ -340,8 +338,10 @@ GEM
       crack (>= 0.3.2)
       hashdiff
     xml-simple (1.1.5)
-    yajl-ruby (1.3.0)
     yard (0.9.5)
+    yard-contracts (0.1.5)
+      contracts (~> 0.7)
+      yard (~> 0.8)
     yuicompressor (1.3.3)
 
 PLATFORMS
@@ -402,6 +402,7 @@ DEPENDENCIES
   w3c_validators
   webmock
   yard
+  yard-contracts
   yuicompressor
 
 BUNDLED WITH

data/NEWS.md

@@ -1,5 +1,15 @@
 # Nanoc news
 
+## 4.4.5 (2016-12-24)
+
+Fixes:
+
+* Prevented stale data from making it into the checksum store and thereby blowing up in memory (#1004, #1027)
+* Fixed slow recompile after adding many items to a site (#1028)
+* Fixed wrong capturing helper output when the output field separator (`$,`) is set
+* Fixed issue that could cause items with multiple reps not to be recompiled when needed (#1031, #1032)
+* Fixed error when fetching textual content of item whose `:last` snapshot is binary (#1035, #1036)
+
 ## 4.4.4 (2016-12-19)
 
 Enhancements:

data/lib/nanoc/base.rb

@@ -1,8 +1,5 @@
 # @api private
 module Nanoc::Int
-  autoload 'Compiler',             'nanoc/base/compilation/compiler'
-  autoload 'OutdatednessChecker',  'nanoc/base/compilation/outdatedness_checker'
-  autoload 'OutdatednessReasons',  'nanoc/base/compilation/outdatedness_reasons'
 end
 
 require_relative 'base/core_ext'

data/lib/nanoc/base/contracts_support.rb

@@ -29,17 +29,58 @@ module Nanoc::Int
       Or          = Ignorer.instance
       Func        = Ignorer.instance
       RespondTo   = Ignorer.instance
+      Named       = Ignorer.instance
+      IterOf      = Ignorer.instance
+      HashOf      = Ignorer.instance
 
       def contract(*args); end
     end
 
     module EnabledContracts
+      class AbstractContract
+        def self.[](*vals)
+          new(*vals)
+        end
+      end
+
+      class Named < AbstractContract
+        def initialize(name)
+          @name = name
+        end
+
+        def valid?(val)
+          val.is_a?(Kernel.const_get(@name))
+        end
+
+        def inspect
+          "#{self.class}(#{@name})"
+        end
+      end
+
+      class IterOf < AbstractContract
+        def initialize(contract)
+          @contract = contract
+        end
+
+        def valid?(val)
+          val.respond_to?(:each) && val.all? { |v| Contract.valid?(v, @contract) }
+        end
+
+        def inspect
+          "#{self.class}(#{@contract})"
+        end
+      end
+
       def contract(*args)
         Contract(*args)
       end
     end
 
-    def self.included(base)
+    def self.setup_once
+      @_contracts_support__setup ||= false
+      return @_contracts_support__should_enable if @_contracts_support__setup
+      @_contracts_support__setup = true
+
       contracts_loadable =
         begin
           require 'contracts'
@@ -48,7 +89,19 @@ module Nanoc::Int
           false
         end
 
-      should_enable = contracts_loadable && !ENV.key?('DISABLE_CONTRACTS')
+      @_contracts_support__should_enable = contracts_loadable && !ENV.key?('DISABLE_CONTRACTS')
+
+      if @_contracts_support__should_enable
+        # FIXME: ugly
+        ::Contracts.const_set('Named', EnabledContracts::Named)
+        ::Contracts.const_set('IterOf', EnabledContracts::IterOf)
+      end
+
+      @_contracts_support__should_enable
+    end
+
+    def self.included(base)
+      should_enable = setup_once
 
       if should_enable
         unless base.include?(::Contracts::Core)

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

@@ -20,8 +20,6 @@ module Nanoc::ArrayExtensions
   # @see Hash#__nanoc_freeze_recursively
   #
   # @return [void]
-  #
-  # @since 3.2.0
   def __nanoc_freeze_recursively
     return if frozen?
     freeze

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

@@ -22,8 +22,6 @@ module Nanoc::HashExtensions
   # @see Array#__nanoc_freeze_recursively
   #
   # @return [void]
-  #
-  # @since 3.2.0
   def __nanoc_freeze_recursively
     return if frozen?
     freeze

data/lib/nanoc/base/entities.rb

@@ -21,4 +21,5 @@ require_relative 'entities/site'
 require_relative 'entities/snapshot_def'
 
 require_relative 'entities/outdatedness_status'
+require_relative 'entities/outdatedness_reasons'
 require_relative 'entities/dependency'

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

@@ -24,12 +24,9 @@ module Nanoc::Int
     #     end
     #     # => "I am Max Payne and I am hiding in a cheap motel."
     def initialize(hash)
+      metaclass = class << self; self; end
       hash.each_pair do |key, value|
-        # Build instance variable
         instance_variable_set('@' + key.to_s, value)
-
-        # Define method
-        metaclass = (class << self; self; end)
         metaclass.send(:define_method, key) { value }
       end
     end

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

@@ -84,8 +84,6 @@ module Nanoc::Int
     # @param to   End vertex of the edge
     #
     # @return [void]
-    #
-    # @since 3.2.0
     def delete_edge(from, to)
       @from_graph[from] ||= Set.new
       @from_graph[from].delete(to)
@@ -105,8 +103,6 @@ module Nanoc::Int
     # @param v The vertex to add to the graph
     #
     # @return [void]
-    #
-    # @since 3.2.0
     def add_vertex(v)
       return if @vertices.key?(v)
 
@@ -120,8 +116,6 @@ module Nanoc::Int
     # @param from Vertex from which all edges should be removed
     #
     # @return [void]
-    #
-    # @since 3.2.0
     def delete_edges_from(from)
       return if @from_graph[from].nil?
 
@@ -154,8 +148,6 @@ module Nanoc::Int
     # @param v Vertex to remove from the graph
     #
     # @return [void]
-    #
-    # @since 3.2.0
     def delete_vertex(v)
       delete_edges_to(v)
       delete_edges_from(v)
@@ -232,8 +224,6 @@ module Nanoc::Int
     # Returns all root vertices, i.e. vertices where no edge points to.
     #
     # @return [Set] The set of all root vertices in this graph.
-    #
-    # @since 3.2.0
     def roots
       @roots
     end

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

@@ -11,8 +11,7 @@ module Nanoc::Int
     def_delegator :@objects, :<<
     def_delegator :@objects, :concat
 
-    # FIXME: use Nanoc::Int::Configuration
-    contract C::Any => C::Any
+    contract C::Or[Hash, C::Named['Nanoc::Int::Configuration']] => C::Any
     def initialize(config)
       @config = config
 

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

@@ -98,15 +98,13 @@ module Nanoc
     end
 
     contract C::None => C::Bool
-    # @return [Boolean] True if this is a full-type identifier (i.e. includes
-    #   the extension), false otherwise
+    # Whether or not this is a full identifier (i.e.includes the extension).
     def full?
       @type == :full
     end
 
     contract C::None => C::Bool
-    # @return [Boolean] True if this is a legacy identifier (i.e. does not
-    #   include the extension), false otherwise
+    # Whether or not this is a legacy identifier (i.e. does not include the extension).
     def legacy?
       @type == :legacy
     end
@@ -133,7 +131,7 @@ module Nanoc
     end
 
     contract C::None => String
-    # @return [String]
+    # The identifier, as string, with the last extension removed
     def without_ext
       unless full?
         raise UnsupportedLegacyOperationError
@@ -149,7 +147,7 @@ module Nanoc
     end
 
     contract C::None => C::Maybe[String]
-    # @return [String, nil] The extension, without a leading dot.
+    # The extension, without a leading dot
     def ext
       unless full?
         raise UnsupportedLegacyOperationError
@@ -160,7 +158,7 @@ module Nanoc
     end
 
     contract C::None => String
-    # @return [String]
+    # The identifier, as string, with all extensions removed
     def without_exts
       extname = exts.join('.')
       if !extname.empty?
@@ -171,7 +169,7 @@ module Nanoc
     end
 
     contract C::None => C::ArrayOf[String]
-    # @return [Array] List of extensions, without a leading dot.
+    # The list of extensions, without a leading dot
     def exts
       unless full?
         raise UnsupportedLegacyOperationError

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

@@ -42,7 +42,7 @@ module Nanoc::Int
       @raw_paths  = {}
       @paths      = {}
       @snapshot_defs = []
-      initialize_content
+      @snapshot_contents = { last: @item.content }
 
       # Reset flags
       @compiled = false
@@ -64,18 +64,14 @@ module Nanoc::Int
     # @return [String] The compiled content at the given snapshot (or the
     #   default snapshot if no snapshot is specified)
     def compiled_content(snapshot: nil)
-      # Make sure we're not binary
-      if binary?
-        raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
-      end
-
       # Get name of last pre-layout snapshot
       snapshot_name = snapshot || (@snapshot_contents[:pre] ? :pre : :last)
-      is_moving = [:pre, :post, :last].include?(snapshot_name)
+      is_movable = [:pre, :post, :last].include?(snapshot_name)
 
       # Check existance of snapshot
       snapshot_def = snapshot_defs.reverse.find { |sd| sd.name == snapshot_name }
-      if !is_moving && (snapshot_def.nil? || !snapshot_def.final?)
+      is_final = snapshot_def && snapshot_def.final?
+      if !is_movable && !is_final
         raise Nanoc::Int::Errors::NoSuchSnapshot.new(self, snapshot_name)
       end
 
@@ -85,7 +81,7 @@ module Nanoc::Int
         when :post, :last
           true
         when :pre
-          snapshot_def.nil? || !snapshot_def.final?
+          !is_final
         end
       is_usable_snapshot = @snapshot_contents[snapshot_name] && (compiled? || !is_still_moving)
       unless is_usable_snapshot
@@ -93,7 +89,13 @@ module Nanoc::Int
         return compiled_content(snapshot: snapshot)
       end
 
-      @snapshot_contents[snapshot_name].string
+      # Verify snapshot is not binary
+      snapshot_content = @snapshot_contents[snapshot_name]
+      if snapshot_content.binary?
+        raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
+      end
+
+      snapshot_content.string
     end
 
     contract Symbol => C::Bool
@@ -101,8 +103,6 @@ module Nanoc::Int
     #
     # @return [Boolean] True if content exists for the snapshot with the
     #   given name, false otherwise
-    #
-    # @since 3.2.0
     def snapshot?(snapshot_name)
       !@snapshot_contents[snapshot_name].nil?
     end
@@ -146,11 +146,5 @@ module Nanoc::Int
     def inspect
       "<#{self.class} name=\"#{name}\" binary=#{binary?} raw_path=\"#{raw_path}\" item.identifier=\"#{item.identifier}\">"
     end
-
-    private
-
-    def initialize_content
-      @snapshot_contents = { last: @item.content }
-    end
   end
 end

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

@@ -5,11 +5,7 @@ module Nanoc::Int
 
     attr_accessor :compiler
 
-    contract C::KeywordArgs[config: Nanoc::Int::Configuration, code_snippets: C::RespondTo[:each], items: C::RespondTo[:each], layouts: C::RespondTo[:each]] => C::Any
-    # @param [Nanoc::Int::Configuration] config
-    # @param [Enumerable<Nanoc::Int::CodeSnippet>] code_snippets
-    # @param [Enumerable<Nanoc::Int::Item>] items
-    # @param [Enumerable<Nanoc::Int::Layout>] layouts
+    contract C::KeywordArgs[config: Nanoc::Int::Configuration, code_snippets: C::IterOf[Nanoc::Int::CodeSnippet], items: C::IterOf[Nanoc::Int::Item], layouts: C::IterOf[Nanoc::Int::Layout]] => C::Any
     def initialize(config:, code_snippets:, items:, layouts:)
       @config = config
       @code_snippets = code_snippets
@@ -21,21 +17,12 @@ module Nanoc::Int
     end
 
     contract C::None => self
-    # Compiles the site.
-    #
-    # @return [void]
-    #
-    # @since 3.2.0
     def compile
       compiler.run_all
       self
     end
 
-    contract C::None => Nanoc::Int::Compiler
-    # Returns the compiler for this site. Will create a new compiler if none
-    # exists yet.
-    #
-    # @return [Nanoc::Int::Compiler] The compiler for this site
+    contract C::None => C::Named['Nanoc::Int::Compiler']
     def compiler
       @compiler ||= Nanoc::Int::CompilerLoader.new.load(self)
     end
@@ -46,9 +33,6 @@ module Nanoc::Int
     attr_reader :layouts
 
     contract C::None => self
-    # Prevents all further modifications to itself, its items, its layouts etc.
-    #
-    # @return [void]
     def freeze
       config.freeze
       items.freeze
@@ -57,7 +41,7 @@ module Nanoc::Int
       self
     end
 
-    contract C::RespondTo[:each], String => self
+    contract C::IterOf[C::Or[Nanoc::Int::Item, Nanoc::Int::Layout]], String => self
     def ensure_identifier_uniqueness(objects, type)
       seen = Set.new
       objects.each do |obj|