nanoc 3.7.4 → 3.7.5

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

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 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.
   #
@@ -11,7 +10,6 @@ module Nanoc::PathnameExtensions
   def checksum
     Nanoc::Checksummer.calc(self)
   end
-
 end
 
 class Pathname

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

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::StringExtensions
-
   # Transforms string into an actual identifier
   #
   # @return [String] The identifier generated from the receiver
@@ -18,7 +17,6 @@ module Nanoc::StringExtensions
   def checksum
     Nanoc::Checksummer.calc(self)
   end
-
 end
 
 class String

data/lib/nanoc/base/directed_graph.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Represents a directed graph. It is used by the dependency tracker for
   # storing and querying dependencies between items.
   #
@@ -30,7 +29,6 @@ module Nanoc
   #   graph.predecessors_of('d').sort
   #     # => %w( b c )
   class DirectedGraph
-
     # @group Creating a graph
 
     # Creates a new directed graph with the given vertices.
@@ -266,7 +264,5 @@ module Nanoc
 
       all_vertices.to_a
     end
-
   end
-
 end

data/lib/nanoc/base/errors.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Module that contains all nanoc-specific errors.
   module Errors
-
     # Generic error. Superclass for all nanoc-specific errors.
     class Generic < ::StandardError
     end
@@ -17,103 +15,86 @@ module Nanoc
     # Error that is raised when a site is loaded that uses a data source with
     # an unknown identifier.
     class UnknownDataSource < Generic
-
       # @param [String] data_source_name The data source name for which no
       #   data source could be found
       def initialize(data_source_name)
         super("The data source specified in the site’s configuration file, “#{data_source_name}”, does not exist.")
       end
-
     end
 
     # Error that is raised during site compilation when an item uses a layout
     # that is not present in the site.
     class UnknownLayout < Generic
-
       # @param [String] layout_identifier The layout identifier for which no
       #   layout could be found
       def initialize(layout_identifier)
         super("The site does not have a layout with identifier “#{layout_identifier}”.")
       end
-
     end
 
     # Error that is raised during site compilation when an item uses a filter
     # that is not known.
     class UnknownFilter < Generic
-
       # @param [Symbol] filter_name The filter name for which no filter could
       #   be found
       def initialize(filter_name)
         super("The requested filter, “#{filter_name}”, does not exist.")
       end
-
     end
 
     # Error that is raised during site compilation when a layout is compiled
     # for which the filter cannot be determined. This is similar to the
     # {UnknownFilter} error, but specific for filters for layouts.
     class CannotDetermineFilter < Generic
-
       # @param [String] layout_identifier The identifier of the layout for
       #   which the filter could not be determined
       def initialize(layout_identifier)
         super("The filter to be used for the “#{layout_identifier}” layout could not be determined. Make sure the layout does have a filter.")
       end
-
     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
       #   that mutually depend on each other
       def initialize(reps)
-        list = reps.map { |r| r.inspect }.join("\n")
+        list = reps.map(&:inspect).join("\n")
         super("The site cannot be compiled because the following items mutually depend on each other:\n#{list}.")
       end
-
     end
 
     # Error that is raised when no rules file can be found in the current
     # working directory.
     class NoRulesFileFound < Generic
-
       def initialize
         super('This site does not have a rules file, which is required for nanoc sites.')
       end
-
     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
       #   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
       #   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
       #   compiled
       attr_reader :rep
@@ -124,24 +105,20 @@ module Nanoc
         @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
       #   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
       #   attempted to be filtered
       #
@@ -149,13 +126,11 @@ module Nanoc
       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.")
       end
-
     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
       #   attempted to be filtered
       #
@@ -163,13 +138,11 @@ module Nanoc
       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.")
       end
-
     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
       #   was requested
       attr_reader :item_rep
@@ -185,12 +158,10 @@ module Nanoc
         @item_rep, @snapshot = item_rep, snapshot
         super("The “#{item_rep.inspect}” item rep does not have a snapshot “#{snapshot.inspect}”")
       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
       #   snapshot was attempted to be made
       #
@@ -199,37 +170,28 @@ module Nanoc
       def initialize(rep, snapshot)
         super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep “#{rep.inspect}”")
       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
       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)
         super("There are multiple #{type}s with the #{identifier} identifier.")
       end
-
     end
-
   end
-
 end

data/lib/nanoc/base/memoization.rb

@@ -1,12 +1,10 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Adds support for memoizing functions.
   #
   # @since 3.2.0
   module Memoization
-
     # Memoizes the method with the given name. The modified method will cache
     # the results of the original method, so that calling a method twice with
     # the same arguments will short-circuit and return the cached results
@@ -61,7 +59,5 @@ module Nanoc
         @__memoization_cache[method_name][args]
       end
     end
-
   end
-
 end

data/lib/nanoc/base/notification_center.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc
-
   # 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.
@@ -10,9 +9,7 @@ module Nanoc
   # table of subscribers is not stored in the observable object itself, but in
   # the notification center.
   class NotificationCenter
-
     class << self
-
       # Adds the given block to the list of blocks that should be called when
       # the notification with the given name is received.
       #
@@ -31,7 +28,7 @@ module Nanoc
         initialize_if_necessary(name)
 
         # Add observer
