nanoc 3.7.3 → 3.7.4

data/lib/nanoc/cli/commands/create-site.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'create-site [options] path'
-aliases     :create_site, :cs
-summary     'create a site'
+usage 'create-site [options] path'
+aliases :create_site, :cs
+summary 'create a site'
 description "
 Create a new site at the given path. The site will use the `filesystem_unified` data source by default, but this can be changed using the `--datasource` commandline option.
 "
@@ -15,7 +15,7 @@ module Nanoc::CLI::Commands
 
     class << self
 
-    protected
+      protected
 
       # Converts the given array to YAML format
       def array_to_yaml(array)
@@ -329,11 +329,11 @@ EOS
       puts "Created a blank nanoc site at '#{path}'. Enjoy!"
     end
 
-  protected
+    protected
 
     # Creates a configuration file and a output directory for this site, as
     # well as a rakefile that loads the standard nanoc tasks.
-    def site_create_minimal(data_source)
+    def site_create_minimal(_data_source)
       # Create output
       FileUtils.mkdir_p('output')
 

data/lib/nanoc/cli/commands/deploy.rb

@@ -1,15 +1,15 @@
 # encoding: utf-8
 
-usage       'deploy [options]'
-summary     'deploy the compiled site'
+usage 'deploy [options]'
+summary 'deploy the compiled site'
 description "
 Deploys the compiled site. The compiled site contents in the output directory will be uploaded to the destination, which is specified using the `--target` option.
 "
 
 option :t, :target,           'specify the location to deploy to (default: `default`)', :argument => :required
-flag   :C, :'no-check',       'do not run the issue checks marked for deployment'
-flag   :L, :list,             'list available locations to deploy to'
-flag   :D, :'list-deployers', 'list available deployers'
+flag :C, :'no-check',       'do not run the issue checks marked for deployment'
+flag :L, :list,             'list available locations to deploy to'
+flag :D, :'list-deployers', 'list available deployers'
 option :n, :'dry-run',        'show what would be deployed'
 
 module Nanoc::CLI::Commands
@@ -35,7 +35,7 @@ module Nanoc::CLI::Commands
 
       if options[:list]
         if deploy_configs.empty?
-          puts  'No deployment configurations.'
+          puts 'No deployment configurations.'
         else
           puts 'Available deployment configurations:'
           deploy_configs.keys.each do |name|
@@ -70,10 +70,10 @@ module Nanoc::CLI::Commands
       # Check
       unless options[:'no-check']
         runner = Nanoc::Extra::Checking::Runner.new(site)
-        if runner.has_dsl?
+        if runner.dsl_present?
           puts 'Running issue checks…'
           ok = runner.run_for_deploy
-          if !ok
+          unless ok
             puts 'Issues found, deploy aborted.'
             return
           end

data/lib/nanoc/cli/commands/nanoc.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-usage   'nanoc command [options] [arguments]'
+usage 'nanoc command [options] [arguments]'
 summary 'nanoc, a static site compiler written in Ruby'
 
 opt :l, :color, 'enable color' do
@@ -12,7 +12,7 @@ opt :d, :debug, 'enable debugging' do
   Nanoc::CLI.debug = true
 end
 
-opt :h, :help, 'show the help message and quit' do |value, cmd|
+opt :h, :help, 'show the help message and quit' do |_value, cmd|
   puts cmd.help
   exit 0
 end
@@ -35,6 +35,6 @@ opt :w, :warn, 'enable warnings' do
   $-w = true
 end
 
-run do |opts, args, cmd|
+run do |_opts, _args, cmd|
   cmd.command_named('compile').run([])
 end

data/lib/nanoc/cli/commands/prune.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'prune'
-summary     'remove files not managed by nanoc from the output directory'
+usage 'prune'
+summary 'remove files not managed by nanoc from the output directory'
 description <<-EOS
 Find all files in the output directory that do not correspond to an item
 managed by nanoc and remove them. Since this is a hazardous operation, an
@@ -33,7 +33,7 @@ module Nanoc::CLI::Commands
       end
     end
 
-  protected
+    protected
 
     def prune_config
       site.config[:prune] || {}

