nanoc 4.1.6 → 4.2.0b1

data/lib/nanoc/base/entities.rb

@@ -1,5 +1,6 @@
 require_relative 'entities/code_snippet'
 require_relative 'entities/configuration'
+require_relative 'entities/lazy_value'
 require_relative 'entities/content'
 require_relative 'entities/document'
 require_relative 'entities/identifier'

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

@@ -27,7 +27,7 @@ module Nanoc
         @filename.freeze
       end
 
-      # @param [String] content The uncompiled item content (if it is textual
+      # @param [String, Proc] content The uncompiled item content (if it is textual
       #   content) or the path to the filename containing the content (if this
       #   is binary content).
       #
@@ -58,11 +58,13 @@ module Nanoc
     # @api private
     class TextualContent < Content
       # @return [String]
-      attr_reader :string
+      def string
+        @string.value
+      end
 
       def initialize(string, filename: nil)
         super(filename)
-        @string = string
+        @string = Nanoc::Int::LazyValue.new(string)
       end
 
       def freeze
@@ -73,6 +75,15 @@ module Nanoc
       def binary?
         false
       end
+
+      def marshal_dump
+        [filename, string]
+      end
+
+      def marshal_load(array)
+        @filename = array[0]
+        @string = Nanoc::Int::LazyValue.new(array[1])
+      end
     end
 
     # @api private

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

@@ -6,27 +6,35 @@ module Nanoc
       attr_reader :content
 
       # @return [Hash]
-      attr_reader :attributes
+      def attributes
+        @attributes.value
+      end
 
       # @return [Nanoc::Identifier]
       attr_accessor :identifier
 
+      # @return [String, nil]
+      attr_accessor :checksum_data
+
       # @param [String, Nanoc::Int::Content] content
       #
-      # @param [Hash] attributes
+      # @param [Hash, Proc] attributes
       #
       # @param [String, Nanoc::Identifier] identifier
-      def initialize(content, attributes, identifier)
+      #
+      # @param [String, nil] checksum_data Used to determine whether the document has changed
+      def initialize(content, attributes, identifier, checksum_data: nil)
         @content = Nanoc::Int::Content.create(content)
-        @attributes = attributes.__nanoc_symbolize_keys_recursively
+        @attributes = Nanoc::Int::LazyValue.new(attributes).map(&:__nanoc_symbolize_keys_recursively)
         @identifier = Nanoc::Identifier.from(identifier)
+        @checksum_data = checksum_data
       end
 
       # @return [void]
       def freeze
         super
-        attributes.__nanoc_freeze_recursively
-        content.freeze
+        @content.freeze
+        @attributes.freeze
       end
 
       # @abstract

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

@@ -1,13 +1,6 @@
 module Nanoc::Int
   # @api private
   class Item < ::Nanoc::Int::Document
-    # @see Document#initialize
-    def initialize(content, attributes, identifier)
-      super
-
-      @forced_outdated_status = ForcedOutdatedStatus.new
-    end
-
     # Returns an object that can be used for uniquely identifying objects.
     #
     # @api private
@@ -16,29 +9,5 @@ module Nanoc::Int
     def reference
       [:item, identifier.to_s]
     end
-
-    # Hack to allow a frozen item to still have modifiable frozen status.
-    #
-    # FIXME: Remove this.
-    class ForcedOutdatedStatus
-      attr_accessor :bool
-
-      def initialize
-        @bool = false
-      end
-
-      def freeze
-      end
-    end
-
-    # @api private
-    def forced_outdated=(bool)
-      @forced_outdated_status.bool = bool
-    end
-
-    # @api private
-    def forced_outdated?
-      @forced_outdated_status.bool
-    end
   end
 end

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

@@ -1,7 +1,7 @@
 module Nanoc::Int
   # @api private
   class ItemRep
-    # @return [Hash<Symbol,Nanoc::Int::Content]
+    # @return [Hash<Symbol,Nanoc::Int::Content>]
     attr_accessor :snapshot_contents
 
     # @return [Boolean]

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