-        @notifications[name] << { :id => id, :block => block }
+        @notifications[name] << { id: id, block: block }
       end
 
       # Posts a notification with the given name and the given arguments.
@@ -76,9 +73,6 @@ module Nanoc
         @notifications ||= {}       # name => observers dictionary
         @notifications[name] ||= [] # list of observers
       end
-
     end
-
   end
-
 end

data/lib/nanoc/base/plugin_registry.rb

@@ -1,19 +1,16 @@
 # encoding: utf-8
 
 module Nanoc
-
   # The class responsible for keeping track of all loaded plugins, such as
   # filters ({Nanoc::Filter}), data sources ({Nanoc::DataSource}) and VCSes
   # ({Nanoc::Extra::VCS}).
   class PluginRegistry
-
     extend Nanoc::Memoization
 
     # A module that contains class methods for plugins. It provides functions
     # for setting identifiers, registering plugins and finding plugins. Plugin
     # classes should extend this module.
     module PluginMethods
-
       # @overload identifiers(*identifiers)
       #
       #   Sets the identifiers for this plugin.
@@ -86,7 +83,6 @@ module Nanoc
       def named(name)
         Nanoc::Plugin.find(self, name)
       end
-
     end
 
     # Returns the shared {PluginRegistry} instance, creating it if none exists
@@ -182,13 +178,13 @@ module Nanoc
           if existing_plugin
             # Add identifier to existing plugin
             existing_plugin[:identifiers] << identifier
-            existing_plugin[:identifiers] = existing_plugin[:identifiers].sort_by { |s| s.to_s }
+            existing_plugin[:identifiers] = existing_plugin[:identifiers].sort_by(&:to_s)
           else
             # Create new plugin
             plugins << {
-              :class       => klass,
-              :superclass  => superclass,
-              :identifiers => [identifier]
+              class: klass,
+              superclass: superclass,
+              identifiers: [identifier]
             }
           end
         end
@@ -218,10 +214,8 @@ module Nanoc
     def name_for_class(klass)
       klass.to_s.sub(/^(::)?/, '::')
     end
-
   end
 
   # @deprecated Use {Nanoc::PluginRegistry.instance} instead
   Plugin = PluginRegistry.instance
-
 end

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

@@ -1,16 +1,13 @@
 # encoding: utf-8
 
 module Nanoc
-
   # A single representation (rep) of an item ({Nanoc::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.
   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
@@ -23,7 +20,7 @@ module Nanoc
 
       # @deprecated Use {Nanoc::ItemRep#compiled_content} instead.
       def content_at_snapshot(snapshot = :pre)
-        compiled_content(:snapshot => snapshot)
+        compiled_content(snapshot: snapshot)
       end
 
       # @deprecated
@@ -55,12 +52,10 @@ module Nanoc
       def written?
         raise NotImplementedError, 'Nanoc::ItemRep#written? is no longer implemented'
       end
-
     end
 
     # Contains all private methods. Mixed into {Nanoc::ItemRep}.
     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
       #   available during the next operation.
@@ -120,7 +115,7 @@ module Nanoc
       # @return [void]
       def write(snapshot = :last)
         # Get raw path
-        raw_path = self.raw_path(:snapshot => snapshot)
+        raw_path = self.raw_path(snapshot: snapshot)
         return if raw_path.nil?
 
         # Create parent directory
@@ -175,7 +170,6 @@ module Nanoc
       def type
         :item_rep
       end
-
     end
 
     include Deprecated
@@ -352,7 +346,7 @@ module Nanoc
         end
 
         # Create snapshot
-        snapshot(@content[:post] ? :post : :pre, :final => false) unless self.binary?
+        snapshot(@content[:post] ? :post : :pre, final: false) unless self.binary?
       ensure
         # Notify end
         Nanoc::NotificationCenter.post(:filtering_ended, self, filter_name)
@@ -383,13 +377,13 @@ module Nanoc
 
       # Create "pre" snapshot
       if @content[:post].nil?
-        snapshot(:pre, :final => true)
+        snapshot(:pre, final: true)
       end
 
       # Create filter
       klass = filter_named(filter_name)
       raise Nanoc::Errors::UnknownFilter.new(filter_name) if klass.nil?
-      filter = klass.new(assigns.merge({ :layout => layout }))
+      filter = klass.new(assigns.merge({ layout: layout }))
 
       # Visit
       Nanoc::NotificationCenter.post(:visit_started, layout)
@@ -404,7 +398,7 @@ module Nanoc
         @content[:last] = filter.setup_and_run(layout.raw_content, filter_args)
 
         # Create "post" snapshot
-        snapshot(:post, :final => false)
+        snapshot(:post, final: false)
       ensure
         # Notify end
         Nanoc::NotificationCenter.post(:filtering_ended,  self, filter_name)
@@ -470,10 +464,10 @@ module Nanoc
     def initialize_content
       # Initialize content and filenames
       if self.binary?
-        @temporary_filenames = { :last => @item.raw_filename }
+        @temporary_filenames = { last: @item.raw_filename }
         @content             = {}
       else
-        @content             = { :last => @item.raw_content }
+        @content             = { last: @item.raw_content }
         @content[:last].freeze
         @temporary_filenames = {}
       end
@@ -482,7 +476,5 @@ module Nanoc
     def filter_named(name)
       Nanoc::Filter.named(name)
     end
-
   end
-
 end