nanoc 3.6.7 → 3.6.8

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

@@ -33,7 +33,7 @@ module Nanoc::CLI::Commands
     # @abstract Subclasses must override {#start} and may override {#stop}.
     class Listener
 
-      def initialize(params={})
+      def initialize(params = {})
       end
 
       # @param [Nanoc::CLI::CommandRunner] command_runner The command runner for this listener
@@ -51,7 +51,7 @@ module Nanoc::CLI::Commands
       #
       # @abstract
       def start
-        raise NotImplementedError, "Subclasses of Listener should implement #start"
+        raise NotImplementedError, 'Subclasses of Listener should implement #start'
       end
 
       # Stops the listener. The default implementation removes self from all notification center observers.
@@ -73,7 +73,7 @@ module Nanoc::CLI::Commands
       # @see Listener#start
       def start
         require 'tempfile'
-        self.setup_diffs
+        setup_diffs
         old_contents = {}
         Nanoc::NotificationCenter.on(:will_write_rep) do |rep, snapshot|
           path = rep.raw_path(:snapshot => snapshot)
@@ -93,7 +93,7 @@ module Nanoc::CLI::Commands
       # @see Listener#stop
       def stop
         super
-        self.teardown_diffs
+        teardown_diffs
       end
 
     protected
@@ -161,7 +161,7 @@ module Nanoc::CLI::Commands
       end
 
       # @option params [Array<Nanoc::ItemRep>] :reps The list of item representations in the site
-      def initialize(params={})
+      def initialize(params = {})
         @times = {}
 
         @reps = params.fetch(:reps)
@@ -180,7 +180,7 @@ module Nanoc::CLI::Commands
 
       # @see Listener#stop
       def stop
-        self.print_profiling_feedback
+        print_profiling_feedback
         super
       end
 
@@ -194,8 +194,8 @@ module Nanoc::CLI::Commands
         # Print warning if necessary
         if @reps.any? { |r| !r.compiled? }
           $stderr.puts
-          $stderr.puts "Warning: profiling information may not be accurate because " +
-                       "some items were not compiled."
+          $stderr.puts 'Warning: profiling information may not be accurate because ' +
+                       'some items were not compiled.'
         end
 
         # Print header
@@ -204,7 +204,7 @@ module Nanoc::CLI::Commands
         puts '-' * max_filter_name_length + '-+-----------------------------------'
 
         durations_per_filter.to_a.sort_by { |r| r[1] }.each do |row|
-          self.print_row(row, max_filter_name_length)
+          print_row(row, max_filter_name_length)
         end
       end
 
@@ -215,8 +215,8 @@ module Nanoc::CLI::Commands
         # Calculate stats
         count = samples.size
         min   = samples.min
-        tot   = samples.inject(0) { |memo, i| memo + i }
-        avg   = tot/count
+        tot   = samples.reduce(0) { |memo, i| memo + i }
+        avg   = tot / count
         max   = samples.max
 
         # Format stats
@@ -234,7 +234,8 @@ module Nanoc::CLI::Commands
       def durations_per_filter
         @_durations_per_filter ||= begin
           @times.keys.each_with_object({}) do |filter_name, result|
-            if durations = durations_for_filter(filter_name)
+            durations = durations_for_filter(filter_name)
+            if durations
               result[filter_name] = durations
             end
           end
@@ -256,10 +257,10 @@ module Nanoc::CLI::Commands
 
       # @see Listener#enable_for?
       def self.enable_for?(command_runner)
-        ! ENV.has_key?('TRAVIS')
+        !ENV.key?('TRAVIS')
       end
 
-      def initialize(params={})
+      def initialize(params = {})
         @gc_count = 0
       end
 
@@ -329,9 +330,8 @@ module Nanoc::CLI::Commands
     class FileActionPrinter < Listener
 
       # @option params [Array<Nanoc::ItemRep>] :reps The list of item representations in the site
-      def initialize(params={})
+      def initialize(params = {})
         @start_times = {}
-        @stop_times  = {}
 
         @reps = params.fetch(:reps)
       end
@@ -341,13 +341,21 @@ module Nanoc::CLI::Commands
         Nanoc::NotificationCenter.on(:compilation_started) do |rep|
           @start_times[rep.raw_path] = Time.now
         end
