nanoc 3.7.4 → 3.7.5

data/lib/nanoc/cli/stream_cleaners/abstract.rb

@@ -1,23 +1,19 @@
 # encoding: utf-8
 
 module Nanoc::CLI::StreamCleaners
-
   # Superclass for all stream cleaners. Stream cleaners have a single method,
   # {#clean}, that takes a string and returns a cleaned string. Stream cleaners
   # can have state, so they can act as a FSM.
   #
   # @abstract Subclasses must implement {#clean}
   class Abstract
-
     # Returns a cleaned version of the given string.
     #
     # @param [String] s The string to clean
     #
     # @return [String] The cleaned string
-    def clean(_s)
+    def clean(s) # rubocop:disable Lint/UnusedMethodArgument
       raise NotImplementedError, 'Subclasses of Nanoc::CLI::StreamCleaners::Abstract must implement #clean'
     end
-
   end
-
 end

data/lib/nanoc/cli/stream_cleaners/ansi_colors.rb

@@ -1,15 +1,11 @@
 # encoding: utf-8
 
 module Nanoc::CLI::StreamCleaners
-
   # Removes ANSI color escape sequences.
   class ANSIColors < Abstract
-
     # @see Nanoc::CLI::StreamCleaners::Abstract#clean
     def clean(s)
       s.gsub(/\e\[.+?m/, '')
     end
-
   end
-
 end

data/lib/nanoc/cli/stream_cleaners/utf8.rb

@@ -1,16 +1,12 @@
 # encoding: utf-8
 
 module Nanoc::CLI::StreamCleaners
-
   # Simplifies output by replacing UTF-8 characters with their ASCII decompositions.
   class UTF8 < Abstract
-
     # @see Nanoc::CLI::StreamCleaners::Abstract#clean
     def clean(s)
-      # FIXME this decomposition is not generally usable
+      # FIXME: this decomposition is not generally usable
       s.gsub(/“|”/, '"').gsub(/‘|’/, '\'').gsub('…', '...').gsub('©', '(c)')
     end
-
   end
-
 end

data/lib/nanoc/data_sources.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   autoload 'Filesystem',         'nanoc/data_sources/filesystem'
   autoload 'FilesystemUnified',  'nanoc/data_sources/filesystem_unified'
   autoload 'FilesystemVerbose',  'nanoc/data_sources/filesystem_verbose'
@@ -12,7 +11,7 @@ module Nanoc::DataSources
   Nanoc::DataSource.register '::Nanoc::DataSources::Static',             :static
 
   # Deprecated; fetch data from online data sources manually instead
-  # TODO [in nanoc 4.0] remove me
+  # TODO: [in nanoc 4.0] remove me
   autoload 'Delicious', 'nanoc/data_sources/deprecated/delicious'
   autoload 'LastFM',    'nanoc/data_sources/deprecated/last_fm'
   autoload 'Twitter',   'nanoc/data_sources/deprecated/twitter'
@@ -21,11 +20,10 @@ module Nanoc::DataSources
   Nanoc::DataSource.register '::Nanoc::DataSources::Twitter',            :twitter
 
   # Deprecated; use `filesystem_verbose` or `filesystem_unified` instead
-  # TODO [in nanoc 4.0] remove me
+  # TODO: [in nanoc 4.0] remove me
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemVerbose',  :filesystem
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemUnified',  :filesystem_combined
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemUnified',  :filesystem_compact
   FilesystemCombined = FilesystemUnified
   FilesystemCompact  = FilesystemUnified
-
 end

data/lib/nanoc/data_sources/deprecated/delicious.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # @deprecated Fetch data from online data sources manually instead
   class Delicious < Nanoc::DataSource
-
     def items
       @items ||= begin
         require 'json'
@@ -21,12 +19,12 @@ module Nanoc::DataSources
           # Get data
           content = raw_item['n']
           attributes = {
-            :url         => raw_item['u'],
-            :description => raw_item['d'],
-            :tags        => raw_item['t'],
-            :date        => Time.parse(raw_item['dt']),
-            :note        => raw_item['n'],
-            :author      => raw_item['a']
+            url: raw_item['u'],
+            description: raw_item['d'],
+            tags: raw_item['t'],
+            date: Time.parse(raw_item['dt']),
+            note: raw_item['n'],
+            author: raw_item['a']
           }
           identifier = "/#{i}/"
           mtime = nil
@@ -36,7 +34,5 @@ module Nanoc::DataSources
         end
       end
     end
-
   end
-
 end

data/lib/nanoc/data_sources/deprecated/last_fm.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # @deprecated Fetch data from online data sources manually instead
   class LastFM < Nanoc::DataSource
-
     def items
       @items ||= begin
         require 'json'
@@ -66,14 +64,14 @@ module Nanoc::DataSources
           end
 
           attributes = {
-            :name      => raw_item['name'],
-            :artist    => {
-              :name      => raw_artist_info['name'],
-              :url       => raw_artist_info['url']
+            name: raw_item['name'],
+            artist: {
+              name: raw_artist_info['name'],
+              url: raw_artist_info['url']
             },
-            :url       => raw_item['url'],
-            :played_at => track_played_at,
-            :now_playing => now_playing
+            url: raw_item['url'],
+            played_at: track_played_at,
+            now_playing: now_playing
           }
           identifier = "/#{i}/"
           mtime = nil
@@ -83,7 +81,5 @@ module Nanoc::DataSources
         end
       end
     end
-
   end
-
 end

data/lib/nanoc/data_sources/deprecated/twitter.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # @deprecated Fetch data from online data sources manually instead
   class Twitter < Nanoc::DataSource
-
     def items
       @item ||= begin
         require 'json'
@@ -21,8 +19,8 @@ module Nanoc::DataSources
           # Get data
           content = raw_item['text']
           attributes = {
-            :created_at  => raw_item['created_at'],
-            :source      => raw_item['source']
+            created_at: raw_item['created_at'],
+            source: raw_item['source']
           }
           identifier = "/#{raw_item['id']}/"
           mtime = Time.parse(raw_item['created_at'])
@@ -32,7 +30,5 @@ module Nanoc::DataSources
         end
       end
     end
-
   end
-
 end

data/lib/nanoc/data_sources/filesystem.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # Provides functionality common across all filesystem data sources.
   module Filesystem
-
     # The VCS that will be called when adding, deleting and moving files. If
     # no VCS has been set, or if the VCS has been set to `nil`, a dummy VCS
     # will be returned.
@@ -101,14 +99,14 @@ module Nanoc::DataSources
 
         # Get attributes
         attributes = {
-          :filename         => content_filename,
-          :content_filename => content_filename,
-          :meta_filename    => meta_filename,
-          :extension        => content_filename ? ext_of(content_filename)[1..-1] : nil,
+          filename: content_filename,
+          content_filename: content_filename,
+          meta_filename: meta_filename,
+          extension: content_filename ? ext_of(content_filename)[1..-1] : nil,
           # WARNING :file is deprecated; please create a File object manually
           # using the :content_filename or :meta_filename attributes.
-          # TODO [in nanoc 4.0] remove me
-          :file             => content_filename ? Nanoc::Extra::FileProxy.new(content_filename) : nil
+          # TODO: [in nanoc 4.0] remove me
+          file: content_filename ? Nanoc::Extra::FileProxy.new(content_filename) : nil
         }.merge(meta)
 
         # Get identifier
@@ -136,7 +134,7 @@ module Nanoc::DataSources
         # Create layout object
         klass.new(
           content_or_filename, attributes, identifier,
-          :binary => is_binary, :mtime => mtime
+          binary: is_binary, mtime: mtime
         )
       end
     end
@@ -153,7 +151,8 @@ module Nanoc::DataSources
     #     'content/qux' => [ nil,    'html' ]
     #   }
     def all_split_files_in(dir_name)
-      grouped_filenames = all_files_in(dir_name)
+      grouped_filenames =
+        all_files_in(dir_name)
         .reject   { |fn| fn =~ /(~|\.orig|\.rej|\.bak)$/ }
         .group_by { |fn| basename_of(fn) }
 
@@ -180,7 +179,7 @@ module Nanoc::DataSources
 
     # Returns all files in the given directory and directories below it.
     def all_files_in(dir_name)
-      Nanoc::Extra::FilesystemTools.all_files_in(dir_name)
+      Nanoc::Extra::FilesystemTools.all_files_in(dir_name, config[:extra_files])
     end
 
     # Returns the filename for the given base filename and the extension.
@@ -318,7 +317,5 @@ module Nanoc::DataSources
     def raise_encoding_error(filename, encoding)
       raise RuntimeError.new("Could not read #{filename} because the file is not valid #{encoding}.")
     end
-
   end
-
 end

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # The filesystem_unified data source stores its items and layouts in nested
   # directories. Items and layouts are represented by one or two files; if it
   # is represented using one file, the metadata can be contained in this file.
@@ -68,7 +67,6 @@ module Nanoc::DataSources
   # understood by Ruby’s `Encoding`. If no encoding is set in the configuration,
   # one will be inferred from the environment.
   class FilesystemUnified < Nanoc::DataSource
-
     include Nanoc::DataSources::Filesystem
 
     private
@@ -121,7 +119,5 @@ module Nanoc::DataSources
       end
       filename.sub(regex, '').cleaned_identifier
     end
-
   end
-
 end

data/lib/nanoc/data_sources/filesystem_verbose.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # The filesystem_verbose data source is the old data source for a new nanoc
   # site. It stores all data as files on the hard disk.
   #
@@ -40,7 +39,6 @@ module Nanoc::DataSources
   # understood by Ruby’s `Encoding`. If no encoding is set in the configuration,
   # one will be inferred from the environment.
   class FilesystemVerbose < Nanoc::DataSource
-
     include Nanoc::DataSources::Filesystem
 
     private
@@ -84,7 +82,5 @@ module Nanoc::DataSources
     def identifier_for_filename(filename)
       filename.sub(/[^\/]+\.yaml$/, '')
     end
-
   end
-
 end

data/lib/nanoc/data_sources/static.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::DataSources
-
   # The static data source provides items from a single directory. Unlike the
   # filesystem data sources, static provides no additional item metadata. In
   # addition, all items are treated as 'binary', regardless of their extension
@@ -26,7 +25,6 @@ module Nanoc::DataSources
   # exclude them from the Blogging helper's atom feed generator, among other
   # things.
   class Static < Nanoc::DataSource
-
     identifier :static
 
     def items
@@ -36,8 +34,8 @@ module Nanoc::DataSources
       # Convert filenames to items
       all_files_in(prefix).map do |filename|
         attributes = {
-          :extension => File.extname(filename)[1..-1],
-          :filename  => filename,
+          extension: File.extname(filename)[1..-1],
+          filename: filename,
         }
         attributes[:is_hidden] = true unless config[:hide_items] == false
         identifier = filename[(prefix.length + 1)..-1] + '/'
@@ -48,7 +46,7 @@ module Nanoc::DataSources
           filename,
           attributes,
           identifier,
-          :binary => true, :mtime => mtime, :checksum => checksum
+          binary: true, mtime: mtime, checksum: checksum
         )
       end
     end
@@ -56,9 +54,7 @@ module Nanoc::DataSources
     protected
 
     def all_files_in(dir_name)
-      Nanoc::Extra::FilesystemTools.all_files_in(dir_name)
+      Nanoc::Extra::FilesystemTools.all_files_in(dir_name, config[:extra_files])
     end
-
   end
-
 end

data/lib/nanoc/extra.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   autoload 'AutoCompiler',        'nanoc/extra/auto_compiler'
   autoload 'Checking',            'nanoc/extra/checking'
   autoload 'CHiCk',               'nanoc/extra/chick'
@@ -13,13 +12,12 @@ module Nanoc::Extra
   autoload 'JRubyNokogiriWarner', 'nanoc/extra/jruby_nokogiri_warner'
 
   # Deprecated; use {Nanoc::Context} instead
-  # TODO [in nanoc 4.0] remove me
+  # TODO: [in nanoc 4.0] remove me
   Context = ::Nanoc::Context
 
   # Deprecated
-  # TODO [in nanoc 4.0] remove me
+  # TODO: [in nanoc 4.0] remove me
   autoload 'FileProxy',         'nanoc/extra/file_proxy'
-
 end
 
 require 'nanoc/extra/core_ext'

data/lib/nanoc/extra/auto_compiler.rb

@@ -1,11 +1,9 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   # A web server that will automatically compile items as they are requested.
   # It also serves static files such as stylesheets and images.
   class AutoCompiler
-
     # @return [Nanoc::Site] The site this autocompiler belongs to
     attr_reader :site
 
@@ -38,10 +36,10 @@ module Nanoc::Extra
 
         # Find rep
         path = Rack::Utils.unescape(env['PATH_INFO'])
-        reps = site.items.map { |i| i.reps }.flatten
+        reps = site.items.map(&:reps).flatten
         rep = reps.find do |r|
           r.path == path ||
-            r.raw_path == site.config[:output_dir] + path
+          r.raw_path == site.config[:output_dir] + path
         end
 
         # Recompile
@@ -97,7 +95,5 @@ module Nanoc::Extra
     def stack
       site.compiler.stack
     end
-
   end
-
 end

data/lib/nanoc/extra/checking.rb

@@ -1,16 +1,12 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   module Checking
-
     autoload 'Check',  'nanoc/extra/checking/check'
     autoload 'DSL',    'nanoc/extra/checking/dsl'
     autoload 'Runner', 'nanoc/extra/checking/runner.rb'
     autoload 'Issue',  'nanoc/extra/checking/issue'
-
   end
-
 end
 
 require 'nanoc/extra/checking/checks'

data/lib/nanoc/extra/checking/check.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
-
   class OutputDirNotFoundError < Nanoc::Errors::Generic
     def initialize(directory_path)
       super("Unable to run check against output directory at “#{directory_path}”: directory does not exist.")
@@ -9,7 +8,6 @@ module Nanoc::Extra::Checking
   end
 
   class Check
-
     extend Nanoc::PluginRegistry::PluginMethods
 
     attr_reader :site
@@ -37,7 +35,5 @@ module Nanoc::Extra::Checking
       end
       Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
     end
-
   end
-
 end