nanoc3 3.1.9 → 3.2.0a1

data/lib/nanoc3/base/plugin_registry.rb

@@ -15,7 +15,7 @@ module Nanoc3
       # Sets the identifiers for this plugin.
       #
       # @param [Array<Symbol>] identifier A list of identifiers to assign to
-      # this plugin.
+      #   this plugin.
       #
       # @return [void]
       def identifiers(*identifiers)
@@ -34,10 +34,10 @@ module Nanoc3
       # Registers the given class as a plugin with the given identifier.
       #
       # @param [Class, String] class_or_name The class to register, or a
-      # string containing the class name to register.
+      #   string containing the class name to register.
       #
       # @param [Array<Symbol>] identifiers A list of identifiers to assign to
-      # this plugin.
+      #   this plugin.
       #
       # @return [void]
       def register(class_or_name, *identifiers)
@@ -79,15 +79,15 @@ module Nanoc3
     # Registers the given class as a plugin.
     #
     # @param [Class] superclass The superclass of the plugin. For example:
-    # {Nanoc3::Filter}, {Nanoc3::Extra::VCS}.
+    #   {Nanoc3::Filter}, {Nanoc3::Extra::VCS}.
     #
     # @param [Class, String] class_or_name The class to register. This can be
-    # a string, in which case it will be automatically converted to a proper
-    # class at lookup. For example: `Nanoc3::Filters::ERB`,
-    # `"Nanoc3::Filters::Haml"`.
+    #   a string, in which case it will be automatically converted to a proper
+    #   class at lookup. For example: `Nanoc3::Filters::ERB`,
+    #   `"Nanoc3::Filters::Haml"`.
     #
     # @param [Symbol] identifiers One or more symbols identifying the class.
-    # For example: `:haml`, :`erb`.
+    #   For example: `:haml`, :`erb`.
     #
     # @return [void]
     def register(superclass, class_or_name, *identifiers)
@@ -159,7 +159,7 @@ module Nanoc3
 
   end
 
-  # @deprecated Use {Nanoc3::PluginRegistry.instance} instead
+  # @deprecated Use {Nanoc3::PluginRegistry.instace} instead
   Plugin = PluginRegistry.instance
 
 end

data/lib/nanoc3/base/rule.rb

@@ -6,29 +6,38 @@ module Nanoc3
   class Rule
 
     # @return [Regexp] The regex that determines which items this rule can be
-    # applied to. This rule can be applied to items with a identifier matching
-    # this regex.
+    #   applied to. This rule can be applied to items with a identifier
+    #   matching this regex.
     attr_reader :identifier_regex
 
     # @return [Symbol] The name of the representation that will be compiled
-    # using this rule
+    #   using this rule
     attr_reader :rep_name
 
+    # @return [Symbol] The name of the snapshot this rule will apply to.
+    #   Ignored for compilation rules, but used for routing rules.
+    attr_reader :snapshot_name
+
     # Creates a new item compilation rule with the given identifier regex,
     # compiler and block. The block will be called during compilation with the
     # item rep as its argument.
     #
     # @param [Regexp] identifier_regex A regular expression that will be used
-    # to determine whether this rule is applicable to certain items.
+    #   to determine whether this rule is applicable to certain items.
     #
     # @param [String, Symbol] rep_name The name of the item representation
-    # where this rule can be applied to
+    #   where this rule can be applied to
     #
     # @param [Proc] block A block that will be called when matching items are
-    # compiled
-    def initialize(identifier_regex, rep_name, block)
+    #   compiled
+    #
+    # @option params [Symbol, nil] :snapshot (nil) The name of the snapshot
+    #   this rule will apply to. Ignored for compilation rules, but used for
+    #   routing rules.
+    def initialize(identifier_regex, rep_name, block, params={})
       @identifier_regex = identifier_regex
       @rep_name         = rep_name.to_sym
+      @snapshot_name    = params[:snapshot_name]
 
       @block = block
     end
@@ -36,7 +45,7 @@ module Nanoc3
     # @param [Nanoc3::Item] item The item to check
     #
     # @return [Boolean] true if this rule can be applied to the given item
-    # rep, false otherwise
+    #   rep, false otherwise
     def applicable_to?(item)
       item.identifier =~ @identifier_regex
     end
