errors.rb in nanoc-4.0.0a1

- old
+ new

@@ -1,13 +1,13 @@
 # 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.
     class GenericTrivial < Generic
     end
@@ -54,11 +54,11 @@
     end
 
     # 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")
         super("The site cannot be compiled because the following items mutually depend on each other:\n#{list}.")
       end
@@ -73,55 +73,55 @@
     end
 
     # 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.")
       end
     end
 
     # 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}”).")
       end
     end
 
     # 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
         super("The current item cannot be compiled yet because of an unmet dependency on the “#{rep.item.identifier}” item (rep “#{rep.name}”).")
       end
     end
 
     # 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.")
       end
     end
 
     # 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
       def initialize(rep, filter_class)
         super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because textual filters cannot be used on binary items.")
@@ -129,11 +129,11 @@
     end
 
     # 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
       def initialize(rep, filter_class)
         super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items. 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.")
@@ -141,18 +141,18 @@
     end
 
     # 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
       def initialize(item_rep, snapshot)
         @item_rep, @snapshot = item_rep, snapshot
@@ -160,11 +160,11 @@
       end
     end
 
     # 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
       #   be made
       def initialize(rep, snapshot)
@@ -172,19 +172,12 @@
       end
     end
 
     # 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