nanoc 3.7.3 → 3.7.4

data/lib/nanoc/base/source_data/item_array.rb

@@ -48,7 +48,7 @@ module Nanoc
       end
     end
 
-  protected
+    protected
 
     def item_with_identifier(identifier)
       if self.frozen?

data/lib/nanoc/base/source_data/layout.rb

@@ -78,7 +78,7 @@ module Nanoc
     #
     # @return [Object] An unique reference to this object
     def reference
-      [ type, identifier ]
+      [type, identifier]
     end
 
     def inspect

data/lib/nanoc/base/source_data/site.rb

@@ -35,10 +35,10 @@ module Nanoc
       :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim ).sort,
       :lib_dirs           => %w( lib ),
       :output_dir         => 'output',
-      :data_sources       => [ {} ],
-      :index_filenames    => [ 'index.html' ],
+      :data_sources       => [{}],
+      :index_filenames    => ['index.html'],
       :enable_output_diff => false,
-      :prune              => { :auto_prune => false, :exclude => [ '.git', '.hg', '.svn', 'CVS' ] }
+      :prune              => { :auto_prune => false, :exclude => ['.git', '.hg', '.svn', 'CVS'] }
     }
 
     # Creates a site object for the site specified by the given
@@ -189,14 +189,14 @@ module Nanoc
 
       @items.each do |item|
         parent_id_end = item.identifier.rindex('/', -2)
-        if parent_id_end
-          parent_id = item.identifier[0..parent_id_end]
-          parent = item_map[parent_id]
-          if parent
-            item.parent = parent
-            parent.children << item
-          end
-        end
+        next unless parent_id_end
+
+        parent_id = item.identifier[0..parent_id_end]
+        parent = item_map[parent_id]
+        next unless parent
+
+        item.parent = parent
+        parent.children << item
       end
     end
 
@@ -224,7 +224,7 @@ module Nanoc
 
     # @deprecated It is no longer necessary to explicitly load site data. It
     #   is safe to remove all {#load_data} calls.
-    def load_data(force = false)
+    def load_data(_force = false)
       warn 'It is no longer necessary to call Nanoc::Site#load_data. This method no longer has any effect. All calls to this method can be safely removed.'
     end
 
@@ -240,10 +240,10 @@ module Nanoc
 
       # Load all data
       load_code_snippets
-      data_sources.each { |ds| ds.use }
-      load_items
-      load_layouts
-      data_sources.each { |ds| ds.unuse }
+      with_datasources do
+        load_items
+        load_layouts
+      end
       setup_child_parent_links
 
       # Ensure unique
@@ -297,7 +297,16 @@ module Nanoc
       filenames.find { |f| File.file?(f) }
     end
 
-  private
+    private
+
+    # Executes the given block, making sure that the datasources are
+    # available for the duration of the block
+    def with_datasources(&block)
+      data_sources.each { |ds| ds.use }
+      yield
+    ensure
+      data_sources.each { |ds| ds.unuse }
+    end
 
     # Loads this site’s code and executes it.
     def load_code_snippets
@@ -365,7 +374,7 @@ module Nanoc
       if parent_config_file
         config.delete(:parent_config_file)
         config_path = File.absolute_path(parent_config_file, File.dirname(config_paths.last))
-        if !File.file?(config_path)
+        unless File.file?(config_path)
           raise Nanoc::Errors::GenericTrivial, "Could not find parent configuration file '#{parent_config_file}'"
         end
         if config_paths.include?(config_path)

data/lib/nanoc/base/store.rb

@@ -52,7 +52,7 @@ module Nanoc
     # @abstract This method must be implemented by the subclass.
     #
     # @return [void]
-    def data=(new_data)
+    def data=(_new_data)
       raise NotImplementedError.new('Nanoc::Store subclasses must implement #data and #data=')
     end
 
@@ -67,7 +67,7 @@ module Nanoc
       end
 
       # Check file existance
