nanoc 4.0.2 → 4.1.0a1

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

@@ -0,0 +1,29 @@
+module Nanoc::Int
+  # @api private
+  class RulesLoader
+    def initialize(config, rules_collection)
+      @dsl = Nanoc::Int::CompilerDSL.new(rules_collection, config)
+    end
+
+    def load
+      # Find rules file
+      rules_filenames = ['Rules', 'rules', 'Rules.rb', 'rules.rb']
+      rules_filename = rules_filenames.find { |f| File.file?(f) }
+      raise Nanoc::Int::Errors::NoRulesFileFound.new if rules_filename.nil?
+
+      parse(rules_filename)
+    end
+
+    def parse(rules_filename)
+      rules_filename = File.absolute_path(rules_filename)
+
+      # Get rule data
+      data = File.read(rules_filename)
+
+      old_rules_filename = @dsl.rules_filename
+      @dsl.rules_filename = rules_filename
+      @dsl.instance_eval(data, rules_filename)
+      @dsl.rules_filename = old_rules_filename
+    end
+  end
+end

data/lib/nanoc/base/views.rb

@@ -1,6 +1,9 @@
 require_relative 'views/mixins/document_view_mixin'
 require_relative 'views/mixins/mutable_document_view_mixin'
 
+require_relative 'views/view'
+require_relative 'views/view_context'
+
 require_relative 'views/config_view'
 require_relative 'views/identifiable_collection_view'
 require_relative 'views/item_view'
@@ -16,3 +19,6 @@ 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/config_view.rb

@@ -1,10 +1,11 @@
 module Nanoc
-  class ConfigView
+  class ConfigView < ::Nanoc::View
     # @api private
     NONE = Object.new
 
     # @api private
-    def initialize(config)
+    def initialize(config, context)
+      super(context)
       @config = config
     end
 
@@ -35,5 +36,10 @@ module Nanoc
     def [](key)
       @config[key]
     end
+
+    # @see Hash#each
+    def each(&block)
+      @config.each(&block)
+    end
   end
 end

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

@@ -1,9 +1,10 @@
 module Nanoc
-  class IdentifiableCollectionView
+  class IdentifiableCollectionView < ::Nanoc::View
     include Enumerable
 
     # @api private
-    def initialize(objects)
+    def initialize(objects, context)
+      super(context)
       @objects = objects
     end
 
@@ -27,7 +28,7 @@ module Nanoc
     #
     # @return [self]
     def each
-      @objects.each { |i| yield view_class.new(i) }
+      @objects.each { |i| yield view_class.new(i, @context) }
       self
     end
 
@@ -70,7 +71,7 @@ module Nanoc
     #   @return [#identifier] if an object was found
     def [](arg)
       res = @objects[arg]
-      res && view_class.new(res)
+      res && view_class.new(res, @context)
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Nanoc
-  class ItemRepCollectionView
+  class ItemRepCollectionView < ::Nanoc::View
     include Enumerable
 
     class NoSuchItemRepError < ::Nanoc::Error
@@ -9,7 +9,8 @@ module Nanoc
     end
 
     # @api private
-    def initialize(item_reps)
+    def initialize(item_reps, context)
+      super(context)
       @item_reps = item_reps
     end
 
@@ -19,7 +20,7 @@ module Nanoc
     end
 
     def to_ary
-      @item_reps.map { |ir| Nanoc::ItemRepView.new(ir) }
+      @item_reps.map { |ir| Nanoc::ItemRepView.new(ir, @context) }
     end
 
     # Calls the given block once for each item rep, passing that item rep as a parameter.
@@ -30,7 +31,7 @@ module Nanoc
     #
     # @return [self]
     def each
-      @item_reps.each { |ir| yield Nanoc::ItemRepView.new(ir) }
+      @item_reps.each { |ir| yield Nanoc::ItemRepView.new(ir, @context) }
       self
     end
 