@@ -44,7 +53,7 @@ module Nanoc3
     # Applies this rule to the given item rep.
     #
     # @param [Nanoc3::ItemRep] rep The item representation where this rule
-    # should be applied to
+    #   should be applied to
     #
     # @return [void]
     def apply_to(rep)

data/lib/nanoc3/base/rule_context.rb

@@ -14,10 +14,10 @@ module Nanoc3
   # * `layouts` ({Array}<{Nanoc3::Layout}>) - A list of all layouts
   class RuleContext < Context
 
-    # Creates a new rule context for the given item representation.
+    # Creates a new rule context for the given iterm representation.
     #
     # @param [Nanoc3::ItemRep] rep The item representation for which to create
-    # a new rule context.
+    #   a new rule context.
     def initialize(rep)
       item    = rep.item
       site    = item.site
@@ -41,10 +41,10 @@ module Nanoc3
     # @see Nanoc3::ItemRep#filter
     #
     # @param [Symbol] filter_name The name of the filter to run the item
-    # representations' content through
+    #   representations' content through
     #
     # @param [Hash] filter_args The filter arguments that should be passed to
-    # the filter's #run method
+    #   the filter's #run method
     #
     # @return [void]
     def filter(filter_name, filter_args={})
@@ -57,7 +57,7 @@ module Nanoc3
     # @see Nanoc3::ItemRep#layout
     #
     # @param [String] layout_identifier The identifier of the layout the item
-    # should be laid out with
+    #   should be laid out with
     #
     # @return [void]
     def layout(layout_identifier)

data/lib/nanoc3/base/site.rb

@@ -39,13 +39,16 @@ module Nanoc3
     # that lacks some options, the default value will be taken from
     # `DEFAULT_CONFIG`.
     DEFAULT_CONFIG = {
-      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml ),
+      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass txt xml ),
       :output_dir         => 'output',
       :data_sources       => [ {} ],
       :index_filenames    => [ 'index.html' ],
       :enable_output_diff => false
     }
 
+    # The name of the file where checksums will be stored.
+    CHECKSUMS_FILE_NAME = 'tmp/checksums'
+
     # The site configuration. The configuration has the following keys:
     #
     # * `text_extensions` ({Array<String>}) - A list of file extensions that
@@ -89,23 +92,33 @@ module Nanoc3
     # @return [Hash] The site configuration
     attr_reader :config
 
-    # @return [Time] The timestamp when the site configuration was last
-    # modified
-    attr_reader :config_mtime
+    # @return [String] The checksum of the site configuration that was in
+    #   effect during the previous site compilation
+    attr_accessor :old_config_checksum
+
+    # @return [String] The current, up-to-date checksum of the site
+    #   configuration
+    attr_reader   :new_config_checksum
+
+    # @return [String] The checksum of the rules file that was in effect
+    #   during the previous site compilation
+    attr_accessor :old_rules_checksum
 
-    # @return [Time] The timestamp when the rules were last modified
-    attr_reader :rules_mtime
+    # @return [String] The current, up-to-date checksum of the rules file
+    attr_reader   :new_rules_checksum
 
     # @return [Proc] The code block that will be executed after all data is
-    # loaded but before the site is compiled
+    #   loaded but before the site is compiled
     attr_accessor :preprocessor
 
     # Creates a site object for the site specified by the given
     # `dir_or_config_hash` argument.
     #
     # @param [Hash, String] dir_or_config_hash If a string, contains the path
-    # to the site directory; if a hash, contains the site configuration.
+    #   to the site directory; if a hash, contains the site configuration.
     def initialize(dir_or_config_hash)
+      @new_checksums = {}
+
       build_config(dir_or_config_hash)
 
       @code_snippets_loaded = false
@@ -125,10 +138,10 @@ module Nanoc3
     # none exists yet.
     #
     # @return [Array<Nanoc3::DataSource>] The list of data sources for this
-    # site
+    #   site
     #
     # @raise [Nanoc3::Errors::UnknownDataSource] if the site configuration
-    # specifies an unknown data source
+    #   specifies an unknown data source
     def data_sources
       @data_sources ||= begin
         @config[:data_sources].map do |data_source_hash|
