nanoc 4.1.6 → 4.2.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f6ba850197dc445a7c7ff2155f172cf559429e4
-  data.tar.gz: 6ffcc91296268720adf1290c403b41d73c0fc762
+  metadata.gz: cc5bddbd9c1b7b365b227cd69def799b2a8da4a2
+  data.tar.gz: 1da63342f4909056377af782094d03c3293ca75f
 SHA512:
-  metadata.gz: 6d87f9120c1c06ef221dc59d7b33a5c5d05deeedb008927232420d0a466a96b37048f25c706d389d393905b46b7bcd19f8487d8818db881d0d100d89b9443a5d
-  data.tar.gz: f4da8a98b02735de58c7d7c57a09ea3f49af3323cb887e31112c5019dd5245ef686949a12540eb8ff469c0cb8544515544a881a53dd12505c0ad2da663c77e1a
+  metadata.gz: de802f2ea52c8b4ee7e9d72bfeffb4870f09b83b6d0edf64fd35508092eb74104b76201754f88382ffcbbab1458af520071e5e77d02b100cb5f76cf62f2ab13c
+  data.tar.gz: d6f3d7751f3c8d0d8f95d7913cb7df7ebf972a47dbe1ad35a91d4d4491cf30919311011846e420c49fb8b9b559bca7f90c18442aa80021d929efa717ed62a7b7

data/Gemfile

@@ -11,6 +11,7 @@ group :devel do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec'
+  gem 'rspec-mocks'
   gem 'rubocop'
   gem 'simplecov', require: false
   gem 'vcr'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (4.1.6)
+    nanoc (4.2.0b1)
       cri (~> 2.3)
 
 GEM
@@ -361,6 +361,7 @@ DEPENDENCIES
   redcarpet
   rouge
   rspec
+  rspec-mocks
   rubocop
   rubypants
   sass

data/NEWS.md

@@ -1,11 +1,18 @@
 # Nanoc news
 
-## 4.1.6 (2016-04-17)
+## 4.2.0b1 (2016-04-17)
 