@@ -50,7 +51,7 @@ module Nanoc
       case rep_name
       when Symbol
         res = @item_reps.find { |ir| ir.name == rep_name }
-        res && Nanoc::ItemRepView.new(res)
+        res && Nanoc::ItemRepView.new(res, @context)
       when Fixnum
         raise ArgumentError, "expected ItemRepCollectionView#[] to be called with a symbol (you likely want `.reps[:default]` rather than `.reps[#{rep_name}]`)"
       else
@@ -69,7 +70,7 @@ module Nanoc
     def fetch(rep_name)
       res = @item_reps.find { |ir| ir.name == rep_name }
       if res
-        Nanoc::ItemRepView.new(res)
+        Nanoc::ItemRepView.new(res, @context)
       else
         raise NoSuchItemRepError.new(rep_name)
       end

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

@@ -1,7 +1,8 @@
 module Nanoc
-  class ItemRepView
+  class ItemRepView < ::Nanoc::View
     # @api private
-    def initialize(item_rep)
+    def initialize(item_rep, context)
+      super(context)
       @item_rep = item_rep
     end
 
@@ -28,17 +29,17 @@ module Nanoc
 
     # Returns the compiled content.
     #
-    # @option params [String] :snapshot The name of the snapshot from which to
+    # @param [String] snapshot The name of the snapshot from which to
     #   fetch the compiled content. By default, the returned compiled content
     #   will be the content compiled right before the first layout call (if
     #   any).
     #
     # @return [String] The content at the given snapshot.
-    def compiled_content(params = {})
+    def compiled_content(snapshot: nil)
       Nanoc::Int::NotificationCenter.post(:visit_started, unwrap.item)
       Nanoc::Int::NotificationCenter.post(:visit_ended,   unwrap.item)
 
-      @item_rep.compiled_content(params)
+      @item_rep.compiled_content(snapshot: snapshot)
     end
 
     # Returns the item rep’s path, as used when being linked to. It starts
@@ -46,30 +47,30 @@ module Nanoc
     # include the path to the output directory. It will not include the
     # filename if the filename is an index filename.
     #
-    # @option params [Symbol] :snapshot (:last) The snapshot for which the
-    #   path should be returned.
+    # @param [Symbol] snapshot The snapshot for which the path should be
+    #   returned.
     #
     # @return [String] The item rep’s path.
-    def path(params = {})
+    def path(snapshot: :last)
       Nanoc::Int::NotificationCenter.post(:visit_started, unwrap.item)
       Nanoc::Int::NotificationCenter.post(:visit_ended,   unwrap.item)
 
-      @item_rep.path(params)
+      @item_rep.path(snapshot: snapshot)
     end
 
     # Returns the item that this item rep belongs to.
     #
     # @return [Nanoc::ItemView]
     def item
-      Nanoc::ItemView.new(@item_rep.item)
+      Nanoc::ItemView.new(@item_rep.item, @context)
     end
 
     # @api private
-    def raw_path(params = {})
+    def raw_path(snapshot: :last)
       Nanoc::Int::NotificationCenter.post(:visit_started, unwrap.item)
       Nanoc::Int::NotificationCenter.post(:visit_ended,   unwrap.item)
 
-      @item_rep.raw_path(params)
+      @item_rep.raw_path(snapshot: snapshot)
     end
 
     # @api private

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

@@ -1,21 +1,21 @@
 module Nanoc
-  class ItemView
+  class ItemView < ::Nanoc::View
     include Nanoc::DocumentViewMixin
 
     # Returns the compiled content.
     #
-    # @option params [String] :rep (:default) The name of the representation
+    # @param [String] rep The name of the representation
     #   from which the compiled content should be fetched. By default, the
     #   compiled content will be fetched from the default representation.
     #
-    # @option params [String] :snapshot The name of the snapshot from which to
+    # @param [String] snapshot The name of the snapshot from which to
     #   fetch the compiled content. By default, the returned compiled content
     #   will be the content compiled right before the first layout call (if
     #   any).
     #
     # @return [String] The content of the given rep at the given snapshot.