@@ -162,7 +175,7 @@ module Nanoc3
     # the `force` parameter is true.
     #
     # @param [Boolean] force If true, will force load the site data even if it
-    # has been loaded before, to circumvent caching issues
+    #   has been loaded before, to circumvent caching issues
     #
     # @return [void]
     def load_data(force=false)
@@ -192,10 +205,10 @@ module Nanoc3
     # Returns this site’s code snippets.
     #
     # @return [Array<Nanoc3::CodeSnippet>] The list of code snippets in this
-    # site
+    #   site
     #
     # @raise [Nanoc3::Errors::DataNotYetAvailable] if the site data hasn’t
-    # been loaded yet (call {#load_data} to load the site data)
+    #   been loaded yet (call {#load_data} to load the site data)
     def code_snippets
       raise Nanoc3::Errors::DataNotYetAvailable.new('Code snippets', false) unless @code_snippets_loaded
       @code_snippets
@@ -206,7 +219,7 @@ module Nanoc3
     # @return [Array<Nanoc3::Item>] The list of items in this site
     #
     # @raise [Nanoc3::Errors::DataNotYetAvailable] if the site data hasn’t
-    # been loaded yet (call {#load_data} to load the site data)
+    #   been loaded yet (call {#load_data} to load the site data)
     def items
       raise Nanoc3::Errors::DataNotYetAvailable.new('Items', true) unless @items_loaded
       @items
@@ -217,12 +230,36 @@ module Nanoc3
     # @return [Array<Nanoc3::Layouts>] The list of layout in this site
     #
     # @raise [Nanoc3::Errors::DataNotYetAvailable] if the site data hasn’t
-    # been loaded yet (call {#load_data} to load the site data)
+    #   been loaded yet (call {#load_data} to load the site data)
     def layouts
       raise Nanoc3::Errors::DataNotYetAvailable.new('Layouts', true) unless @layouts_loaded
       @layouts
     end
 
+    # Stores the checksums into the checksums file.
+    #
+    # @return [void]
+    def store_checksums
+      # Store
+      FileUtils.mkdir_p(File.dirname(CHECKSUMS_FILE_NAME))
+      store = PStore.new(CHECKSUMS_FILE_NAME)
+      store.transaction do
+        store[:checksums] = @new_checksums || {}
+      end
+    end
+
+    # @return [Boolean] true if the site configuration was modified since the
+    #   site was last compiled, false otherwise
+    def config_outdated?
+      !self.old_config_checksum || !self.new_config_checksum || self.old_config_checksum != self.new_config_checksum
+    end
+
+    # @return [Boolean] true if the rules were modified since the site was
+    #   last compiled, false otherwise
+    def rules_outdated?
+      !self.old_rules_checksum || !self.new_rules_checksum || self.old_rules_checksum != self.new_rules_checksum
+    end
+
   private
 
     # Returns the Nanoc3::CompilerDSL that should be used for this site.
@@ -240,10 +277,16 @@ module Nanoc3
         Nanoc3::CodeSnippet.new(
           File.read(filename),
           filename,
-          File.stat(filename).mtime
+          :checksum => Nanoc3::Checksummer.checksum_for(filename)
         )
       end
 
+      # Set checksums
+      @code_snippets.each do |cs|
+        cs.old_checksum = old_checksum_for(:code_snippet, cs.filename)
+        @new_checksums[ [ :code_snippet, cs.filename ] ] = cs.new_checksum
+      end
+
       # Execute code snippets
       @code_snippets.each { |cs| cs.load }
 
@@ -257,8 +300,10 @@ module Nanoc3
       raise Nanoc3::Errors::NoRulesFileFound.new if rules_filename.nil?
 
       # Get rule data
-      @rules       = File.read(rules_filename)
-      @rules_mtime = File.stat(rules_filename).mtime
+      @rules = File.read(rules_filename)
+      @new_rules_checksum = Nanoc3::Checksummer.checksum_for(rules_filename)
+      @old_rules_checksum = old_checksum_for(:misc, 'Rules')
+      @new_checksums[ [ :misc, 'Rules' ] ] = @new_rules_checksum
 
       # Load DSL
       dsl.instance_eval(@rules, "./#{rules_filename}")
@@ -274,6 +319,12 @@ module Nanoc3
         @items.concat(items_in_ds)
       end
 