@@ -0,0 +1,36 @@
+module Nanoc::Int
+  # Holds a value that might be generated lazily.
+  #
+  # @api private
+  class LazyValue
+    # @param [Object, Proc] value_or_proc A value or a proc to generate the value
+    def initialize(value_or_proc)
+      @value = { raw: value_or_proc }
+    end
+
+    # @return [Object] The value, generated when needed
+    def value
+      if @value.key?(:raw)
+        value = @value.delete(:raw)
+        @value[:final] = value.respond_to?(:call) ? value.call : value
+        @value.__nanoc_freeze_recursively if frozen?
+      end
+      @value[:final]
+    end
+
+    # Returns a new lazy value that will apply the given transformation when the value is requested.
+    #
+    # @yield resolved value
+    #
+    # @return [Nanoc::Int::LazyValue]
+    def map
+      Nanoc::Int::LazyValue.new(-> { yield(value) })
+    end
+
+    # @return [void]
+    def freeze
+      super
+      @value.__nanoc_freeze_recursively unless @value[:raw]
+    end
+  end
+end

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

@@ -29,13 +29,14 @@ module Nanoc::Int
 
   # @api private
   class StringPattern
+    MATCH_OPTS = File::FNM_PATHNAME | File::FNM_EXTGLOB
+
     def initialize(string)
       @string = string
     end
 
     def match?(identifier)
-      opts = File::FNM_PATHNAME | File::FNM_EXTGLOB
-      File.fnmatch(@string, identifier.to_s, opts)
+      File.fnmatch(@string, identifier.to_s, MATCH_OPTS)
     end
 
     def captures(_identifier)

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

@@ -1,6 +1,8 @@
 module Nanoc::Int
   # @api private
   class Site
+    attr_accessor :compiler
+
     # @param [Nanoc::Int::Configuration] config
     # @param [Enumerable<Nanoc::Int::CodeSnippet>] code_snippets
     # @param [Enumerable<Nanoc::Int::Item>] items

data/lib/nanoc/base/memoization.rb

@@ -1,3 +1,5 @@
+require 'weakref'
+
 module Nanoc::Int
   # Adds support for memoizing functions.
   #
@@ -5,6 +7,14 @@ module Nanoc::Int
   #
   # @since 3.2.0
   module Memoization
+    class Wrapper
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+    end
+
     # Memoizes the method with the given name. The modified method will cache
     # the results of the original method, so that calling a method twice with
     # the same arguments will short-circuit and return the cached results
@@ -39,24 +49,21 @@ module Nanoc::Int
     #
     # @return [void]
     def memoize(method_name)
-      # Alias
       original_method_name = '__nonmemoized_' + method_name.to_s
       alias_method original_method_name, method_name
 
-      # Redefine
       define_method(method_name) do |*args|
-        # Get cache
         @__memoization_cache ||= {}
         @__memoization_cache[method_name] ||= {}
+        method_cache = @__memoization_cache[method_name]
 
-        # Recalculate if necessary
-        unless @__memoization_cache[method_name].key?(args)
-          result = send(original_method_name, *args)
-          @__memoization_cache[method_name][args] = result
+        if method_cache.key?(args) && method_cache[args].weakref_alive?
+          method_cache[args].value
+        else
+          send(original_method_name, *args).tap do |r|
+            method_cache[args] = WeakRef.new(Wrapper.new(r))
+          end
         end
-
-        # Done
-        @__memoization_cache[method_name][args]
       end
     end
   end

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

@@ -5,7 +5,7 @@ module Nanoc::Int
   # @api private
   class CompiledContentCache < ::Nanoc::Int::Store
     def initialize
-      super('tmp/compiled_content', 1)
+      super('tmp/compiled_content', 2)
 
       @cache = {}
     end

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

@@ -130,18 +130,20 @@ module Nanoc
     # Creates a new in-memory item instance. This is intended for use within
     # the {#items} method.
     #
