nanoc 3.7.4 → 3.7.5

data/lib/nanoc/cli/command_runner.rb

@@ -1,16 +1,14 @@
 # encoding: utf-8
 
 module Nanoc::CLI
-
   # A command runner subclass for nanoc commands that adds nanoc-specific
   # convenience methods and error handling.
   class CommandRunner < ::Cri::CommandRunner
-
     # @see http://rubydoc.info/gems/cri/Cri/CommandRunner#call-instance_method
     #
     # @return [void]
     def call
-      Nanoc::CLI::ErrorHandler.handle_while(:command => self) do
+      Nanoc::CLI::ErrorHandler.handle_while(command: self) do
         run
       end
     end
@@ -104,10 +102,8 @@ module Nanoc::CLI
     def stack
       (site && site.compiler.stack) || []
     end
-
   end
 
   # @deprecated Use {Nanoc::CLI::CommandRunner} instead
   Command = CommandRunner
-
 end

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

@@ -24,9 +24,7 @@ required :o, :host,    'specify the host to listen on (default: 0.0.0.0)'
 required :p, :port,    'specify the port to listen on (default: 3000)'
 
 module Nanoc::CLI::Commands
-
   class AutoCompile < ::Nanoc::CLI::CommandRunner
-
     def run
       warn 'WARNING: The `autocompile` command is deprecated. Please consider using `guard-nanoc` instead (see https://github.com/nanoc/guard-nanoc).'
 
@@ -38,8 +36,8 @@ module Nanoc::CLI::Commands
 
       # Set options
       options_for_rack = {
-        :Port      => (options[:port] || autocompile_config[:port] || 3000).to_i,
-        :Host      => (options[:host] || autocompile_config[:host] || '0.0.0.0')
+        Port: (options[:port] || autocompile_config[:port] || 3000).to_i,
+        Host: (options[:host] || autocompile_config[:host] || '0.0.0.0')
       }
 
       # Guess which handler we should use
@@ -65,9 +63,7 @@ module Nanoc::CLI::Commands
       puts "Running on http://#{options_for_rack[:Host]}:#{options_for_rack[:Port]}/"
       handler.run(app, options_for_rack)
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::AutoCompile

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

@@ -11,9 +11,7 @@ flag :L, :list,   'list all checks'
 flag :d, :deploy, 'run checks for deployment'
 
 module Nanoc::CLI::Commands
-
   class Check < ::Nanoc::CLI::CommandRunner
-
     def run
       validate_options_and_arguments
       require_site
@@ -47,9 +45,7 @@ module Nanoc::CLI::Commands
           'nothing to do (pass either --all, --deploy or --list or a list of checks)'
       end
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::Check

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

@@ -21,9 +21,7 @@ option :a, :all,   '(ignored)'
 option :f, :force, '(ignored)'
 
 module Nanoc::CLI::Commands
-
   class Compile < ::Nanoc::CLI::CommandRunner
-
     extend Nanoc::Memoization
 
     # Listens to compilation events and reacts to them. This abstract class
@@ -32,7 +30,6 @@ module Nanoc::CLI::Commands
     #
     # @abstract Subclasses must override {#start} and may override {#stop}.
     class Listener
-
       def initialize(_params = {})
       end
 
@@ -41,7 +38,7 @@ module Nanoc::CLI::Commands
       # @return [Boolean] true if this listener should be enabled for the given command runner, false otherwise
       #
       # @abstract Returns `true` by default, but subclasses may override this.
-      def self.enable_for?(_command_runner)
+      def self.enable_for?(command_runner) # rubocop:disable Lint/UnusedMethodArgument
         true
       end
 
@@ -59,12 +56,10 @@ module Nanoc::CLI::Commands
       # @return [void]
       def stop
       end
-
     end
 
     # Generates diffs for every output file written
     class DiffGenerator < Listener
-
       # @see Listener#enable_for?
       def self.enable_for?(command_runner)
         command_runner.site.config[:enable_output_diff]
@@ -76,7 +71,7 @@ module Nanoc::CLI::Commands
         setup_diffs
         old_contents = {}
         Nanoc::NotificationCenter.on(:will_write_rep) do |rep, snapshot|
-          path = rep.raw_path(:snapshot => snapshot)
+          path = rep.raw_path(snapshot: snapshot)
           old_contents[rep] = File.file?(path) ? File.read(path) : nil
         end
         Nanoc::NotificationCenter.on(:rep_written) do |rep, path, _is_created, _is_modified|