+      # Set checksums
+      @items.each do |i|
+        i.old_checksum = old_checksum_for(:item, i.identifier)
+        @new_checksums[ [ :item, i.identifier ] ] = i.new_checksum
+      end
+
       @items_loaded = true
     end
 
@@ -286,6 +337,12 @@ module Nanoc3
         @layouts.concat(layouts_in_ds)
       end
 
+      # Set checksums
+      @layouts.each do |l|
+        l.old_checksum = old_checksum_for(:layout, l.identifier)
+        @new_checksums[ [ :layout, l.identifier ] ] = l.new_checksum
+      end
+
       @layouts_loaded = true
     end
 
@@ -337,52 +394,51 @@ module Nanoc3
     def route_reps
       reps = @items.map { |i| i.reps }.flatten
       reps.each do |rep|
-        # Find matching rule
-        rule = self.compiler.routing_rule_for(rep)
-        raise Nanoc3::Errors::NoMatchingRoutingRuleFound.new(rep) if rule.nil?
-
-        # Get basic path by applying matching rule
-        basic_path = rule.apply_to(rep)
-        next if basic_path.nil?
-        if basic_path !~ %r{^/}
-          raise RuntimeError, "The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash.".make_compatible_with_env
-        end
-
-        # Get raw path by prepending output directory
-        rep.raw_path = self.config[:output_dir] + basic_path
-
-        # Get normal path by stripping index filename
-        rep.path = basic_path
-        self.config[:index_filenames].each do |index_filename|
-          if rep.path[-index_filename.length..-1] == index_filename
-            # Strip and stop
-            rep.path = rep.path[0..-index_filename.length-1]
-            break
+        # Find matching rules
+        rules = self.compiler.routing_rules_for(rep)
+        raise Nanoc3::Errors::NoMatchingRoutingRuleFound.new(rep) if rules[:last].nil?
+
+        rules.each_pair do |snapshot, rule|
+          # Get basic path by applying matching rule
+          basic_path = rule.apply_to(rep)
+          next if basic_path.nil?
+
+          # Get raw path by prepending output directory
+          rep.raw_paths[snapshot] = self.config[:output_dir] + basic_path
+
+          # Get normal path by stripping index filename
+          rep.paths[snapshot] = basic_path
+          self.config[:index_filenames].each do |index_filename|
+            if rep.paths[snapshot][-index_filename.length..-1] == index_filename
+              # Strip and stop
+              rep.paths[snapshot] = rep.paths[snapshot][0..-index_filename.length-1]
+              break
+            end
           end
         end
       end
     end
 
     # Builds the configuration hash based on the given argument. Also see
-    # #initialize for details.
+    # {#initialize} for details.
     def build_config(dir_or_config_hash)
       if dir_or_config_hash.is_a? String
-        # Check whether it is supported
-        if dir_or_config_hash != '.'
-          warn 'WARNING: Calling Nanoc3::Site.new with a directory that is not the current working directory is not supported. It is recommended to change the directory before calling Nanoc3::Site.new. For example, instead of Nanoc3::Site.new(\'abc\'), use Dir.chdir(\'abc\') { Nanoc3::Site.new(\'.\') }.'
-        end
-
         # Read config from config.yaml in given dir
         config_path = File.join(dir_or_config_hash, 'config.yaml')
         @config = DEFAULT_CONFIG.merge(YAML.load_file(config_path).symbolize_keys)
         @config[:data_sources].map! { |ds| ds.symbolize_keys }
-        @config_mtime = File.stat(config_path).mtime
+
+        @new_config_checksum = Nanoc3::Checksummer.checksum_for('config.yaml')
+        @new_checksums[ [ :misc, 'config.yaml' ] ] = @new_config_checksum
       else
         # Use passed config hash
         @config = DEFAULT_CONFIG.merge(dir_or_config_hash)
-        @config_mtime = nil
+        @new_config_checksum = nil
       end
 
+      # Build checksum
+      @old_config_checksum = old_checksum_for(:misc, 'config.yaml')
+
       # Merge data sources with default data source config
       @config[:data_sources].map! { |ds| DEFAULT_DATA_SOURCE_CONFIG.merge(ds) }
     end
