nanoc 3.8.0 → 4.0.0a1

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

@@ -1,60 +1,16 @@
 # encoding: utf-8
 
-module Nanoc
-  # A single representation (rep) of an item ({Nanoc::Item}). An item can
+module Nanoc::Int
+  # A single representation (rep) of an item ({Nanoc::Int::Item}). An item can
   # have multiple representations. A representation has its own output file.
   # A single item can therefore have multiple output files, each run through
   # a different set of filters with a different layout.
+  #
+  # @api private
   class ItemRep
-    # Contains all deprecated methods. Mixed into {Nanoc::ItemRep}.
-    module Deprecated
-      # @deprecated Modify the {#raw_paths} attribute instead
-      def raw_path=(raw_path)
-        raw_paths[:last] = raw_path
-      end
-
-      # @deprecated Modify the {#paths} attribute instead
-      def path=(path)
-        paths[:last] = path
-      end
-
-      # @deprecated Use {Nanoc::ItemRep#compiled_content} instead.
-      def content_at_snapshot(snapshot = :pre)
-        compiled_content(snapshot: snapshot)
-      end
-
-      # @deprecated
-      def created
-        raise NotImplementedError, 'Nanoc::ItemRep#created is no longer implemented'
-      end
-
-      # @deprecated
-      def created?
-        raise NotImplementedError, 'Nanoc::ItemRep#created? is no longer implemented'
-      end
-
-      # @deprecated
-      def modified
-        raise NotImplementedError, 'Nanoc::ItemRep#modified is no longer implemented'
-      end
-
-      # @deprecated
-      def modified?
-        raise NotImplementedError, 'Nanoc::ItemRep#modified? is no longer implemented'
-      end
-
-      # @deprecated
-      def written
-        raise NotImplementedError, 'Nanoc::ItemRep#written is no longer implemented'
-      end
-
-      # @deprecated
-      def written?
-        raise NotImplementedError, 'Nanoc::ItemRep#written? is no longer implemented'
-      end
-    end
-
-    # Contains all private methods. Mixed into {Nanoc::ItemRep}.
+    # Contains all private methods. Mixed into {Nanoc::Int::ItemRep}.
+    #
+    # @api private
     module Private
       # @return [Hash] A hash containing the assigns that will be used in the
       #   next filter or layout operation. The keys (symbols) will be made
@@ -125,7 +81,7 @@ module Nanoc
         is_created = !File.file?(raw_path)
 
         # Notify
-        Nanoc::NotificationCenter.post(:will_write_rep, self, snapshot)
+        Nanoc::Int::NotificationCenter.post(:will_write_rep, self, snapshot)
 
         if self.binary?
           temp_path = temporary_filenames[:last]
@@ -141,13 +97,13 @@ module Nanoc
         FileUtils.cp(temp_path, raw_path) if is_modified
 
         # Notify
-        Nanoc::NotificationCenter.post(:rep_written, self, raw_path, is_created, is_modified)
+        Nanoc::Int::NotificationCenter.post(:rep_written, self, raw_path, is_created, is_modified)
       end
 
       TMP_TEXT_ITEMS_DIR = 'text_items'
 
       def temp_filename
-        Nanoc::TempFilenameFactory.instance.create(TMP_TEXT_ITEMS_DIR)
+        Nanoc::Int::TempFilenameFactory.instance.create(TMP_TEXT_ITEMS_DIR)
       end
 
       # Resets the compilation progress for this item representation. This is
@@ -172,10 +128,9 @@ module Nanoc
       end
     end
 
-    include Deprecated
     include Private
 
-    # @return [Nanoc::Item] The item to which this rep belongs
+    # @return [Nanoc::Int::Item] The item to which this rep belongs
     attr_reader :item
 
     # @return [Symbol] The representation's unique name
@@ -192,7 +147,7 @@ module Nanoc
 
     # Creates a new item representation for the given item.
     #
-    # @param [Nanoc::Item] item The item to which the new representation will
+    # @param [Nanoc::Int::Item] item The item to which the new representation will
     #   belong.
     #
     # @param [Symbol] name The unique name for the new item representation.
@@ -227,12 +182,12 @@ module Nanoc
     def compiled_content(params = {})
       # Make sure we're not binary
       if item.binary?
-        raise Nanoc::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
+        raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
       end
 
       # Notify
-      Nanoc::NotificationCenter.post(:visit_started, item)
-      Nanoc::NotificationCenter.post(:visit_ended,   item)
+      Nanoc::Int::NotificationCenter.post(:visit_started, item)
+      Nanoc::Int::NotificationCenter.post(:visit_ended,   item)
 
       # Get name of last pre-layout snapshot
       snapshot_name = params.fetch(:snapshot) { @content[:pre] ? :pre : :last }