-Fixes:
+Features:
+
+* Allow creating items and layouts with a pre-calculated checksum (#793) [Ruben Verborgh]
+* Allow lazy-loading item/layout content and attributes (#794) [Ruben Verborgh]
+* Added `exclude_origins` configuration option to internal links checker (#847)
+* Added `ChildParent` helper, providing `#children_of` and `#parent_of` (#849)
+
+Enhancements:
 
-* Strip index.html only if it is a full component (#850, #851)
-* Force UTF-8 for item rep paths (#837, #852)
+* Made `#html_escape` raise an appropriate error when the given argument is not a String (#840) [Micha Rosenbaum]
+* Improved memory usage of memoized values by using weak refs (#846)
 
 ## 4.1.5 (2016-03-24)
 

data/lib/nanoc/base/checksummer.rb

@@ -48,70 +48,159 @@ module Nanoc::Int
 
       def update(obj, digest, visited = Set.new)
         digest.update(obj.class.to_s)
-        digest.update('<')
 
         if visited.include?(obj)
-          digest.update('recur>')
-          return
+          digest.update('<recur>')
+        else
+          digest.update('<')
+          behavior_for(obj).update(obj, digest) { |o| update(o, digest, visited + [obj]) }
+          digest.update('>')
         end
+      end
 
+      def behavior_for(obj)
         case obj
-        when ::String, ::Symbol, ::Numeric
-          digest.update(obj.to_s)
-        when nil, true, false
-        when ::Array, ::Nanoc::Int::IdentifiableCollection
-          obj.each do |el|
-            update(el, digest, visited + [obj])
-            digest.update(',')
-          end
-        when ::Hash, ::Nanoc::Int::Configuration
-          obj.each do |key, value|
-            update(key, digest, visited + [obj])
-            digest.update('=')
-            update(value, digest, visited + [obj])
-            digest.update(',')
-          end
-        when ::Pathname
-          filename = obj.to_s
-          if File.exist?(filename)
-            stat = File.stat(filename)
-            digest.update(stat.size.to_s + '-' + stat.mtime.to_i.to_s)
-          else
-            digest.update('???')
-          end
+        when String, Symbol, Numeric
+          RawUpdateBehavior
+        when Pathname
+          PathnameUpdateBehavior
+        when Nanoc::Int::BinaryContent
+          BinaryContentUpdateBehavior
+        when Array, Nanoc::Int::IdentifiableCollection
+          ArrayUpdateBehavior
+        when Hash, Nanoc::Int::Configuration
+          HashUpdateBehavior
+        when Nanoc::Int::Item, Nanoc::Int::Layout
+          DocumentUpdateBehavior
+        when NilClass, TrueClass, FalseClass
+          NoUpdateBehavior
         when Time
-          digest.update(obj.to_i.to_s)
+          ToIToSUpdateBehavior
         when Nanoc::Identifier
-          update(obj.to_s, digest)
-        # TODO: Use RuleMemory rather than RulesCollection
+          ToSUpdateBehavior
         when Nanoc::RuleDSL::RulesCollection, Nanoc::Int::CodeSnippet
-          update(obj.data, digest)
+          DataUpdateBehavior
         when Nanoc::Int::TextualContent
-          update(obj.string, digest)
-        when Nanoc::Int::BinaryContent
-          update(Pathname.new(obj.filename), digest)
-        when Nanoc::Int::Item, Nanoc::Int::Layout
+          StringUpdateBehavior
+        when Nanoc::View
+          UnwrapUpdateBehavior
+        else
+          RescueUpdateBehavior
+        end
+      end
+    end
+
+    class UpdateBehavior
+      def self.update(_obj, _digest)
+        raise NotImpementedError
+      end
+    end
+
+    class RawUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        digest.update(obj.to_s)
+      end
+    end
+
+    class ToSUpdateBehavior < UpdateBehavior
+      def self.update(obj, _digest)
+        yield(obj.to_s)
+      end
+    end
+
+    class ToIToSUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        digest.update(obj.to_i.to_s)
+      end
+    end
+
+    class StringUpdateBehavior < UpdateBehavior
+      def self.update(obj, _digest)
+        yield(obj.string)
+      end
+    end
+
+    class DataUpdateBehavior < UpdateBehavior
+      def self.update(obj, _digest)
+        yield(obj.data)
+      end
+    end
+
+    class NoUpdateBehavior < UpdateBehavior
+      def self.update(_obj, _digest)
+      end
+    end
+
+    class UnwrapUpdateBehavior < UpdateBehavior
+      def self.update(obj, _digest)
+        yield(obj.unwrap)
+      end
+    end
+
+    class ArrayUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        obj.each do |el|
+          yield(el)
+          digest.update(',')
+        end
+      end
+    end
+
+    class HashUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        obj.each do |key, value|
+          yield(key)
+          digest.update('=')
+          yield(value)
+          digest.update(',')
+        end
+      end
+    end
+
+    class DocumentUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        if obj.checksum_data
+          digest.update('checksum_data=' + obj.checksum_data)
+        else
           digest.update('content=')
-          update(obj.content, digest)
+          yield(obj.content)
 
           digest.update(',attributes=')
-          update(obj.attributes, digest, visited + [obj])
+          yield(obj.attributes)
 
           digest.update(',identifier=')
-          update(obj.identifier, digest)
-        when Nanoc::ItemWithRepsView, Nanoc::ItemWithoutRepsView, Nanoc::LayoutView, Nanoc::ConfigView, Nanoc::IdentifiableCollectionView
-          update(obj.unwrap, digest)
+          yield(obj.identifier)
+        end
+      end
+    end
+
+    class PathnameUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        filename = obj.to_s
+        if File.exist?(filename)
+          stat = File.stat(filename)
+          digest.update(stat.size.to_s + '-' + stat.mtime.to_i.to_s)
         else
-          data = begin
-            Marshal.dump(obj)
-          rescue
-            obj.inspect
-          end
+          digest.update('???')
+        end
+      end
+    end
+
+    class BinaryContentUpdateBehavior < UpdateBehavior
+      def self.update(obj, _digest)
+        yield(Pathname.new(obj.filename))
+      end
+    end
 
-          digest.update(data)
+    class RescueUpdateBehavior < UpdateBehavior
+      def self.update(obj, digest)
+        data = begin
+          Marshal.dump(obj)
+        rescue
+          obj.inspect
         end
 
-        digest.update('>')
+        digest.update(data)
       end
     end
   end

data/lib/nanoc/base/compilation/compiler.rb

@@ -16,18 +16,6 @@ module Nanoc::Int
   #   this item representation (either successfully or with failure). Has one
   #   argument: the item representation itself.
   #
-  # * `visit_started` — indicates that the compiler requires content or
-  #   attributes from the item representation that will be visited. Has one
-  #   argument: the visited item identifier. This notification is used to
-  #   track dependencies of items on other items; a `visit_started` event
-  #   followed by another `visit_started` event indicates that the item
-  #   corresponding to the former event will depend on the item from the
-  #   latter event.
-  #
-  # * `visit_ended` — indicates that the compiler has finished visiting the
-  #   item representation and that the requested attributes or content have
-  #   been fetched (either successfully or with failure)
-  #
   # * `processing_started` — indicates that the compiler has started
   #   processing the specified object, which can be an item representation
   #   (when it is compiled) or a layout (when it is used to lay out an item
@@ -98,10 +86,7 @@ module Nanoc::Int
       forget_dependencies_if_outdated
 
       @stack = []
-      dependency_tracker = Nanoc::Int::DependencyTracker.new(@dependency_store)
-      dependency_tracker.run do
-        compile_reps
-      end
+      compile_reps
       store
     ensure
       Nanoc::Int::TempFilenameFactory.instance.cleanup(
@@ -147,7 +132,7 @@ module Nanoc::Int
     #   operation
     #
     # @api private
-    def assigns_for(rep)
+    def assigns_for(rep, dependency_tracker)
       content_or_filename_assigns =
         if rep.binary?
           { filename: rep.snapshot_contents[:last].filename }
@@ -155,9 +140,8 @@ module Nanoc::Int
           { content: rep.snapshot_contents[:last].string }
         end
 
-      view_context = create_view_context
+      view_context = create_view_context(dependency_tracker)
 
-      # TODO: Do not expose @site (necessary for captures store though…)
       content_or_filename_assigns.merge(
         item: Nanoc::ItemWithRepsView.new(rep.item, view_context),
         rep: Nanoc::ItemRepView.new(rep, view_context),
@@ -165,12 +149,16 @@ module Nanoc::Int
         items: Nanoc::ItemCollectionWithRepsView.new(site.items, view_context),
         layouts: Nanoc::LayoutCollectionView.new(site.layouts, view_context),
         config: Nanoc::ConfigView.new(site.config, view_context),
-        site: Nanoc::SiteView.new(site, view_context),
       )
     end
 
-    def create_view_context
-      Nanoc::ViewContext.new(reps: @reps, items: @site.items)
+    def create_view_context(dependency_tracker)
+      Nanoc::ViewContext.new(
+        reps: @reps,
+        items: @site.items,
+        dependency_tracker: dependency_tracker,
+        compiler: self,
+      )
     end
 
     # @api private
@@ -216,15 +204,17 @@ module Nanoc::Int
     #
     # @return [void]
     def compile_rep(rep)
+      dependency_tracker = Nanoc::Int::DependencyTracker.new(@dependency_store)
+
       Nanoc::Int::NotificationCenter.post(:compilation_started, rep)
       Nanoc::Int::NotificationCenter.post(:processing_started,  rep)
-      Nanoc::Int::NotificationCenter.post(:visit_started,       rep.item)
+      dependency_tracker.enter(rep.item)
 
       if can_reuse_content_for_rep?(rep)
         Nanoc::Int::NotificationCenter.post(:cached_content_used, rep)
         rep.snapshot_contents = compiled_content_cache[rep]
       else
-        recalculate_content_for_rep(rep)
+        recalculate_content_for_rep(rep, dependency_tracker)
       end
 
       rep.compiled = true
@@ -237,17 +227,17 @@ module Nanoc::Int
       Nanoc::Int::NotificationCenter.post(:compilation_failed, rep, e)
       raise e
     ensure
-      Nanoc::Int::NotificationCenter.post(:visit_ended, rep.item)
+      dependency_tracker.exit(rep.item)
     end
 
     # @return [Boolean]
     def can_reuse_content_for_rep?(rep)
-      !rep.item.forced_outdated? && !outdatedness_checker.outdated?(rep) && compiled_content_cache[rep]
+      !outdatedness_checker.outdated?(rep) && compiled_content_cache[rep]
     end
 
     # @return [void]
-    def recalculate_content_for_rep(rep)
-      executor = Nanoc::Int::Executor.new(self)
+    def recalculate_content_for_rep(rep, dependency_tracker)
+      executor = Nanoc::Int::Executor.new(self, dependency_tracker)
 
       action_provider.memory_for(rep).each do |action|
         case action

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

@@ -1,48 +1,38 @@
 module Nanoc::Int
   # @api private
   class DependencyTracker
-    def initialize(dependency_store)
-      @dependency_store = dependency_store
-    end
+    class Null
+      def enter(_obj)
+      end
 
-    # Record dependencies for the duration of the block.
-    #
-    # @return [void]
-    def run
-      unless block_given?
-        raise ArgumentError, 'No block given'
+      def exit(_obj)
       end
 
-      stack = []
-      start_tracking(stack)
-      yield
-    ensure
-      stop_tracking(stack)
+      def bounce(_obj)
+      end
     end
 
-    # @api private
-    def start_tracking(stack)
-      Nanoc::Int::NotificationCenter.on(:visit_started, self) do |obj|
-        unless stack.empty?
-          Nanoc::Int::NotificationCenter.post(:dependency_created, stack.last, obj)
-          @dependency_store.record_dependency(stack.last, obj)
-        end
-        stack.push(obj)
-      end
+    def initialize(dependency_store)
+      @dependency_store = dependency_store
+      @stack = []
+    end
 
-      Nanoc::Int::NotificationCenter.on(:visit_ended, self) do |_obj|
-        stack.pop
+    def enter(obj)
+      unless @stack.empty?
+        Nanoc::Int::NotificationCenter.post(:dependency_created, @stack.last, obj)
+        @dependency_store.record_dependency(@stack.last, obj)
       end
+
+      @stack.push(obj)
     end
 
-    # @api private
-    def stop_tracking(stack)
-      unless stack.empty?
-        raise 'Internal inconsistency: dependency tracker stack not empty at end of compilation'
-      end
+    def exit(_obj)
+      @stack.pop
+    end
 
-      Nanoc::Int::NotificationCenter.remove(:visit_started, self)
-      Nanoc::Int::NotificationCenter.remove(:visit_ended,   self)
+    def bounce(obj)
+      enter(obj)
+      exit(obj)
     end
   end
 end

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

@@ -187,10 +187,8 @@ module Nanoc
       items = items.map { |i| i.is_a?(Nanoc::ItemWithRepsView) ? i.unwrap : i }
 
       # Notify
-      items.each do |item|
-        Nanoc::Int::NotificationCenter.post(:visit_started, item)
-        Nanoc::Int::NotificationCenter.post(:visit_ended,   item)
-      end
+      dependency_tracker = @assigns[:item]._context.dependency_tracker
+      items.each { |item| dependency_tracker.bounce(item) }
 
       # Raise unmet dependency error if necessary
       items.each do |item|