@@ -397,6 +453,38 @@ module Nanoc3
       })
     end
 
+    # Returns the checksums, loads the checksums from the cached checksums
+    # file first if necessary. The checksums returned is a hash in th following
+    # format:
+    #
+    #     {
+    #       [ :layout,       '/identifier/'    ] => checksum,
+    #       [ :item,         '/identifier/'    ] => checksum,
+    #       [ :code_snippet, 'lib/filename.rb' ] => checksum,
+    #     }
+    def checksums
+      return @checksums if @checksums_loaded
+
+      if !File.file?(CHECKSUMS_FILE_NAME)
+        @checksums = {}
+      else
+        require 'pstore'
+        store = PStore.new(CHECKSUMS_FILE_NAME)
+        store.transaction do
+          @checksums = store[:checksums] || {}
+        end
+      end
+
+      @checksums_loaded = true
+      @checksums
+    end
+
+    # Returns the old checksum for the given object.
+    def old_checksum_for(type, identifier)
+      key = [ type, identifier ]
+      checksums[key]
+    end
+
   end
 
 end

data/lib/nanoc3/base.rb

@@ -5,27 +5,29 @@ module Nanoc3
   require 'nanoc3/base/core_ext'
   require 'nanoc3/base/ordered_hash'
 
-  autoload 'CodeSnippet',         'nanoc3/base/code_snippet'
-  autoload 'Compiler',            'nanoc3/base/compiler'
-  autoload 'CompilerDSL',         'nanoc3/base/compiler_dsl'
-  autoload 'Config',              'nanoc3/base/config'
-  autoload 'Context',             'nanoc3/base/context'
-  autoload 'DataSource',          'nanoc3/base/data_source'
-  autoload 'DependencyTracker',   'nanoc3/base/dependency_tracker'
-  autoload 'DirectedGraph',       'nanoc3/base/directed_graph'
-  autoload 'Errors',              'nanoc3/base/errors'
-  autoload 'Filter',              'nanoc3/base/filter'
-  autoload 'Item',                'nanoc3/base/item'
-  autoload 'ItemRep',             'nanoc3/base/item_rep'
-  autoload 'Layout',              'nanoc3/base/layout'
-  autoload 'NotificationCenter',  'nanoc3/base/notification_center'
-  autoload 'PluginRegistry',      'nanoc3/base/plugin_registry'
-  autoload 'Rule',                'nanoc3/base/rule'
-  autoload 'RuleContext',         'nanoc3/base/rule_context'
-  autoload 'Site',                'nanoc3/base/site'
+  autoload 'Checksummer',          'nanoc3/base/checksummer'
+  autoload 'CodeSnippet',          'nanoc3/base/code_snippet'
+  autoload 'CompiledContentCache', 'nanoc3/base/compiled_content_cache'
+  autoload 'Compiler',             'nanoc3/base/compiler'
+  autoload 'CompilerDSL',          'nanoc3/base/compiler_dsl'
+  autoload 'Config',               'nanoc3/base/config'
+  autoload 'Context',              'nanoc3/base/context'
+  autoload 'DataSource',           'nanoc3/base/data_source'
+  autoload 'DependencyTracker',    'nanoc3/base/dependency_tracker'
+  autoload 'DirectedGraph',        'nanoc3/base/directed_graph'
+  autoload 'Errors',               'nanoc3/base/errors'
+  autoload 'Filter',               'nanoc3/base/filter'
+  autoload 'Item',                 'nanoc3/base/item'
+  autoload 'ItemRep',              'nanoc3/base/item_rep'
+  autoload 'Layout',               'nanoc3/base/layout'
+  autoload 'NotificationCenter',   'nanoc3/base/notification_center'
+  autoload 'PluginRegistry',       'nanoc3/base/plugin_registry'
+  autoload 'Rule',                 'nanoc3/base/rule'
+  autoload 'RuleContext',          'nanoc3/base/rule_context'
+  autoload 'Site',                 'nanoc3/base/site'
 
   # Deprecated; use PluginRepository instead
   # TODO [in nanoc 4.0] remove me
-  autoload 'Plugin',              'nanoc3/base/plugin_registry'
+  autoload 'Plugin',               'nanoc3/base/plugin_registry'
 
 end