@@ -241,7 +196,7 @@ module Nanoc
       # Check existance of snapshot
       snapshot = snapshots.find { |s| s.first == snapshot_name }
       if !is_moving && (snapshot.nil? || snapshot[-1] == false)
-        raise Nanoc::Errors::NoSuchSnapshot.new(self, snapshot_name)
+        raise Nanoc::Int::Errors::NoSuchSnapshot.new(self, snapshot_name)
       end
 
       # Verify snapshot is usable
@@ -254,7 +209,7 @@ module Nanoc
         end
       is_usable_snapshot = @content[snapshot_name] && (self.compiled? || !is_still_moving)
       unless is_usable_snapshot
-        raise Nanoc::Errors::UnmetDependency.new(self)
+        raise Nanoc::Int::Errors::UnmetDependency.new(self)
       end
 
       @content[snapshot_name]
@@ -279,8 +234,8 @@ module Nanoc
     #
     # @return [String] The item rep’s path
     def raw_path(params = {})
-      Nanoc3::NotificationCenter.post(:visit_started, item)
-      Nanoc3::NotificationCenter.post(:visit_ended,   item)
+      Nanoc::Int::NotificationCenter.post(:visit_started, item)
+      Nanoc::Int::NotificationCenter.post(:visit_ended,   item)
 
       snapshot_name = params[:snapshot] || :last
       @raw_paths[snapshot_name]
@@ -296,8 +251,8 @@ module Nanoc
     #
     # @return [String] The item rep’s path
     def path(params = {})
-      Nanoc3::NotificationCenter.post(:visit_started, item)
-      Nanoc3::NotificationCenter.post(:visit_ended,   item)
+      Nanoc::Int::NotificationCenter.post(:visit_started, item)
+      Nanoc::Int::NotificationCenter.post(:visit_ended,   item)
 
       snapshot_name = params[:snapshot] || :last
       @paths[snapshot_name]
@@ -308,9 +263,9 @@ module Nanoc
     # filtered content of the last snapshot.
     #
     # This method is supposed to be called only in a compilation rule block
-    # (see {Nanoc::CompilerDSL#compile}).
+    # (see {Nanoc::Int::CompilerDSL#compile}).
     #
-    # @see Nanoc::ItemRepProxy#filter
+    # @see Nanoc::Int::ItemRepProxy#filter
     #
     # @param [Symbol] filter_name The name of the filter to run the item
     #   representations' content through
@@ -322,18 +277,18 @@ module Nanoc
     def filter(filter_name, filter_args = {})
       # Get filter class
       klass = filter_named(filter_name)
-      raise Nanoc::Errors::UnknownFilter.new(filter_name) if klass.nil?
+      raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
 
       # Check whether filter can be applied
       if klass.from_binary? && !self.binary?
-        raise Nanoc::Errors::CannotUseBinaryFilter.new(self, klass)
+        raise Nanoc::Int::Errors::CannotUseBinaryFilter.new(self, klass)
       elsif !klass.from_binary? && self.binary?
-        raise Nanoc::Errors::CannotUseTextualFilter.new(self, klass)
+        raise Nanoc::Int::Errors::CannotUseTextualFilter.new(self, klass)
       end
 
       begin
         # Notify start
-        Nanoc::NotificationCenter.post(:filtering_started, self, filter_name)
+        Nanoc::Int::NotificationCenter.post(:filtering_started, self, filter_name)
 
         # Create filter
         filter = klass.new(assigns)
@@ -358,7 +313,7 @@ module Nanoc
         snapshot(@content[:post] ? :post : :pre, final: false) unless self.binary?
       ensure
         # Notify end
-        Nanoc::NotificationCenter.post(:filtering_ended, self, filter_name)
+        Nanoc::Int::NotificationCenter.post(:filtering_ended, self, filter_name)
       end
     end
 
@@ -367,11 +322,11 @@ module Nanoc
     # snapshot.
     #
     # This method is supposed to be called only in a compilation rule block
-    # (see {Nanoc::CompilerDSL#compile}).
+    # (see {Nanoc::Int::CompilerDSL#compile}).
     #
-    # @see Nanoc::ItemRepProxy#layout
+    # @see Nanoc::Int::ItemRepProxy#layout
     #
-    # @param [Nanoc::Layout] layout The layout to use
+    # @param [Nanoc::Int::Layout] layout The layout to use
     #
     # @param [Symbol] filter_name The name of the filter to layout the item
     #   representations' content with
@@ -382,7 +337,7 @@ module Nanoc
     # @return [void]
     def layout(layout, filter_name, filter_args)
       # Check whether item can be laid out