-        Nanoc::NotificationCenter.on(:compilation_ended) do |rep|
-          @stop_times[rep.raw_path] = Time.now
-        end
         Nanoc::NotificationCenter.on(:rep_written) do |rep, path, is_created, is_modified|
-          action = (is_created ? :create : (is_modified ? :update : :identical))
-          level  = (is_created ? :high   : (is_modified ? :high   : :low))
-          log(level, action, path, duration_for(rep))
+          duration = path && @start_times[path] ? Time.now - @start_times[path] : nil
+          action =
+            case
+            when is_created  then :create
+            when is_modified then :update
+            else :identical
+            end
+          level =
+            case
+            when is_created  then :high
+            when is_modified then :high
+            else :low
+            end
+          log(level, action, path, duration)
         end
       end
 
@@ -356,22 +364,12 @@ module Nanoc::CLI::Commands
         super
         @reps.select { |r| !r.compiled? }.each do |rep|
           rep.raw_paths.each do |snapshot_name, raw_path|
-            log(:low, :skip, raw_path, duration_for(rep))
+            log(:low, :skip, raw_path, nil)
           end
         end
       end
 
-      private
-
-      def duration_for(rep)
-        return nil if rep.raw_path.nil?
-
-        start = @start_times[rep.raw_path]
-        stop  = @stop_times[rep.raw_path]
-        return nil if start.nil? || stop.nil?
-
-        stop - start
-      end
+    private
 
       def log(level, action, path, duration)
         Nanoc::CLI::Logger.instance.file(level, action, path, duration)
@@ -379,21 +377,21 @@ module Nanoc::CLI::Commands
 
     end
 
-    def initialize(options, arguments, command, params={})
+    def initialize(options, arguments, command, params = {})
       super(options, arguments, command)
-      @listener_classes = params.fetch(:listener_classes, self.default_listener_classes)
+      @listener_classes = params.fetch(:listener_classes, default_listener_classes)
     end
 
     def run
       time_before = Time.now
 
-      self.load_site
-      self.check_for_deprecated_usage
+      load_site
+      check_for_deprecated_usage
 
-      puts "Compiling site…"
-      self.run_listeners_while do
-        self.site.compile
-        self.prune
+      puts 'Compiling site…'
+      run_listeners_while do
+        site.compile
+        prune
       end
 
       time_after = Time.now
@@ -404,8 +402,8 @@ module Nanoc::CLI::Commands
   protected
 
     def prune
-      if self.site.config[:prune][:auto_prune]
-        Nanoc::Extra::Pruner.new(self.site, :exclude => self.prune_config_exclude).run
+      if site.config[:prune][:auto_prune]
+        Nanoc::Extra::Pruner.new(site, :exclude => prune_config_exclude).run
       end
     end
 
@@ -422,7 +420,7 @@ module Nanoc::CLI::Commands
     def setup_listeners
       @listeners = @listener_classes.
         select { |klass| klass.enable_for?(self) }.
-        map    { |klass| klass.new(:reps => self.reps) }
+        map    { |klass| klass.new(:reps => reps) }
 
       @listeners.each { |s| s.start }
     end
@@ -432,10 +430,10 @@ module Nanoc::CLI::Commands
     end
 
     def run_listeners_while
-      self.setup_listeners
+      setup_listeners
       yield
     ensure
-      self.teardown_listeners
+      teardown_listeners
     end
 
     def teardown_listeners
@@ -443,14 +441,14 @@ module Nanoc::CLI::Commands
     end
 
     def reps
-      self.site.items.map { |i| i.reps }.flatten
+      site.items.map { |i| i.reps }.flatten
     end
     memoize :reps
 
     def check_for_deprecated_usage
       # Check presence of --all option
-      if options.has_key?(:all) || options.has_key?(:force)
-        $stderr.puts "Warning: the --force option (and its deprecated --all alias) are, as of nanoc 3.2, no longer supported and have no effect."
+      if options.key?(:all) || options.key?(:force)
+        $stderr.puts 'Warning: the --force option (and its deprecated --all alias) are, as of nanoc 3.2, no longer supported and have no effect.'
       end
 
       # Warn if trying to compile a single item
@@ -462,11 +460,11 @@ module Nanoc::CLI::Commands
     end
 
     def prune_config
-      self.site.config[:prune] || {}
+      site.config[:prune] || {}
     end
 
     def prune_config_exclude
