nanoc 3.7.4 → 3.7.5

data/lib/nanoc/extra/deployers.rb

@@ -1,15 +1,11 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   module Deployers
-
     autoload 'Fog',   'nanoc/extra/deployers/fog'
     autoload 'Rsync', 'nanoc/extra/deployers/rsync'
 
     Nanoc::Extra::Deployer.register '::Nanoc::Extra::Deployers::Fog',   :fog
     Nanoc::Extra::Deployer.register '::Nanoc::Extra::Deployers::Rsync', :rsync
-
   end
-
 end

data/lib/nanoc/extra/deployers/fog.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Deployers
-
   # A deployer that deploys a site using [fog](https://github.com/geemus/fog).
   #
   # @example A deployment configuration with public and staging configurations
@@ -18,7 +17,6 @@ module Nanoc::Extra::Deployers
   #       local_root: ~/myCloud
   #       bucket:     nanoc-site-staging
   class Fog < ::Nanoc::Extra::Deployer
-
     # @see Nanoc::Extra::Deployer#run
     def run
       require 'fog'
@@ -45,7 +43,7 @@ module Nanoc::Extra::Deployers
       # Get bucket
       puts 'Getting bucket'
       begin
-        directory = connection.directories.get(bucket, :prefix => path)
+        directory = connection.directories.get(bucket, prefix: path)
       rescue ::Excon::Errors::NotFound
         should_create_bucket = true
       end
@@ -53,18 +51,18 @@ module Nanoc::Extra::Deployers
 
       # Create bucket if necessary
       if should_create_bucket
-        directory = connection.directories.create(:key => bucket, :prefix => path)
+        directory = connection.directories.create(key: bucket, prefix: path)
       end
 
       # Get list of remote files
       files = directory.files
       truncated = files.respond_to?(:is_truncated) && files.is_truncated
       while truncated
-        set = directory.files.all(:marker => files.last.key)
+        set = directory.files.all(marker: files.last.key)
         truncated = set.is_truncated
         files += set
       end
-      keys_to_destroy = files.all.map { |file| file.key }
+      keys_to_destroy = files.all.map(&:key)
 
       # Upload all the files in the output folder to the clouds
       puts 'Uploading local files'
@@ -73,9 +71,9 @@ module Nanoc::Extra::Deployers
         files.each do |file_path|
           key = path ? File.join(path, file_path) : file_path
           directory.files.create(
-            :key => key,
-            :body => File.open(file_path),
-            :public => true)
+            key: key,
+            body: File.open(file_path),
+            public: true)
           keys_to_destroy.delete(key)
         end
       end
@@ -95,7 +93,5 @@ module Nanoc::Extra::Deployers
     def error(msg)
       raise RuntimeError.new(msg)
     end
-
   end
-
 end

data/lib/nanoc/extra/deployers/rsync.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Deployers
-
   # A deployer that deploys a site using rsync.
   #
   # The configuration has should include a `:dst` value, a string containing
@@ -20,7 +19,6 @@ module Nanoc::Extra::Deployers
   #       dst: "ectype:sites/stoneship-staging/public"
   #       options: [ "-glpPrtvz" ]
   class Rsync < ::Nanoc::Extra::Deployer