-      raise Nanoc::Errors::CannotLayoutBinaryItem.new(self) if self.binary?
+      raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(self) if self.binary?
 
       # Create "pre" snapshot
       if @content[:post].nil?
@@ -391,17 +346,17 @@ module Nanoc
 
       # Create filter
       klass = filter_named(filter_name)
-      raise Nanoc::Errors::UnknownFilter.new(filter_name) if klass.nil?
+      raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
       filter = klass.new(assigns.merge({ layout: layout }))
 
       # Visit
-      Nanoc::NotificationCenter.post(:visit_started, layout)
-      Nanoc::NotificationCenter.post(:visit_ended,   layout)
+      Nanoc::Int::NotificationCenter.post(:visit_started, layout)
+      Nanoc::Int::NotificationCenter.post(:visit_ended,   layout)
 
       begin
         # Notify start
-        Nanoc::NotificationCenter.post(:processing_started, layout)
-        Nanoc::NotificationCenter.post(:filtering_started,  self, filter_name)
+        Nanoc::Int::NotificationCenter.post(:processing_started, layout)
+        Nanoc::Int::NotificationCenter.post(:filtering_started,  self, filter_name)
 
         # Layout
         @content[:last] = filter.setup_and_run(layout.raw_content, filter_args)
@@ -410,8 +365,8 @@ module Nanoc
         snapshot(:post, final: false)
       ensure
         # Notify end
-        Nanoc::NotificationCenter.post(:filtering_ended,  self, filter_name)
-        Nanoc::NotificationCenter.post(:processing_ended, layout)
+        Nanoc::Int::NotificationCenter.post(:filtering_ended,  self, filter_name)
+        Nanoc::Int::NotificationCenter.post(:processing_ended, layout)
       end
     end
 
@@ -444,9 +399,9 @@ module Nanoc
     #
     # @api private
     #
-    # @return [Nanoc::ItemRepRecorderProxy] The recording proxy
+    # @return [Nanoc::Int::ItemRepRecorderProxy] The recording proxy
     def to_recording_proxy
-      Nanoc::ItemRepRecorderProxy.new(self)
+      Nanoc::Int::ItemRepRecorderProxy.new(self)
     end
 
     # Returns false because this item is not yet a proxy, and therefore does
@@ -456,8 +411,8 @@ module Nanoc
     #
     # @return [false]
     #
-    # @see Nanoc::ItemRepRecorderProxy#proxy?
-    # @see Nanoc::ItemRepProxy#proxy?
+    # @see Nanoc::Int::ItemRepRecorderProxy#proxy?
+    # @see Nanoc::Int::ItemRepProxy#proxy?
     def proxy?
       false
     end

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

@@ -1,7 +1,9 @@
 # encoding: utf-8
 
-module Nanoc
-  # Nanoc::CodeSnippet represent a piece of custom code of a nanoc site.
+module Nanoc::Int
+  # Nanoc::Int::CodeSnippet represent a piece of custom code of a nanoc site.
+  #
+  # @api private
   class CodeSnippet
     # A string containing the actual code in this code snippet.
     #
@@ -47,8 +49,8 @@ module Nanoc
 
     # @return [String] The checksum for this object. If its contents change,
     #   the checksum will change as well.
-    def checksum
-      Nanoc::Checksummer.calc(self)
+    def __nanoc_checksum
+      Nanoc::Int::Checksummer.calc(self)
     end
   end
 end

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

@@ -1,7 +1,9 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Represents the site configuration.
+  #
+  # @api private
   class Configuration < ::Hash
     # Creates a new configuration with the given hash.
     #

data/lib/nanoc/base/source_data/data_source.rb

@@ -3,8 +3,7 @@
 module Nanoc
   # Responsible for loading site data. It is the (abstract) superclass for all
   # data sources. Subclasses must at least implement the data reading methods
-  # ({#items} and {#layouts}); all other methods involving data manipulation
-  # are optional.
+  # ({#items} and {#layouts}).
   #
   # Apart from the methods for loading and storing data, there are the {#up}
   # and {#down} methods for bringing up and tearing down the connection to the
@@ -16,14 +15,7 @@ module Nanoc
   # reference count goes from 1 to 0, the data source will be unloaded
   # ({#down} will be called).
   #
-  # The {#setup} method is used for setting up a site's data source for the
-  # first time.
-  #
-  # @abstract Subclasses should at least implement {#items} and {#layouts}. If
-  #   the data source should support creating items and layouts using the
-  #   `create_item` and `create_layout` CLI commands, the {#setup},
-  #   {#create_item} and {#create_layout} methods should be implemented as
-  #   well.
+  # @abstract Subclasses should at least implement {#items} and {#layouts}.
   class DataSource
     # @return [String] The root path where items returned by this data source
     #   should be mounted.
