nanoc 3.7.3 → 3.7.4

data/lib/nanoc/cli/logger.rb

@@ -47,7 +47,7 @@ module Nanoc::CLI
           ACTION_COLORS[action.to_sym],
           action,
           "\e[0m",
-          duration.nil? ? '' : '[%2.2fs]  ' % [ duration ],
+          duration.nil? ? '' : '[%2.2fs]  ' % [duration],
           name
         ]
       )

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

@@ -14,7 +14,7 @@ module Nanoc::CLI::StreamCleaners
     # @param [String] s The string to clean
     #
     # @return [String] The cleaned string
-    def clean(s)
+    def clean(_s)
       raise NotImplementedError, 'Subclasses of Nanoc::CLI::StreamCleaners::Abstract must implement #clean'
     end
 

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

@@ -21,9 +21,9 @@ module Nanoc::DataSources
         # Get data
         @http_client ||= Nanoc::Extra::CHiCk::Client.new
         _status, _headers, data = *@http_client.get(
-          'http://ws.audioscrobbler.com/2.0/' +
-            '?method=user.getRecentTracks' +
-            '&format=json' +
+          'http://ws.audioscrobbler.com/2.0/' \
+            '?method=user.getRecentTracks' \
+            '&format=json' \
             '&user=' + URI.escape(config[:username]) +
             '&api_key=' + URI.escape(config[:api_key])
         )
