nanoc 3.8.0 → 4.0.0a1

data/lib/nanoc/base/store.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # An abstract superclass for classes that need to store data to the
   # filesystem, such as checksums, cached compiled content and dependency
   # graphs.
@@ -42,7 +42,7 @@ module Nanoc
     #
     # @abstract This method must be implemented by the subclass.
     def data
-      raise NotImplementedError.new('Nanoc::Store subclasses must implement #data and #data=')
+      raise NotImplementedError.new('Nanoc::Int::Store subclasses must implement #data and #data=')
     end
 
     # @param new_data The data that has been loaded from the disk
@@ -51,7 +51,7 @@ module Nanoc
     #
     # @return [void]
     def data=(new_data) # rubocop:disable Lint/UnusedMethodArgument
-      raise NotImplementedError.new('Nanoc::Store subclasses must implement #data and #data=')
+      raise NotImplementedError.new('Nanoc::Int::Store subclasses must implement #data and #data=')
     end
 
     # Loads the data from the filesystem into memory. This method will set the
@@ -91,8 +91,6 @@ module Nanoc
     end
 
     # Undoes the effects of {#load}. Used when {#load} raises an exception.
-    #
-    # @api private
     def unload
     end
 

data/lib/nanoc/base/temp_filename_factory.rb

@@ -2,12 +2,13 @@
 
 require 'tmpdir'
 
-module Nanoc
+module Nanoc::Int
+  # @api private
   class TempFilenameFactory
     # @return [String] The root directory for all temporary filenames
     attr_reader :root_dir
 