-      self.prune_config[:exclude] || {}
+      prune_config[:exclude] || {}
     end
 
   end

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

@@ -24,16 +24,16 @@ module Nanoc::CLI::Commands
       identifier = arguments[0].cleaned_identifier
 
       # 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 whether item is unique
-      if !self.site.items.find { |i| i.identifier == identifier }.nil?
+      if !site.items.find { |i| i.identifier == identifier }.nil?
         raise Nanoc::Errors::GenericTrivial,
           "An item already exists at #{identifier}. Please " +
-          "pick a unique name for the item you are creating."
+          'pick a unique name for the item you are creating.'
       end
 
       # Setup notifications
@@ -42,10 +42,10 @@ module Nanoc::CLI::Commands
       end
 
       # Create item
-      data_source = self.site.data_sources[0]
+      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
       )
 

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

@@ -22,23 +22,23 @@ module Nanoc::CLI::Commands
       identifier = arguments[0].cleaned_identifier
 
       # 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 whether layout is unique
-      if !self.site.layouts.find { |l| l.identifier == identifier }.nil?
+      if !site.layouts.find { |l| l.identifier == identifier }.nil?
         raise Nanoc::Errors::GenericTrivial,
           "A layout already exists at #{identifier}. Please " +
-          "pick a unique name for the layout you are creating."
+          'pick a unique name for the layout you are creating.'
       end
 
       # Check whether layout is not at /
       if identifier == '/'
         raise Nanoc::Errors::GenericTrivial,
           "There cannot be a layout with the identifier '/'; " +
-          "please pick a different identifier for this layout."
+          'please pick a different identifier for this layout.'
       end
 
       # Setup notifications
@@ -47,7 +47,7 @@ module Nanoc::CLI::Commands
       end
 
       # Create layout
-      data_source = self.site.data_sources[0]
+      data_source = site.data_sources[0]
       data_source.create_layout(
         "<html>\n" +
         "  <head>\n" +

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

@@ -3,9 +3,9 @@
 usage       'create-site [options] path'
 aliases     :create_site, :cs
 summary     'create a site'
-description <<-EOS
+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.
-EOS
+"
 
 required :d, :datasource, 'specify the data source for the new site'
 
@@ -102,12 +102,10 @@ EOS
 #   item, use the pattern “/about/*/”; “/about/*” will also select the parent,
 #   because “*” matches zero or more characters.
 
-compile '/stylesheet/' do
-  # don’t filter or layout
-end
-
 compile '*' do
-  if item.binary?
+  if item[:extension] == 'css'
+    # don’t filter stylesheets
+  elsif item.binary?
     # don’t filter binary items
   else
     filter :erb
@@ -115,12 +113,11 @@ compile '*' do
   end
 end
 
-route '/stylesheet/' do
-  '/style.css'
-end
-
 route '*' do
-  if item.binary?
+  if item[:extension] == 'css'
+    # Write item with identifier /foo/ to /foo.css
+    item.identifier.chop + '.css'
+  elsif item.binary?
     # Write item with identifier /foo/ to /foo.ext
     item.identifier.chop + '.' + item[:extension]
   else
@@ -358,7 +355,7 @@ EOS
       # Create home page
       data_source.create_item(
         DEFAULT_ITEM,
-        { :title => "Home" },
+        { :title => 'Home' },
         '/'
       )
 

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

@@ -2,9 +2,9 @@
 
 usage       'deploy [options]'
 summary     'deploy the compiled site'
-description <<-EOS
+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.
-EOS
+"
 
 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'
@@ -17,13 +17,13 @@ module Nanoc::CLI::Commands
   class Deploy < ::Nanoc::CLI::CommandRunner
 
     def run
-      self.load_site
+      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 }
-        puts "Available deployers:"
+        puts 'Available deployers:'
         deployer_names.each do |name|
           puts "  #{name}"
         end
@@ -35,9 +35,9 @@ module Nanoc::CLI::Commands
 
       if options[:list]
         if deploy_configs.empty?
-          puts  "No deployment configurations."
+          puts  'No deployment configurations.'
         else
-          puts "Available deployment configurations:"
+          puts 'Available deployment configurations:'
           deploy_configs.keys.each do |name|
             puts "  #{name}"
           end
@@ -47,7 +47,7 @@ module Nanoc::CLI::Commands
 
       # Can't proceed further without a deploy config
       if deploy_configs.empty?
