nanoc 4.7.12 → 4.7.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc70bc281ec6b39ca3de14107a1c2374d13e2807
-  data.tar.gz: 0f16fd6cd14eb18bafd194ee2d0e0421fae93765
+  metadata.gz: d6113ac8b3ca8085d1247d4e880144d62af62037
+  data.tar.gz: 557d2ae493c26da9ebe71735fcb19da59f9aeba4
 SHA512:
-  metadata.gz: ea4bfbf259d607544769201bf1cb950c5f8f9d4cbfe80aa48f53be0aaaa68db8b861949374a557700afb91193922c66dc62c16c510a2b2dddc99e4ea2d2b5858
-  data.tar.gz: 3be571aecf8dbf7c742894aa1415726c915ee7eee916506f31f79c0d0ae986589176f76bfd90c8564111e11194fcd7ded82fe5aa1694340f4cddd9abf0facf10
+  metadata.gz: 7a0f046fd0f6b324dfea8451b0ab89142ff32a572e3e948cbf23e13337de70726097069101ed5484805d105f72ccd245ab8de0db2568f8310878e09eb083db4e
+  data.tar.gz: 06e63734588725c3260fa543ad6844fb94dd7369092bea7249415f1096f363eed66267b752b0cb309e52377d730737688ef8b445b5b19b4029ed13889e7c6894

data/NEWS.md

@@ -1,5 +1,11 @@
 # Nanoc news
 
+## 4.7.13 (2017-07-02)
+
+Enhancements:
+
+* Made adding an item or a layout only recompile items that likely depend on it (#1191, #1193)
+
 ## 4.7.12 (2017-06-23)
 
 Fixes:

data/lib/nanoc/base/core_ext.rb

@@ -2,5 +2,4 @@
 
 require 'nanoc/base/core_ext/array'
 require 'nanoc/base/core_ext/hash'
-require 'nanoc/base/core_ext/pathname'
 require 'nanoc/base/core_ext/string'

data/lib/nanoc/base/entities.rb

@@ -8,11 +8,14 @@ require_relative 'entities/content'
 require_relative 'entities/processing_action'
 require_relative 'entities/processing_actions'
 
+require_relative 'entities/identifiable_collection'
+require_relative 'entities/item_collection'
+require_relative 'entities/layout_collection'
+
 require_relative 'entities/code_snippet'
 require_relative 'entities/configuration'
 require_relative 'entities/lazy_value'
 require_relative 'entities/document'
-require_relative 'entities/identifiable_collection'
 require_relative 'entities/item'
 require_relative 'entities/item_rep'
 require_relative 'entities/layout'

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

@@ -6,18 +6,19 @@ module Nanoc::Int
   class Dependency
     include Nanoc::Int::ContractsSupport
 
-    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration]
+    C_OBJ_FROM = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::IdentifiableCollection]
+    C_OBJ_TO   = Nanoc::Int::Item
 
-    contract C::None => C::Maybe[C_OBJ]
+    contract C::None => C::Maybe[C_OBJ_FROM]
     attr_reader :from
 
-    contract C::None => C::Maybe[C_OBJ]
+    contract C::None => C::Maybe[C_OBJ_TO]
     attr_reader :to
 
     contract C::None => Nanoc::Int::Props
     attr_reader :props
 
-    contract C::Maybe[C_OBJ], C::Maybe[C_OBJ], Nanoc::Int::Props => C::Any
+    contract C::Maybe[C_OBJ_FROM], C::Maybe[C_OBJ_TO], Nanoc::Int::Props => C::Any
     def initialize(from, to, props)
       @from  = from
       @to    = to

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

@@ -50,6 +50,18 @@ module Nanoc::Int
       invalidate_caches
     end
 
+    def inspect
+      s = []
+
+      @vertices.each_pair do |v1, _|
+        direct_successors_of(v1).each do |v2|
+          s << [v1.inspect + ' -> ' + v2.inspect + ' props=' + @edge_props[[v1, v2]].inspect]
+        end
+      end
+
+      self.class.to_s + '(' + s.join(', ') + ')'
+    end
+
     # @group Modifying the graph
 
     # Adds an edge from the first vertex to the second vertex.

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

