nanoc3 3.2.0a3 → 3.2.0a4

data/lib/nanoc3/base/result_data/item_rep.rb

@@ -132,7 +132,7 @@ module Nanoc3
 
         # Calculate characteristics of old content
         if File.file?(raw_path)
-          hash_old = Nanoc3::Checksummer.checksum_for_file(raw_path)
+          hash_old = Pathname.new(raw_path).checksum
           size_old = File.size(raw_path)
         end
 
@@ -142,7 +142,7 @@ module Nanoc3
         if self.binary?
           # Calculate characteristics of new content
           size_new = File.size(temporary_filenames[:last])
-          hash_new = Nanoc3::Checksummer.checksum_for_file(temporary_filenames[:last]) if size_old == size_new
+          hash_new = Pathname.new(temporary_filenames[:last]).checksum if size_old == size_new
 
           # Check whether content was modified
           is_modified = (size_old != size_new || hash_old != hash_new)
@@ -263,6 +263,8 @@ module Nanoc3
     #
     # @return [Boolean] True if content exists for the snapshot with the
     #   given name, false otherwise
+    #
+    # @since 3.2.0
     def has_snapshot?(snapshot_name)
       !@content[snapshot_name].nil?
     end
@@ -321,33 +323,36 @@ module Nanoc3
         raise Nanoc3::Errors::CannotUseTextualFilter.new(self, klass)
       end
 
-      # Notify start
-      Nanoc3::NotificationCenter.post(:filtering_started, self, filter_name)
+      begin
+        # Notify start
+        Nanoc3::NotificationCenter.post(:filtering_started, self, filter_name)
 
-      # Create filter
-      filter = klass.new(assigns)
+        # Create filter
+        filter = klass.new(assigns)
 
-      # Run filter
-      source = self.binary? ? temporary_filenames[:last] : @content[:last]
-      result = filter.run(source, filter_args)
-      if klass.to_binary?
-        temporary_filenames[:last] = filter.output_filename
-      else
-        @content[:last] = result
-      end
-      @binary = klass.to_binary?
+        # Run filter
+        source = self.binary? ? temporary_filenames[:last] : @content[:last]
+        result = filter.run(source, filter_args)
+        if klass.to_binary?
+          temporary_filenames[:last] = filter.output_filename
+        else
+          @content[:last] = result
+          @content[:last].freeze
+        end
+        @binary = klass.to_binary?
 
-      # Check whether file was written
-      if self.binary? && !File.file?(filter.output_filename)
-        raise RuntimeError,
-          "The #{filter_name.inspect} filter did not write anything to the required output file, #{filter.output_filename}."
-      end
+        # Check whether file was written
+        if self.binary? && !File.file?(filter.output_filename)
+          raise RuntimeError,
+            "The #{filter_name.inspect} filter did not write anything to the required output file, #{filter.output_filename}."
+        end
 
-      # Create snapshot
-      snapshot(@content[:post] ? :post : :pre, :final => false) unless self.binary?
-    ensure
-      # Notify end
-      Nanoc3::NotificationCenter.post(:filtering_ended, self, filter_name)
+        # Create snapshot
+        snapshot(@content[:post] ? :post : :pre, :final => false) unless self.binary?
+      ensure
+        # Notify end
+        Nanoc3::NotificationCenter.post(:filtering_ended, self, filter_name)
+      end
     end
 
     # Lays out the item using the given layout. This method will replace the
@@ -421,6 +426,39 @@ module Nanoc3
       write(snapshot_name) if params[:final]
     end
 