@@ -36,8 +36,8 @@ module Nanoc::DataSources
         raw_items.enum_with_index.map do |raw_item, i|
           # Get artist data
           _artist_status, _artist_headers, artist_data = *@http_client.get(
-            'http://ws.audioscrobbler.com/2.0/' +
-              '?method=artist.getInfo' +
+            'http://ws.audioscrobbler.com/2.0/' \
+              '?method=artist.getInfo' \
               '&format=json' +
               (
                 if raw_item['artist']['mbid'].empty?

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

@@ -17,7 +17,7 @@ module Nanoc::DataSources
         raw_items = JSON.parse(data)
 
         # Convert to items
-        raw_items.enum_with_index.map do |raw_item, i|
+        raw_items.enum_with_index.map do |raw_item, _i|
           # Get data
           content = raw_item['text']
           attributes = {

data/lib/nanoc/data_sources/filesystem.rb

@@ -34,7 +34,7 @@ module Nanoc::DataSources
     # See {Nanoc::DataSource#setup}.
     def setup
       # Create directories
-      [ content_dir_name, layouts_dir_name ].each do |dir|
+      [content_dir_name, layouts_dir_name].each do |dir|
         FileUtils.mkdir_p(dir)
         vcs.add(dir)
       end
@@ -60,12 +60,12 @@ module Nanoc::DataSources
       create_object(layouts_dir_name, content, attributes, identifier, params)
     end
 
-  protected
+    protected
 
     # Creates a new object (item or layout) on disk in dir_name according to
     # the given identifier. The file will have its attributes taken from the
     # attributes hash argument and its content from the content argument.
-    def create_object(dir_name, content, attributes, identifier, params = {})
+    def create_object(_dir_name, _content, _attributes, _identifier, _params = {})
       raise NotImplementedError.new(
         "#{self.class} does not implement ##{name}"
       )
@@ -89,7 +89,7 @@ module Nanoc::DataSources
         content_filename = filename_for(base_filename, content_ext)
 
         # Read content and metadata
-        is_binary = !!(content_filename && !@site.config[:text_extensions].include?(File.extname(content_filename)[1..-1]))
+        is_binary = content_filename && !@site.config[:text_extensions].include?(File.extname(content_filename)[1..-1])
         if is_binary && klass == Nanoc::Item
           meta                = (meta_filename && YAML.load_file(meta_filename)) || {}
           content_or_filename = content_filename
@@ -153,9 +153,9 @@ module Nanoc::DataSources
     #     'content/qux' => [ nil,    'html' ]
     #   }
     def all_split_files_in(dir_name)
-      grouped_filenames = all_files_in(dir_name).
-        reject   { |fn| fn =~ /(~|\.orig|\.rej|\.bak)$/ }.
-        group_by { |fn| basename_of(fn) }
+      grouped_filenames = all_files_in(dir_name)
+        .reject   { |fn| fn =~ /(~|\.orig|\.rej|\.bak)$/ }
+        .group_by { |fn| basename_of(fn) }
 
       grouped_filenames.each_pair do |key, filenames|
         # Divide
@@ -163,10 +163,10 @@ module Nanoc::DataSources
         content_filenames = filenames.select { |fn| ext_of(fn) != '.yaml' }
 
         # Check number of files per type
-        if ![ 0, 1 ].include?(meta_filenames.size)
+        unless [0, 1].include?(meta_filenames.size)
           raise "Found #{meta_filenames.size} meta files for #{key}; expected 0 or 1"
         end
-        if ![ 0, 1 ].include?(content_filenames.size)
+        unless [0, 1].include?(content_filenames.size)
           raise "Found #{content_filenames.size} content files for #{key}; expected 0 or 1"
         end
 
@@ -193,7 +193,7 @@ module Nanoc::DataSources
     # data sources may prefer to implement this differently (for example,
     # {Nanoc::DataSources::FilesystemVerbose} doubles the last part of the
     # basename before concatenating it with a period and the extension).
-    def filename_for(base_filename, ext)
+    def filename_for(_base_filename, _ext)
       raise NotImplementedError.new(
         "#{self.class} does not implement #filename_for"
       )
@@ -201,7 +201,7 @@ module Nanoc::DataSources
 
     # Returns the identifier that corresponds with the given filename, which
     # can be the content filename or the meta filename.
-    def identifier_for_filename(filename)
+    def identifier_for_filename(_filename)
       raise NotImplementedError.new(
         "#{self.class} does not implement #identifier_for_filename"
       )
@@ -235,7 +235,7 @@ module Nanoc::DataSources
     # Parses the file named `filename` and returns an array with its first
     # element a hash with the file's metadata, and with its second element the
     # file content itself.
-    def parse(content_filename, meta_filename, kind)
+    def parse(content_filename, meta_filename, _kind)
       # Read content and metadata from separate files
       if meta_filename
         content = content_filename ? read(content_filename) : ''
@@ -245,7 +245,7 @@ module Nanoc::DataSources
         rescue Exception => e
           raise "Could not parse YAML for #{meta_filename}: #{e.message}"
         end
-        return [ meta, content ]
+        return [meta, content]
       end
 
       # Read data
@@ -253,7 +253,7 @@ module Nanoc::DataSources
 
       # Check presence of metadata section
       if data !~ /\A-{3,5}\s*$/
-        return [ {}, data ]
+        return [{}, data]
       end
 
       # Split data
@@ -273,7 +273,7 @@ module Nanoc::DataSources
       content = pieces[4]
 
       # Done
-      [ meta, content ]
+      [meta, content]
     end
 
     # Reads the content of the file with the given name and returns a string
@@ -303,7 +303,7 @@ module Nanoc::DataSources
           raise_encoding_error(filename, original_encoding)
         end
 
-        if !data.valid_encoding?
+        unless data.valid_encoding?
           raise_encoding_error(filename, original_encoding)
         end
       end

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -71,7 +71,7 @@ module Nanoc::DataSources
 
     include Nanoc::DataSources::Filesystem
 
-  private
+    private
 
     # See {Nanoc::DataSources::Filesystem#create_object}.
     def create_object(dir_name, content, attributes, identifier, params = {})

data/lib/nanoc/data_sources/filesystem_verbose.rb

@@ -43,7 +43,7 @@ module Nanoc::DataSources
 
     include Nanoc::DataSources::Filesystem
 
-  private
+    private
 
     # See {Nanoc::DataSources::Filesystem#create_object}.
     def create_object(dir_name, content, attributes, identifier, params = {})

data/lib/nanoc/data_sources/static.rb

@@ -53,7 +53,7 @@ module Nanoc::DataSources
       end
     end
 
-  protected
+    protected
 
     def all_files_in(dir_name)
       Nanoc::Extra::FilesystemTools.all_files_in(dir_name)

data/lib/nanoc/extra/auto_compiler.rb

@@ -51,7 +51,7 @@ module Nanoc::Extra
         if path =~ /\/$/
           possible_paths = site.config[:index_filenames].map { |f| path + f }
         else
-          possible_paths = [ path ]
+          possible_paths = [path]
         end
 
         # Find matching file
@@ -79,7 +79,7 @@ module Nanoc::Extra
       raise e
     end
 
-  private
+    private
 
     def build_site
       @site = Nanoc::Site.new(@site_path)

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

@@ -2,6 +2,12 @@
 
 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.")
+    end
+  end
+
   class Check
 
     extend Nanoc::PluginRegistry::PluginMethods
@@ -25,7 +31,11 @@ module Nanoc::Extra::Checking
     end
 
     def output_filenames
-      Dir[@site.config[:output_dir] + '/**/*'].select { |f| File.file?(f) }
+      output_dir = @site.config[:output_dir]
+      unless File.exist?(output_dir)
+        raise Nanoc::Extra::Checking::OutputDirNotFoundError.new(output_dir)
+      end
+      Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
     end
 
   end

data/lib/nanoc/extra/checking/checks/external_links.rb

@@ -71,11 +71,12 @@ module ::Nanoc::Extra::Checking::Checks
           loop do
             href = enum.next
             break if href.nil?
+
             res = validate(href)
-            if res
-              mutex.synchronize do
-                invalid << res
-              end
+            next unless res
+
+            mutex.synchronize do
+              invalid << res
             end
           end
         end
@@ -99,16 +100,19 @@ module ::Nanoc::Extra::Checking::Checks
 
       # Get status
       res = nil
+      last_err = nil
+      timeouts = [3, 5, 10, 30, 60]
       5.times do |i|
         begin
-          Timeout.timeout(10) do
+          Timeout.timeout(timeouts[i]) do
             res = request_url_once(url)
             if res.code == '405'
               res = request_url_once(url, Net::HTTP::Get)
             end
           end
         rescue => e
-          return Result.new(href, e.message)
+          last_err = e
+          next # can not allow
         end
 
         if res.code =~ /^3..$/
@@ -133,7 +137,11 @@ module ::Nanoc::Extra::Checking::Checks
           return Result.new(href, res.code)
         end
       end
-      raise 'should not have gotten here'
+      if last_err
+        return Result.new(href, last_err.message)
+      else
+        raise 'should not have gotten here'
+      end
     end
 
     def path_for_url(url)

data/lib/nanoc/extra/checking/checks/internal_links.rb

@@ -19,16 +19,16 @@ module Nanoc::Extra::Checking::Checks
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :internal).filenames_per_href
       hrefs_with_filenames.each_pair do |href, fns|
         fns.each do |filename|
-          unless valid?(href, filename)
+          next if valid?(href, filename)
+
           add_issue(
             "broken reference to #{href}",
             :subject  => filename)
-          end
         end
       end
     end
 
-  protected
+    protected
 
     def valid?(href, origin)
       # Skip hrefs that point to self

data/lib/nanoc/extra/checking/checks/stale.rb

@@ -11,15 +11,15 @@ module Nanoc::Extra::Checking::Checks
 
       output_filenames.each do |f|
         next if pruner.filename_excluded?(f)
-        if !item_rep_paths.include?(f)
-          add_issue(
-            'file without matching item',
-            :subject  => f)
-        end
+        next if item_rep_paths.include?(f)
+
+        add_issue(
+          'file without matching item',
+          :subject  => f)
       end
     end
 
-  protected
+    protected
 
     def pruner
       exclude_config = @site.config.fetch(:prune, {}).fetch(:exclude, [])

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

@@ -20,9 +20,10 @@ module Nanoc::Extra::Checking
     end
 
     # @return [Boolean] true if a Checks file exists, false otherwise
-    def has_dsl?
+    def dsl_present?
       checks_filename && File.file?(checks_filename)
     end
+    alias_method :has_dsl?, :dsl_present?
 
     # Lists all available checks on stdout.
     #
@@ -65,12 +66,12 @@ module Nanoc::Extra::Checking
       run_check_classes(check_classes_named(check_class_names))
     end
 
-  protected
+    protected
 
     def load_dsl_if_available
       @dsl_loaded ||= false
-      if !@dsl_loaded
-        if self.has_dsl?
+      unless @dsl_loaded
+        if self.dsl_present?
           @dsl = Nanoc::Extra::Checking::DSL.from_file(checks_filename)
         else
           @dsl = nil
@@ -138,11 +139,11 @@ module Nanoc::Extra::Checking
       issues.group_by { |i| i.subject }.to_a.sort_by { |p| p.first }.each do |pair|
         subject = pair.first
         issues  = pair.last
-        unless issues.empty?
-          puts "  #{subject}:"
-          issues.each do |i|
-            puts "    [ #{'ERROR'.red} ] #{i.check_class.identifier} - #{i.description}"
-          end
+        next if issues.empty?
+
+        puts "  #{subject}:"
+        issues.each do |i|
+          puts "    [ #{'ERROR'.red} ] #{i.check_class.identifier} - #{i.description}"
         end
       end
     end

data/lib/nanoc/extra/chick.rb

@@ -55,7 +55,7 @@ module Nanoc::Extra
         body_parts.each { |part| body << part }
 
         # Done
-        [ status, headers, body ]
+        [status, headers, body]
       end
 
     end
@@ -115,7 +115,7 @@ module Nanoc::Extra
           return [
             response.code.to_i,
             response.to_hash.reduce({}) { |m, (k, v)| m.merge(k => v[0]) },
-            [ response.body ]
+            [response.body]
           ]
         end
       end

data/lib/nanoc/extra/core_ext/enumerable.rb

@@ -2,7 +2,7 @@
 
 module Enumerable
 
-  if !Enumerable.instance_methods.include?('group_by')
+  unless Enumerable.instance_methods.include?('group_by')
 
     # Returns a hash, which keys are evaluated result from the block, and
     # values are arrays of elements in enum corresponding to the key. This

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

@@ -62,7 +62,7 @@ module Nanoc::Extra::Deployers
       while truncated
         set = directory.files.all(:marker => files.last.key)
         truncated = set.is_truncated
-        files = files + set
+        files += set
       end
       keys_to_destroy = files.all.map { |file| file.key }
 
@@ -89,7 +89,7 @@ module Nanoc::Extra::Deployers
       puts 'Done!'
     end
 
-  private
+    private
 
     # Prints the given message on stderr and exits.
     def error(msg)

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

@@ -51,13 +51,13 @@ module Nanoc::Extra::Deployers
       # Run
       if dry_run
         warn 'Performing a dry-run; no actions will actually be performed'
-        run_shell_cmd([ 'echo', 'rsync', options, src, dst ].flatten)
+        run_shell_cmd(['echo', 'rsync', options, src, dst].flatten)
       else
-        run_shell_cmd([ 'rsync', options, src, dst ].flatten)
+        run_shell_cmd(['rsync', options, src, dst].flatten)
       end
     end
 
-  private
+    private
 
     def run_shell_cmd(cmd)
       piper = Nanoc::Extra::Piper.new(:stdout => $stdout, :stderr => $stderr)