-      if !File.file?(filename)
+      unless File.file?(filename)
         no_data_found
         @loaded = true
         return
@@ -129,7 +129,7 @@ module Nanoc
     def version_mismatch_detected
     end
 
-  private
+    private
 
     def pstore
       @pstore ||= PStore.new(filename)

data/lib/nanoc/base/temp_filename_factory.rb

@@ -42,13 +42,13 @@ module Nanoc
     def cleanup(prefix)
       path = File.join(@root_dir, prefix)
       if File.exist?(path)
-        FileUtils.remove_entry_secure(path)
+        FileUtils.rm_rf(path)
       end
 
       @counts.delete(prefix)
 
       if @counts.empty? && File.directory?(@root_dir)
-        FileUtils.remove_entry_secure(@root_dir)
+        FileUtils.rm_rf(@root_dir)
       end
     end
 

data/lib/nanoc/cli.rb

@@ -79,10 +79,10 @@ module Nanoc::CLI
   # @return [void]
   def self.after_setup(&block)
     # TODO decide what should happen if the CLI is already set up
-    self.add_after_setup_proc(block)
+    add_after_setup_proc(block)
   end
 
-protected
+  protected
 
   # Makes the commandline interface ready for use.
   #
@@ -177,11 +177,11 @@ protected
   def self.wrap_in_cleaning_stream(io)
     cio = ::Nanoc::CLI::CleaningStream.new(io)
 
-    if !self.enable_utf8?(io)
+    unless self.enable_utf8?(io)
       cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::UTF8)
     end
 
-    if !self.enable_ansi_colors?(io)
+    unless self.enable_ansi_colors?(io)
       cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
     end
 
@@ -198,14 +198,14 @@ protected
 
   # @return [Boolean] true if UTF-8 support is present, false if not
   def self.enable_utf8?(io)
-    return true if !io.tty?
+    return true unless io.tty?
 
     %w( LC_ALL LC_CTYPE LANG ).any? { |e| ENV[e] =~ /UTF/i }
   end
 
   # @return [Boolean] true if color support is present, false if not
   def self.enable_ansi_colors?(io)
-    if !io.tty?
+    unless io.tty?
       return false
     end
 

data/lib/nanoc/cli/cleaning_stream.rb

@@ -119,7 +119,7 @@ module Nanoc::CLI
       @stream.winsize = (arg)
     end
 
-  protected
+    protected
 
     def _nanoc_clean(s)
       @stream_cleaners.reduce(s) { |m, c| c.clean(m) }

data/lib/nanoc/cli/command_runner.rb

@@ -38,9 +38,10 @@ module Nanoc::CLI
 
     # @return [Boolean] true if the current working directory is a nanoc site
     #   directory, false otherwise
-    def is_in_site_dir?
+    def in_site_dir?
       Nanoc::Site.cwd_is_nanoc_site?
     end
+    alias_method :is_in_site_dir?, :in_site_dir?
 
     # Asserts that the current working directory contains a site
     # ({Nanoc::Site} instance). If no site is present, prints an error
@@ -71,7 +72,7 @@ module Nanoc::CLI
       Nanoc::CLI.debug?
     end
 
-  protected
+    protected
 
     # Sets the data source's VCS to the VCS with the given name. Does nothing
     # when the site's data source does not support VCSes (i.e. does not
@@ -92,7 +93,7 @@ module Nanoc::CLI
 
       site.data_sources.each do |data_source|
         # Skip if not possible
-        next if !data_source.respond_to?(:vcs=)
+        next unless data_source.respond_to?(:vcs=)
 
         # Set VCS
         data_source.vcs = vcs_class.new

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

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-usage       'autocompile [options]'
-summary     'start the autocompiler'
+usage 'autocompile [options]'
+summary 'start the autocompiler'
 be_hidden