+    # Returns a recording proxy that is used for determining whether the
+    # compilation has changed, and thus whether the item rep needs to be
+    # recompiled.
+    #
+    # @api private
+    #
+    # @return [Nanoc3::ItemRepRecorderProxy] The recording proxy
+    def to_recording_proxy
+      Nanoc3::ItemRepRecorderProxy.new(self)
+    end
+
+    # Returns false because this item is not yet a proxy, and therefore does
+    # need to be wrapped in a proxy during compilation.
+    #
+    # @api private
+    #
+    # @return [false]
+    #
+    # @see Nanoc3::ItemRepRecorderProxy#is_proxy?
+    # @see Nanoc3::ItemRepProxy#is_proxy?
+    def is_proxy?
+      false
+    end
+
+    # Returns an object that can be used for uniquely identifying objects.
+    #
+    # @api private
+    #
+    # @return [Object] An unique reference to this object
+    def reference
+      [ type, self.item.identifier, self.name ]
+    end
+
     def inspect
       "<#{self.class}:0x#{self.object_id.to_s(16)} name=#{self.name} binary=#{self.binary?} raw_path=#{self.raw_path} item.identifier=#{self.item.identifier}>"
     end
@@ -434,6 +472,7 @@ module Nanoc3
         @content             = {}
       else
         @content             = { :last => @item.raw_content }
+        @content[:last].freeze
         @temporary_filenames = {}
       end
     end

data/lib/nanoc3/base/source_data/code_snippet.rb

@@ -43,6 +43,15 @@ module Nanoc3
       [ :code_snippet, filename ]
     end
 
+    def inspect
+      "<#{self.class}:0x#{self.object_id.to_s(16)} filename=#{self.filename}>"
+    end
+
+    # TODO document
+    def checksum
+      @data.checksum
+    end
+
   end
 
 end

data/lib/nanoc3/base/source_data/configuration.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # TODO document
+  class Configuration < ::Hash
+
+    # TODO document
+    def initialize(hash)
+      self.replace(hash)
+    end
+
+    # TODO document
+    def reference
+      :config
+    end
+
+  end
+
+end

data/lib/nanoc3/base/source_data/item.rb

@@ -7,6 +7,8 @@ module Nanoc3
   # store the modification time to speed up compilation.
   class Item
 
+    extend Nanoc3::Memoization
+
     # @return [Hash] This item's attributes
     attr_accessor :attributes
 
@@ -78,10 +80,10 @@ module Nanoc3
 
       # Get rest of params
       @attributes   = attributes.symbolize_keys
-      @identifier   = identifier.cleaned_identifier
+      @identifier   = identifier.cleaned_identifier.freeze
 
       # Set mtime
-      @attributes.merge(:mtime => params[:mtime]) if params[:mtime]
+      @attributes.merge!(:mtime => params[:mtime]) if params[:mtime]
 
       @parent       = nil
       @children     = []
@@ -164,6 +166,12 @@ module Nanoc3
       # Get captured content (hax)
       # TODO [in nanoc 4.0] remove me
       if key.to_s =~ /^content_for_(.*)$/
+        # Warn
+        unless @_content_for_warning_issued
+          warn 'WARNING: Accessing captured content should happen using the #content_for method defined in the Capturing helper instead of using item[:content_for_something]. The latter way of accessing captured content will be removed in nanoc 4.0.'
+          @_content_for_warning_issued = true
+        end
+
         # Include capturing helper if necessary
         unless @_Nanoc3_Helpers_Capturing_included
           self.class.send(:include, ::Nanoc3::Helpers::Capturing)
@@ -210,16 +218,33 @@ module Nanoc3
       [ type, self.identifier ]
     end
 
-    # Prevents all further modifications to itself, its items, its layouts etc.
+    # Prevents all further modifications to its attributes.
     #
     # @return [void]
     def freeze
-      attributes.freeze
+      attributes.freeze_recursively
+      children.freeze
+      identifier.freeze
+      raw_filename.freeze if raw_filename
+      raw_content.freeze  if raw_content
     end
+
     def inspect
       "<#{self.class}:0x#{self.object_id.to_s(16)} identifier=#{self.identifier} binary?=#{self.binary?}>"
     end
 
