nanoc 4.0.2 → 4.1.0a1

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

@@ -27,19 +27,12 @@ module Nanoc::Int
     # @param [Proc] block A block that will be called when matching items are
     #   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(pattern, rep_name, block, params = {})
-      # TODO: remove me
-      unless pattern.is_a?(Nanoc::Int::StringPattern) || pattern.is_a?(Nanoc::Int::RegexpPattern)
-        raise 'Can only create rules with patterns'
-      end
-
-      @pattern          = pattern
-      @rep_name         = rep_name.to_sym
-      @snapshot_name    = params[:snapshot_name]
-
+    # @param [Symbol, nil] :snapshot The name of the snapshot this rule will
+    #   apply to. Ignored for compilation rules, but used for routing rules.
+    def initialize(pattern, rep_name, block, snapshot_name: nil)
+      @pattern = pattern
+      @rep_name = rep_name.to_sym
+      @snapshot_name = snapshot_name
       @block = block
     end
 
@@ -53,19 +46,15 @@ module Nanoc::Int
 
     # Applies this rule to the given item rep.
     #
-    # @param [Nanoc::Int::ItemRep] rep The item representation where this rule
-    #   should be applied to
-    #
-    # @option params [Nanoc::Int::Compiler] :compiler The compiler
-    #
-    # @raise [ArgumentError] if no compiler is passed
+    # @param [Nanoc::Int::ItemRep] rep
+    # @param [Nanoc::Int::Site] site
+    # @param [Nanoc::Int::Executor, Nanoc::Int::RecordingExecutor] executor
+    # @param [Nanoc::ViewContext] view_context
     #
     # @return [void]
-    def apply_to(rep, params = {})
-      compiler = params.fetch(:compiler)
-      executor = params.fetch(:executor)
-
-      context = Nanoc::Int::RuleContext.new(rep: rep, executor: executor, compiler: compiler)
+    def apply_to(rep, site:, executor:, view_context:)
+      context = Nanoc::Int::RuleContext.new(
+        rep: rep, executor: executor, site: site, view_context: view_context)
       context.instance_exec(matches(rep.item.identifier), &@block)
     end
 

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

@@ -5,21 +5,21 @@ module Nanoc::Int
   #
   # @api private
   class RuleContext < Nanoc::Int::Context
