nanoc 3.7.4 → 3.7.5

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

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Nanoc::CodeSnippet represent a piece of custom code of a nanoc site.
   class CodeSnippet
-
     # A string containing the actual code in this code snippet.
     #
     # @return [String]
@@ -22,7 +20,7 @@ module Nanoc
     #
     # @param [String] filename The filename corresponding to this code snippet
     #
-    # @param [Time, Hash] params Extra parameters. Ignored by nanoc; it is
+    # @param [Time, Hash] _params Extra parameters. Ignored by nanoc; it is
     #   only included for backwards compatibility.
     def initialize(data, filename, _params = nil)
       @data     = data
@@ -52,7 +50,5 @@ module Nanoc
     def checksum
       Nanoc::Checksummer.calc(self)
     end
-
   end
-
 end

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

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Represents the site configuration.
   class Configuration < ::Hash
-
     # Creates a new configuration with the given hash.
     #
     # @param [Hash] hash The actual configuration hash
@@ -18,7 +16,5 @@ module Nanoc
     def reference
       :config
     end
-
   end
-
 end

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

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 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
@@ -26,7 +25,6 @@ module Nanoc
   #   {#create_item} and {#create_layout} methods should be implemented as
   #   well.
   class DataSource
-
     # @return [String] The root path where items returned by this data source
     #   should be mounted.
     attr_reader :items_root
@@ -207,7 +205,7 @@ module Nanoc
     #   files that should be generated.
     #
     # @return [void]
-    def create_item(_content, _attributes, _identifier, _params = {})
+    def create_item(content, attributes, identifier, params = {}) # rubocop:disable Lint/UnusedMethodArgument
       not_implemented('create_item')
     end
 
@@ -230,7 +228,7 @@ module Nanoc
     #   files that should be generated.
     #
     # @return [void]
-    def create_layout(_content, _attributes, _identifier, _params = {})
+    def create_layout(content, attributes, identifier, params = {}) # rubocop:disable Lint/UnusedMethodArgument
       not_implemented('create_layout')
     end
 
@@ -241,6 +239,5 @@ module Nanoc
         "#{self.class} does not implement ##{name}"
       )
     end
-
   end
 end

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

@@ -1,12 +1,10 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Represents a compileable item in a site. It has content and attributes, as
   # well as an identifier (which starts and ends with a slash). It can also
   # store the modification time to speed up compilation.
   class Item
-
     extend Nanoc::Memoization
 
     # @return [Hash] This item's attributes
@@ -70,7 +68,7 @@ module Nanoc
     def initialize(raw_content_or_raw_filename, attributes, identifier, params = nil)
       # Parse params
       params ||= {}
-      params = { :mtime => params } if params.is_a?(Time)
+      params = { mtime: params } if params.is_a?(Time)
       params[:binary] = false unless params.key?(:binary)
 
       if raw_content_or_raw_filename.nil?
@@ -91,7 +89,7 @@ module Nanoc
       @identifier   = identifier.cleaned_identifier.freeze
 
       # Set mtime
-      @attributes.merge!(:mtime => params[:mtime]) if params[:mtime]
+      @attributes.merge!(mtime: params[:mtime]) if params[:mtime]
 
       @parent       = nil
       @children     = []
@@ -172,7 +170,7 @@ module Nanoc
       Nanoc::NotificationCenter.post(:visit_ended,   self)
 
       # Get captured content (hax)
-      # TODO [in nanoc 4.0] remove me
+      # TODO: [in nanoc 4.0] remove me
       if key.to_s =~ /^content_for_(.*)$/
         @@_content_for_warning_issued ||= false
         @@_capturing_helper_included ||= false
@@ -295,7 +293,5 @@ module Nanoc
     def mtime
       self[:mtime]
     end
-
   end
-
 end

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

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Acts as an array, but allows fetching items using identifiers, e.g. `@items['/blah/']`.
   class ItemArray
-
     include Enumerable
 
     extend Forwardable
@@ -18,7 +16,7 @@ module Nanoc
       :instance_eval, :instance_exec, :__send__, :__id__
     ]
 
-    DELEGATED_METHODS = (Array.instance_methods + Enumerable.instance_methods).map { |m| m.to_sym } - EXCLUDED_METHODS
+    DELEGATED_METHODS = (Array.instance_methods + Enumerable.instance_methods).map(&:to_sym) - EXCLUDED_METHODS
     def_delegators :@items, *DELEGATED_METHODS
 
     def initialize
@@ -65,7 +63,5 @@ module Nanoc
       end
       @mapping.freeze
     end
-
   end
-
 end

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

@@ -1,11 +1,9 @@
 # encoding: utf-8
 
 module Nanoc