+    # TODO document
+    def checksum
+      if binary?
+        Pathname.new(raw_filename).checksum
+      else
+        attributes = @attributes.dup
+        attributes.delete(:file)
+        @raw_content.checksum + ',' + attributes.checksum
+      end
+    end
+    memoize :checksum
+
     # @deprecated Access the modification time using `item[:mtime]` instead.
     def mtime
       self[:mtime]

data/lib/nanoc3/base/source_data/layout.rb

@@ -6,6 +6,8 @@ module Nanoc3
   # identifier and a modification time (to speed up compilation).
   class Layout
 
+    extend Nanoc3::Memoization
+
     # @return [String] The raw content of this layout
     attr_reader :raw_content
 
@@ -34,7 +36,7 @@ module Nanoc3
     def initialize(raw_content, attributes, identifier, params=nil)
       @raw_content  = raw_content
       @attributes   = attributes.symbolize_keys
-      @identifier   = identifier.cleaned_identifier
+      @identifier   = identifier.cleaned_identifier.freeze
 
       # Set mtime
       params ||= {}
@@ -61,6 +63,15 @@ module Nanoc3
       :layout
     end
 
+    # Prevents all further modifications to the layout.
+    #
+    # @return [void]
+    def freeze
+      attributes.freeze_recursively
+      identifier.freeze
+      raw_content.freeze
+    end
+
     # Returns an object that can be used for uniquely identifying objects.
     #
     # @api private
@@ -74,6 +85,14 @@ module Nanoc3
       "<#{self.class}:0x#{self.object_id.to_s(16)} identifier=#{self.identifier}>"
     end
 
+    # TODO document
+    def checksum
+      attributes = @attributes.dup
+      attributes.delete(:file)
+      @raw_content.checksum + ',' + attributes.checksum
+    end
+    memoize :checksum
+
     # @deprecated Access the modification time using `layout[:mtime]` instead.
     def mtime
       self[:mtime]

data/lib/nanoc3/base/source_data/site.rb

@@ -51,6 +51,8 @@ module Nanoc3
     # Compiles the site.
     #
     # @return [void]
+    #
+    # @since 3.2.0
     def compile
       compiler.run
     end
@@ -167,20 +169,6 @@ module Nanoc3
     #
     # @return [Hash] The site configuration
     def config
-      # Add reference to config if necessary
-      if !@config.respond_to?(:reference)
-        def @config.reference
-          :config
-        end
-      end
-
-      # Add data to config if necessary
-      if !@config.respond_to?(:data)
-        def @config.data
-          self.inspect
-        end
-      end
-
       @config
     end
 
@@ -190,12 +178,7 @@ module Nanoc3
     #
     # @return [void]
     def setup_child_parent_links
-      # Clear all links
-      @items.each do |item|
-        item.parent = nil
-        item.children = []
-      end
-
+      teardown_child_parent_links
       @items.each do |item|
         # Get parent
         parent_identifier = item.identifier.sub(/[^\/]+\/$/, '')
@@ -208,13 +191,23 @@ module Nanoc3
       end
     end
 
+    # Removes all child-parent links.
+    #
+    # @api private
+    #
+    # @return [void]
+    def teardown_child_parent_links
+      @items.each do |item|
+        item.parent = nil
+        item.children = []
+      end
+    end
+
     # Prevents all further modifications to itself, its items, its layouts etc.
     #
     # @return [void]
     def freeze
-      super
-
-      config.freeze
+      config.freeze_recursively
       items.each         { |i|  i.freeze  }
       layouts.each       { |l|  l.freeze  }
       code_snippets.each { |cs| cs.freeze }
@@ -233,8 +226,8 @@ module Nanoc3
     #
     # @return [void]
     def load
-      return if @data_loaded
-      @data_loaded = true
+      return if @loaded || @loading
+      @loading = true
 
       # Load all data
       load_code_snippets
@@ -247,6 +240,33 @@ module Nanoc3
       # Load compiler too
       # FIXME this should not be necessary
       compiler.load