-
     # Default rsync options
     DEFAULT_OPTIONS = [
       '--group',
@@ -60,10 +58,8 @@ module Nanoc::Extra::Deployers
     private
 
     def run_shell_cmd(cmd)
-      piper = Nanoc::Extra::Piper.new(:stdout => $stdout, :stderr => $stderr)
+      piper = Nanoc::Extra::Piper.new(stdout: $stdout, stderr: $stderr)
       piper.run(cmd, nil)
     end
-
   end
-
 end

data/lib/nanoc/extra/file_proxy.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   # @deprecated Create a File instance directly and use that instead.
   class FileProxy
-
     instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
 
     @@deprecation_warning_shown = false
@@ -32,9 +30,7 @@ module Nanoc::Extra
     private
 
     def file_instance_methods
-      @@file_instance_methods ||= Set.new(File.instance_methods.map { |m| m.to_sym })
+      @@file_instance_methods ||= Set.new(File.instance_methods.map(&:to_sym))
     end
-
   end
-
 end

data/lib/nanoc/extra/filesystem_tools.rb

@@ -1,17 +1,14 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   # Contains useful functions for managing the filesystem.
   #
   # @api private
   module FilesystemTools
-
     # Error that is raised when too many symlink indirections are encountered.
     #
     # @api private
     class MaxSymlinkDepthExceededError < ::Nanoc::Errors::GenericTrivial
-
       # @return [String] The last filename that was attempted to be
       #   resolved before giving up
       attr_reader :filename
@@ -22,7 +19,6 @@ module Nanoc::Extra
         @filename = filename
         super("Too many indirections while resolving symlinks. I gave up after finding out #{filename} was yet another symlink. Sorry!")
       end
-
     end
 
     # Error that is raised when a file of an unknown type is encountered
@@ -30,7 +26,6 @@ module Nanoc::Extra
     #
     # @api private
     class UnsupportedFileTypeError < ::Nanoc::Errors::GenericTrivial
-
       # @return [String] The filename of the file whose type is not supported
       attr_reader :filename
 
@@ -40,7 +35,6 @@ module Nanoc::Extra
         @filename = filename
         super("The file at #{filename} is of an unsupported type (expected file, directory or link, but it is #{File.ftype(filename)}")
       end
-
     end
 
     # Returns all files in the given directory and directories below it,
@@ -49,18 +43,22 @@ module Nanoc::Extra
     # @param [String] dir_name The name of the directory whose contents to
     #   fetch
     #
+    # @param [String, Array, nil] extra_files The list of extra patterns
+    #   to extend the file search for files not found by default, example
+    #   "**/.{htaccess,htpasswd}"
+    #
     # @param [Integer] recursion_limit The maximum number of times to
     #   recurse into a symlink to a directory
     #
-    # @return [Array<String>] A list of filenames
+    # @return [Array<String>] A list of file names
     #
     # @raise [MaxSymlinkDepthExceededError] if too many indirections are
     #   encountered while resolving symlinks
     #
     # @raise [UnsupportedFileTypeError] if a file of an unsupported type is
     #   detected (something other than file, directory or link)
-    def all_files_in(dir_name, recursion_limit = 10)
-      Dir[dir_name + '/**/*'].map do |fn|
+    def all_files_in(dir_name, extra_files, recursion_limit = 10)
+      all_files_and_dirs_in(dir_name, extra_files).map do |fn|
         case File.ftype(fn)
         when 'link'
           if 0 == recursion_limit
@@ -70,7 +68,7 @@ module Nanoc::Extra
             if File.file?(absolute_target)
               fn
             else
-              all_files_in(absolute_target, recursion_limit - 1).map do |sfn|
+              all_files_in(absolute_target, extra_files, recursion_limit - 1).map do |sfn|
                 fn + sfn[absolute_target.size..-1]
               end
             end
@@ -86,6 +84,35 @@ module Nanoc::Extra
     end
     module_function :all_files_in
 
+    # Returns all files and directories in the given directory and
+    # directories below it.
+    #
+    # @param [String] dir_name The name of the directory whose contents to
+    #   fetch
+    #
+    # @param [String, Array, nil] extra_files The list of extra patterns
+    #   to extend the file search for files not found by default, example
+    #   "**/.{htaccess,htpasswd}"
+    #
+    # @return [Array<String>] A list of files and directories
+    #
+    # @raise [GenericTrivial] when pattern can not be handled
+    def all_files_and_dirs_in(dir_name, extra_files)
+      patterns = ["#{dir_name}/**/*"]
+      case extra_files
+      when nil
+      when String
+        patterns << "#{dir_name}/#{extra_files}"
+      when Array
+        patterns.concat(extra_files.map { |extra_file| "#{dir_name}/#{extra_file}" })
+      else
+        raise Nanoc::Errors::GenericTrivial,
+          "Do not know how to handle extra_files: #{extra_files.inspect}"
+      end
+      Dir.glob(patterns)
+    end
+    module_function :all_files_and_dirs_in
+
     # Resolves the given symlink into an absolute path.
     #
     # @param [String] filename The filename of the symlink to resolve
@@ -118,7 +145,5 @@ module Nanoc::Extra
       end
     end
     module_function :resolve_symlink
-
   end
-
 end

data/lib/nanoc/extra/jruby_nokogiri_warner.rb

@@ -3,9 +3,7 @@
 require 'singleton'
 
 module Nanoc::Extra
-
   class JRubyNokogiriWarner
-
     include Singleton
 
     TEXT = <<EOS
@@ -42,7 +40,5 @@ EOS
       $stderr.puts TEXT
       @warned = true
     end
-
   end
-
 end

data/lib/nanoc/extra/link_collector.rb

@@ -3,9 +3,7 @@
 require 'set'
 
 module ::Nanoc::Extra
-
   class LinkCollector
-
     def initialize(filenames, mode = nil)
       Nanoc::Extra::JRubyNokogiriWarner.check_and_warn
 
@@ -13,11 +11,11 @@ module ::Nanoc::Extra
       @filter =
         case mode
         when nil
-          lambda { |_h| true }
+          ->(_h) { true }
         when :external
-          lambda { |h| external_href?(h) }
+          ->(h) { external_href?(h) }
         when :internal
-          lambda { |h| !external_href?(h) }
+          ->(h) { !external_href?(h) }
         else
           raise ArgumentError, 'Expected mode argument to be :internal, :external or nil'
         end
@@ -54,7 +52,5 @@ module ::Nanoc::Extra
 
       hrefs_in_file.select(&@filter)
     end
-
   end
-
 end

data/lib/nanoc/extra/piper.rb

@@ -3,11 +3,8 @@
 require 'open3'
 
 module Nanoc::Extra
-
   class Piper
-
     class Error < ::Nanoc::Errors::Generic
-
       def initialize(command, exit_code)
         @command   = command
         @exit_code = exit_code
@@ -16,7 +13,6 @@ module Nanoc::Extra
       def message
         "command exited with a nonzero status code #{@exit_code} (command: #{@command.join(' ')})"
       end
-
     end
 
     # @option [IO] :stdout ($stdout)
@@ -48,7 +44,5 @@ module Nanoc::Extra
         end
       end
     end
-
   end
-
 end

data/lib/nanoc/extra/pruner.rb

@@ -1,11 +1,9 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   # Responsible for finding and deleting files in the site’s output directory
   # that are not managed by nanoc.
   class Pruner
-
     # @return [Nanoc::Site] The site this pruner belongs to
     attr_reader :site
 
@@ -28,9 +26,7 @@ module Nanoc::Extra
 
       # Get compiled files
       all_raw_paths = site.items.map do |item|
-        item.reps.map do |rep|
-          rep.raw_path
-        end
+        item.reps.map(&:raw_path)
       end
       compiled_files = all_raw_paths.flatten.compact.select { |f| File.file?(f) }
 
@@ -84,7 +80,5 @@ module Nanoc::Extra
         Dir.rmdir(dir)
       end
     end
-
   end
-
 end

data/lib/nanoc/extra/validators.rb

@@ -1,12 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   module Validators
-
     autoload 'W3C',   'nanoc/extra/validators/w3c'
     autoload 'Links', 'nanoc/extra/validators/links'
-
   end
-
 end

data/lib/nanoc/extra/validators/links.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Validators
-
   # @deprecated Use the Checking API or the `check` command instead
   class Links
-
     def initialize(_dir, _index_filenames, params = {})
       @include_internal = params.key?(:internal) && params[:internal]
       @include_external = params.key?(:external) && params[:external]
@@ -16,7 +14,5 @@ module Nanoc::Extra::Validators
       checks << 'elinks' if options[:external]
       Nanoc::CLI.run ['check', checks].flatten
     end
-
   end
-
 end

data/lib/nanoc/extra/validators/w3c.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Validators
-
   # @deprecated Use the Checking API or the `check` command instead
   class W3C
-
     def initialize(dir, types)
       @dir   = dir
       @types = types
@@ -21,7 +19,5 @@ module Nanoc::Extra::Validators
 
       Nanoc::CLI.run(['check', args].flatten)
     end
-
   end
-
 end

data/lib/nanoc/extra/vcs.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   # A very simple representation of a version control system (VCS) that
   # abstracts the add, remove and move operations. It does not commit. This
   # class is primarily used by data sources that store data as flat files on
@@ -10,7 +9,6 @@ module Nanoc::Extra
   # @abstract Subclass and override {#add}, {#remove} and {#move} to implement
   #   a custom VCS.
   class VCS
-
     extend Nanoc::PluginRegistry::PluginMethods
 
     # Adds the file with the given filename to the working copy.
@@ -20,7 +18,7 @@ module Nanoc::Extra
     # @return [void]
     #
     # @abstract
-    def add(_filename)
+    def add(filename) # rubocop:disable Lint/UnusedMethodArgument
       not_implemented('add')
     end
 
@@ -33,7 +31,7 @@ module Nanoc::Extra
     # @return [void]
     #
     # @abstract
-    def remove(_filename)
+    def remove(filename) # rubocop:disable Lint/UnusedMethodArgument
       not_implemented('remove')
     end
 
@@ -48,7 +46,7 @@ module Nanoc::Extra
     # @return [void]
     #
     # @abstract
-    def move(_src, _dst)
+    def move(src, dst) # rubocop:disable Lint/UnusedMethodArgument
       not_implemented('move')
     end
 
@@ -60,7 +58,5 @@ module Nanoc::Extra
         'this data source to be used.'
       )
     end
-
   end
-
 end