nanoc 3.6.7 → 3.6.8

data/lib/nanoc/cli.rb

@@ -55,8 +55,8 @@ module Nanoc::CLI
   # @return [void]
   def self.run(args)
     Nanoc::CLI::ErrorHandler.handle_while do
-      self.setup
-      self.root_command.run(args)
+      setup
+      root_command.run(args)
     end
   end
 
@@ -71,7 +71,7 @@ module Nanoc::CLI
   #
   # @return [void]
   def self.add_command(cmd)
-    self.root_command.add_command(cmd)
+    root_command.add_command(cmd)
   end
 
 protected
@@ -80,9 +80,9 @@ protected
   #
   # @return [void]
   def self.setup
-    self.setup_cleaning_streams
-    self.setup_commands
-    self.load_custom_commands
+    setup_cleaning_streams
+    setup_commands
+    load_custom_commands
   end
 
   # Sets up the root command and base subcommands.
@@ -93,19 +93,19 @@ protected
     @root_command = nil
 
     # Add root command
-    filename = File.dirname(__FILE__) + "/cli/commands/nanoc.rb"
-    @root_command = self.load_command_at(filename)
+    filename = File.dirname(__FILE__) + '/cli/commands/nanoc.rb'
+    @root_command = load_command_at(filename)
 
     # Add help command
     help_cmd = Cri::Command.new_basic_help
-    self.add_command(help_cmd)
+    add_command(help_cmd)
 
     # Add other commands
     cmd_filenames = Dir[File.dirname(__FILE__) + '/cli/commands/*.rb']
-    cmd_filenames.each do |filename|
-      next if File.basename(filename, '.rb') == 'nanoc'
-      cmd = self.load_command_at(filename)
-      self.add_command(cmd)
+    cmd_filenames.each do |cmd_filename|
+      next if File.basename(cmd_filename, '.rb') == 'nanoc'
+      cmd = load_command_at(cmd_filename)
+      add_command(cmd)
     end
   end
 
@@ -113,15 +113,15 @@ protected
   #
   # @return [void]
   def self.load_custom_commands
-    self.recursive_contents_of('commands').each do |filename|
+    recursive_contents_of('commands').each do |filename|
       # Create command
       command = Nanoc::CLI.load_command_at(filename)
 
       # Get supercommand
       pieces = filename.gsub(/^commands\/|\.rb$/, '').split('/')
-      pieces = pieces[0, pieces.size-1] || []
+      pieces = pieces[0, pieces.size - 1] || []
       root = Nanoc::CLI.root_command
-      supercommand = pieces.inject(root) do |cmd, piece|
+      supercommand = pieces.reduce(root) do |cmd, piece|
         cmd.nil? ? nil : cmd.command_named(piece)
       end
 
@@ -138,7 +138,7 @@ protected
   # @param [String] filename The name of the file that contains the command
   #
   # @return [Cri::Command] The loaded command
-  def self.load_command_at(filename, command_name=nil)
+  def self.load_command_at(filename, command_name = nil)
     # Load
     code = File.read(filename)
     cmd = Cri::Command.define(code, filename)
@@ -155,7 +155,7 @@ protected
   def self.recursive_contents_of(path)
     return [] unless File.directory?(path)
     files, dirs = *Dir[path + '/*'].sort.partition { |e| File.file?(e) }
-    dirs.each { |d| files.concat self.recursive_contents_of(d) }
+    dirs.each { |d| files.concat recursive_contents_of(d) }
     files
   end
 
@@ -183,8 +183,8 @@ protected
   #
   # @return [void]
   def self.setup_cleaning_streams
-    $stdout = self.wrap_in_cleaning_stream($stdout)
-    $stderr = self.wrap_in_cleaning_stream($stderr)
+    $stdout = wrap_in_cleaning_stream($stdout)
+    $stderr = wrap_in_cleaning_stream($stderr)
   end
 
   # @return [Boolean] true if UTF-8 support is present, false if not
@@ -196,13 +196,15 @@ protected
 
   # @return [Boolean] true if color support is present, false if not
   def self.enable_ansi_colors?(io)
-    return false if !io.tty?
+    if !io.tty?
+      return false
+    end
 
     if Nanoc.on_windows?
       return defined?(::Win32::Console::ANSI)
     end
 
-    return true
+    true
   end
 
 end

data/lib/nanoc/data_sources/deprecated/delicious.rb

@@ -11,7 +11,7 @@ module Nanoc::DataSources
 
         # Get data
         @http_client ||= Nanoc::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get("http://feeds.delicious.com/v2/json/#{self.config[:username]}")