+
+      @loaded = true
+    rescue => e
+      unload
+      raise e
+    ensure
+      @loading = false
+    end
+
+    # Undoes the effects of {#load}. Used when {#load} raises an exception.
+    #
+    # @api private
+    def unload
+      return if @unloading
+      @unloading = true
+
+      @items_loaded = false
+      @items = []
+      @layouts_loaded = false
+      @layouts = []
+      @code_snippets_loaded = false
+      @code_snippets = []
+
+      compiler.unload
+
+      @loaded = false
+      @unloading = false
     end
 
   private
@@ -319,7 +339,10 @@ module Nanoc3
       end
 
       # Merge data sources with default data source config
-      @config[:data_sources].map! { |ds| DEFAULT_DATA_SOURCE_CONFIG.merge(ds) }
+      @config[:data_sources] = @config[:data_sources].map { |ds| DEFAULT_DATA_SOURCE_CONFIG.merge(ds) }
+
+      # Convert to proper configuration
+      @config = Nanoc3::Configuration.new(@config)
     end
 
   end

data/lib/nanoc3/base/store.rb

@@ -6,6 +6,10 @@ module Nanoc3
   # filesystem, such as checksums, cached compiled content and dependency
   # graphs.
   #
+  # Each store has a version number. When attempting to load data from a store
+  # that has an incompatible version number, no data will be loaded, but
+  # {#version_mismatch_detected} will be called.
+  #
   # @abstract Subclasses must implement {#data} and {#data=}, and may
   #   implement {#no_data_found} and {#version_mismatch_detected}.
   #
@@ -83,6 +87,12 @@ module Nanoc3
       end
     end
 
+    # Undoes the effects of {#load}. Used when {#load} raises an exception.
+    #
+    # @api private
+    def unload
+    end
+
     # Stores the data contained in memory to the filesystem. This method will
     #   use the {#data} method to fetch the data that should be written.
     #
@@ -117,7 +127,6 @@ module Nanoc3
   private
 
     def pstore
-      require 'pstore'
       @pstore ||= PStore.new(self.filename)
     end
 

data/lib/nanoc3/base.rb

@@ -9,12 +9,14 @@ module Nanoc3
   autoload 'Context',              'nanoc3/base/context'
   autoload 'DirectedGraph',        'nanoc3/base/directed_graph'
   autoload 'Errors',               'nanoc3/base/errors'
+  autoload 'Memoization',          'nanoc3/base/memoization'
   autoload 'NotificationCenter',   'nanoc3/base/notification_center'
   autoload 'PluginRegistry',       'nanoc3/base/plugin_registry'
   autoload 'Store',                'nanoc3/base/store'
 
   # Load source data classes
   autoload 'CodeSnippet',          'nanoc3/base/source_data/code_snippet'
+  autoload 'Configuration',        'nanoc3/base/source_data/configuration'
   autoload 'DataSource',           'nanoc3/base/source_data/data_source'
   autoload 'Item',                 'nanoc3/base/source_data/item'
   autoload 'Layout',               'nanoc3/base/source_data/layout'
@@ -24,7 +26,6 @@ module Nanoc3
   autoload 'ItemRep',              'nanoc3/base/result_data/item_rep'
 
   # Load compilation classes
-  autoload 'Checksummer',          'nanoc3/base/compilation/checksummer'
   autoload 'ChecksumStore',        'nanoc3/base/compilation/checksum_store'
   autoload 'CompiledContentCache', 'nanoc3/base/compilation/compiled_content_cache'
   autoload 'Compiler',             'nanoc3/base/compilation/compiler'
@@ -32,10 +33,14 @@ module Nanoc3
   autoload 'DependencyTracker',    'nanoc3/base/compilation/dependency_tracker'
   autoload 'Filter',               'nanoc3/base/compilation/filter'
   autoload 'ItemRepProxy',         'nanoc3/base/compilation/item_rep_proxy'
