nanoc 3.7.4 → 3.7.5

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

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking::Checks
-
   autoload 'CSS',           'nanoc/extra/checking/checks/css'
   autoload 'ExternalLinks', 'nanoc/extra/checking/checks/external_links'
   autoload 'HTML',          'nanoc/extra/checking/checks/html'
@@ -15,5 +14,4 @@ module Nanoc::Extra::Checking::Checks
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::InternalLinks', :internal_links
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::InternalLinks', :ilinks
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::Stale',         :stale
-
 end

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

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
 module ::Nanoc::Extra::Checking::Checks
-
   class CSS < ::Nanoc::Extra::Checking::Check
-
     identifier :css
 
     def run
@@ -11,13 +9,15 @@ module ::Nanoc::Extra::Checking::Checks
 
       Dir[site.config[:output_dir] + '/**/*.css'].each do |filename|
         results = ::W3CValidators::CSSValidator.new.validate_file(filename)
+        lines = File.readlines(filename)
         results.errors.each do |e|
-          desc = e.message.gsub(%r{\s+}, ' ').strip
-          add_issue(desc, :subject => filename)
+          line_num = e.line.to_i - 1
+          line = lines[line_num]
+          message = e.message.gsub(%r{\s+}, ' ').strip.sub(/\s+:$/, '')
+          desc = "line #{line_num + 1}: #{message}: #{line}"
+          add_issue(desc, subject: filename)
         end
       end
     end
-
   end
-
 end

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

@@ -7,15 +7,13 @@ require 'timeout'
 require 'uri'
 
 module ::Nanoc::Extra::Checking::Checks
-
   # A validator that verifies that all external links point to a location that exists.
   class ExternalLinks < ::Nanoc::Extra::Checking::Check
-
     identifiers :external_links, :elinks
 
     def run
       # Find all broken external hrefs
-      # TODO de-duplicate this (duplicated in internal links check)
+      # TODO: de-duplicate this (duplicated in internal links check)
       filenames = output_filenames.select { |f| File.extname(f) == '.html' }
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :external).filenames_per_href
       results = select_invalid(hrefs_with_filenames.keys)
@@ -26,13 +24,12 @@ module ::Nanoc::Extra::Checking::Checks
         filenames.each do |filename|
           add_issue(
             "broken reference to #{res.href}: #{res.explanation}",
-            :subject => filename)
+            subject: filename)
         end
       end
     end
 
     class Result
-
       attr_reader :href
       attr_reader :explanation
 
@@ -40,11 +37,9 @@ module ::Nanoc::Extra::Checking::Checks
         @href        = href
         @explanation = explanation
       end
-
     end
 
     class ArrayEnumerator
-
       def initialize(array)
         @array = array
         @index = 0
@@ -57,7 +52,6 @@ module ::Nanoc::Extra::Checking::Checks
           return @array[@index - 1]
         end
       end
-
     end
 
     def select_invalid(hrefs)
@@ -81,7 +75,7 @@ module ::Nanoc::Extra::Checking::Checks
           end
         end
       end
-      threads.each { |t| t.join }
+      threads.each(&:join)
 
       invalid
     end
@@ -167,7 +161,5 @@ module ::Nanoc::Extra::Checking::Checks
       end
       http.request(req)
     end
-
   end
-
 end

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

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
 module ::Nanoc::Extra::Checking::Checks
-
   class HTML < ::Nanoc::Extra::Checking::Check
-
     identifier :html
 
     def run
@@ -11,13 +9,15 @@ module ::Nanoc::Extra::Checking::Checks
 
       Dir[site.config[:output_dir] + '/**/*.{htm,html}'].each do |filename|
         results = ::W3CValidators::MarkupValidator.new.validate_file(filename)
+        lines = File.readlines(filename)
         results.errors.each do |e|
-          desc = e.message.gsub(%r{\s+}, ' ').strip
-          add_issue(desc, :subject => filename)
+          line_num = e.line.to_i - 1
+          line = lines[line_num]
+          message = e.message.gsub(%r{\s+}, ' ').strip.sub(/\s+:$/, '')
+          desc = "line #{line_num + 1}: #{message}: #{line}"
+          add_issue(desc, subject: filename)
         end
       end
     end
-
   end
-
 end

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

@@ -3,10 +3,8 @@
 require 'uri'
 
 module Nanoc::Extra::Checking::Checks