+        _status, _headers, data = *@http_client.get("http://feeds.delicious.com/v2/json/#{config[:username]}")
 
         # Parse as JSON
         raw_items = JSON.parse(data)

data/lib/nanoc/data_sources/deprecated/last_fm.rb

@@ -11,21 +11,21 @@ module Nanoc::DataSources
         require 'uri'
 
         # Check configuration
-        if self.config[:username].nil?
-          raise RuntimeError, "LastFM data source requires a username in the configuration"
+        if config[:username].nil?
+          raise 'LastFM data source requires a username in the configuration'
         end
-        if self.config[:api_key].nil?
-          raise RuntimeError, "LastFM data source requires an API key in the configuration"
+        if config[:api_key].nil?
+          raise 'LastFM data source requires an API key in the configuration'
         end
 
         # Get data
         @http_client ||= Nanoc::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get(
+        _status, _headers, data = *@http_client.get(
           'http://ws.audioscrobbler.com/2.0/' +
             '?method=user.getRecentTracks' +
             '&format=json' +
-            '&user=' + URI.escape(self.config[:username]) +
-            '&api_key=' + URI.escape(self.config[:api_key])
+            '&user=' + URI.escape(config[:username]) +
+            '&api_key=' + URI.escape(config[:api_key])
         )
 
         # Parse as JSON
@@ -35,16 +35,18 @@ module Nanoc::DataSources
         # Convert to items
         raw_items.enum_with_index.map do |raw_item, i|
           # Get artist data
-          artist_status, artist_headers, artist_data = *@http_client.get(
+          _artist_status, _artist_headers, artist_data = *@http_client.get(
             'http://ws.audioscrobbler.com/2.0/' +
               '?method=artist.getInfo' +
               '&format=json' +
               (
-                raw_item['artist']['mbid'].empty? ?
-                '&artist=' + URI.escape(raw_item['artist']['#text']) :
-                '&mbid=' + URI.escape(raw_item['artist']['mbid'])
+                if raw_item['artist']['mbid'].empty?
+                  '&artist=' + URI.escape(raw_item['artist']['#text'])
+                else
+                  '&mbid=' + URI.escape(raw_item['artist']['mbid'])
+                end
               ) +
-              '&api_key=' + URI.escape(self.config[:api_key])
+              '&api_key=' + URI.escape(config[:api_key])
           )
 
           # Parse as JSON
@@ -59,10 +61,10 @@ module Nanoc::DataSources
             track_played_at = Time.now
             now_playing = true
           else
-            played_at = Time.parse(raw_item['date']['#text'])
+            track_played_at = Time.parse(raw_item['date']['#text'])
             now_playing = false
           end
-          
+
           attributes = {
             :name      => raw_item['name'],
             :artist    => {

data/lib/nanoc/data_sources/deprecated/twitter.rb

@@ -11,7 +11,7 @@ module Nanoc::DataSources
 
         # Get data
         @http_client ||= Nanoc::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get("http://twitter.com/statuses/user_timeline/#{self.config[:username]}.json")
+        _status, _headers, data = *@http_client.get("http://twitter.com/statuses/user_timeline/#{config[:username]}.json")
 
         # Parse as JSON
         raw_items = JSON.parse(data)

data/lib/nanoc/data_sources/filesystem.rb

@@ -43,12 +43,12 @@ module Nanoc::DataSources
     end
 
     # See {Nanoc::DataSource#create_item}.
-    def create_item(content, attributes, identifier, params={})
+    def create_item(content, attributes, identifier, params = {})
       create_object('content', content, attributes, identifier, params)
     end
 
     # See {Nanoc::DataSource#create_layout}.
-    def create_layout(content, attributes, identifier, params={})
+    def create_layout(content, attributes, identifier, params = {})
       create_object('layouts', content, attributes, identifier, params)
     end
 
@@ -57,7 +57,7 @@ module Nanoc::DataSources
     # Creates a new object (item or layout) on disk in dir_name according to
     # the given identifier. The file will have its attributes taken from the
     # attributes hash argument and its content from the content argument.
-    def create_object(dir_name, content, attributes, identifier, params={})
+    def create_object(dir_name, content, attributes, identifier, params = {})
       raise NotImplementedError.new(
         "#{self.class} does not implement ##{name}"
       )
@@ -103,11 +103,11 @@ module Nanoc::DataSources
 
         # Get identifier
         if meta_filename
-          identifier = identifier_for_filename(meta_filename[(dir_name.length+1)..-1])
+          identifier = identifier_for_filename(meta_filename[(dir_name.length + 1)..-1])
         elsif content_filename
-          identifier = identifier_for_filename(content_filename[(dir_name.length+1)..-1])
+          identifier = identifier_for_filename(content_filename[(dir_name.length + 1)..-1])
         else
-          raise RuntimeError, "meta_filename and content_filename are both nil"
+          raise 'meta_filename and content_filename are both nil'
         end
 
         # Get modification times
@@ -120,7 +120,7 @@ module Nanoc::DataSources
         elsif content_mtime
           mtime = content_mtime
         else
-          raise RuntimeError, "meta_mtime and content_mtime are both nil"
+          raise 'meta_mtime and content_mtime are both nil'
         end
 
         # Create layout object
@@ -143,14 +143,10 @@ module Nanoc::DataSources
     #     'content/qux' => [ nil,    'html' ]
     #   }
     def all_split_files_in(dir_name)
-      # Get all good file names
-      filenames = self.all_files_in(dir_name)
-      filenames.reject! { |fn| fn =~ /(~|\.orig|\.rej|\.bak)$/ }
+      grouped_filenames = all_files_in(dir_name).
+        reject   { |fn| fn =~ /(~|\.orig|\.rej|\.bak)$/ }.
+        group_by { |fn| basename_of(fn) }
 
-      # Group by identifier
-      grouped_filenames = filenames.group_by { |fn| basename_of(fn) }
-
-      # Convert values into metafile/content file extension tuple
       grouped_filenames.each_pair do |key, filenames|
         # Divide
         meta_filenames    = filenames.select { |fn| ext_of(fn) == '.yaml' }
@@ -158,18 +154,17 @@ module Nanoc::DataSources
 
         # Check number of files per type
         if ![ 0, 1 ].include?(meta_filenames.size)
-          raise RuntimeError, "Found #{meta_filenames.size} meta files for #{key}; expected 0 or 1"
+          raise "Found #{meta_filenames.size} meta files for #{key}; expected 0 or 1"
         end
         if ![ 0, 1 ].include?(content_filenames.size)
-          raise RuntimeError, "Found #{content_filenames.size} content files for #{key}; expected 0 or 1"
+          raise "Found #{content_filenames.size} content files for #{key}; expected 0 or 1"
         end
 
         # Reorder elements and convert to extnames
         filenames[0] = meta_filenames[0]    ? 'yaml'                                   : nil
-        filenames[1] = content_filenames[0] ? ext_of(content_filenames[0])[1..-1] || '': nil
+        filenames[1] = content_filenames[0] ? ext_of(content_filenames[0])[1..-1] || '' : nil
       end
 
-      # Done
       grouped_filenames
     end
 
@@ -292,8 +287,15 @@ module Nanoc::DataSources
           original_encoding = data.encoding
         end
 
-        data.encode!('UTF-8') rescue raise_encoding_error(filename, original_encoding)
-        raise_encoding_error(filename, original_encoding) if !data.valid_encoding?
+        begin
+          data.encode!('UTF-8')
+        rescue
+          raise_encoding_error(filename, original_encoding)
+        end
+
+        if !data.valid_encoding?
+          raise_encoding_error(filename, original_encoding)
+        end
       end
 
       # Remove UTF-8 BOM (ugly)

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -67,11 +67,10 @@ module Nanoc::DataSources
   private
 
     # See {Nanoc::DataSources::Filesystem#create_object}.
-    def create_object(dir_name, content, attributes, identifier, params={})
+    def create_object(dir_name, content, attributes, identifier, params = {})
       # Check for periods
       if (@config.nil? || !@config[:allow_periods_in_identifiers]) && identifier.include?('.')
-        raise RuntimeError,
-          "Attempted to create an object in #{dir_name} with identifier #{identifier} containing a period, but allow_periods_in_identifiers is not enabled in the site configuration. (Enabling allow_periods_in_identifiers may cause the site to break, though.)"
+        raise "Attempted to create an object in #{dir_name} with identifier #{identifier} containing a period, but allow_periods_in_identifiers is not enabled in the site configuration. (Enabling allow_periods_in_identifiers may cause the site to break, though.)"
       end
 
       # Determine path
@@ -109,9 +108,9 @@ module Nanoc::DataSources
     # the given directory name off the filename.
     def identifier_for_filename(filename)
       if filename =~ /(^|\/)index(\.[^\/]+)?$/
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/)
+        regex = @config && @config[:allow_periods_in_identifiers] ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/
       else
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/         : /\.[^\/]+$/)
+        regex = @config && @config[:allow_periods_in_identifiers] ? /\.[^\/\.]+$/ : /\.[^\/]+$/
       end
       filename.sub(regex, '').cleaned_identifier
     end

data/lib/nanoc/data_sources/filesystem_verbose.rb

@@ -46,17 +46,16 @@ module Nanoc::DataSources
   private
 
     # See {Nanoc::DataSources::Filesystem#create_object}.
-    def create_object(dir_name, content, attributes, identifier, params={})
+    def create_object(dir_name, content, attributes, identifier, params = {})
       # Determine base path
       last_component = identifier.split('/')[-1] || dir_name
-      base_path = dir_name + identifier + last_component
 
       # Get filenames
       ext = params[:extension] || '.html'
       dir_path         = dir_name + identifier
       meta_filename    = dir_name + identifier + last_component + '.yaml'
       content_filename = dir_name + identifier + last_component + ext
-                                     
+
       # Notify
       Nanoc::NotificationCenter.post(:file_created, meta_filename)
       Nanoc::NotificationCenter.post(:file_created, content_filename)

data/lib/nanoc/data_sources/static.rb

@@ -34,13 +34,13 @@ module Nanoc::DataSources
       prefix = config[:prefix] || 'static'
 
       # Convert filenames to items
-      self.all_files_in(prefix).map do |filename|
+      all_files_in(prefix).map do |filename|
         attributes = {
           :extension => File.extname(filename)[1..-1],
           :filename  => filename,
         }
         attributes[:is_hidden] = true unless config[:hide_items] == false
-        identifier = filename[(prefix.length+1)..-1] + '/'
+        identifier = filename[(prefix.length + 1)..-1] + '/'
         mtime      = File.mtime(filename)
         checksum   = Pathname.new(filename).checksum
 

data/lib/nanoc/extra/auto_compiler.rb

@@ -25,7 +25,7 @@ module Nanoc::Extra
     end
 
     # Calls the autocompiler. The behaviour of this method is defined by the
-    # [Rack specification](http://rack.rubyforge.org/doc/files/SPEC.html).
+    # [Rack specification](http://rack.rubyforge.org/doc/SPEC.html).
     #
     # @param [Hash] env The environment, as defined by the Rack specification
     #
@@ -37,7 +37,7 @@ module Nanoc::Extra
         build_site
 
         # Find rep
-        path = Rack::Utils::unescape(env['PATH_INFO'])
+        path = Rack::Utils.unescape(env['PATH_INFO'])
         reps = site.items.map { |i| i.reps }.flatten
         rep = reps.find do |r|
           r.path == path ||
@@ -87,7 +87,7 @@ module Nanoc::Extra
 
     def mime_type_of(path, fallback)
       mime_type = MIME::Types.of(path).first
-      mime_type = mime_type.nil? ? fallback : mime_type.simplified
+      mime_type.nil? ? fallback : mime_type.simplified
     end
 
     def file_server

data/lib/nanoc/extra/checking/check.rb

@@ -15,17 +15,17 @@ module Nanoc::Extra::Checking
     end
 
     def run
-      raise NotImplementedError.new("Nanoc::Extra::Checking::Check subclasses must implement #run")
+      raise NotImplementedError.new('Nanoc::Extra::Checking::Check subclasses must implement #run')
     end
 
-    def add_issue(desc, params={})
+    def add_issue(desc, params = {})
       subject  = params.fetch(:subject, nil)
 
       @issues << Issue.new(desc, subject, self.class)
     end
 
     def output_filenames
-      Dir[@site.config[:output_dir] + '/**/*'].select{ |f| File.file?(f) }
+      Dir[@site.config[:output_dir] + '/**/*'].select { |f| File.file?(f) }
     end
 
   end

data/lib/nanoc/extra/checking/checks/css.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 module ::Nanoc::Extra::Checking::Checks
 
@@ -13,7 +13,7 @@ module ::Nanoc::Extra::Checking::Checks
         results = ::W3CValidators::CSSValidator.new.validate_file(filename)
         results.errors.each do |e|
           desc = e.message.gsub(%r{\s+}, ' ').strip
-          self.add_issue(desc, :subject => filename)
+          add_issue(desc, :subject => filename)
         end
       end
     end

data/lib/nanoc/extra/checking/checks/external_links.rb

@@ -16,16 +16,16 @@ module ::Nanoc::Extra::Checking::Checks
     def run
       # Find all broken external hrefs
       # TODO de-duplicate this (duplicated in internal links check)
-      filenames = self.output_filenames.select { |f| File.extname(f) == '.html' }
+      filenames = output_filenames.select { |f| File.extname(f) == '.html' }
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :external).filenames_per_href
-      results = self.select_invalid(hrefs_with_filenames.keys)
+      results = select_invalid(hrefs_with_filenames.keys)
 
       # Report them
       results.each do |res|
         filenames = hrefs_with_filenames[res.href]
         filenames.each do |filename|
-          self.add_issue(
-            "reference to #{res.href}: #{res.explanation}",
+          add_issue(
+            "broken reference to #{res.href}: #{res.explanation}",
             :subject => filename)
         end
       end
@@ -54,7 +54,7 @@ module ::Nanoc::Extra::Checking::Checks
       def next
         @mutex.synchronize do
           @index += 1
-          return @array[@index-1]
+          return @array[@index - 1]
         end
       end
 
@@ -71,7 +71,7 @@ module ::Nanoc::Extra::Checking::Checks
           loop do
             href = enum.next
             break if href.nil?
-            res = self.validate(href)
+            res = validate(href)
             if res
               mutex.synchronize do
                 invalid << res
@@ -101,7 +101,7 @@ module ::Nanoc::Extra::Checking::Checks
       res = nil
       5.times do |i|
         begin
-          Timeout::timeout(10) do
+          Timeout.timeout(10) do
             res = request_url_once(url)
             if res.code == '405'
               res = request_url_once(url, Net::HTTP::Get)
@@ -151,13 +151,13 @@ module ::Nanoc::Extra::Checking::Checks
     end
 
     def request_url_once(url, req_method = Net::HTTP::Head)
-      req = req_method.new(self.path_for_url(url))
+      req = req_method.new(path_for_url(url))
       http = Net::HTTP.new(url.host, url.port)
       if url.instance_of? URI::HTTPS
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
-      res = http.request(req)
+      http.request(req)
     end
 
   end

data/lib/nanoc/extra/checking/checks/html.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 module ::Nanoc::Extra::Checking::Checks
 
@@ -13,7 +13,7 @@ module ::Nanoc::Extra::Checking::Checks
         results = ::W3CValidators::MarkupValidator.new.validate_file(filename)
         results.errors.each do |e|
           desc = e.message.gsub(%r{\s+}, ' ').strip
-          self.add_issue(desc, :subject => filename)
+          add_issue(desc, :subject => filename)
         end
       end
     end
@@ -21,4 +21,3 @@ module ::Nanoc::Extra::Checking::Checks
   end
 
 end
-

data/lib/nanoc/extra/checking/checks/internal_links.rb

@@ -12,13 +12,13 @@ module Nanoc::Extra::Checking::Checks
     # @return [void]
     def run
       # TODO de-duplicate this (duplicated in external links check)
-      filenames = self.output_filenames.select { |f| File.extname(f) == '.html' }
+      filenames = output_filenames.select { |f| File.extname(f) == '.html' }
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :internal).filenames_per_href
-      hrefs_with_filenames.each_pair do |href, filenames|
-        filenames.each do |filename|
+      hrefs_with_filenames.each_pair do |href, fns|
+        fns.each do |filename|
           unless valid?(href, filename)
-          self.add_issue(
-            "reference to #{href}",
+          add_issue(
+            "broken reference to #{href}",
             :subject  => filename)
           end
         end
@@ -57,10 +57,9 @@ module Nanoc::Extra::Checking::Checks
       return true if File.directory?(path) && @site.config[:index_filenames].any? { |fn| File.file?(File.join(path, fn)) }
 
       # Nope :(
-      return false
+      false
     end
 
   end
 
 end
-

data/lib/nanoc/extra/checking/checks/stale.rb

@@ -7,19 +7,19 @@ module Nanoc::Extra::Checking::Checks
     def run
       require 'set'
 
-      item_rep_paths = Set.new(@site.items.collect { |i| i.reps }.flatten.collect { |r| r.raw_path })
+      item_rep_paths = Set.new(@site.items.map { |i| i.reps }.flatten.map { |r| r.raw_path })
 
-      self.output_filenames.each do |f|
-        next if self.pruner.filename_excluded?(f)
+      output_filenames.each do |f|
+        next if pruner.filename_excluded?(f)
         if !item_rep_paths.include?(f)
-          self.add_issue(
-            "file without matching item",
+          add_issue(
+            'file without matching item',
             :subject  => f)
         end
       end
     end
 
-    protected
+  protected
 
     def pruner
       exclude_config = @site.config.fetch(:prune, {}).fetch(:exclude, [])

data/lib/nanoc/extra/checking/dsl.rb

@@ -7,7 +7,7 @@ module Nanoc::Extra::Checking
     attr_reader :deploy_checks
 
     def self.from_file(filename)
-      dsl = self.new
+      dsl = new
       dsl.instance_eval File.read(filename)
       dsl
     end