@@ -105,7 +100,7 @@ module Nanoc::CLI::Commands
       end
 
       def teardown_diffs
-        @diff_threads.each { |t| t.join }
+        @diff_threads.each(&:join)
       end
 
       def generate_diff_for(rep, old_content, new_content)
@@ -149,12 +144,10 @@ module Nanoc::CLI::Commands
              'content will be available.'
         nil
       end
-
     end
 
     # Records the time spent per filter and per item representation
     class TimingRecorder < Listener
-
       # @see Listener#enable_for?
       def self.enable_for?(command_runner)
         command_runner.options.fetch(:verbose, false)
@@ -171,7 +164,7 @@ module Nanoc::CLI::Commands
       def start
         Nanoc::NotificationCenter.on(:filtering_started) do |_rep, filter_name|
           @times[filter_name] ||= []
-          @times[filter_name] << { :start => Time.now }
+          @times[filter_name] << { start: Time.now }
         end
         Nanoc::NotificationCenter.on(:filtering_ended) do |_rep, filter_name|
           @times[filter_name].last[:stop] = Time.now
@@ -215,7 +208,7 @@ module Nanoc::CLI::Commands
         # Calculate stats
         count = samples.size
         min   = samples.min
-        tot   = samples.reduce(0) { |memo, i| memo + i }
+        tot   = samples.reduce(0) { |a, e| a + e }
         avg   = tot / count
         max   = samples.max
 
@@ -253,12 +246,10 @@ module Nanoc::CLI::Commands
         end
         result
       end
-
     end
 
     # Controls garbage collection so that it only occurs once every 20 items
     class GCController < Listener
-
       # @see Listener#enable_for?
       def self.enable_for?(_command_runner)
         !ENV.key?('TRAVIS')
@@ -285,12 +276,10 @@ module Nanoc::CLI::Commands
         super
         GC.enable
       end
-
     end
 
     # Prints debug information (compilation started/ended, filtering started/ended, …)
     class DebugPrinter < Listener
-
       # @see Listener#enable_for?
       def self.enable_for?(command_runner)
         command_runner.debug?
@@ -327,12 +316,10 @@ module Nanoc::CLI::Commands
           puts "*** Dependency created from #{src.inspect} onto #{dst.inspect}"
         end
       end
-
     end
 
     # Prints file actions (created, updated, deleted, identical, skipped)
     class FileActionPrinter < Listener
-
       # @option params [Array<Nanoc::ItemRep>] :reps The list of item representations in the site
       def initialize(params = {})
         @start_times = {}
@@ -378,7 +365,6 @@ module Nanoc::CLI::Commands
       def log(level, action, path, duration)
         Nanoc::CLI::Logger.instance.file(level, action, path, duration)
       end
-
     end
 
     def initialize(options, arguments, command, params = {})
@@ -407,7 +393,7 @@ module Nanoc::CLI::Commands
 
     def prune
       if site.config[:prune][:auto_prune]
-        Nanoc::Extra::Pruner.new(site, :exclude => prune_config_exclude).run
+        Nanoc::Extra::Pruner.new(site, exclude: prune_config_exclude).run
       end
     end
 
@@ -422,11 +408,12 @@ module Nanoc::CLI::Commands
     end
 
     def setup_listeners
-      @listeners = @listener_classes
+      @listeners =
+        @listener_classes
         .select { |klass| klass.enable_for?(self) }
-        .map    { |klass| klass.new(:reps => reps) }
+        .map    { |klass| klass.new(reps: reps) }
 
-      @listeners.each { |s| s.start }
+      @listeners.each(&:start)
     end
 
     def listeners
@@ -441,11 +428,11 @@ module Nanoc::CLI::Commands
     end
 
     def teardown_listeners
-      @listeners.each { |s| s.stop }
+      @listeners.each(&:stop)
     end
 
     def reps
-      site.items.map { |i| i.reps }.flatten
+      site.items.map(&:reps).flatten
     end
     memoize :reps
 
@@ -470,9 +457,7 @@ module Nanoc::CLI::Commands
     def prune_config_exclude
       prune_config[:exclude] || {}
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::Compile

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

@@ -11,9 +11,7 @@ EOS
 required :c, :vcs, 'specify the VCS to use'
 
 module Nanoc::CLI::Commands
-
   class CreateItem < ::Nanoc::CLI::CommandRunner
-
     def run
       # Check arguments
       if arguments.length != 1