-        raise Nanoc::Errors::GenericTrivial, "The site has no deployment configurations."
+        raise Nanoc::Errors::GenericTrivial, 'The site has no deployment configurations.'
       end
 
       # Get target
@@ -59,7 +59,7 @@ module Nanoc::CLI::Commands
       # Get deployer
       names = Nanoc::Extra::Deployer.all.keys
       name = config.fetch(:kind) do
-        $stderr.puts "Warning: The specified deploy target does not have a kind attribute. Assuming rsync."
+        $stderr.puts 'Warning: The specified deploy target does not have a kind attribute. Assuming rsync.'
         'rsync'
       end
       deployer_class = Nanoc::Extra::Deployer.named(name)
@@ -71,13 +71,13 @@ module Nanoc::CLI::Commands
       unless options[:'no-check']
         runner = Nanoc::Extra::Checking::Runner.new(site)
         if runner.has_dsl?
-          puts "Running issue checks…"
+          puts 'Running issue checks…'
           ok = runner.run_for_deploy
           if !ok
-            puts "Issues found, deploy aborted."
+            puts 'Issues found, deploy aborted.'
             return
           end
-          puts "No issues found. Deploying!"
+          puts 'No issues found. Deploying!'
         end
       end
 

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

@@ -19,16 +19,16 @@ module Nanoc::CLI::Commands
   class Prune < ::Nanoc::CLI::CommandRunner
 
     def run
-      self.load_site
+      load_site
 
-      if options.has_key?(:yes)
-        Nanoc::Extra::Pruner.new(self.site, :exclude => self.prune_config_exclude).run
-      elsif options.has_key?(:'dry-run')
-        Nanoc::Extra::Pruner.new(self.site, :exclude => self.prune_config_exclude, :dry_run => true).run
+      if options.key?(:yes)
+        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
       else
-        $stderr.puts "WARNING: Since the prune command is a destructive command, it requires an additional --yes flag in order to work."
+        $stderr.puts 'WARNING: Since the prune command is a destructive command, it requires an additional --yes flag in order to work.'
         $stderr.puts
-        $stderr.puts "Please ensure that the output directory does not contain any files (such as images or stylesheets) that are necessary but are not managed by nanoc. If you want to get a list of all files that would be removed, pass --dry-run."
+        $stderr.puts 'Please ensure that the output directory does not contain any files (such as images or stylesheets) that are necessary but are not managed by nanoc. If you want to get a list of all files that would be removed, pass --dry-run.'
         exit 1
       end
     end
@@ -36,13 +36,13 @@ module Nanoc::CLI::Commands
   protected
 
     def prune_config
-      self.site.config[:prune] || {}
+      site.config[:prune] || {}
     end
 
     def prune_config_exclude
-      self.prune_config[:exclude] || {}
+      prune_config[:exclude] || {}
     end
-    
+
   end
 
 end

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

@@ -3,9 +3,9 @@
 usage       'shell'
 summary     'open a shell on the nanoc environment'
 aliases     'console'
-description <<-EOS
+description "
 Open an IRB shell on a context that contains @items, @layouts, @config and @site.
-EOS
+"
 
 module Nanoc::CLI::Commands
 
@@ -14,7 +14,7 @@ module Nanoc::CLI::Commands
     def run
       require 'pry'
 
-      self.require_site
+      require_site
 
       Nanoc::Context.new(env).pry
     end
@@ -23,10 +23,10 @@ module Nanoc::CLI::Commands
 
     def env
       {
-        :site    => self.site,
-        :items   => self.site.items,
-        :layouts => self.site.layouts,
-        :config  => self.site.config
+        :site    => site,
+        :items   => site.items,
+        :layouts => site.layouts,
+        :config  => site.config
       }
     end
 

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

@@ -13,23 +13,22 @@ module Nanoc::CLI::Commands
   class ShowData < ::Nanoc::CLI::CommandRunner
 
     def run
-      self.load_site
+      load_site
 
       # Get data
-      items     = self.site.items
-      item_reps = items.map { |i| i.reps }.flatten
-      layouts   = self.site.layouts
+      items   = site.items
+      layouts = site.layouts
 
       # Get dependency tracker
-      compiler = self.site.compiler
+      compiler = site.compiler
       compiler.load
       dependency_tracker = compiler.dependency_tracker
 
       # Print data
