nanoc 3.8.0 → 4.0.0a1

data/lib/nanoc/base/core_ext/hash.rb

@@ -1,57 +1,48 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::HashExtensions
   # Returns a new hash where all keys are recursively converted to symbols by
-  # calling {Nanoc::ArrayExtensions#symbolize_keys_recursively} or
-  # {Nanoc::HashExtensions#symbolize_keys_recursively}.
+  # calling {Nanoc::ArrayExtensions#__nanoc_symbolize_keys_recursively} or
+  # {Nanoc::HashExtensions#__nanoc_symbolize_keys_recursively}.
   #
   # @return [Hash] The converted hash
-  def symbolize_keys_recursively
+  def __nanoc_symbolize_keys_recursively
     hash = {}
     each_pair do |key, value|
       new_key   = key.respond_to?(:to_sym) ? key.to_sym : key
-      new_value = value.respond_to?(:symbolize_keys_recursively) ? value.symbolize_keys_recursively : value
+      new_value = value.respond_to?(:__nanoc_symbolize_keys_recursively) ? value.__nanoc_symbolize_keys_recursively : value
       hash[new_key] = new_value
     end
     hash
   end
 
-  # @deprecated Renamed to {#symbolize_keys_recursively}
-  def symbolize_keys
-    symbolize_keys_recursively
-  end
-
   # Returns a new hash where all keys are recursively converted to strings by
-  # calling {Nanoc::ArrayExtensions#stringify_keys_recursively} or
-  # {Nanoc::HashExtensions#stringify_keys_recursively}.
+  # calling {Nanoc::ArrayExtensions#__nanoc_stringify_keys_recursively} or
+  # {Nanoc::HashExtensions#__nanoc_stringify_keys_recursively}.
   #
   # @return [Hash] The converted hash
-  def stringify_keys_recursively
+  def __nanoc_stringify_keys_recursively
     reduce({}) do |hash, (key, value)|
-      hash.merge(key.to_s => value.respond_to?(:stringify_keys_recursively) ? value.stringify_keys_recursively : value)
+      hash.merge(key.to_s => value.respond_to?(:__nanoc_stringify_keys_recursively) ? value.__nanoc_stringify_keys_recursively : value)
     end
   end
 
-  # @deprecated Renamed to {#stringify_keys_recursively}
-  def stringify_keys
-    stringify_keys_recursively
-  end
-
   # Freezes the contents of the hash, as well as all hash values. The hash
-  # values will be frozen using {#freeze_recursively} if they respond to
+  # values will be frozen using {#__nanoc_freeze_recursively} if they respond to
   # that message, or #freeze if they do not.
   #
-  # @see Array#freeze_recursively
+  # @see Array#__nanoc_freeze_recursively
   #
   # @return [void]
   #
   # @since 3.2.0
-  def freeze_recursively
+  def __nanoc_freeze_recursively
     return if self.frozen?
     freeze
     each_pair do |_key, value|
-      if value.respond_to?(:freeze_recursively)
-        value.freeze_recursively
+      if value.respond_to?(:__nanoc_freeze_recursively)
+        value.__nanoc_freeze_recursively
       else
         value.freeze
       end
@@ -64,11 +55,12 @@ module Nanoc::HashExtensions
   # @return [String] The checksum for this hash
   #
   # @api private
-  def checksum
-    Nanoc::Checksummer.calc(self)
+  def __nanoc_checksum
+    Nanoc::Int::Checksummer.calc(self)
   end
 end
 
+# @api private
 class Hash
   include Nanoc::HashExtensions
 end

data/lib/nanoc/base/core_ext/pathname.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::PathnameExtensions
   # Calculates the checksum for the file referenced to by this pathname. Any
   # change to the file contents will result in a different checksum.
@@ -7,11 +8,12 @@ module Nanoc::PathnameExtensions
   # @return [String] The checksum for this file
   #
   # @api private
-  def checksum
-    Nanoc::Checksummer.calc(self)
+  def __nanoc_checksum
+    Nanoc::Int::Checksummer.calc(self)
   end
 end
 
+# @api private
 class Pathname
   include Nanoc::PathnameExtensions
 end

data/lib/nanoc/base/core_ext/string.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::StringExtensions
   # Transforms string into an actual identifier
   #
   # @return [String] The identifier generated from the receiver