@@ -12,14 +12,15 @@ module Nanoc::Int
     def_delegator :@objects, :each
     def_delegator :@objects, :size
 
-    contract C::Or[Hash, C::Named['Nanoc::Int::Configuration']], C::IterOf[C::RespondTo[:identifier]] => C::Any
-    def initialize(config, objects = [])
-      @config = config
-      @objects = Hamster::Vector.new(objects)
+    def initialize(*)
+      raise 'IdentifiableCollection is abstract and cannot be instantiated'
     end
 
-    def self.from(enum, config)
-      new(config, enum)
+    contract C::Or[Hash, C::Named['Nanoc::Int::Configuration']], C::IterOf[C::RespondTo[:identifier]], C::Maybe[String] => C::Any
+    def initialize_basic(config, objects = [], name = nil)
+      @config = config
+      @objects = Hamster::Vector.new(objects)
+      @name = name
     end
 
     contract C::None => self
@@ -58,14 +59,17 @@ module Nanoc::Int
       @objects.empty?
     end
 
+    contract C::RespondTo[:identifier] => self
     def add(obj)
       self.class.new(@config, @objects.add(obj))
     end
 
+    contract C::Func[C::RespondTo[:identifier] => C::Any] => self
     def reject(&block)
       self.class.new(@config, @objects.reject(&block))
     end
 
+    contract C::Any => C::Maybe[C::RespondTo[:identifier]]
     def object_with_identifier(identifier)
       if frozen?
         @mapping[identifier.to_s]
@@ -123,6 +127,7 @@ module Nanoc::Int
       @mapping.freeze
     end
 
+    contract C::None => C::Bool
     def use_globs?
       @config[:string_pattern_type] == 'glob'
     end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nanoc::Int
+  # @api private
+  class ItemCollection < IdentifiableCollection
+    def initialize(config, objects = [])
+      initialize_basic(config, objects, 'items')
+    end
+
+    def reference
+      :items
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nanoc::Int
+  # @api private
+  class LayoutCollection < IdentifiableCollection
+    def initialize(config, objects = [])
+      initialize_basic(config, objects, 'layouts')
+    end
+
+    def reference
+      :layouts
+    end
+  end
+end

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

@@ -46,6 +46,25 @@ module Nanoc::Int
       Props.new(raw_content: true, compiled_content: true),
     )
 
+    class DocumentCollectionExtended < Generic
+      attr_reader :objects
+
+      def initialize(objects)
+        super(
+          'New items/layouts have been added to the site.',
+          Props.new(raw_content: true),
+        )
+
+        @objects = objects
+      end
+    end
+
+    class ItemCollectionExtended < DocumentCollectionExtended
+    end
+
+    class LayoutCollectionExtended < DocumentCollectionExtended
+    end
+
     class AttributesModified < Generic
       attr_reader :attributes
 

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

@@ -6,11 +6,13 @@ module Nanoc::Int
     include Nanoc::Int::ContractsSupport
 
     attr_reader :attributes
+    attr_reader :raw_content
 
+    # TODO: Split raw_content for documents and collections
+    C_RAW_CONTENT = C::Or[C::IterOf[C::Or[String, Regexp]], C::Bool]
     C_ATTRS = C::Or[C::IterOf[Symbol], C::Bool]
-    contract C::KeywordArgs[raw_content: C::Optional[C::Bool], attributes: C::Optional[C_ATTRS], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]] => C::Any
+    contract C::KeywordArgs[raw_content: C::Optional[C_RAW_CONTENT], attributes: C::Optional[C_ATTRS], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]] => C::Any
     def initialize(raw_content: false, attributes: false, compiled_content: false, path: false)
-      @raw_content = raw_content
       @compiled_content = compiled_content
       @path = path
 
@@ -21,6 +23,14 @@ module Nanoc::Int
         else
           attributes
         end