@@ -37,11 +29,11 @@ module Nanoc
     #   online data sources could contain authentication details.
     attr_reader :config
 
-    extend Nanoc::PluginRegistry::PluginMethods
+    extend Nanoc::Int::PluginRegistry::PluginMethods
 
     # Creates a new data source for the given site.
     #
-    # @param [Nanoc::Site] site The site this data source belongs to.
+    # @param [Nanoc::Int::Site] site The site this data source belongs to.
     #
     # @param [String] items_root The prefix that should be given to all items
     #   returned by the #items method (comparable to mount points for
@@ -122,43 +114,7 @@ module Nanoc
     def down
     end
 
-    # Creates the bare minimum essentials for this data source to work. This
-    # action will likely be destructive. This method should not create sample
-    # data such as a default home page, a default layout, etc. For example,
-    # when using a database, this is where you should create the necessary
-    # tables for the data source to function properly.
-    #
-    # @abstract
-    #
-    # @return [void]
-    def setup
-      not_implemented('setup')
-    end
-
-    # Updated the content stored in this site to a newer version. A newer
-    # version of a data source may store content in a different format, and
-    # this method will update the stored content to this newer format.
-    #
-    # Subclasses may override this method, but are not required to do so; the
-    # default implementation simply does nothing.
-    #
-    # @return [void]
-    def update
-    end
-
-    # Sync the content for this data source with an external source.
-    # This method is called by the `nanoc sync` command so that data sources may
-    # update local caches of external data, such as items fetched from
-    # third-party APIs.
-    #
-    # Subclasses may override this method, but are not required to do so; the
-    # default implementation simply does nothing.
-    #
-    # @return [void]
-    def sync
-    end
-
-    # Returns the list of items (represented by {Nanoc::Item}) in this site.
+    # Returns the list of items (represented by {Nanoc::Int::Item}) in this site.
     # The default implementation simply returns an empty array.
     #
     # Subclasses should not prepend `items_root` to the item's identifiers, as
@@ -167,12 +123,12 @@ module Nanoc
     # Subclasses may override this method, but are not required to do so; the
     # default implementation simply does nothing.
     #
-    # @return [Array<Nanoc::Item>] A list of items
+    # @return [Array<Nanoc::Int::Item>] A list of items
     def items
       []
     end
 
-    # Returns the list of layouts (represented by {Nanoc::Layout}) in this
+    # Returns the list of layouts (represented by {Nanoc::Int::Layout}) in this
     # site. The default implementation simply returns an empty array.
     #
     # Subclasses should prepend `layout_root` to the layout's identifiers,
@@ -181,55 +137,17 @@ module Nanoc
     # Subclasses may override this method, but are not required to do so; the
     # default implementation simply does nothing.
     #
-    # @return [Array<Nanoc::Layout>] A list of layouts
+    # @return [Array<Nanoc::Int::Layout>] A list of layouts
     def layouts
       []
     end
 
-    # Creates a new item with the given content, attributes and identifier. No
-    # instance of {Nanoc::Item} will be created; this method creates the item
-    # in the data source so that it can be loaded and turned into a
-    # {Nanoc::Item} instance by the {#items} method.
-    #
-    # @abstract
-    #
-    # @param [String] content
-    #
-    # @param [Hash] attributes
-    #
-    # @param [String] identifier
-    #
-    # @param [Hash] params Extra parameters to give to the data source. This
-    #   can be used to influence the way items are stored. For example,
-    #   filesystem data sources could use this to pass the extension of the
-    #   files that should be generated.
-    #
-    # @return [void]
-    def create_item(content, attributes, identifier, params = {}) # rubocop:disable Lint/UnusedMethodArgument
-      not_implemented('create_item')
+    def new_item(content, attributes, identifier, params = {})
+      Nanoc::Int::Item.new(content, attributes, identifier, params)
     end
 
-    # Creates a new layout with the given content, attributes and identifier.
-    # No instance of {Nanoc::Layout} will be created; this method creates the
-    # layout in the data source so that it can be loaded and turned into a
-    # {Nanoc::Layout} instance by the {#layouts} method.
-    #
-    # @abstract
-    #
-    # @param [String] content
-    #
-    # @param [Hash] attributes
-    #
-    # @param [String] identifier
-    #
-    # @param [Hash] params Extra parameters to give to the data source. This
-    #   can be used to influence the way items are stored. For example,
-    #   filesystem data sources could use this to pass the extension of the
-    #   files that should be generated.
-    #
-    # @return [void]
-    def create_layout(content, attributes, identifier, params = {}) # rubocop:disable Lint/UnusedMethodArgument
-      not_implemented('create_layout')
+    def new_layout(content, attributes, identifier)
+      Nanoc::Int::Layout.new(content, attributes, identifier)
     end
 
     private