+  autoload 'ItemRepRecorderProxy', 'nanoc3/base/compilation/item_rep_recorder_proxy'
   autoload 'OutdatednessChecker',  'nanoc3/base/compilation/outdatedness_checker'
   autoload 'OutdatednessReasons',  'nanoc3/base/compilation/outdatedness_reasons'
   autoload 'Rule',                 'nanoc3/base/compilation/rule'
   autoload 'RuleContext',          'nanoc3/base/compilation/rule_context'
+  autoload 'RuleMemoryCalculator', 'nanoc3/base/compilation/rule_memory_calculator'
+  autoload 'RuleMemoryStore',      'nanoc3/base/compilation/rule_memory_store'
+  autoload 'RulesCollection',      'nanoc3/base/compilation/rules_collection'
 
   # Deprecated; use PluginRepository instead
   # TODO [in nanoc 4.0] remove me

data/lib/nanoc3/cli/base.rb

@@ -27,9 +27,11 @@ module Nanoc3::CLI
       'rack/cache'     => 'rack-cache',
       'rainpress'      => 'rainpress',
       'rdiscount'      => 'rdiscount',
+      'redcarpet'      => 'redcarpet',
       'redcloth'       => 'redcloth',
       'rubypants'      => 'rubypants',
       'sass'           => 'sass',
+      'systemu'        => 'systemu',
       'w3c_validators' => 'w3c_validators'
     }
 
@@ -65,6 +67,8 @@ module Nanoc3::CLI
     end
 
     # @return [Boolean] true if debug output is enabled, false if not
+    #
+    # @since 3.2.0
     def debug?
       @debug
     end
@@ -147,10 +151,10 @@ module Nanoc3::CLI
       $stderr.puts
       $stderr.puts '=== COMPILATION STACK:'
       $stderr.puts
-      if ((self.site && self.site.compiler.stack) || []).empty?
+      if stack.empty?
         $stderr.puts "  (empty)"
       else
-        self.site.compiler.stack.reverse.each do |obj|
+        stack.reverse.each do |obj|
           if obj.is_a?(Nanoc3::ItemRep)
             $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
           else # layout
@@ -160,7 +164,6 @@ module Nanoc3::CLI
       end
 
       # Backtrace
-      require 'enumerator'
       $stderr.puts
       $stderr.puts '=== BACKTRACE:'
       $stderr.puts
@@ -177,7 +180,9 @@ module Nanoc3::CLI
       case error
       when LoadError
         # Get gem name
-        lib_name = error.message.match(/no such file to load -- ([^\s]+)/)[1]
+        matches = error.message.match(/no such file to load -- ([^\s]+)/)
+        return nil if matches.empty?
+        lib_name = matches[1]
         gem_name = GEM_NAMES[$1]
 
         # Build message
@@ -187,8 +192,10 @@ module Nanoc3::CLI
       when RuntimeError
         if error.message =~ /^can't modify frozen/
           "You attempted to modify immutable data. Some data, such as " \
-          "item/layout attributes and raw item/layout content, can no " \
-          "longer be modified once compilation has started."
+          "item/layout attributes and raw item/layout content, can not " \
+          "be modified once compilation has started. (This was " \
+          "unintentionally possible in 3.1.x and before, but has been " \
+          "disabled in 3.2.x in order to allow compiler optimisations.)"
         end
       end
     end
@@ -261,7 +268,7 @@ module Nanoc3::CLI
         gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : "without RubyGems"
         engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
 
-        puts "nanoc #{Nanoc3::VERSION} (c) 2007-2010 Denis Defreyne."
+        puts "nanoc #{Nanoc3::VERSION} (c) 2007-2011 Denis Defreyne."
         puts "Running #{engine} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} #{gem_info}"
         exit 0
       when :verbose
@@ -280,6 +287,12 @@ module Nanoc3::CLI
       end
     end
 