+
+      @raw_content =
+        case raw_content
+        when Enumerable
+          Set.new(raw_content)
+        else
+          raw_content
+        end
     end
 
     contract C::None => String
@@ -37,7 +47,12 @@ module Nanoc::Int
 
     contract C::None => C::Bool
     def raw_content?
-      @raw_content
+      case @raw_content
+      when Enumerable
+        @raw_content.any?
+      else
+        @raw_content
+      end
     end
 
     contract C::None => C::Bool
@@ -63,27 +78,35 @@ module Nanoc::Int
     contract Nanoc::Int::Props => Nanoc::Int::Props
     def merge(other)
       Props.new(
-        raw_content: raw_content? || other.raw_content?,
+        raw_content: merge_raw_content(other),
         attributes: merge_attributes(other),
         compiled_content: compiled_content? || other.compiled_content?,
         path: path? || other.path?,
       )
     end
 
+    def merge_raw_content(other)
+      merge_prop(raw_content, other.raw_content)
+    end
+
     def merge_attributes(other)
-      case attributes
+      merge_prop(attributes, other.attributes)
+    end
+
+    def merge_prop(own, other)
+      case own
       when true
         true
       when false
-        other.attributes
+        other
       else
-        case other.attributes
+        case other
         when true
           true
         when false
-          attributes
+          own
         else
-          attributes + other.attributes
+          own + other
         end
       end
     end
@@ -101,7 +124,7 @@ module Nanoc::Int
     contract C::None => Hash
     def to_h
       {
-        raw_content: raw_content?,
+        raw_content: raw_content,
         attributes: attributes,
         compiled_content: compiled_content?,
         path: path?,

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

@@ -12,14 +12,14 @@ module Nanoc::Int
     def items
       @_items ||= begin
         objs = @data_sources.flat_map(&:items)
-        Nanoc::Int::IdentifiableCollection.from(objs, @config)
+        Nanoc::Int::ItemCollection.new(@config, objs)
       end
     end
 
     def layouts
       @_layouts ||= begin
         objs = @data_sources.flat_map(&:layouts)
-        Nanoc::Int::IdentifiableCollection.from(objs, @config)
+        Nanoc::Int::LayoutCollection.new(@config, objs)
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Nanoc::Int
 
     contract C::KeywordArgs[site: C::Maybe[Nanoc::Int::Site], objects: C::IterOf[c_obj]] => C::Any
     def initialize(site: nil, objects:)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'checksums'), 1)
+      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'checksums'), 2)
 
       @objects = objects
 

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

@@ -8,8 +8,9 @@ module Nanoc::Int
     attr_accessor :items
     attr_accessor :layouts
 
+    contract Nanoc::Int::ItemCollection, Nanoc::Int::LayoutCollection, Nanoc::Int::Configuration, C::KeywordArgs[site: C::Optional[C::Maybe[Nanoc::Int::Site]]] => C::Any
     def initialize(items, layouts, config, site: nil)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'dependencies'), 4)
+      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'dependencies'), 5)
 
       @items = items
       @layouts = layouts
@@ -18,14 +19,17 @@ module Nanoc::Int
       items.each   { |o| add_vertex_for(o) }
       layouts.each { |o| add_vertex_for(o) }
       add_vertex_for(config)
+      add_vertex_for(items)
+      add_vertex_for(layouts)
 
       @new_objects = []
       @graph = Nanoc::Int::DirectedGraph.new([nil] + objs2refs(@items) + objs2refs(@layouts))
     end
 
-    # FIXME: ItemRep?
-    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Layout, Nanoc::Int::Configuration]
-    contract C_OBJ => C::ArrayOf[Nanoc::Int::Dependency]
+    C_OBJ_SRC = Nanoc::Int::Item
+    C_OBJ_DST = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::IdentifiableCollection]
+
+    contract C_OBJ_SRC => C::ArrayOf[Nanoc::Int::Dependency]
     def dependencies_causing_outdatedness_of(object)
       objects_causing_outdatedness_of(object).map do |other_object|
         props = props_for(other_object, object)