-
   # A check that verifies that all internal links point to a location that exists.
   class InternalLinks < ::Nanoc::Extra::Checking::Check
-
     # Starts the validator. The results will be printed to stdout.
     #
     # Internal links that match a regexp pattern in `@config[:checks][:internal_links][:exclude]` will
@@ -14,7 +12,7 @@ module Nanoc::Extra::Checking::Checks
     #
     # @return [void]
     def run
-      # TODO de-duplicate this (duplicated in external links check)
+      # TODO: de-duplicate this (duplicated in external links check)
       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, fns|
@@ -23,7 +21,7 @@ module Nanoc::Extra::Checking::Checks
 
           add_issue(
             "broken reference to #{href}",
-            :subject  => filename)
+            subject: filename)
         end
       end
     end
@@ -32,7 +30,7 @@ module Nanoc::Extra::Checking::Checks
 
     def valid?(href, origin)
       # Skip hrefs that point to self
-      # FIXME this is ugly and won’t always be correct
+      # FIXME: this is ugly and won’t always be correct
       return true if href == '.'
 
       # Skip hrefs that are specified in the exclude configuration
@@ -70,7 +68,5 @@ module Nanoc::Extra::Checking::Checks
       excludes =  @site.config.fetch(:checks, {}).fetch(:internal_links, {}).fetch(:exclude, [])
       excludes.any? { |pattern| Regexp.new(pattern).match(href) }
     end
-
   end
-
 end

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

@@ -1,13 +1,11 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking::Checks
-
   class Stale < ::Nanoc::Extra::Checking::Check
-
     def run
       require 'set'
 
-      item_rep_paths = Set.new(@site.items.map { |i| i.reps }.flatten.map { |r| r.raw_path })
+      item_rep_paths = Set.new(@site.items.map(&:reps).flatten.map(&:raw_path))
 
       output_filenames.each do |f|
         next if pruner.filename_excluded?(f)
@@ -15,7 +13,7 @@ module Nanoc::Extra::Checking::Checks
 
         add_issue(
           'file without matching item',
-          :subject  => f)
+          subject: f)
       end
     end
 
@@ -23,9 +21,7 @@ module Nanoc::Extra::Checking::Checks
 
     def pruner
       exclude_config = @site.config.fetch(:prune, {}).fetch(:exclude, [])
-      @pruner ||= Nanoc::Extra::Pruner.new(@site, :exclude => exclude_config)
+      @pruner ||= Nanoc::Extra::Pruner.new(@site, exclude: exclude_config)
     end
-
   end
-
 end

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

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
-
   class DSL
-
     attr_reader :deploy_checks
 
     def self.from_file(filename)
@@ -25,7 +23,5 @@ module Nanoc::Extra::Checking
     def deploy_check(*identifiers)
       identifiers.each { |i| @deploy_checks << i }
     end
-
   end
-
 end

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

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
-
   class Issue
-
     attr_reader :description
     attr_reader :subject
     attr_reader :check_class
@@ -13,7 +11,5 @@ module Nanoc::Extra::Checking
       @subject       = subject
       @check_class = check_class
     end
-
   end
-
 end

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

@@ -1,12 +1,10 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
-
   # Runner is reponsible for running issue checks.
   #
   # @api private
   class Runner
-
     CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb']
 
     # @param [Nanoc::Site] site The nanoc site this runner is for
@@ -14,7 +12,7 @@ module Nanoc::Extra::Checking
       @site = site
     end
 
-    # @param [String] The name of the Checks file
+    # @return [String] The name of the Checks file
     def checks_filename
       @_checks_filename ||= CHECKS_FILENAMES.find { |f| File.file?(f) }
     end
@@ -98,7 +96,7 @@ module Nanoc::Extra::Checking
     end
 
     def all_check_classes
-      Nanoc::Extra::Checking::Check.all.map { |p| p.last }.uniq
+      Nanoc::Extra::Checking::Check.all.map(&:last).uniq
     end
 
     def check_classes_named(n)
@@ -124,7 +122,7 @@ module Nanoc::Extra::Checking
         checks << check
         issues.merge(check.issues)
 
-        # TODO report progress
+        # TODO: report progress
 
         puts check.issues.empty? ? 'ok'.green : 'error'.red
       end
@@ -136,7 +134,7 @@ module Nanoc::Extra::Checking
 
       return if issues.empty?
       puts 'Issues found!'