-  def cleaned_identifier
+  def __nanoc_cleaned_identifier
     "/#{self}/".gsub(/^\/+|\/+$/, '/')
   end
 
@@ -14,11 +15,12 @@ module Nanoc::StringExtensions
   # @return [String] The checksum for this string
   #
   # @api private
-  def checksum
-    Nanoc::Checksummer.calc(self)
+  def __nanoc_checksum
+    Nanoc::Int::Checksummer.calc(self)
   end
 end
 
+# @api private
 class String
   include Nanoc::StringExtensions
 end

data/lib/nanoc/base/directed_graph.rb

@@ -1,13 +1,13 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Represents a directed graph. It is used by the dependency tracker for
   # storing and querying dependencies between items.
   #
   # @example Creating and using a directed graph
   #
   #   # Create a graph with three vertices
-  #   graph = Nanoc::DirectedGraph.new(%w( a b c d ))
+  #   graph = Nanoc::Int::DirectedGraph.new(%w( a b c d ))
   #
   #   # Add edges
   #   graph.add_edge('a', 'b')
@@ -28,6 +28,8 @@ module Nanoc
   #     # => %w( c )
   #   graph.predecessors_of('d').sort
   #     # => %w( b c )
+  #
+  # @api private
   class DirectedGraph
     # @group Creating a graph
 
@@ -224,13 +226,6 @@ module Nanoc
       @roots
     end
 
-    # @group Deprecated methods
-
-    # @deprecated Use {#delete_edge} instead
-    def remove_edge(from, to)
-      delete_edge(from, to)
-    end
-
     private
 
     # Invalidates cached data. This method should be called when the internal

data/lib/nanoc/base/error.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Nanoc
+  # Generic error. Superclass for all nanoc-specific errors.
+  class Error < ::StandardError
+  end
+end

data/lib/nanoc/base/errors.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Module that contains all nanoc-specific errors.
+  #
+  # @api private
   module Errors
-    # Generic error. Superclass for all nanoc-specific errors.
-    class Generic < ::StandardError
-    end
+    Generic = ::Nanoc::Error
 
     # Generic trivial error. Superclass for all nanoc-specific errors that are
     # considered "trivial", i.e. errors that do not require a full crash report.
@@ -56,7 +56,7 @@ module Nanoc
     # Error that is raised during site compilation when an item (directly or
     # indirectly) includes its own item content, leading to endless recursion.
     class RecursiveCompilation < Generic
-      # @param [Array<Nanoc::ItemRep>] reps A list of item representations
+      # @param [Array<Nanoc::Int::ItemRep>] reps A list of item representations
       #   that mutually depend on each other
       def initialize(reps)
         list = reps.map(&:inspect).join("\n")
@@ -75,7 +75,7 @@ module Nanoc
     # Error that is raised when no compilation rule that can be applied to the
     # current item can be found.
     class NoMatchingCompilationRuleFound < Generic
-      # @param [Nanoc::Item] item The item for which no compilation rule
+      # @param [Nanoc::Int::Item] item The item for which no compilation rule
       #   could be found
       def initialize(item)
         super("No compilation rules were found for the “#{item.identifier}” item.")
@@ -85,7 +85,7 @@ module Nanoc
     # Error that is raised when no routing rule that can be applied to the
     # current item can be found.
     class NoMatchingRoutingRuleFound < Generic
-      # @param [Nanoc::ItemRep] rep The item repiresentation for which no
+      # @param [Nanoc::Int::ItemRep] rep The item repiresentation for which no
       #   routing rule could be found
       def initialize(rep)
         super("No routing rules were found for the “#{rep.item.identifier}” item (rep “#{rep.name}”).")
@@ -95,11 +95,11 @@ module Nanoc
     # Error that is raised when an rep cannot be compiled because it depends
     # on other representations.
     class UnmetDependency < Generic
-      # @return [Nanoc::ItemRep] The item representation that cannot yet be
+      # @return [Nanoc::Int::ItemRep] The item representation that cannot yet be
       #   compiled
       attr_reader :rep
 
-      # @param [Nanoc::ItemRep] rep The item representation that cannot yet be
+      # @param [Nanoc::Int::ItemRep] rep The item representation that cannot yet be
       #   compiled
       def initialize(rep)
         @rep = rep