-      self.print_item_dependencies(items, dependency_tracker)
-      self.print_item_rep_paths(items)
-      self.print_item_rep_outdatedness(items, compiler)
-      self.print_layouts(layouts, compiler)
+      print_item_dependencies(items, dependency_tracker)
+      print_item_rep_paths(items)
+      print_item_rep_outdatedness(items, compiler)
+      print_layouts(layouts, compiler)
     end
 
   protected
@@ -54,7 +53,7 @@ module Nanoc::CLI::Commands
 
     def print_header(title)
       header = '=' * 78
-      header[3..(title.length+5)] = " #{title} "
+      header[3..(title.length + 5)] = " #{title} "
 
       puts
       puts header
@@ -62,9 +61,9 @@ module Nanoc::CLI::Commands
     end
 
     def print_item_dependencies(items, dependency_tracker)
-      self.print_header('Item dependencies')
+      print_header('Item dependencies')
 
-      self.sorted_with_prev(items) do |item, prev|
+      sorted_with_prev(items) do |item, prev|
         puts if prev
         puts "item #{item.identifier} depends on:"
         predecessors = dependency_tracker.objects_causing_outdatedness_of(item).sort_by { |i| i ? i.identifier : '' }
@@ -72,21 +71,21 @@ module Nanoc::CLI::Commands
           if pred
             puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
           else
-            puts "  ( removed item )"
+            puts '  ( removed item )'
           end
         end
-        puts "  (nothing)" if predecessors.empty?
+        puts '  (nothing)' if predecessors.empty?
       end
     end
 
     def print_item_rep_paths(items)
-      self.print_header('Item representation paths')
+      print_header('Item representation paths')
 
-      self.sorted_reps_with_prev(items) do |rep, prev|
+      sorted_reps_with_prev(items) do |rep, prev|
         puts if prev
         puts "item #{rep.item.identifier}, rep #{rep.name}:"
         if rep.raw_paths.empty?
-          puts "  (not written)"
+          puts '  (not written)'
         end
         length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
         rep.raw_paths.each do |snapshot_name, raw_path|
@@ -96,31 +95,31 @@ module Nanoc::CLI::Commands
     end
 
     def print_item_rep_outdatedness(items, compiler)
-      self.print_header('Item representation outdatedness')
+      print_header('Item representation outdatedness')
 
-      self.sorted_reps_with_prev(items) do |rep, prev|
+      sorted_reps_with_prev(items) do |rep, prev|
         puts if prev
         puts "item #{rep.item.identifier}, rep #{rep.name}:"
         outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(rep)
         if outdatedness_reason
           puts "  is outdated: #{outdatedness_reason.message}"
         else
-          puts "  is not outdated"
+          puts '  is not outdated'
         end
       end
     end
 
     def print_layouts(layouts, compiler)
-      self.print_header('Layouts')
+      print_header('Layouts')
 
-      self.sorted_with_prev(layouts) do |layout, prev|
+      sorted_with_prev(layouts) do |layout, prev|
         puts if prev
         puts "layout #{layout.identifier}:"
         outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(layout)
         if outdatedness_reason
           puts "  is outdated: #{outdatedness_reason.message}"
         else
-          puts "  is not outdated"
+          puts '  is not outdated'
         end
         puts
       end

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

@@ -20,7 +20,7 @@ module Nanoc::CLI::Commands
 
       # Get list of plugins (before and after)
       plugins_before = Nanoc::Plugin.all
-      self.site.code_snippets if self.site
+      site.code_snippets if site
       plugins_after  = Nanoc::Plugin.all
 
       # Divide list of plugins into builtin and custom
@@ -28,7 +28,7 @@ module Nanoc::CLI::Commands
       plugins_custom  = plugins_after - plugins_before
 
       # Find max identifiers length
-      plugin_with_longest_identifiers = plugins_after.inject do |longest, current|
+      plugin_with_longest_identifiers = plugins_after.reduce do |longest, current|
         longest[:identifiers].join(', ').size > current[:identifiers].join(', ').size ? longest : current
       end
       max_identifiers_length = plugin_with_longest_identifiers[:identifiers].join(', ').size
@@ -52,7 +52,7 @@ module Nanoc::CLI::Commands
           # Print type
           puts "  #{type}:"
           if relevant_plugins.empty?
-            puts "    (none)"
+            puts '    (none)'
             next
           end