@@ -46,11 +50,21 @@ module Nanoc::Int
     def items=(items)
       @items = items
       items.each { |o| @refs2objs[obj2ref(o)] = o }
+      add_vertex_for(items)
     end
 
     def layouts=(layouts)
       @layouts = layouts
       layouts.each { |o| @refs2objs[obj2ref(o)] = o }
+      add_vertex_for(layouts)
+    end
+
+    def new_items
+      @new_objects.select { |o| o.is_a?(Nanoc::Int::Item) }
+    end
+
+    def new_layouts
+      @new_objects.select { |o| o.is_a?(Nanoc::Int::Layout) }
     end
 
     # Returns the direct dependencies for the given object.
@@ -71,15 +85,14 @@ module Nanoc::Int
     # predecessors of
     #   the given object
     def objects_causing_outdatedness_of(object)
-      if @new_objects.any?
-        [@new_objects.first]
-      else
-        refs2objs(@graph.direct_predecessors_of(obj2ref(object)))
-      end
+      refs2objs(@graph.direct_predecessors_of(obj2ref(object)))
     end
 
+    C_RAW_CONTENT = C::Or[C::IterOf[C::Or[String, Regexp]], C::Bool]
     C_ATTR = C::Or[C::IterOf[Symbol], C::Bool]
-    contract C::Maybe[C_OBJ], C::Maybe[C_OBJ], C::KeywordArgs[raw_content: C::Optional[C::Bool], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]] => C::Any
+    C_KEYWORD_PROPS = C::KeywordArgs[raw_content: C::Optional[C_RAW_CONTENT], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]]
+
+    contract C::Maybe[C_OBJ_SRC], C::Maybe[C_OBJ_DST], C_KEYWORD_PROPS => C::Any
     # Records a dependency from `src` to `dst` in the dependency graph. When
     # `dst` is oudated, `src` will also become outdated.
     #
@@ -92,7 +105,7 @@ module Nanoc::Int
     #
     # @return [void]
     def record_dependency(src, dst, raw_content: false, attributes: false, compiled_content: false, path: false)
-      # TODO: do src == dst check first (faster)
+      return if src == dst
 
       add_vertex_for(src)
       add_vertex_for(dst)
@@ -104,7 +117,7 @@ module Nanoc::Int
       new_props = Nanoc::Int::Props.new(raw_content: raw_content, attributes: attributes, compiled_content: compiled_content, path: path)
       props = existing_props.merge(new_props)
 
-      @graph.add_edge(dst_ref, src_ref, props: props.to_h) unless src == dst
+      @graph.add_edge(dst_ref, src_ref, props: props.to_h)
     end
 
     def add_vertex_for(o)

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

@@ -5,9 +5,10 @@ module Nanoc::Int
   class DependencyTracker
     include Nanoc::Int::ContractsSupport
 
-    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration]
+    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::IdentifiableCollection]
+    C_RAW_CONTENT = C::Or[C::IterOf[C::Or[String, Regexp]], C::Bool]
     C_ATTR = C::Or[C::IterOf[Symbol], C::Bool]
-    C_ARGS = C::KeywordArgs[raw_content: C::Optional[C::Bool], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]]
+    C_ARGS = C::KeywordArgs[raw_content: C::Optional[C_RAW_CONTENT], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]]
 
     class Null
       include Nanoc::Int::ContractsSupport

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

@@ -35,7 +35,17 @@ module Nanoc::Int
           Rules::AttributesModified,
         ].freeze
 
-      C_OBJ_MAYBE_REP = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Configuration, Nanoc::Int::Layout]
+      RULES_FOR_ITEM_COLLECTION =
+        [
+          Rules::ItemCollectionExtended,
+        ].freeze
+
+      RULES_FOR_LAYOUT_COLLECTION =
+        [
+          Rules::LayoutCollectionExtended,
+        ].freeze
+
+      C_OBJ_MAYBE_REP = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Configuration, Nanoc::Int::Layout, Nanoc::Int::ItemCollection, Nanoc::Int::LayoutCollection]
 
       contract C::KeywordArgs[outdatedness_checker: OutdatednessChecker, reps: Nanoc::Int::ItemRepRepo] => C::Any
       def initialize(outdatedness_checker:, reps:)