-    # @return [Nanoc::TempFilenameFactory] A common instance
+    # @return [Nanoc::Int::TempFilenameFactory] A common instance
     def self.instance
       @instance ||= new
     end

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Nanoc
+  class ConfigView
+    # @api private
+    def initialize(config)
+      @config = config
+    end
+
+    # @api private
+    def unwrap
+      @config
+    end
+
+    def [](key)
+      @config[key]
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+module Nanoc
+  class ItemView
+    # @api private
+    def initialize(item)
+      @item = item
+    end
+
+    # @api private
+    def unwrap
+      @item
+    end
+
+    def ==(other)
+      identifier == other.identifier
+    end
+    alias_method :eql?, :==
+
+    def hash
+      self.class.hash ^ identifier.hash
+    end
+
+    def identifier
+      @item.identifier
+    end
+
+    def [](key)
+      @item[key]
+    end
+
+    def compiled_content(params = {})
+      @item.compiled_content(params)
+    end
+
+    def path(params = {})
+      @item.path(params)
+    end
+
+    def children
+      @item.children.map { |i| Nanoc::ItemView.new(i) }
+    end
+
+    def binary?
+      @item.binary?
+    end
+
+    def raw_content
+      @item.raw_content
+    end
+
+    # @api private
+    def reference
+      @item.reference
+    end
+
+    # @api private
+    def reps
+      @item.reps.map { |r| Nanoc::ItemRepView.new(r) }
+    end
+
+    # @api private
+    def raw_filename
+      @item.raw_filename
+    end
+
+    # @api private
+    def forced_outdated?
+      @item.forced_outdated?
+    end
+
+    # @api private
+    def __nanoc_checksum
+      @item.__nanoc_checksum
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module Nanoc
+  class ItemCollectionView
+    include Enumerable
+
+    # @api private
+    def initialize(items)
+      @items = items
+    end
+
+    # @api private
+    def unwrap
+      @items
+    end
+
+    # @api private
+    def view_class
+      Nanoc::ItemView
+    end
+
+    def each
+      @items.each { |i| yield view_class.new(i) }
+    end
+
+    def at(arg)
+      item = @items.at(arg)
+      item && view_class.new(item)
+    end
+
+    def [](*args)
+      res = @items[*args]
+      case res
+      when Array
+        res.map { |r| view_class.new(r) }
+      when nil
+        nil
+      else
+        view_class.new(res)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+module Nanoc
+  class ItemRepView
+    # @api private
+    def initialize(item_rep)
+      @item_rep = item_rep
+    end
+
+    # @api private
+    def unwrap
+      @item_rep
+    end
+
+    def ==(other)
+      item.identifier == other.item.identifier && name == other.name
+    end
+    alias_method :eql?, :==
+
+    def hash
+      self.class.hash ^ item.identifier.hash ^ name.hash
+    end
+
+    def name
+      @item_rep.name
+    end
+
+    def compiled_content(params = {})
+      @item_rep.compiled_content(params)
+    end
+
+    def path(params = {})
+      @item_rep.path(params)
+    end
+
+    def item
+      Nanoc::ItemView.new(@item_rep.item)
+    end
+
+    # @api private
+    def to_recording_proxy
+      @item_rep.to_recording_proxy
+    end
+
+    # @api private
+    def raw_path(params = {})
+      @item_rep.raw_path(params)
+    end
+
+    # @api private
+    def compiled?
+      @item_rep.compiled?
+    end
+
+    # @api private
+    def compiled=(new_compiled)
+      @item_rep.compiled = new_compiled
+    end
+
+    # @api private
+    def forget_progress
+      @item_rep.forget_progress
+    end
+
+    # @api private
+    def assigns
+      @item_rep.assigns
+    end
+
+    # @api private
+    def assigns=(new_assigns)
+      @item_rep.assigns = new_assigns
+    end
+
+    # @api private
+    def type
+      @item_rep.type
+    end
+
+    # @api private
+    def reference
+      @item_rep.reference
+    end
+
+    # @api private
+    def snapshot(snapshot_name, params = {})
+      @item_rep.snapshot(snapshot_name, params)
+    end
+
+    # @api private
+    def filter(filter_name, filter_args = {})
+      @item_rep.filter(filter_name, filter_args)
+    end
+
+    # @api private
+    def layout(layout, filter_name, filter_args)
+      @item_rep.layout(layout, filter_name, filter_args)
+    end
+
+    # @api private
+    def proxy?
+      @item_rep.proxy?
+    end
+
+    # @api private
+    def binary?
+      @item_rep.binary?
+    end
+
+    # @api private
+    def has_snapshot?(snapshot_name)
+      @item_rep.has_snapshot?(snapshot_name)
+    end
+
+    # @api private
+    def content
+      @item_rep.content
+    end
+
+    # @api private
+    def temporary_filenames
+      @item_rep.temporary_filenames
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Nanoc
+  class LayoutView
+    # @api private
+    def initialize(layout)
+      @layout = layout
+    end
+
+    # @api private
+    def unwrap
+      @layout
+    end
+
+    def ==(other)
+      identifier == other.identifier
+    end
+    alias_method :eql?, :==
+
+    def hash
+      self.class.hash ^ identifier.hash
+    end
+
+    def identifier
+      @layout.identifier
+    end
+
+    def [](key)
+      @layout[key]
+    end
+
+    # @api private
+    def reference
+      @layout.reference
+    end
+
+    # @api private
+    def raw_content
+      @layout.raw_content
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Nanoc
+  class LayoutCollectionView
+    include Enumerable
+
+    # @api private
+    def initialize(layouts)
+      @layouts = layouts
+    end
+
+    # @api private
+    def unwrap
+      @item
+    end
+
+    # @api private
+    def view_class
+      Nanoc::LayoutView
+    end
+
+    def each
+      @layouts.each { |l| yield view_class.new(l) }
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Nanoc
+  class MutableConfigView < Nanoc::ConfigView
+    def []=(key, value)
+      @config[key] = value
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Nanoc
+  class MutableItemView < Nanoc::ItemView
+    def []=(key, value)
+      unwrap[key] = value
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Nanoc
+  class MutableItemCollectionView < Nanoc::ItemCollectionView
+    # @api private
+    def view_class
+      Nanoc::MutableItemView
+    end
+
+    def create(content, attributes, identifier, params = {})
+      @items << Nanoc::Int::Item.new(content, attributes, identifier, params)
+    end
+
+    def delete_if(&block)
+      @items.delete_if(&block)
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Nanoc
+  class MutableLayoutView < Nanoc::LayoutView
+    def []=(key, value)
+      unwrap[key] = value
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Nanoc
+  class MutableLayoutCollectionView < Nanoc::LayoutCollectionView
+    # @api private
+    def view_class
+      Nanoc::MutableLayoutView
+    end
+
+    def create(content, attributes, identifier, params = {})
+      @layouts << Nanoc::Int::Layout.new(content, attributes, identifier, params)
+    end
+
+    def delete_if(&block)
+      @layouts.delete_if(&block)
+    end
+  end
+end