-
   # Represents a layout in a nanoc site. It has content, attributes, an
   # identifier and a modification time (to speed up compilation).
   class Layout
-
     extend Nanoc::Memoization
 
     # @return [String] The raw content of this layout
@@ -40,8 +38,8 @@ module Nanoc
 
       # Set mtime
       params ||= {}
-      params = { :mtime => params } if params.is_a?(Time)
-      @attributes.merge(:mtime => params[:mtime]) if params[:mtime]
+      params = { mtime: params } if params.is_a?(Time)
+      @attributes.merge(mtime: params[:mtime]) if params[:mtime]
     end
 
     # Requests the attribute with the given key.
@@ -122,7 +120,5 @@ module Nanoc
     def mtime
       self[:mtime]
     end
-
   end
-
 end

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

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc
-
   # The in-memory representation of a nanoc site. It holds references to the
   # following site data:
   #
@@ -17,14 +16,13 @@ module Nanoc
   # that contains a configuration file, site data, a rakefile, a rules file,
   # etc. The way site data is stored depends on the data source.
   class Site
-
     # The default configuration for a data source. A data source's
     # configuration overrides these options.
     DEFAULT_DATA_SOURCE_CONFIG = {
-      :type         => 'filesystem_unified',
-      :items_root   => '/',
-      :layouts_root => '/',
-      :config       => {}
+      type: 'filesystem_unified',
+      items_root: '/',
+      layouts_root: '/',
+      config: {}
     }
 
     # The default configuration for a site. A site's configuration overrides
@@ -32,13 +30,13 @@ module Nanoc
     # that lacks some options, the default value will be taken from
     # `DEFAULT_CONFIG`.
     DEFAULT_CONFIG = {
-      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim ).sort,
-      :lib_dirs           => %w( lib ),
-      :output_dir         => 'output',
-      :data_sources       => [{}],
-      :index_filenames    => ['index.html'],
-      :enable_output_diff => false,
-      :prune              => { :auto_prune => false, :exclude => ['.git', '.hg', '.svn', 'CVS'] }
+      text_extensions: %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim ).sort,
+      lib_dirs: %w( lib ),
+      output_dir: 'output',
+      data_sources: [{}],
+      index_filenames: ['index.html'],
+      enable_output_diff: false,
+      prune: { auto_prune: false, exclude: ['.git', '.hg', '.svn', 'CVS'] }
     }
 
     # Creates a site object for the site specified by the given
@@ -85,7 +83,7 @@ module Nanoc
           raise Nanoc::Errors::UnknownDataSource.new(data_source_hash[:type]) if data_source_class.nil?
 
           # Warn about deprecated data sources
-          # TODO [in nanoc 4.0] remove me
+          # TODO: [in nanoc 4.0] remove me
           case data_source_hash[:type]
           when 'filesystem'
             warn "Warning: the 'filesystem' data source has been renamed to 'filesystem_verbose'. Using 'filesystem' will work in nanoc 3.1.x, but it will likely not work anymore in a future release of nanoc. Please update your data source configuration and replace 'filesystem' with 'filesystem_verbose'."
@@ -217,9 +215,9 @@ module Nanoc
     # @return [void]
     def freeze
       config.freeze_recursively
-      items.each         { |i|  i.freeze  }
-      layouts.each       { |l|  l.freeze  }
-      code_snippets.each { |cs| cs.freeze }
+      items.each(&:freeze)
+      layouts.each(&:freeze)
+      code_snippets.each(&:freeze)
     end
 
     # @deprecated It is no longer necessary to explicitly load site data. It
@@ -251,7 +249,7 @@ module Nanoc
       ensure_identifier_uniqueness(@layouts, 'layout')
 
       # Load compiler too
-      # FIXME this should not be necessary
+      # FIXME: this should not be necessary
       compiler.load
 
       @loaded = true
@@ -301,11 +299,11 @@ module Nanoc
 
     # Executes the given block, making sure that the datasources are
     # available for the duration of the block
-    def with_datasources(&block)
-      data_sources.each { |ds| ds.use }
+    def with_datasources(&_block)
+      data_sources.each(&:use)
       yield
     ensure
-      data_sources.each { |ds| ds.unuse }
+      data_sources.each(&:unuse)
     end
 
     # Loads this site’s code and executes it.
@@ -327,7 +325,7 @@ module Nanoc
       end
 
       # Execute code snippets
-      @code_snippets.each { |cs| cs.load }
+      @code_snippets.each(&:load)
     end
 
     # Loads this site’s items, sets up item child-parent relationships and
@@ -431,5 +429,4 @@ module Nanoc
       @config = Nanoc::Configuration.new(@config)
     end
   end
-
 end

data/lib/nanoc/base/store.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc
-
   # An abstract superclass for classes that need to store data to the
   # filesystem, such as checksums, cached compiled content and dependency
   # graphs.