+  protected
+
+    def stack
+      (self.site && self.site.compiler.stack) || []
+    end
+
   end
 
 end

data/lib/nanoc3/cli/commands/compile.rb

@@ -166,7 +166,6 @@ module Nanoc3::CLI::Commands
       # Check whether there’s a different
       return if old_content == new_content
 
-      require 'thread'
       @diff_threads << Thread.new do
         # Generate diff
         diff = diff_strings(old_content, new_content)
@@ -182,7 +181,6 @@ module Nanoc3::CLI::Commands
 
     # TODO move this elsewhere
     def diff_strings(a, b)
-      require 'tempfile'
       require 'open3'
 
       # Create files

data/lib/nanoc3/cli/commands/create_site.rb

@@ -82,6 +82,9 @@ EOS
 
 # A few helpful tips about the Rules file:
 #
+# * The string given to #compile and #route are matching patterns for
+#   identifiers--not for paths. Therefore, you can’t match on extension.
+#
 # * The order of rules is important: for each item, only the first matching
 #   rule is applied.
 #
@@ -95,8 +98,12 @@ compile '/stylesheet/' do
 end
 
 compile '*' do
-  filter :erb
-  layout 'default'
+  if item.binary?
+    # don’t filter binary items
+  else
+    filter :erb
+    layout 'default'
+  end
 end
 
 route '/stylesheet/' do
@@ -105,10 +112,10 @@ end
 
 route '*' do
   if item.binary?
-    # /foo/ -> /foo.ext
+    # Write item with identifier /foo/ to /foo.ext
     item.identifier.chop + '.' + item[:extension]
   else
-    # /foo/ -> /foo/index.html
+    # Write item with identifier /foo/ to /foo/index.html
     item.identifier + 'index.html'
   end
 end
@@ -180,18 +187,20 @@ a:hover {
   line-height: 20px;
 }
 
-#main ul {
+#main ul, #main ol {
   margin: 20px;
 }
 
 #main li {
-  list-style-type: square;
-
   font-size: 15px;
   
   line-height: 20px;
 }
 
+#main ul li {
+  list-style-type: square;
+}
+
 #sidebar {
   position: absolute;
 

data/lib/nanoc3/cli/commands/debug.rb

@@ -51,7 +51,7 @@ module Nanoc3::CLI::Commands
       puts
       items.sort_by { |i| i.identifier }.each do |item|
         puts "item #{item.identifier} depends on:"
-        predecessors = dependency_tracker.direct_predecessors_of(item).sort_by { |i| i.identifier }
+        predecessors = dependency_tracker.objects_causing_outdatedness_of(item).sort_by { |i| i.identifier }
         predecessors.each do |pred|
           puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
         end
@@ -82,7 +82,7 @@ module Nanoc3::CLI::Commands
       items.sort_by { |i| i.identifier }.each do |item|
         item.reps.sort_by { |r| r.name.to_s }.each do |rep|
           puts "item #{item.identifier}, rep #{rep.name}:"
-          outdatedness_reason = compiler.outdatedness_reason_for(rep)
+          outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(rep)
           if outdatedness_reason
             puts "  is outdated: #{outdatedness_reason.message}"
           else
@@ -97,7 +97,7 @@ module Nanoc3::CLI::Commands
       puts
       layouts.each do |layout|
         puts "layout #{layout.identifier}:"
-        outdatedness_reason = compiler.outdatedness_reason_for(layout)
+        outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(layout)
         if outdatedness_reason
           puts "  is outdated: #{outdatedness_reason.message}"
         else

data/lib/nanoc3/cli/commands/view.rb

@@ -72,6 +72,7 @@ module Nanoc3::CLI::Commands
         use Rack::CommonLogger
         use Rack::ShowExceptions
         use Rack::Lint
+        use Rack::Head
         use Adsf::Rack::IndexFileFinder, :root => site.config[:output_dir]
         run Rack::File.new(site.config[:output_dir])
       end.to_app