-    def compiled_content(params = {})
-      reps.fetch(params.fetch(:rep, :default)).compiled_content(params)
+    def compiled_content(rep: :default, snapshot: :pre)
+      reps.fetch(rep).compiled_content(snapshot: snapshot)
     end
 
     # Returns the item path, as used when being linked to. It starts
@@ -23,16 +23,16 @@ module Nanoc
     # include the path to the output directory. It will not include the
     # filename if the filename is an index filename.
     #
-    # @option params [String] :rep (:default) The name of the representation
+    # @param [String] rep The name of the representation
     #   from which the path should be fetched. By default, the path will be
     #   fetched from the default representation.
     #
-    # @option params [Symbol] :snapshot (:last) The snapshot for which the
+    # @param [Symbol] snapshot The snapshot for which the
     #   path should be returned.
     #
     # @return [String] The item’s path.
-    def path(params = {})
-      reps.fetch(params.fetch(:rep, :default)).path(params)
+    def path(rep: :default, snapshot: :last)
+      reps.fetch(rep).path(snapshot: snapshot)
     end
 
     # Returns the children of this item. For items with identifiers that have
@@ -44,7 +44,10 @@ module Nanoc
         raise Nanoc::Int::Errors::CannotGetParentOrChildrenOfNonLegacyItem.new(unwrap.identifier)
       end
 
-      unwrap.children.map { |i| Nanoc::ItemView.new(i) }
+      children_pattern = Nanoc::Int::Pattern.from(unwrap.identifier.to_s + '*/')
+      children = @context.items.select { |i| children_pattern.match?(i.identifier) }
+
+      children.map { |i| Nanoc::ItemView.new(i, @context) }.freeze
     end
 
     # Returns the parent of this item, if one exists. For items with identifiers
@@ -58,7 +61,10 @@ module Nanoc
         raise Nanoc::Int::Errors::CannotGetParentOrChildrenOfNonLegacyItem.new(unwrap.identifier)
       end
 
-      unwrap.parent && Nanoc::ItemView.new(unwrap.parent)
+      parent_identifier = '/' + unwrap.identifier.components[0..-2].join('/') + '/'
+      parent = @context.items[parent_identifier]
+
+      parent && Nanoc::ItemView.new(parent, @context).freeze
     end
 
     # @return [Boolean] True if the item is binary, false otherwise
@@ -70,7 +76,7 @@ module Nanoc
     #
     # @return [Nanoc::ItemRepCollectionView]
     def reps
-      Nanoc::ItemRepCollectionView.new(unwrap.reps)
+      Nanoc::ItemRepCollectionView.new(@context.reps[unwrap], @context)
     end
 
     # @api private

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

@@ -1,5 +1,5 @@
 module Nanoc
-  class LayoutView
+  class LayoutView < ::Nanoc::View
     include Nanoc::DocumentViewMixin
   end
 end

data/lib/nanoc/base/views/mixins/document_view_mixin.rb

@@ -4,7 +4,8 @@ module Nanoc
     NONE = Object.new
 
     # @api private
-    def initialize(document)
+    def initialize(document, context)
+      super(context)
       @document = document
     end
 

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

@@ -8,7 +8,7 @@ module Nanoc
     #
     # @return [self]
     def delete_if(&_block)
-      @objects.delete_if { |o| yield(view_class.new(o)) }
+      @objects.delete_if { |o| yield(view_class.new(o, @context)) }
       self
     end
   end

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

@@ -15,17 +15,14 @@ module Nanoc
     #
     # @param [Nanoc::Identifier, String] identifier This item's identifier.
     #
-    # @param [Hash] params Extra parameters.
+    # @param [Boolean] binary Whether or not this item is binary
     #
-    # @option params [Boolean] :binary (false) Whether or not this item is
-    #   binary
-    #
-    # @option params [String] :filename (nil) Absolute path to the file
+    # @param [String] filename Absolute path to the file
     #   containing this content (if any)
     #
     # @return [self]