-    # @option params [Nanoc::Int::ItemRep] :rep
-    # @option params [Nanoc::Int::Compiler] :compiler
-    def initialize(params = {})
-      rep = params.fetch(:rep)
-      compiler = params.fetch(:compiler)
-      @_executor = params.fetch(:executor)
+    # @param [Nanoc::Int::ItemRep] rep
+    # @param [Nanoc::Int::Site] site
+    # @param [Nanoc::Int::Executor, Nanoc::Int::RecordingExecutor] executor
+    # @param [Nanoc::ViewContext] view_context
+    def initialize(rep:, site:, executor:, view_context:)
+      @_executor = executor
 
       super({
-        item: Nanoc::ItemView.new(rep.item),
-        rep: Nanoc::ItemRepView.new(rep),
-        item_rep: Nanoc::ItemRepView.new(rep),
-        items: Nanoc::ItemCollectionView.new(compiler.site.items),
-        layouts: Nanoc::LayoutCollectionView.new(compiler.site.layouts),
-        config: Nanoc::ConfigView.new(compiler.site.config),
-        site: Nanoc::SiteView.new(compiler.site),
+        item: Nanoc::ItemView.new(rep.item, view_context),
+        rep: Nanoc::ItemRepView.new(rep, view_context),
+        item_rep: Nanoc::ItemRepView.new(rep, view_context),
+        items: Nanoc::ItemCollectionView.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
 
@@ -59,9 +59,23 @@ module Nanoc::Int
     #
     # @param [Symbol] snapshot_name The name of the snapshot to create
     #
+    # @param [String, nil] path
+    #
+    # @return [void]
+    def snapshot(snapshot_name, path: nil)
+      @_executor.snapshot(rep.unwrap, snapshot_name, path: path)
+    end
+
+    # Creates a snapshot named :last the current compiled item content, with
+    # the given path. This is a convenience method for {#snapshot}.
+    #
+    # @see #snapshot
+    #
+    # @param [String] path
+    #
     # @return [void]
-    def snapshot(snapshot_name)
-      @_executor.snapshot(rep.unwrap, snapshot_name)
+    def write(path)
+      snapshot(:last, path: path)
     end
   end
 end

data/lib/nanoc/base/entities.rb

@@ -1,6 +1,16 @@
+require_relative 'entities/code_snippet'
+require_relative 'entities/configuration'
 require_relative 'entities/content'
 require_relative 'entities/document'
 require_relative 'entities/identifier'
+require_relative 'entities/identifiable_collection'
+require_relative 'entities/item'
+require_relative 'entities/item_rep'
 require_relative 'entities/layout'
 require_relative 'entities/pattern'
+require_relative 'entities/rule_memory'
+require_relative 'entities/rule_memory_action'
+require_relative 'entities/rule_memory_actions'
+require_relative 'entities/rules_collection'
+require_relative 'entities/site'
 require_relative 'entities/snapshot_def'

data/lib/nanoc/base/{source_data → entities}/code_snippet.rb

@@ -19,10 +19,7 @@ module Nanoc::Int
     #   compilation
     #
     # @param [String] filename The filename corresponding to this code snippet
-    #
-    # @param [Time, Hash] _params Extra parameters. Ignored by Nanoc; it is
-    #   only included for backwards compatibility.
-    def initialize(data, filename, _params = nil)
+    def initialize(data, filename)
       @data     = data
       @filename = filename
     end

data/lib/nanoc/base/{source_data → entities}/configuration.rb

@@ -20,7 +20,7 @@ module Nanoc::Int
     # 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 coffee hb handlebars mustache ms slim rdoc ).sort,
+      text_extensions: %w( adoc asciidoc atom css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim rdoc ).sort,
       lib_dirs: %w( lib ),
       commands_dirs: %w( commands ),
       output_dir: 'output',

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

@@ -31,20 +31,19 @@ module Nanoc
       #   content) or the path to the filename containing the content (if this
       #   is binary content).
       #
-      # @option params [Boolean] :binary (false) Whether or not this item is
-      #   binary
+      # @param [Boolean] binary Whether or not this item is binary
       #
-      # @option params [String] :filename (nil) Absolute path to the file
-      #   containing this content (if any)
-      def self.create(content, params = {})
+      # @param [String] filename Absolute path to the file containing this
+      #   content (if any)
+      def self.create(content, binary: false, filename: nil)
         if content.nil?
           raise ArgumentError, 'Cannot create nil content'
         elsif content.is_a?(Nanoc::Int::Content)
           content
-        elsif params.fetch(:binary, false)
+        elsif binary
           Nanoc::Int::BinaryContent.new(content)
         else
-          Nanoc::Int::TextualContent.new(content, filename: params[:filename])
+          Nanoc::Int::TextualContent.new(content, filename: filename)
         end
       end
 
@@ -61,8 +60,8 @@ module Nanoc
       # @return [String]
       attr_reader :string
 
-      def initialize(string, params = {})
-        super(params[:filename])
+      def initialize(string, filename: nil)
+        super(filename)
         @string = string
       end
 

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

@@ -48,8 +48,8 @@ module Nanoc
       end
     end
 
-    def initialize(string, params = {})
-      @type = params.fetch(:type, :full)
+    def initialize(string, type: :full)
+      @type = type
 
       case @type
       when :legacy
@@ -161,6 +161,15 @@ module Nanoc
       s ? s.split('.', -1).drop(1) : []
     end
 
+    def components
+      res = to_s.split('/')
+      if res.empty?
+        []
+      else
+        res[1..-1]
+      end
+    end
+
     def to_s
       @string
     end

data/lib/nanoc/base/{source_data → entities}/item.rb

@@ -1,31 +1,13 @@
 module Nanoc::Int
   # @api private
   class Item < ::Nanoc::Int::Document
-    # @return [Array<Nanoc::Int::ItemRep>] This item’s list of item reps
-    attr_reader :reps
-
-    # @return [Nanoc::Int::Item, nil] The parent item of this item. This can be
-    #   nil even for non-root items.
-    attr_accessor :parent
-
-    # @return [Array<Nanoc::Int::Item>] The child items of this item
-    attr_accessor :children
-
     # @see Document#initialize
     def initialize(content, attributes, identifier)
       super
 
-      @parent = nil
-      @children = []
-      @reps = []
       @forced_outdated_status = ForcedOutdatedStatus.new
     end
 
-    def freeze
-      super
-      @children.freeze
-    end
-
     # Returns an object that can be used for uniquely identifying objects.
     #
     # @api private

data/lib/nanoc/base/{result_data → entities}/item_rep.rb

@@ -23,6 +23,10 @@ module Nanoc::Int
     # @return [Enumerable<Nanoc::Int:SnapshotDef]
     attr_accessor :snapshot_defs
 
+    # @return [Boolean]
+    attr_accessor :modified
+    alias_method :modified?, :modified
+
     # @param [Nanoc::Int::Item] item
     #
     # @param [Symbol] name
@@ -47,21 +51,21 @@ module Nanoc::Int
 
     # Returns the compiled content from a given snapshot.
     #
-    # @option params [String] :snapshot The name of the snapshot from which to
+    # @param [Symbol] 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 compiled content at the given snapshot (or the
     #   default snapshot if no snapshot is specified)
-    def compiled_content(params = {})
+    def compiled_content(snapshot: nil)
       # Make sure we're not binary
       if binary?
         raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
       end
 
       # Get name of last pre-layout snapshot
-      snapshot_name = params.fetch(:snapshot) { @snapshot_contents[:pre] ? :pre : :last }
+      snapshot_name = snapshot || (@snapshot_contents[:pre] ? :pre : :last)
       is_moving = [:pre, :post, :last].include?(snapshot_name)
 
       # Check existance of snapshot
@@ -100,13 +104,12 @@ module Nanoc::Int
     # Returns the item rep’s raw path. It includes the path to the output
     # directory and the full 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 raw_path(params = {})
-      snapshot_name = params[:snapshot] || :last
-      @raw_paths[snapshot_name]
+    def raw_path(snapshot: :last)
+      @raw_paths[snapshot]
     end
 
     # Returns the item rep’s path, as used when being linked to. It starts
@@ -114,13 +117,12 @@ module Nanoc::Int
     # 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 = {})
-      snapshot_name = params[:snapshot] || :last
-      @paths[snapshot_name]
+    def path(snapshot: :last)
+      @paths[snapshot]
     end
 
     # Resets the compilation progress for this item representation. This is

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

@@ -0,0 +1,54 @@
+module Nanoc::Int
+  class RuleMemory
+    include Enumerable
+
+    def initialize(item_rep)
+      @item_rep = item_rep
+      @actions = []
+    end
+
+    def size
+      @actions.size
+    end
+
+    def [](idx)
+      @actions[idx]
+    end
+
+    def add_filter(filter_name, params)
+      @actions << Nanoc::Int::RuleMemoryActions::Filter.new(filter_name, params)
+    end
+
+    def add_layout(layout_identifier, params)
+      @actions << Nanoc::Int::RuleMemoryActions::Layout.new(layout_identifier, params)
+    end
+
+    def add_snapshot(snapshot_name, final, path)
+      will_add_snapshot(snapshot_name)
+      @actions << Nanoc::Int::RuleMemoryActions::Snapshot.new(snapshot_name, final, path)
+    end
+
+    def snapshot_actions
+      @actions.select { |a| a.is_a?(Nanoc::Int::RuleMemoryActions::Snapshot) }
+    end
+
+    def serialize
+      map(&:serialize)
+    end
+
+    def each
+      @actions.each { |a| yield(a) }
+    end
+
+    private
+
+    def will_add_snapshot(name)
+      @_snapshot_names ||= Set.new
+      if @_snapshot_names.include?(name)
+        raise Nanoc::Int::Errors::CannotCreateMultipleSnapshotsWithSameName.new(@item_rep, name)
+      else
+        @_snapshot_names << name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Nanoc::Int
+  class RuleMemoryAction
+    def serialize
+      raise NotImplementedError.new('Nanoc::RuleMemoryAction subclasses must implement #serialize and #to_s')
+    end
+
+    def to_s
+      raise NotImplementedError.new('Nanoc::RuleMemoryAction subclasses must implement #serialize and #to_s')
+    end
+
+    def inspect
+      format(
+        '<%s %s>',
+        self.class.to_s,
+        serialize[1..-1].map(&:inspect).join(', ')
+      )
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+require_relative 'rule_memory_actions/filter'
+require_relative 'rule_memory_actions/layout'
+require_relative 'rule_memory_actions/snapshot'

data/lib/nanoc/base/entities/rule_memory_actions/filter.rb

@@ -0,0 +1,22 @@
+module Nanoc::Int::RuleMemoryActions
+  class Filter < Nanoc::Int::RuleMemoryAction
+    # filter :foo
+    # filter :foo, params
+
+    attr_reader :filter_name
+    attr_reader :params
+
+    def initialize(filter_name, params)
+      @filter_name = filter_name
+      @params      = params
+    end
+
+    def serialize
+      [:filter, @filter_name, Nanoc::Int::Checksummer.calc(@params)]
+    end
+
+    def to_s
+      "filter #{@filter_name.inspect}, #{@params.inspect}"
+    end
+  end
+end

data/lib/nanoc/base/entities/rule_memory_actions/layout.rb

@@ -0,0 +1,22 @@
+module Nanoc::Int::RuleMemoryActions
+  class Layout < Nanoc::Int::RuleMemoryAction
+    # layout '/foo.erb'
+    # layout '/foo.erb', params
+
+    attr_reader :layout_identifier
+    attr_reader :params
+
+    def initialize(layout_identifier, params)
+      @layout_identifier = layout_identifier
+      @params = params
+    end
+
+    def serialize
+      [:layout, @layout_identifier, Nanoc::Int::Checksummer.calc(@params)]
+    end
+
+    def to_s
+      "layout #{@layout_identifier.inspect}, #{@params.inspect}"
+    end
+  end
+end