@@ -109,7 +109,7 @@ module Nanoc
 
     # Error that is raised when a binary item is attempted to be laid out.
     class CannotLayoutBinaryItem < Generic
-      # @param [Nanoc::ItemRep] rep The item representation that was attempted
+      # @param [Nanoc::Int::ItemRep] rep The item representation that was attempted
       #   to be laid out
       def initialize(rep)
         super("The “{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.")
@@ -119,7 +119,7 @@ module Nanoc
     # Error that is raised when a textual filter is attempted to be applied to
     # a binary item representation.
     class CannotUseTextualFilter < Generic
-      # @param [Nanoc::ItemRep] rep The item representation that was
+      # @param [Nanoc::Int::ItemRep] rep The item representation that was
       #   attempted to be filtered
       #
       # @param [Class] filter_class The filter class that was used
@@ -131,7 +131,7 @@ module Nanoc
     # Error that is raised when a binary filter is attempted to be applied to
     # a textual item representation.
     class CannotUseBinaryFilter < Generic
-      # @param [Nanoc::ItemRep] rep The item representation that was
+      # @param [Nanoc::Int::ItemRep] rep The item representation that was
       #   attempted to be filtered
       #
       # @param [Class] filter_class The filter class that was used
@@ -143,14 +143,14 @@ module Nanoc
     # Error that is raised when the compiled content at a non-existing snapshot
     # is requested.
     class NoSuchSnapshot < Generic
-      # @return [Nanoc::ItemRep] The item rep from which the compiled content
+      # @return [Nanoc::Int::ItemRep] The item rep from which the compiled content
       #   was requested
       attr_reader :item_rep
 
       # @return [Symbol] The requested snapshot
       attr_reader :snapshot
 
-      # @param [Nanoc::ItemRep] item_rep The item rep from which the compiled
+      # @param [Nanoc::Int::ItemRep] item_rep The item rep from which the compiled
       #   content was requested
       #
       # @param [Symbol] snapshot The requested snapshot
@@ -162,7 +162,7 @@ module Nanoc
 
     # Error that is raised when a snapshot with an existing name is made.
     class CannotCreateMultipleSnapshotsWithSameName < Generic
-      # @param [Nanoc::ItemRep] rep The item representation for which a
+      # @param [Nanoc::Int::ItemRep] rep The item representation for which a
       #   snapshot was attempted to be made
       #
       # @param [Symbol] snapshot The name of the snapshot that was attempted to
@@ -174,19 +174,12 @@ module Nanoc
 
     # Error that is raised when the compiled content of a binary item is attempted to be accessed.
     class CannotGetCompiledContentOfBinaryItem < Generic
-      # @param [Nanoc::ItemRep] rep The binary item representation whose compiled content was attempted to be accessed
+      # @param [Nanoc::Int::ItemRep] rep The binary item representation whose compiled content was attempted to be accessed
       def initialize(rep)
         super("You cannot access the compiled content of a binary item representation (but you can access the path). The offending item rep is #{rep.inspect}.")
       end
     end
 
-    # @deprecated No longer necessary, but kept for backwards compatibility.
-    class DataNotYetAvailable < Generic
-      def initialize(type, plural)
-        super("#{type} #{plural ? 'are' : 'is'} not available yet. You may be missing a Nanoc::Site#load_data call.")
-      end
-    end
-
     # Error that is raised when multiple items or layouts with the same identifier exist.
     class DuplicateIdentifier < Generic
       def initialize(identifier, type)

data/lib/nanoc/base/memoization.rb

@@ -1,8 +1,10 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Adds support for memoizing functions.
   #
+  # @api private
+  #
   # @since 3.2.0
   module Memoization
     # Memoizes the method with the given name. The modified method will cache
@@ -20,7 +22,7 @@ module Nanoc
     #
     #     class FibFast
     #
-    #       extend Nanoc::Memoization
+    #       extend Nanoc::Int::Memoization
     #
     #       def run(n)
     #         if n == 0

data/lib/nanoc/base/notification_center.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Provides a way to send notifications between objects. It allows blocks
   # associated with a certain notification name to be registered; these blocks
   # will be called when the notification with the given name is posted.
@@ -8,6 +8,8 @@ module Nanoc
   # It is a slightly different implementation of the Observer pattern; the
   # table of subscribers is not stored in the observable object itself, but in
   # the notification center.