-aliases     :aco
+aliases :aco
 description <<-EOS
 Start the autocompiler web server. Unless overridden with commandline options
 or configuration entries, the web server will run on port 3000 and listen on all

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'check [options] [names]'
-summary     'run issue checks'
+usage 'check [options] [names]'
+summary 'run issue checks'
 description "
 Run issue checks on the current site. If the `--all` option is passed, all available issue checks will be run. If the `--deploy` option is passed, the issue checks marked for deployment will be run.
 "
@@ -39,7 +39,7 @@ module Nanoc::CLI::Commands
       end
     end
 
-  protected
+    protected
 
     def validate_options_and_arguments
       if arguments.empty? && !options[:all] && !options[:deploy] && !options[:list]

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'compile [options]'
-summary     'compile items of this site'
+usage 'compile [options]'
+summary 'compile items of this site'
 description <<-EOS
 Compile all items of the current site.
 
@@ -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
@@ -41,7 +41,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)
         true
       end
 
@@ -79,8 +79,8 @@ module Nanoc::CLI::Commands
           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|
-          if !rep.binary?
+        Nanoc::NotificationCenter.on(:rep_written) do |rep, path, _is_created, _is_modified|
+          unless rep.binary?
             new_contents = File.file?(path) ? File.read(path) : nil
             if old_contents[rep] && new_contents
               generate_diff_for(rep, old_contents[rep], new_contents)
@@ -96,7 +96,7 @@ module Nanoc::CLI::Commands
         teardown_diffs
       end
 
-    protected
+      protected
 
       def setup_diffs
         @diff_lock    = Mutex.new
@@ -137,8 +137,8 @@ module Nanoc::CLI::Commands
             new_file.flush
 
             # Diff
-            cmd = [ 'diff', '-u', old_file.path, new_file.path ]
-            Open3.popen3(*cmd) do |stdin, stdout, stderr|
+            cmd = ['diff', '-u', old_file.path, new_file.path]
+            Open3.popen3(*cmd) do |_stdin, stdout, _stderr|
               result = stdout.read
               return (result == '' ? nil : result)
             end
@@ -169,11 +169,11 @@ module Nanoc::CLI::Commands
 
       # @see Listener#start
       def start
-        Nanoc::NotificationCenter.on(:filtering_started) do |rep, filter_name|
+        Nanoc::NotificationCenter.on(:filtering_started) do |_rep, filter_name|
           @times[filter_name] ||= []
           @times[filter_name] << { :start => Time.now }
         end
-        Nanoc::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
+        Nanoc::NotificationCenter.on(:filtering_ended) do |_rep, filter_name|
           @times[filter_name].last[:stop] = Time.now
         end
       end
@@ -184,7 +184,7 @@ module Nanoc::CLI::Commands
         super
       end
 
-    protected
+      protected
 
       def print_profiling_feedback
         # Get max filter length
@@ -194,7 +194,7 @@ 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 ' +
+          $stderr.puts 'Warning: profiling information may not be accurate because ' \
                        'some items were not compiled.'
         end
 
@@ -260,17 +260,17 @@ module Nanoc::CLI::Commands
     class GCController < Listener
 
       # @see Listener#enable_for?
-      def self.enable_for?(command_runner)
+      def self.enable_for?(_command_runner)
         !ENV.key?('TRAVIS')
       end
 
-      def initialize(params = {})
+      def initialize(_params = {})
         @gc_count = 0
       end
 
       # @see Listener#start
       def start
-        Nanoc::NotificationCenter.on(:compilation_started) do |rep|
+        Nanoc::NotificationCenter.on(:compilation_started) do |_rep|
           if @gc_count % 20 == 0
             GC.enable
             GC.start
@@ -345,7 +345,7 @@ module Nanoc::CLI::Commands
         Nanoc::NotificationCenter.on(:compilation_started) do |rep|
           @start_times[rep.raw_path] = Time.now
         end
-        Nanoc::NotificationCenter.on(:rep_written) do |rep, path, is_created, is_modified|
+        Nanoc::NotificationCenter.on(:rep_written) do |_rep, path, is_created, is_modified|
           duration = path && @start_times[path] ? Time.now - @start_times[path] : nil
           action =
             case