-      issues.group_by { |i| i.subject }.to_a.sort_by { |p| p.first }.each do |pair|
+      issues.group_by(&:subject).to_a.sort_by(&:first).each do |pair|
         subject = pair.first
         issues  = pair.last
         next if issues.empty?
@@ -148,5 +146,4 @@ module Nanoc::Extra::Checking
       end
     end
   end
-
 end

data/lib/nanoc/extra/chick.rb

@@ -5,24 +5,21 @@ require 'rack'
 require 'rack/cache'
 
 module Nanoc::Extra
-
   # @deprecated Use a HTTP library such as
   #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
   #   [Curb](https://github.com/taf2/curb) instead.
   module CHiCk
-
     # @deprecated Use a HTTP library such as
     #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
     #   [Curb](https://github.com/taf2/curb) instead.
     class Client
-
       DEFAULT_OPTIONS = {
-        :cache => {
-          :metastore   => 'file:tmp/rack/cache.meta',
-          :entitystore => 'file:tmp/rack/cache.body'
+        cache: {
+          metastore: 'file:tmp/rack/cache.meta',
+          entitystore: 'file:tmp/rack/cache.body'
         },
-        :cache_controller => {
-          :max_age => 60
+        cache_controller: {
+          max_age: 60
         }
       }
 
@@ -37,13 +34,13 @@ module Nanoc::Extra
         # Build app
         options = @options
         @app ||= Rack::Builder.new do
-          use Rack::Cache, options[:cache].merge(:verbose => true)
+          use Rack::Cache, options[:cache].merge(verbose: true)
           use Nanoc::Extra::CHiCk::CacheController, options[:cache_controller]
           run Nanoc::Extra::CHiCk::RackClient
         end
 
         # Build environment for request
-        env = Rack::MockRequest.env_for(url, :method => 'GET')
+        env = Rack::MockRequest.env_for(url, method: 'GET')
 
         # Fetch
         puts "[CHiCk] Fetching #{url}..." if $DEBUG
@@ -57,14 +54,12 @@ module Nanoc::Extra
         # Done
         [status, headers, body]
       end
-
     end
 
     # @deprecated Use a HTTP library such as
     #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
     #   [Curb](https://github.com/taf2/curb) instead.
     class CacheController
-
       def initialize(app, options = {})
         @app = app
         @options = options
@@ -77,14 +72,12 @@ module Nanoc::Extra
         end
         res
       end
-
     end
 
     # @deprecated Use a HTTP library such as
     #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
     #   [Curb](https://github.com/taf2/curb) instead.
     class RackClient
-
       METHOD_TO_CLASS_MAPPING = {
         'DELETE'  => Net::HTTP::Delete,
         'GET'     => Net::HTTP::Get,
@@ -119,9 +112,6 @@ module Nanoc::Extra
           ]
         end
       end
-
     end
-
   end
-
 end

data/lib/nanoc/extra/core_ext.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
 
-require 'nanoc/extra/core_ext/enumerable'
 require 'nanoc/extra/core_ext/pathname'
 require 'nanoc/extra/core_ext/time'

data/lib/nanoc/extra/core_ext/pathname.rb

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   module PathnameExtensions
-
     def components
       components = []
       tmp = self
@@ -19,9 +17,7 @@ module Nanoc::Extra
     def include_component?(component)
       components.include?(component)
     end
-
   end
-
 end
 
 class ::Pathname

data/lib/nanoc/extra/core_ext/time.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Extra::TimeExtensions
-
   # @return [String] The time in an ISO-8601 date format.
   def to_iso8601_date
     strftime('%Y-%m-%d')
@@ -11,7 +10,6 @@ module Nanoc::Extra::TimeExtensions
   def to_iso8601_time
     getutc.strftime('%Y-%m-%dT%H:%M:%SZ')
   end
-
 end
 
 class Time

data/lib/nanoc/extra/deployer.rb

@@ -1,13 +1,11 @@
 # encoding: utf-8
 
 module Nanoc::Extra
-
   # Represents a deployer, an object that allows uploading the compiled site
   # to a specific (remote) location.
   #
   # @abstract Subclass and override {#run} to implement a custom filter.
   class Deployer
-
     extend Nanoc::PluginRegistry::PluginMethods
 
     # @return [String] The path to the directory that contains the files to
@@ -41,7 +39,5 @@ module Nanoc::Extra
     def run
       raise NotImplementedError.new('Nanoc::Extra::Deployer subclasses must implement #run')
     end
-
   end
-
 end