@@ -15,7 +14,6 @@ module Nanoc
   #
   # @api private
   class Store
-
     # @return [String] The name of the file where data will be loaded from and
     #   stored to.
     attr_reader :filename
@@ -52,7 +50,7 @@ module Nanoc
     # @abstract This method must be implemented by the subclass.
     #
     # @return [void]
-    def data=(_new_data)
+    def data=(new_data) # rubocop:disable Lint/UnusedMethodArgument
       raise NotImplementedError.new('Nanoc::Store subclasses must implement #data and #data=')
     end
 
@@ -134,7 +132,5 @@ module Nanoc
     def pstore
       @pstore ||= PStore.new(filename)
     end
-
   end
-
 end

data/lib/nanoc/base/temp_filename_factory.rb

@@ -3,9 +3,7 @@
 require 'tmpdir'
 
 module Nanoc
-
   class TempFilenameFactory
-
     # @return [String] The root directory for all temporary filenames
     attr_reader :root_dir
 
@@ -51,7 +49,5 @@ module Nanoc
         FileUtils.rm_rf(@root_dir)
       end
     end
-
   end
-
 end

data/lib/nanoc/cli.rb

@@ -16,7 +16,6 @@ if Nanoc.on_windows?
 end
 
 module Nanoc::CLI
-
   module Commands
   end
 
@@ -28,7 +27,7 @@ module Nanoc::CLI
   autoload 'ErrorHandler',        'nanoc/cli/error_handler'
 
   # Deprecated; use CommandRunner instead
-  # TODO [in nanoc 4.0] remove me
+  # TODO: [in nanoc 4.0] remove me
   autoload 'Command',             'nanoc/cli/command_runner'
 
   # @return [Boolean] true if debug output is enabled, false if not
@@ -78,7 +77,7 @@ module Nanoc::CLI
   #
   # @return [void]
   def self.after_setup(&block)
-    # TODO decide what should happen if the CLI is already set up
+    # TODO: decide what should happen if the CLI is already set up
     add_after_setup_proc(block)
   end
 
@@ -91,7 +90,7 @@ module Nanoc::CLI
     setup_cleaning_streams
     setup_commands
     load_custom_commands
-    after_setup_procs.each { |b| b.call }
+    after_setup_procs.each(&:call)
   end
 
   # Sets up the root command and base subcommands.
@@ -224,5 +223,4 @@ module Nanoc::CLI
     @after_setup_procs ||= []
     @after_setup_procs << proc
   end
-
 end

data/lib/nanoc/cli/ansi_string_colorizer.rb

@@ -1,18 +1,16 @@
 # encoding: utf-8
 
 module Nanoc::CLI
-
   # A simple ANSI colorizer for strings. When given a string and a list of
   # attributes, it returns a colorized string.
   module ANSIStringColorizer
-
-    # TODO complete mapping
+    # TODO: complete mapping
     MAPPING = {
-      :bold   => "\e[1m",
-      :red    => "\e[31m",
-      :green  => "\e[32m",
-      :yellow => "\e[33m",
-      :blue   => "\e[34m"
+      bold: "\e[1m",
+      red: "\e[31m",
+      green: "\e[32m",
+      yellow: "\e[33m",
+      blue: "\e[34m"
     }
 
     # @param [String] s The string to colorize
@@ -24,7 +22,5 @@ module Nanoc::CLI
     def self.c(s, *as)
       as.map { |a| MAPPING[a] }.join('') + s + "\e[0m"
     end
-
   end
-
 end

data/lib/nanoc/cli/cleaning_stream.rb

@@ -1,11 +1,9 @@
 # encoding: utf-8
 
 module Nanoc::CLI
-
   # An output stream that passes output through stream cleaners. This can be
   # used to strip ANSI color sequences, for instance.
   class CleaningStream
-
     # @param [IO, StringIO] stream The stream to wrap
     def initialize(stream)
       @stream = stream
@@ -20,7 +18,7 @@ module Nanoc::CLI
     #
     # @return [void]
     def add_stream_cleaner(klass)
-      unless @stream_cleaners.map { |c| c.class }.include?(klass)
+      unless @stream_cleaners.map(&:class).include?(klass)
         @stream_cleaners << klass.new
       end
     end
@@ -122,14 +120,12 @@ module Nanoc::CLI
     protected
 
     def _nanoc_clean(s)
-      @stream_cleaners.reduce(s) { |m, c| c.clean(m) }
+      @stream_cleaners.reduce(s) { |a, e| e.clean(a) }
     end
 
     def _nanoc_swallow_broken_pipe_errors_while
       yield
     rescue Errno::EPIPE
     end
-
   end
-
 end