+  #
+  # @api private
   class NotificationCenter
     class << self
       # Adds the given block to the list of blocks that should be called when

data/lib/nanoc/base/plugin_registry.rb

@@ -1,11 +1,12 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # The class responsible for keeping track of all loaded plugins, such as
-  # filters ({Nanoc::Filter}), data sources ({Nanoc::DataSource}) and VCSes
-  # ({Nanoc::Extra::VCS}).
+  # filters ({Nanoc::Filter}) and data sources ({Nanoc::DataSource}).
+  #
+  # @api private
   class PluginRegistry
-    extend Nanoc::Memoization
+    extend Nanoc::Int::Memoization
 
     # A module that contains class methods for plugins. It provides functions
     # for setting identifiers, registering plugins and finding plugins. Plugin
@@ -25,7 +26,7 @@ module Nanoc
       #   @return [Array<Symbol>] The identifiers for this plugin
       def identifiers(*identifiers)
         if identifiers.empty?
-          Nanoc::PluginRegistry.instance.identifiers_of(superclass, self)
+          Nanoc::Int::PluginRegistry.instance.identifiers_of(superclass, self)
         else
           register(self, *identifiers)
         end
@@ -46,7 +47,7 @@ module Nanoc
         if identifier
           identifiers(identifier)
         else
-          Nanoc::PluginRegistry.instance.identifiers_of(superclass, self).first
+          Nanoc::Int::PluginRegistry.instance.identifiers_of(superclass, self).first
         end
       end
 
@@ -65,14 +66,14 @@ module Nanoc
         klass = klass.superclass while klass.superclass.respond_to?(:register)
 
         # Register
-        registry = Nanoc::PluginRegistry.instance
+        registry = Nanoc::Int::PluginRegistry.instance
         registry.register(klass, class_or_name, *identifiers)
       end
 
       # @return [Hash<Symbol, Class>] All plugins of this type, with keys
       #   being the identifiers and values the plugin classes
       def all
-        Nanoc::Plugin.find_all(self)
+        Nanoc::Int::PluginRegistry.instance.find_all(self)
       end
 
       # Returns the plugin with the given name (identifier)
@@ -81,21 +82,21 @@ module Nanoc
       #
       # @return [Class] The plugin class with the given name
       def named(name)
-        Nanoc::Plugin.find(self, name)
+        Nanoc::Int::PluginRegistry.instance.find(self, name)
       end
     end
 
     # Returns the shared {PluginRegistry} instance, creating it if none exists
     # yet.
     #
-    # @return [Nanoc::PluginRegistry] The shared plugin registry
+    # @return [Nanoc::Int::PluginRegistry] The shared plugin registry
     def self.instance
       @instance ||= new
     end
 
     # Creates a new plugin registry. This should usually not be necessary; it
     # is recommended to use the shared instance (obtained from
-    # {Nanoc::PluginRegistry.instance}).
+    # {Nanoc::Int::PluginRegistry.instance}).
     def initialize
       @identifiers_to_classes = {}
       @classes_to_identifiers = {}
@@ -104,7 +105,7 @@ module Nanoc
     # Registers the given class as a plugin.
     #
     # @param [Class] superclass The superclass of the plugin. For example:
-    #   {Nanoc::Filter}, {Nanoc::Extra::VCS}.
+    #   {Nanoc::Filter}.
     #
     # @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
@@ -126,7 +127,7 @@ module Nanoc
     end
 
     # @param [Class] superclass The superclass of the plugin. For example:
-    #   {Nanoc::Filter}, {Nanoc::Extra::VCS}.
+    #   {Nanoc::Filter}.
     #
     # @param [Class] klass The class to get the identifiers for.
     #
@@ -193,11 +194,6 @@ module Nanoc
       plugins
     end
 
-    # @deprecated Use {Nanoc::PluginRegistry#find} instead
-    def named(name)
-      find(self, name)
-    end
-
     protected
 
     def resolve(class_or_name, _klass)
@@ -215,7 +211,4 @@ module Nanoc
       klass.to_s.sub(/^(::)?/, '::')
     end
   end
-
-  # @deprecated Use {Nanoc::PluginRegistry.instance} instead
-  Plugin = PluginRegistry.instance
 end