data/lib/nanoc/cli/commands/shell.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'shell'
-summary     'open a shell on the nanoc environment'
-aliases     'console'
+usage 'shell'
+summary 'open a shell on the nanoc environment'
+aliases 'console'
 description "
 Open an IRB shell on a context that contains @items, @layouts, @config and @site.
 "
@@ -19,7 +19,7 @@ module Nanoc::CLI::Commands
       Nanoc::Context.new(env).pry
     end
 
-  protected
+    protected
 
     def env
       {

data/lib/nanoc/cli/commands/show-data.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'show-data'
-aliases     :debug
-summary     'show data in this site'
+usage 'show-data'
+aliases :debug
+summary 'show data in this site'
 description <<-EOS
 Show information about all items, item representations and layouts in the
 current site, along with dependency information.
@@ -31,7 +31,7 @@ module Nanoc::CLI::Commands
       print_layouts(layouts, compiler)
     end
 
-  protected
+    protected
 
     def sorted_with_prev(objects)
       prev = nil
@@ -89,7 +89,7 @@ module Nanoc::CLI::Commands
         end
         length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
         rep.raw_paths.each do |snapshot_name, raw_path|
-          puts "  [ %-#{length}s ] %s" % [ snapshot_name, raw_path ]
+          puts "  [ %-#{length}s ] %s" % [snapshot_name, raw_path]
         end
       end
     end

data/lib/nanoc/cli/commands/show-plugins.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-summary     'show all available plugins'
-aliases     :info
-usage       'show-plugins [options]'
+summary 'show all available plugins'
+aliases :info
+usage 'show-plugins [options]'
 description <<-EOS
 Show a list of available plugins, including filters, data sources and VCSes.
 If the current directory contains a nanoc web site, the plugins defined in this site will be shown as well.
@@ -45,7 +45,7 @@ module Nanoc::CLI::Commands
         puts
 
         # Print plugins organised by subtype
-        [ :builtin, :custom ].each do |type|
+        [:builtin, :custom].each do |type|
           # Find relevant plugins
           relevant_plugins = plugins_with_this_superclass[type]
 
@@ -71,7 +71,7 @@ module Nanoc::CLI::Commands
       end
     end
 
-  private
+    private
 
     PLUGIN_CLASS_ORDER = [
       Nanoc::Filter,

data/lib/nanoc/cli/commands/show-rules.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'show-rules [thing]'
-aliases     :explain
-summary     'describe the rules for each item'
+usage 'show-rules [thing]'
+aliases :explain
+summary 'describe the rules for each item'
 description "
 Prints the rules used for all items and layouts in the current site.
 "
@@ -25,7 +25,7 @@ module Nanoc::CLI::Commands
       site.layouts.each { |l| explain_layout(l) }
     end
 
-  protected
+    protected
 
     def explain_item(item)
       puts "#{@c.c('Item ' + item.identifier, :bold, :yellow)}:"

data/lib/nanoc/cli/commands/sync.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-usage   'sync'
+usage 'sync'
 summary 'sync data sources'
 description <<-EOS
 Sync data source data. This command is useful for updating local item caches

data/lib/nanoc/cli/commands/update.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-usage   'update [options]'
+usage 'update [options]'
 summary 'update the data stored by the data source to a newer version'
 description <<-EOS
 Update the data stored by the data source to a newer format. The format in
@@ -13,7 +13,7 @@ backup in case something goes wrong.
 EOS
 
 required :c, :vcs, 'select the VCS to use'
-flag     :y, :yes, 'update the data without warning'
+flag :y, :yes, 'update the data without warning'
 
 module Nanoc::CLI::Commands
 
@@ -37,21 +37,21 @@ module Nanoc::CLI::Commands
         $stderr.puts '** WARNING **'
         $stderr.puts '*************'
         $stderr.puts
-        $stderr.puts 'Are you absolutely sure you want to update the ' +
-                     'content for this site? Updating the site content ' +
-                     'will change the structure of existing data. This ' +
-                     'operation is destructive and cannot be reverted. ' +
-                     'Please do not interrupt this operation; doing so can ' +
-                     'result in data loss. As always, consider making a ' +
+        $stderr.puts 'Are you absolutely sure you want to update the ' \
+                     'content for this site? Updating the site content ' \
+                     'will change the structure of existing data. This ' \
+                     'operation is destructive and cannot be reverted. ' \
+                     'Please do not interrupt this operation; doing so can ' \
+                     'result in data loss. As always, consider making a ' \
                      'backup copy.'
         $stderr.puts
-        $stderr.puts 'If this nanoc site is versioned using a VCS ' +
-                     'supported by nanoc, consider using the --vcs option ' +
-                     'to have nanoc perform add/delete/move operations ' +
-                     'using the specified VCS. To get a list of VCSes ' +
+        $stderr.puts 'If this nanoc site is versioned using a VCS ' \
+                     'supported by nanoc, consider using the --vcs option ' \
+                     'to have nanoc perform add/delete/move operations ' \
+                     'using the specified VCS. To get a list of VCSes ' \
                      'supported by nanoc, issue the "info" command.'
         $stderr.puts
-        $stderr.puts 'To continue, use the -y/--yes option, like "nanoc ' +
+        $stderr.puts 'To continue, use the -y/--yes option, like "nanoc ' \
                      'update -y".'
         exit 1
       end

data/lib/nanoc/cli/commands/validate-css.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'validate-css [options]'
-aliases     :validate_css, :vcss
-summary     'validate the site’s CSS'
+usage 'validate-css [options]'
+aliases :validate_css, :vcss
+summary 'validate the site’s CSS'
 be_hidden
 description "
 Validates the site’s CSS files.

data/lib/nanoc/cli/commands/validate-html.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'validate-html [options]'
-aliases     :validate_html, :vhtml
-summary     'validate the site’s HTML'
+usage 'validate-html [options]'
+aliases :validate_html, :vhtml
+summary 'validate the site’s HTML'
 be_hidden
 description "
 Validates the site’s HTML files.

data/lib/nanoc/cli/commands/validate-links.rb

@@ -1,15 +1,15 @@
 # encoding: utf-8
 
-usage       'validate-links [options]'
-aliases     :validate_links, :vlink
-summary     'validate links in site'
+usage 'validate-links [options]'
+aliases :validate_links, :vlink
+summary 'validate links in site'
 be_hidden
 description "
 Validates the site’s links. By default, both internal and external links will be checked.
 "
 
-flag   :i, :internal, 'validate internal links only'
-flag   :e, :external, 'validate external links only'
+flag :i, :internal, 'validate internal links only'
+flag :e, :external, 'validate external links only'
 
 module Nanoc::CLI::Commands
 
@@ -21,7 +21,7 @@ module Nanoc::CLI::Commands
       checks = []
       checks << 'ilinks' if options[:internal]
       checks << 'elinks' if options[:external]
-      Nanoc::CLI.run [ 'check', checks ].flatten
+      Nanoc::CLI.run ['check', checks].flatten
     end
 
   end

data/lib/nanoc/cli/commands/view.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'view [options]'
-summary     'start the web server that serves static files'
+usage 'view [options]'
+summary 'start the web server that serves static files'
 description <<-EOS
 Start the static web server. Unless specified, the web server will run on port
 3000 and listen on all IP addresses. Running this static web server requires
@@ -57,7 +57,7 @@ module Nanoc::CLI::Commands
       handler.run(app, options_for_rack)
     end
 
-  protected
+    protected
 
     def load_adsf
       # Load adsf
@@ -66,7 +66,7 @@ module Nanoc::CLI::Commands
         return
       rescue LoadError
         $stderr.puts "Could not find the required 'adsf' gem, " \
-          "which is necessary for the view command."
+          'which is necessary for the view command.'
       end
 
       # Check asdf

data/lib/nanoc/cli/commands/watch.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'watch [options]'
-summary     'start the watcher'
+usage 'watch [options]'
+summary 'start the watcher'
 be_hidden
 description <<-EOS
 Start the watcher. When a change is detected, the site will be recompiled.
@@ -114,25 +114,25 @@ module Nanoc::CLI::Commands
         end
       end
 
-    protected
+      protected
 
-      def have_tool_nix?(tool)
+      def nix_tool_present?(tool)
         !`which #{tool}`.empty?
       rescue Errno::ENOENT
         false
       end
 
-      def have_tool_windows?(tool)
+      def windows_tool_present?(tool)
         !`where #{tool} 2> nul`.empty?
       rescue Errno::ENOENT
         false
       end
 
-      def have_tool?(tool)
+      def tool_present?(tool)
         if self.on_windows?
-          self.have_tool_windows?(tool)
+          self.windows_tool_present?(tool)
         else
-          self.have_tool_nix?(tool)
+          self.nix_tool_present?(tool)
         end
       end
 
@@ -141,7 +141,7 @@ module Nanoc::CLI::Commands
           require 'terminal-notifier'
           'terminal-notify'
         rescue LoadError
-          TOOLS.find { |t| have_tool?(t) }
+          TOOLS.find { |t| tool_present?(t) }
         end
       end
 
@@ -150,7 +150,7 @@ module Nanoc::CLI::Commands
       end
 
       def growlnotify_cmd_for(message)
-        [ 'growlnotify', '-m', message ]
+        ['growlnotify', '-m', message]
       end
 
       def growlnotify(message)
@@ -158,7 +158,7 @@ module Nanoc::CLI::Commands
       end
 
       def growlnotify_windows_cmd_for(message)
-        [ 'growlnotify', '/t:nanoc', message ]
+        ['growlnotify', '/t:nanoc', message]
       end
 
       def growlnotify_windows(message)

data/lib/nanoc/cli/error_handler.rb

@@ -50,7 +50,7 @@ module Nanoc::CLI
     # @return [void]
     #
     # @api private
-    def handle_while(&block)
+    def handle_while(&_block)
       # Set exit handler
       %w( INT TERM ).each do |signal|
         Signal.trap(signal) do
@@ -157,7 +157,7 @@ module Nanoc::CLI
       write_load_paths(stream,        :verbose => true)
     end
 
-  protected
+    protected
 
     # @return [Boolean] true if debug output is enabled, false if not
     #
@@ -184,7 +184,7 @@ module Nanoc::CLI
     # @return [Hash<String, Array>] A hash containing the gem names as keys and gem versions as value
     def gems_and_versions
       gems = {}
-      Gem::Specification.find_all.sort_by { |s| [ s.name, s.version ] }.each do |spec|
+      Gem::Specification.find_all.sort_by { |s| [s.name, s.version] }.each do |spec|
         gems[spec.name] ||= []
         gems[spec.name] << spec.version.to_s
       end
@@ -248,11 +248,11 @@ module Nanoc::CLI
         end
       when RuntimeError
         if error.message =~ /^can't modify frozen/
-          "You attempted to modify immutable data. Some data, such as " \
-          "item/layout attributes and raw item/layout content, can not " \
-          "be modified once compilation has started. (This was " \
-          "unintentionally possible in 3.1.x and before, but has been " \
-          "disabled in 3.2.x in order to allow compiler optimisations.)"
+          'You attempted to modify immutable data. Some data, such as ' \
+          'item/layout attributes and raw item/layout content, can not ' \
+          'be modified once compilation has started. (This was ' \
+          'unintentionally possible in 3.1.x and before, but has been ' \
+          'disabled in 3.2.x in order to allow compiler optimisations.)'
         end
       end
     end
@@ -279,7 +279,7 @@ module Nanoc::CLI
       stream.puts "#{resolution}" if resolution
     end
 
-    def write_compilation_stack(stream, error, params = {})
+    def write_compilation_stack(stream, _error, params = {})
       write_section_header(stream, 'Compilation stack', params)
 
       if stack.empty?
@@ -309,7 +309,7 @@ module Nanoc::CLI
       end
     end
 
-    def write_issue_link(stream, params = {})
+    def write_issue_link(stream, _params = {})
       stream.puts
       stream.puts 'If you believe this is a bug in nanoc, please do report it at'
       stream.puts '-> https://github.com/nanoc/nanoc/issues/new <-'