nanoc 3.6.7 → 3.6.8

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

@@ -3,26 +3,26 @@
 usage       'show-rules [thing]'
 aliases     :explain
 summary     'describe the rules for each item'
-description <<-EOS
+description "
 Prints the rules used for all items and layouts in the current site.
-EOS
+"
 
 module Nanoc::CLI::Commands
 
   class ShowRules < ::Nanoc::CLI::CommandRunner
 
     def run
-      self.require_site
+      require_site
 
       @c    = Nanoc::CLI::ANSIStringColorizer
-      @calc = self.site.compiler.rule_memory_calculator
+      @calc = site.compiler.rule_memory_calculator
 
       # TODO explain /foo/
       # TODO explain content/foo.html
       # TODO explain output/foo/index.html
 
-      self.site.items.each   { |i| self.explain_item(i)   }
-      self.site.layouts.each { |l| self.explain_layout(l) }
+      site.items.each   { |i| explain_item(i)   }
+      site.layouts.each { |l| explain_layout(l) }
     end
 
   protected
@@ -33,7 +33,7 @@ module Nanoc::CLI::Commands
       item.reps.each do |rep|
         puts "  Rep #{rep.name}:"
         if @calc[rep].empty? && rep.raw_path.nil?
-          puts "    (nothing)"
+          puts '    (nothing)'
         else
           @calc[rep].each do |mem|
             puts '    %s %s' % [
@@ -55,7 +55,7 @@ module Nanoc::CLI::Commands
     def explain_layout(layout)
       puts "#{@c.c('Layout ' + layout.identifier, :bold, :yellow)}:"
       puts "  (from #{layout[:filename]})" if layout[:filename]
-      puts "  %s %s" % [
+      puts '  %s %s' % [
         @c.c(format('%-10s', 'filter'), :blue),
         @calc[layout].map { |m| m.inspect }.join(', ')
       ]

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 usage   'sync'
 summary 'sync data sources'
 description <<-EOS
@@ -16,10 +18,10 @@ module Nanoc::CLI::Commands
       end
 
       # Make sure we are in a nanoc site directory
-      self.require_site
+      require_site
 
       # Update all syncable data sources
-      self.site.data_sources.each do |data_source|
+      site.data_sources.each do |data_source|
         unless data_source.method(:sync).owner == Nanoc::DataSource
           puts "Syncing #{data_source.config[:type]} data source: #{data_source.items_root}"
           data_source.sync

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

@@ -26,13 +26,13 @@ module Nanoc::CLI::Commands
       end
 
       # Make sure we are in a nanoc site directory
-      self.require_site
+      require_site
 
       # Set VCS if possible
-      self.set_vcs(options[:vcs])
+      set_vcs(options[:vcs])
 
       # Check for -y switch
-      unless options.has_key?(:yes)
+      unless options.key?(:yes)
         $stderr.puts '*************'
         $stderr.puts '** WARNING **'
         $stderr.puts '*************'
@@ -57,7 +57,7 @@ module Nanoc::CLI::Commands
       end
 
       # Update
-      self.site.data_sources.each do |data_source|
+      site.data_sources.each do |data_source|
         data_source.update
       end
     end

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

@@ -4,16 +4,16 @@ usage       'validate-css [options]'
 aliases     :validate_css, :vcss
 summary     'validate the site’s CSS'
 be_hidden
-description <<-EOS
+description "
 Validates the site’s CSS files.
-EOS
+"
 
 module Nanoc::CLI::Commands
 
   class ValidateCSS < ::Nanoc::CLI::CommandRunner
 
     def run
-      warn "The `validate-css` command is deprecated. Please use the new `check` command instead."
+      warn 'The `validate-css` command is deprecated. Please use the new `check` command instead.'
       Nanoc::CLI.run %w( check css )
     end
 

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

@@ -4,16 +4,16 @@ usage       'validate-html [options]'
 aliases     :validate_html, :vhtml
 summary     'validate the site’s HTML'
 be_hidden
-description <<-EOS
+description "
 Validates the site’s HTML files.
-EOS
+"
 
 module Nanoc::CLI::Commands
 
   class ValidateHTML < ::Nanoc::CLI::CommandRunner
 
     def run
-      warn "The `validate-html` command is deprecated. Please use the new `check` command instead."
+      warn 'The `validate-html` command is deprecated. Please use the new `check` command instead.'
       Nanoc::CLI.run %w( check html )
     end
 

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

@@ -4,9 +4,9 @@ usage       'validate-links [options]'
 aliases     :validate_links, :vlink
 summary     'validate links in site'
 be_hidden
-description <<-EOS
+description "
 Validates the site’s links. By default, both internal and external links will be checked.
-EOS
+"
 
 flag   :i, :internal, 'validate internal links only'
 flag   :e, :external, 'validate external links only'
@@ -16,7 +16,7 @@ module Nanoc::CLI::Commands
   class ValidateLinks < ::Nanoc::CLI::CommandRunner
 
     def run
-      warn "The `validate-links` command is deprecated. Please use the new `check` command instead."
+      warn 'The `validate-links` command is deprecated. Please use the new `check` command instead.'
 
       checks = []
       checks << 'ilinks' if options[:internal]

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

@@ -3,7 +3,9 @@
 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 `adsf` (not `asdf`!).
+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
+`adsf` (not `asdf`!).
 EOS
 
 required :H, :handler, 'specify the handler to use (webrick/mongrel/...)'
@@ -21,7 +23,7 @@ module Nanoc::CLI::Commands
       require 'rack'
 
       # Make sure we are in a nanoc site directory
-      self.require_site
+      require_site
 
       # Set options
       options_for_rack = {
@@ -30,7 +32,7 @@ module Nanoc::CLI::Commands
       }
 
       # Get handler
-      if options.has_key?(:handler)
+      if options.key?(:handler)
         handler = Rack::Handler.get(options[:handler])
       else
         begin

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

@@ -18,7 +18,7 @@ module Nanoc::CLI::Commands
       require 'pathname'
 
       require_site
-      watcher_config = self.site.config[:watcher] || {}
+      watcher_config = site.config[:watcher] || {}
 
       @notifier = Notifier.new
 
@@ -35,7 +35,7 @@ module Nanoc::CLI::Commands
         if filename
           print "Change detected to #{filename}; recompiling… "
         else
-          print "Watcher started; compiling the entire site… "
+          print 'Watcher started; compiling the entire site… '
         end
 
         # Recompile
@@ -50,7 +50,7 @@ module Nanoc::CLI::Commands
             @notifier.notify('Compilation complete')
           end
 
-          time_spent = ((Time.now - start)*1000.0).round
+          time_spent = ((Time.now - start) * 1000.0).round
           puts "done in #{format '%is %ims', *(time_spent.divmod(1000))}"
         rescue Exception => e
           # TODO include icon (--image misc/error-icon.png)
@@ -69,15 +69,15 @@ module Nanoc::CLI::Commands
       rebuilder.call(nil)
 
       # Get directories to watch
-      dirs_to_watch  = watcher_config[:dirs_to_watch]  || [ 'content', 'layouts', 'lib' ]
-      files_to_watch = watcher_config[:files_to_watch] || [ 'nanoc.yaml', 'config.yaml', 'Rules', 'rules', 'Rules.rb', 'rules.rb' ]
+      dirs_to_watch  = watcher_config[:dirs_to_watch]  || %w( content layouts lib )
+      files_to_watch = watcher_config[:files_to_watch] || %w( nanoc.yaml config.yaml Rules rules Rules.rb rules.rb )
       files_to_watch = Regexp.new(files_to_watch.map { |name| Regexp.quote(name) + '$' }.join('|'))
       ignore_dir = Regexp.new(Dir.glob('*').map { |dir| dir if File.directory?(dir) }.compact.join('|'))
 
       # Watch
-      puts "Watching for changes…"
+      puts 'Watching for changes…'
 
-      callback = Proc.new do |modified, added, removed|
+      callback = proc do |modified, added, removed|
         rebuilder.call(modified[0]) if modified[0]
         rebuilder.call(added[0]) if added[0]
         rebuilder.call(removed[0]) if removed[0]
@@ -108,13 +108,13 @@ module Nanoc::CLI::Commands
       def notify(message)
         return if tool.nil?
         if tool == 'growlnotify' && self.on_windows?
-          self.growlnotify_windows(message)
+          growlnotify_windows(message)
         else
           send(tool.tr('-', '_'), message)
         end
       end
 
-      protected
+    protected
 
       def have_tool_nix?(tool)
         !`which #{tool}`.empty?
@@ -146,7 +146,7 @@ module Nanoc::CLI::Commands
       end
 
       def terminal_notify(message)
-        TerminalNotifier.notify(message, :title => "nanoc")
+        TerminalNotifier.notify(message, :title => 'nanoc')
       end
 
       def growlnotify_cmd_for(message)
@@ -154,7 +154,7 @@ module Nanoc::CLI::Commands
       end
 
       def growlnotify(message)
-        system(*self.growlnotify_cmd_for(message))
+        system(*growlnotify_cmd_for(message))
       end
 
       def growlnotify_windows_cmd_for(message)
@@ -162,7 +162,7 @@ module Nanoc::CLI::Commands
       end
 
       def growlnotify_windows(message)
-        system(*self.growlnotify_windows_cmd_for(message))
+        system(*growlnotify_windows_cmd_for(message))
       end
 
       def notify_send(message)

data/lib/nanoc/cli/error_handler.rb

@@ -9,7 +9,7 @@ module Nanoc::CLI
 
     # @option params [Nanoc::CLI::Command, nil] command The command that is
     #   currently being executed, or nil if there is none
-    def initialize(params={})
+    def initialize(params = {})
       @command = params[:command]
     end
 
@@ -19,11 +19,11 @@ module Nanoc::CLI
     #   currently being executed, or nil if there is none
     #
     # @return [void]
-    def self.handle_while(params={}, &block)
+    def self.handle_while(params = {}, &block)
       if @disabled
         yield
       else
-        self.new(params).handle_while(&block)
+        new(params).handle_while(&block)
       end
     end
 
@@ -52,7 +52,7 @@ module Nanoc::CLI
     # @api private
     def handle_while(&block)
       # Set exit handler
-      [ 'INT', 'TERM' ].each do |signal|
+      %w( INT TERM ).each do |signal|
         Signal.trap(signal) do
           puts
           exit!(0)
@@ -60,7 +60,7 @@ module Nanoc::CLI
       end
       begin
         Signal.trap('USR1') do
-          puts "Caught USR1; dumping a stack trace"
+          puts 'Caught USR1; dumping a stack trace'
           puts caller.map { |i| "  #{i}" }.join("\n")
         end
       rescue ArgumentError
@@ -71,10 +71,10 @@ module Nanoc::CLI
     rescue Nanoc::Errors::GenericTrivial => e
       $stderr.puts "Error: #{e.message}"
       exit(1)
-    rescue Interrupt => e
+    rescue Interrupt
       exit(1)
     rescue StandardError, ScriptError => e
-      self.print_error(e)
+      print_error(e)
       exit(1)
     end
 
@@ -85,7 +85,7 @@ module Nanoc::CLI
     #
     # @return [void]
     def self.print_error(error)
-      self.new.print_error(error)
+      new.print_error(error)
     end
 
     # Prints the given error to stderr. Includes message, possible resolution
@@ -117,15 +117,15 @@ module Nanoc::CLI
     def write_compact_error(error, stream)
       # Header
       stream.puts
-      stream.puts "Captain! We’ve been hit!"
+      stream.puts 'Captain! We’ve been hit!'
 
       # Sections
-      self.write_error_message(    stream, error)
-      self.write_compilation_stack(stream, error)
-      self.write_stack_trace(      stream, error)
+      write_error_message(stream, error)
+      write_compilation_stack(stream, error)
+      write_stack_trace(stream, error)
 
       # Issue link
-      self.write_issue_link(stream)
+      write_issue_link(stream)
     end
 
     # Writes a verbose representation of the error on the given stream.
@@ -142,15 +142,15 @@ module Nanoc::CLI
       stream.puts "Crashlog created at #{Time.now}"
 
       # Sections
-      self.write_error_message(      stream, error, :verbose => true)
-      self.write_compilation_stack(  stream, error, :verbose => true)
-      self.write_stack_trace(        stream, error, :verbose => true)
-      self.write_version_information(stream,        :verbose => true)
-      self.write_system_information( stream,        :verbose => true)
-      self.write_installed_gems(     stream,        :verbose => true)
-      self.write_environment(        stream,        :verbose => true)
-      self.write_gemfile_lock(       stream,        :verbose => true)
-      self.write_load_paths(         stream,        :verbose => true)
+      write_error_message(stream, error, :verbose => true)
+      write_compilation_stack(stream, error, :verbose => true)
+      write_stack_trace(stream, error, :verbose => true)
+      write_version_information(stream,        :verbose => true)
+      write_system_information(stream,        :verbose => true)
+      write_installed_gems(stream,        :verbose => true)
+      write_environment(stream,        :verbose => true)
+      write_gemfile_lock(stream,        :verbose => true)
+      write_load_paths(stream,        :verbose => true)
     end
 
   protected
@@ -238,7 +238,7 @@ module Nanoc::CLI
         # Build message
         if gem_name
           if self.using_bundler?
-            "Make sure the gem is added to Gemfile and run `bundle install`."
+            'Make sure the gem is added to Gemfile and run `bundle install`.'
           else
             "Install the '#{gem_name}' gem using `gem install #{gem_name}`."
           end
@@ -258,7 +258,7 @@ module Nanoc::CLI
       defined?(Bundler) && Bundler::SharedHelpers.in_bundle?
     end
 
-    def write_section_header(stream, title, params={})
+    def write_section_header(stream, title, params = {})
       stream.puts
       if params[:verbose]
         stream.puts '===== ' + title.upcase + ':'
@@ -268,21 +268,21 @@ module Nanoc::CLI
       stream.puts
     end
 
-    def write_error_message(stream, error, params={})
-      self.write_section_header(stream, 'Message', params)
+    def write_error_message(stream, error, params = {})
+      write_section_header(stream, 'Message', params)
 
       stream.puts "#{error.class}: #{error.message}"
-      resolution = self.resolution_for(error)
+      resolution = resolution_for(error)
       stream.puts "#{resolution}" if resolution
     end
 
-    def write_compilation_stack(stream, error, params={})
-      self.write_section_header(stream, 'Compilation stack', params)
+    def write_compilation_stack(stream, error, params = {})
+      write_section_header(stream, 'Compilation stack', params)
 
-      if self.stack.empty?
-        stream.puts "  (empty)"
+      if stack.empty?
+        stream.puts '  (empty)'
       else
-        self.stack.reverse.each do |obj|
+        stack.reverse.each do |obj|
           if obj.is_a?(Nanoc::ItemRep)
             stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
           else # layout
@@ -292,63 +292,63 @@ module Nanoc::CLI
       end
     end
 
-    def write_stack_trace(stream, error, params={})
-      self.write_section_header(stream, 'Stack trace', params)
+    def write_stack_trace(stream, error, params = {})
+      is_verbose = params.fetch(:verbose, false)
 
-      count = params[:verbose] ? -1 : 10
+      write_section_header(stream, 'Stack trace', params)
+
+      count = is_verbose ? -1 : 10
       error.backtrace[0...count].each_with_index do |item, index|
         stream.puts "  #{index}. #{item}"
       end
-      if error.backtrace.size > count
+      if !is_verbose && error.backtrace.size > count
         stream.puts "  ... #{error.backtrace.size - count} more lines omitted. See full crash log for details."
       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 <-"
+      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 <-'
       stream.puts
-      stream.puts "A detailed crash log has been written to ./crash.log."
+      stream.puts 'A detailed crash log has been written to ./crash.log.'
     end
 
-    def write_version_information(stream, params={})
-      self.write_section_header(stream, 'Version information', params)
+    def write_version_information(stream, params = {})
+      write_section_header(stream, 'Version information', params)
       stream.puts Nanoc.version_information
     end
 
-    def write_system_information(stream, params={})
-      begin
-        uname = `uname -a`
-        self.write_section_header(stream, 'System information', params)
-        stream.puts uname
-      rescue Errno::ENOENT
-      end
+    def write_system_information(stream, params = {})
+      uname = `uname -a`
+      write_section_header(stream, 'System information', params)
+      stream.puts uname
+    rescue Errno::ENOENT
     end
 
-    def write_installed_gems(stream, params={})
-      self.write_section_header(stream, 'Installed gems', params)
-      self.gems_and_versions.each do |g|
+    def write_installed_gems(stream, params = {})
+      write_section_header(stream, 'Installed gems', params)
+      gems_and_versions.each do |g|
         stream.puts "  #{g.first} #{g.last.join(', ')}"
       end
     end
 
-    def write_environment(stream, params={})
-      self.write_section_header(stream, 'Environment', params)
+    def write_environment(stream, params = {})
+      write_section_header(stream, 'Environment', params)
       ENV.sort.each do |e|
         stream.puts "#{e.first} => #{e.last.inspect}"
       end
     end
 
-    def write_gemfile_lock(stream, params={})
+    def write_gemfile_lock(stream, params = {})
       if File.exist?('Gemfile.lock')
-        self.write_section_header(stream, 'Gemfile.lock', params)
+        write_section_header(stream, 'Gemfile.lock', params)
         stream.puts File.read('Gemfile.lock')
       end
     end
 
-    def write_load_paths(stream, params={})
-      self.write_section_header(stream, 'Load paths', params)
+    def write_load_paths(stream, params = {})
+      write_section_header(stream, 'Load paths', params)
       $LOAD_PATH.each_with_index do |i, index|
         stream.puts "  #{index}. #{i}"
       end

data/lib/nanoc/cli/logger.rb

@@ -13,8 +13,8 @@ module Nanoc::CLI
     ACTION_COLORS = {
       :create         => "\e[32m", # green
       :update         => "\e[33m", # yellow
-      :identical      => "",       # (nothing)
-      :skip           => "",       # (nothing)
+      :identical      => '',       # (nothing)
+      :skip           => '',       # (nothing)
       :delete         => "\e[31m"  # red
     }
 
@@ -40,14 +40,14 @@ module Nanoc::CLI
     # @param [String] name The name of the file the action was performed on
     #
     # @return [void]
-    def file(level, action, name, duration=nil)
+    def file(level, action, name, duration = nil)
       log(
         level,
         '%s%12s%s  %s%s' % [
           ACTION_COLORS[action.to_sym],
           action,
           "\e[0m",
-          duration.nil? ? '' : "[%2.2fs]  " % [ duration ],
+          duration.nil? ? '' : '[%2.2fs]  ' % [ duration ],
           name
         ]
       )
@@ -62,12 +62,12 @@ module Nanoc::CLI
     # @param [#puts] io The stream to which the message should be written
     #
     # @return [void]
-    def log(level, message, io=$stdout)
+    def log(level, message, io = $stdout)
       # Don't log when logging is disabled
       return if @level == :off
 
       # Log when level permits it
-      io.puts(message) if (@level == :low or @level == level)
+      io.puts(message) if @level == :low || @level == level
     end
 
   end

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

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

data/lib/nanoc/cli/stream_cleaners.rb

@@ -11,4 +11,3 @@ module Nanoc::CLI
   end
 
 end
-