@@ -367,13 +367,13 @@ module Nanoc::CLI::Commands
       def stop
         super
         @reps.select { |r| !r.compiled? }.each do |rep|
-          rep.raw_paths.each do |snapshot_name, raw_path|
+          rep.raw_paths.each do |_snapshot_name, raw_path|
             log(:low, :skip, raw_path, nil)
           end
         end
       end
 
-    private
+      private
 
       def log(level, action, path, duration)
         Nanoc::CLI::Logger.instance.file(level, action, path, duration)
@@ -403,7 +403,7 @@ module Nanoc::CLI::Commands
       puts "Site compiled in #{format('%.2f', time_after - time_before)}s."
     end
 
-  protected
+    protected
 
     def prune
       if site.config[:prune][:auto_prune]
@@ -422,9 +422,9 @@ module Nanoc::CLI::Commands
     end
 
     def setup_listeners
-      @listeners = @listener_classes.
-        select { |klass| klass.enable_for?(self) }.
-        map    { |klass| klass.new(:reps => reps) }
+      @listeners = @listener_classes
+        .select { |klass| klass.enable_for?(self) }
+        .map    { |klass| klass.new(:reps => reps) }
 
       @listeners.each { |s| s.start }
     end

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

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'create-item [options] identifier'
-aliases     :create_item, :ci
-summary     'create an item'
+usage 'create-item [options] identifier'
+aliases :create_item, :ci
+summary 'create an item'
 description <<-EOS
 Create a new item in the current site. The first data source in the site
 configuration will be used.
@@ -30,9 +30,9 @@ module Nanoc::CLI::Commands
       set_vcs(options[:vcs])
 
       # Check whether item is unique
-      if !site.items.find { |i| i.identifier == identifier }.nil?
+      unless site.items.find { |i| i.identifier == identifier }.nil?
         raise Nanoc::Errors::GenericTrivial,
-          "An item already exists at #{identifier}. Please " +
+          "An item already exists at #{identifier}. Please " \
           'pick a unique name for the item you are creating.'
       end
 

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

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'create-layout [options] identifier'
-aliases     :create_layout, :cl
-summary     'create a layout'
+usage 'create-layout [options] identifier'
+aliases :create_layout, :cl
+summary 'create a layout'
 description <<-EOS
 Create a new layout in the current site. The first data source in the site
 configuration will be used.
@@ -28,16 +28,16 @@ module Nanoc::CLI::Commands
       set_vcs(options[:vcs])
 
       # Check whether layout is unique
-      if !site.layouts.find { |l| l.identifier == identifier }.nil?
+      unless site.layouts.find { |l| l.identifier == identifier }.nil?
         raise Nanoc::Errors::GenericTrivial,
-          "A layout already exists at #{identifier}. Please " +
+          "A layout already exists at #{identifier}. Please " \
           '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 '/'; " +
+          "There cannot be a layout with the identifier '/'; " \
           'please pick a different identifier for this layout.'
       end
 
@@ -49,14 +49,14 @@ module Nanoc::CLI::Commands
       # Create layout
       data_source = site.data_sources[0]
       data_source.create_layout(
-        "<html>\n" +
-        "  <head>\n" +
-        "    <title><%= @item[:title] %></title>\n" +
-        "  </head>\n" +
-        "  <body>\n" +
-        "    <p>Hi, I'm a new layout. Please customize me!</p>\n" +
-        "<%= yield %>\n" +
-        "  </body>\n" +
+        "<html>\n" \
+        "  <head>\n" \
+        "    <title><%= @item[:title] %></title>\n" \
+        "  </head>\n" \
+        "  <body>\n" \
+        "    <p>Hi, I'm a new layout. Please customize me!</p>\n" \
+        "<%= yield %>\n" \
+        "  </body>\n" \
         "</html>\n",
         {},
         identifier