@@ -45,15 +43,13 @@ module Nanoc::CLI::Commands
       data_source = site.data_sources[0]
       data_source.create_item(
         "Hi, I'm a new item!\n",
-        { :title => 'A New Item' },
+        { title: 'A New Item' },
         identifier
       )
 
       puts "An item has been created at #{identifier}."
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::CreateItem

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

@@ -9,9 +9,7 @@ configuration will be used.
 EOS
 
 module Nanoc::CLI::Commands
-
   class CreateLayout < ::Nanoc::CLI::CommandRunner
-
     def run
       # Check arguments
       if arguments.length != 1
@@ -64,9 +62,7 @@ module Nanoc::CLI::Commands
 
       puts "A layout has been created at #{identifier}."
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::CreateLayout

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

@@ -10,18 +10,14 @@ Create a new site at the given path. The site will use the `filesystem_unified`
 required :d, :datasource, 'specify the data source for the new site'
 
 module Nanoc::CLI::Commands
-
   class CreateSite < ::Nanoc::CLI::CommandRunner
-
     class << self
-
       protected
 
       # Converts the given array to YAML format
       def array_to_yaml(array)
         '[ ' + array.map { |s| "'" + s + "'" }.join(', ') + ' ]'
       end
-
     end
 
     DEFAULT_CONFIG = <<EOS unless defined? DEFAULT_CONFIG
@@ -370,7 +366,7 @@ EOS
       # Create home page
       data_source.create_item(
         DEFAULT_ITEM,
-        { :title => 'Home' },
+        { title: 'Home' },
         '/'
       )
 
@@ -379,7 +375,7 @@ EOS
         DEFAULT_STYLESHEET,
         {},
         '/stylesheet/',
-        :extension => '.css'
+        extension: '.css'
       )
 
       # Create layout
@@ -396,9 +392,7 @@ EOS
         io.write "\# before nanoc starts compiling.\n"
       end
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::CreateSite

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

@@ -6,23 +6,21 @@ 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
+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'
 option :n, :'dry-run',        'show what would be deployed'
 
 module Nanoc::CLI::Commands
-
   class Deploy < ::Nanoc::CLI::CommandRunner
-
     def run
       load_site
 
       # List deployers
       if options[:'list-deployers']
         deployers      = Nanoc::PluginRegistry.instance.find_all(Nanoc::Extra::Deployer)
-        deployer_names = deployers.keys.sort_by { |k| k.to_s }
+        deployer_names = deployers.keys.sort_by(&:to_s)
         puts 'Available deployers:'
         deployer_names.each do |name|
           puts "  #{name}"
@@ -85,12 +83,10 @@ module Nanoc::CLI::Commands
       deployer = deployer_class.new(
         site.config[:output_dir],
         config,
-        :dry_run => options[:'dry-run'])
+        dry_run: options[:'dry-run'])
       deployer.run
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::Deploy

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

@@ -15,16 +15,14 @@ flag :y, :yes,       'confirm deletion'
 flag :n, :'dry-run', 'print files to be deleted instead of actually deleting them'
 
 module Nanoc::CLI::Commands
-
   class Prune < ::Nanoc::CLI::CommandRunner
-
     def run
       load_site
 
       if options.key?(:yes)
-        Nanoc::Extra::Pruner.new(site, :exclude => prune_config_exclude).run
+        Nanoc::Extra::Pruner.new(site, exclude: prune_config_exclude).run
       elsif options.key?(:'dry-run')
-        Nanoc::Extra::Pruner.new(site, :exclude => prune_config_exclude, :dry_run => true).run
+        Nanoc::Extra::Pruner.new(site, exclude: prune_config_exclude, dry_run: true).run
       else
         $stderr.puts 'WARNING: Since the prune command is a destructive command, it requires an additional --yes flag in order to work.'
         $stderr.puts
@@ -42,9 +40,7 @@ module Nanoc::CLI::Commands
     def prune_config_exclude
       prune_config[:exclude] || {}
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::Prune

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

@@ -8,9 +8,7 @@ Open an IRB shell on a context that contains @items, @layouts, @config and @site
 "
 
 module Nanoc::CLI::Commands
-
   class Shell < ::Nanoc::CLI::CommandRunner
-
     def run
       require 'pry'
 
@@ -23,15 +21,13 @@ module Nanoc::CLI::Commands
 
     def env
       {
-        :site    => site,
-        :items   => site.items,
-        :layouts => site.layouts,
-        :config  => site.config
+        site: site,
+        items: site.items,
+        layouts: site.layouts,
+        config: site.config
       }
     end
-
   end
-
 end
 
 runner Nanoc::CLI::Commands::Shell