-    # @param [String] content The uncompiled item content
+    # @param [String, Proc] content The uncompiled item content
     #   (if it is a textual item) or the path to the filename containing the
     #   content (if it is a binary item).
     #
-    # @param [Hash] attributes A hash containing this item's attributes.
+    # @param [Hash, Proc] attributes A hash containing this item's attributes.
     #
     # @param [String] identifier This item's identifier.
     #
     # @param [Boolean] binary Whether or not this item is binary
-    def new_item(content, attributes, identifier, binary: false)
+    #
+    # @param [String, nil] checksum_data Used to determine whether the item has changed
+    def new_item(content, attributes, identifier, binary: false, checksum_data: nil)
       content = Nanoc::Int::Content.create(content, binary: binary)
-      Nanoc::Int::Item.new(content, attributes, identifier)
+      Nanoc::Int::Item.new(content, attributes, identifier, checksum_data: checksum_data)
     end
 
     # Creates a new in-memory layout instance. This is intended for use within
@@ -152,8 +154,10 @@ module Nanoc
     # @param [Hash] attributes A hash containing this layout's attributes.
     #
     # @param [String] identifier This layout's identifier.
-    def new_layout(raw_content, attributes, identifier)
-      Nanoc::Int::Layout.new(raw_content, attributes, identifier)
+    #
+    # @param [String, nil] checksum_data Used to determine whether the layout has changed
+    def new_layout(raw_content, attributes, identifier, checksum_data: nil)
+      Nanoc::Int::Layout.new(raw_content, attributes, identifier, checksum_data: checksum_data)
     end
   end
 end

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

@@ -7,49 +7,36 @@ module Nanoc
         end
       end
 
-      def initialize(compiler)
+      def initialize(compiler, dependency_tracker)
         @compiler = compiler
+        @dependency_tracker = dependency_tracker
       end
 
       def filter(rep, filter_name, filter_args = {})
-        # Get filter class
-        klass = Nanoc::Filter.named(filter_name)
-        raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
-
-        # Check whether filter can be applied
-        if klass.from_binary? && !rep.binary?
-          raise Nanoc::Int::Errors::CannotUseBinaryFilter.new(rep, klass)
-        elsif !klass.from_binary? && rep.binary?
-          raise Nanoc::Int::Errors::CannotUseTextualFilter.new(rep, klass)
-        end
+        filter = filter_for_filtering(rep, filter_name)
 
         begin
-          # Notify start
           Nanoc::Int::NotificationCenter.post(:filtering_started, rep, filter_name)
 
-          # Create filter
-          filter = klass.new(assigns_for(rep))
-
           # Run filter
           last = rep.snapshot_contents[:last]
           source = rep.binary? ? last.filename : last.string
           result = filter.setup_and_run(source, filter_args)
           rep.snapshot_contents[:last] =
-            if klass.to_binary?
+            if filter.class.to_binary?
               Nanoc::Int::BinaryContent.new(filter.output_filename).tap(&:freeze)
             else
               Nanoc::Int::TextualContent.new(result).tap(&:freeze)
             end
 
           # Check whether file was written
-          if klass.to_binary? && !File.file?(filter.output_filename)
+          if filter.class.to_binary? && !File.file?(filter.output_filename)
             raise OutputNotWrittenError.new(filter_name, filter.output_filename)
           end
 
           # Create snapshot
           snapshot(rep, rep.snapshot_contents[:post] ? :post : :pre, final: false) unless rep.binary?
         ensure
-          # Notify end
           Nanoc::Int::NotificationCenter.post(:filtering_ended, rep, filter_name)
         end
       end
@@ -73,12 +60,12 @@ module Nanoc
         # Create filter
         klass = Nanoc::Filter.named(filter_name)
         raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
-        layout_view = Nanoc::LayoutView.new(layout, nil)
+        view_context = @compiler.create_view_context(@dependency_tracker)
+        layout_view = Nanoc::LayoutView.new(layout, view_context)
         filter = klass.new(assigns_for(rep).merge({ layout: layout_view }))
 
         # Visit