@@ -54,6 +64,10 @@ module Nanoc::Int
           apply_rules(RULES_FOR_LAYOUT, obj)
         when Nanoc::Int::Configuration
           apply_rules(RULES_FOR_CONFIG, obj)
+        when Nanoc::Int::ItemCollection
+          apply_rules(RULES_FOR_ITEM_COLLECTION, obj)
+        when Nanoc::Int::LayoutCollection
+          apply_rules(RULES_FOR_LAYOUT_COLLECTION, obj)
         else
           raise Nanoc::Int::Errors::InternalInconsistency, "do not know how to check outdatedness of #{obj.inspect}"
         end
@@ -96,7 +110,8 @@ module Nanoc::Int
 
     Reasons = Nanoc::Int::OutdatednessReasons
 
-    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Configuration, Nanoc::Int::Layout]
+    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Configuration, Nanoc::Int::Layout, Nanoc::Int::ItemCollection]
+    C_ITEM_OR_REP = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep]
     C_ACTION_SEQUENCES = C::HashOf[C_OBJ => Nanoc::Int::ActionSequence]
 
     contract C::KeywordArgs[site: Nanoc::Int::Site, checksum_store: Nanoc::Int::ChecksumStore, checksums: Nanoc::Int::ChecksumCollection, dependency_store: Nanoc::Int::DependencyStore, action_sequence_store: Nanoc::Int::ActionSequenceStore, action_sequences: C_ACTION_SEQUENCES, reps: Nanoc::Int::ItemRepRepo] => C::Any
@@ -140,7 +155,7 @@ module Nanoc::Int
       @_basic ||= Basic.new(outdatedness_checker: self, reps: @reps)
     end
 
-    contract C_OBJ, Hamster::Set => C::Bool
+    contract C_ITEM_OR_REP, Hamster::Set => C::Bool
     def outdated_due_to_dependencies?(obj, processed = Hamster::Set.new)
       # Convert from rep to item if necessary
       obj = obj.item if obj.is_a?(Nanoc::Int::ItemRep)
@@ -176,19 +191,27 @@ module Nanoc::Int
       status = basic.outdatedness_status_for(dependency.from)
 
       active = status.props.active & dependency.props.active
-      if attributes_unaffected?(status, dependency)
-        active.delete(:attributes)
-      end
+      active.delete(:attributes) if attributes_unaffected?(status, dependency)
+      active.delete(:raw_content) if raw_content_unaffected?(status, dependency)
 
       active.any?
     end
 
     def attributes_unaffected?(status, dependency)
-      attr_reason = status.reasons.find do |r|
-        r.is_a?(Nanoc::Int::OutdatednessReasons::AttributesModified)
-      end
+      reason = status.reasons.find { |r| r.is_a?(Nanoc::Int::OutdatednessReasons::AttributesModified) }
+      reason && dependency.props.attributes.is_a?(Enumerable) && (dependency.props.attributes & reason.attributes).empty?
+    end
 
-      attr_reason && dependency.props.attributes.is_a?(Enumerable) && (dependency.props.attributes & attr_reason.attributes).empty?
+    def raw_content_unaffected?(status, dependency)
+      reason = status.reasons.find { |r| r.is_a?(Nanoc::Int::OutdatednessReasons::DocumentCollectionExtended) }
+      if reason.nil?
+        false
+      elsif !dependency.props.raw_content.is_a?(Enumerable)
+        false
+      else
+        patterns = dependency.props.raw_content.map { |r| Nanoc::Int::Pattern.from(r) }
+        patterns.none? { |pat| reason.objects.any? { |obj| pat.match?(obj.identifier) } }
+      end
     end
   end
 end