-    def create(content, attributes, identifier, params = {})
-      content = Nanoc::Int::Content.create(content, params)
+    def create(content, attributes, identifier, binary: false, filename: nil)
+      content = Nanoc::Int::Content.create(content, binary: binary, filename: filename)
       @objects << Nanoc::Int::Item.new(content, attributes, identifier)
       self
     end

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

@@ -0,0 +1,8 @@
+module Nanoc
+  class PostCompileItemCollectionView < Nanoc::IdentifiableCollectionView
+    # @api private
+    def view_class
+      Nanoc::PostCompileItemView
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Nanoc
+  class PostCompileItemView < Nanoc::ItemView
+    def modified
+      reps.select { |rep| rep.unwrap.modified }
+    end
+  end
+end

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

@@ -1,7 +1,8 @@
 module Nanoc
-  class SiteView
+  class SiteView < ::Nanoc::View
     # @api private
-    def initialize(site)
+    def initialize(site, context)
+      super(context)
       @site = site
     end
 

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

@@ -0,0 +1,12 @@
+module Nanoc
+  class View
+    # @api private
+    def initialize(context)
+      @context = context
+    end
+
+    def _context
+      @context
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Nanoc
+  # @api private
+  class ViewContext
+    attr_reader :reps
+    attr_reader :items
+
+    def initialize(reps:, items:)
+      @reps = reps
+      @items = items
+    end
+  end
+end

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

@@ -17,15 +17,13 @@ EOS
 
 module Nanoc::CLI::Commands
   class Compile < ::Nanoc::CLI::CommandRunner
-    extend Nanoc::Int::Memoization
-
     # Listens to compilation events and reacts to them. This abstract class
     # does not have a real implementation; subclasses should override {#start}
     # and set up notifications to listen to.
     #
     # @abstract Subclasses must override {#start} and may override {#stop}.
     class Listener
-      def initialize(_params = {})
+      def initialize(*)
       end
 
       # @param [Nanoc::CLI::CommandRunner] command_runner The command runner for this listener
@@ -147,11 +145,11 @@ module Nanoc::CLI::Commands
         command_runner.options.fetch(:verbose, false)
       end
 
-      # @option params [Array<Nanoc::Int::ItemRep>] :reps The list of item representations in the site
-      def initialize(params = {})
+      # @param [Enumerable<Nanoc::Int::ItemRep>] reps
+      def initialize(reps:)
         @times = {}
 
-        @reps = params.fetch(:reps)
+        @reps = reps
       end
 
       # @see Listener#start
@@ -249,7 +247,7 @@ module Nanoc::CLI::Commands
         !ENV.key?('TRAVIS')
       end
 
-      def initialize(_params = {})
+      def initialize(*)
         @gc_count = 0
       end
 
@@ -314,11 +312,10 @@ module Nanoc::CLI::Commands
 
     # Prints file actions (created, updated, deleted, identical, skipped)
     class FileActionPrinter < Listener
-      # @option params [Array<Nanoc::Int::ItemRep>] :reps The list of item representations in the site
-      def initialize(params = {})
+      def initialize(reps:)
         @start_times = {}
 
-        @reps = params.fetch(:reps)
+        @reps = reps
       end
 
       # @see Listener#start
@@ -361,9 +358,11 @@ module Nanoc::CLI::Commands
       end
     end
 
-    def initialize(options, arguments, command, params = {})
-      super(options, arguments, command)
-      @listener_classes = params.fetch(:listener_classes, default_listener_classes)
+    attr_accessor :listener_classes
+
+    def initialize(options, arguments, command)
+      super
+      @listener_classes = default_listener_classes
     end
 
     def run
@@ -425,9 +424,8 @@ module Nanoc::CLI::Commands
     end
 
     def reps
-      site.items.map(&:reps).flatten
+      site.compiler.reps
     end
-    memoize :reps
 
     def prune_config
       site.config[:prune] || {}