-        Nanoc::Int::NotificationCenter.post(:visit_started, layout)
-        Nanoc::Int::NotificationCenter.post(:visit_ended,   layout)
+        @dependency_tracker.bounce(layout)
 
         begin
           # Notify start
@@ -120,7 +107,7 @@ module Nanoc
       end
 
       def assigns_for(rep)
-        @compiler.assigns_for(rep)
+        @compiler.assigns_for(rep, @dependency_tracker)
       end
 
       def layouts
@@ -141,6 +128,19 @@ module Nanoc
         raise Nanoc::Int::Errors::UnknownLayout.new(arg)
       end
 
+      def filter_for_filtering(rep, filter_name)
+        klass = Nanoc::Filter.named(filter_name)
+        raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
+
+        if klass.from_binary? && !rep.binary?
+          raise Nanoc::Int::Errors::CannotUseBinaryFilter.new(rep, klass)
+        elsif !klass.from_binary? && rep.binary?
+          raise Nanoc::Int::Errors::CannotUseTextualFilter.new(rep, klass)
+        end
+
+        klass.new(assigns_for(rep))
+      end
+
       def use_globs?
         @compiler.site.config[:string_pattern_type] == 'glob'
       end

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

@@ -28,7 +28,6 @@ module Nanoc::Int
     def route_rep(rep, snapshot_action, paths_to_reps)
       basic_path = snapshot_action.path
       return if basic_path.nil?
-      basic_path = basic_path.encode('UTF-8')
 
       # Check for duplicate paths
       if paths_to_reps.key?(basic_path)
@@ -43,10 +42,10 @@ module Nanoc::Int
 
     def strip_index_filename(basic_path)
       @site.config[:index_filenames].each do |index_filename|
-        slashed_index_filename = '/' + index_filename
-        if basic_path.end_with?(slashed_index_filename)
-          return basic_path[0..-index_filename.length - 1]
-        end
+        rep_path_ending = basic_path[-index_filename.length..-1]
+        next unless rep_path_ending == index_filename
+
+        return basic_path[0..-index_filename.length - 1]
       end
 
       basic_path

data/lib/nanoc/base/views.rb

@@ -21,7 +21,6 @@ require_relative 'views/mutable_item_view'
 require_relative 'views/mutable_item_collection_view'
 require_relative 'views/mutable_layout_view'
 require_relative 'views/mutable_layout_collection_view'
-require_relative 'views/site_view'
 
 require_relative 'views/post_compile_item_view'
 require_relative 'views/post_compile_item_collection_view'

data/lib/nanoc/base/views/item_rep_view.rb

@@ -36,9 +36,7 @@ module Nanoc
     #
     # @return [String] The content at the given snapshot.
     def compiled_content(snapshot: nil)
-      Nanoc::Int::NotificationCenter.post(:visit_started, unwrap.item)
-      Nanoc::Int::NotificationCenter.post(:visit_ended,   unwrap.item)
-
+      @context.dependency_tracker.bounce(unwrap.item)
       @item_rep.compiled_content(snapshot: snapshot)
     end
 
@@ -52,9 +50,7 @@ module Nanoc
     #
     # @return [String] The item rep’s path.
     def path(snapshot: :last)
-      Nanoc::Int::NotificationCenter.post(:visit_started, unwrap.item)
-      Nanoc::Int::NotificationCenter.post(:visit_ended,   unwrap.item)
-
+      @context.dependency_tracker.bounce(unwrap.item)
       @item_rep.path(snapshot: snapshot)
     end
 
@@ -67,9 +63,7 @@ module Nanoc
 
     # @api private
     def raw_path(snapshot: :last)
-      Nanoc::Int::NotificationCenter.post(:visit_started, unwrap.item)
-      Nanoc::Int::NotificationCenter.post(:visit_ended,   unwrap.item)
-
+      @context.dependency_tracker.bounce(unwrap.item)
       @item_rep.raw_path(snapshot: snapshot)
     end