nanoc 4.0.2 → 4.1.0a1

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

@@ -91,6 +91,21 @@ checks:
     # E.g.:
     #   exclude: ['^/server_status']
     exclude: []
+
+  # Configuration for the “external_links” checker, which checks whether all
+  # external links are valid.
+  external_links:
+    # A list of patterns, specified as regular expressions, to exclude from the check.
+    # If an external link matches this pattern, the validity check will be skipped.
+    # E.g.:
+    #   exclude: ['^http://example.com$']
+    exclude: []
+
+    # A list of file patterns, specified as regular expressions, to exclude from the check.
+    # If a file matches this pattern, the links from this file will not be checked.
+    # E.g.:
+    #   exclude_files: ['blog/page']
+    exclude_files: []
 EOS
 
     DEFAULT_RULES = <<EOS unless defined? DEFAULT_RULES

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

@@ -16,7 +16,7 @@ module Nanoc::CLI::Commands
   class Prune < ::Nanoc::CLI::CommandRunner
     def run
       load_site
-      site.compiler.load
+      site.compiler.build_reps
 
       if options.key?(:yes)
         Nanoc::Extra::Pruner.new(site, exclude: prune_config_exclude).run

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

@@ -23,9 +23,9 @@ module Nanoc::CLI::Commands
 
     def self.env_for_site(site)
       {
-        items: Nanoc::ItemCollectionView.new(site.items),
-        layouts: Nanoc::LayoutCollectionView.new(site.layouts),
-        config: Nanoc::ConfigView.new(site.config),
+        items: Nanoc::ItemCollectionView.new(site.items, nil),
+        layouts: Nanoc::LayoutCollectionView.new(site.layouts, nil),
+        config: Nanoc::ConfigView.new(site.config, nil),
       }
     end
   end

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

@@ -17,11 +17,11 @@ module Nanoc::CLI::Commands
 
       # Get dependency tracker
       compiler = site.compiler
-      compiler.load
-      dependency_tracker = compiler.dependency_tracker
+      compiler.load_stores
+      dependency_store = compiler.dependency_store
 
       # Print data
-      print_item_dependencies(items, dependency_tracker)
+      print_item_dependencies(items, dependency_store)
       print_item_rep_paths(items)
       print_item_rep_outdatedness(items, compiler)
       print_layouts(layouts, compiler)
@@ -56,13 +56,13 @@ module Nanoc::CLI::Commands
       puts
     end
 
-    def print_item_dependencies(items, dependency_tracker)
+    def print_item_dependencies(items, dependency_store)
       print_header('Item dependencies')
 
       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 : '' }
+        predecessors = dependency_store.objects_causing_outdatedness_of(item).sort_by { |i| i ? i.identifier : '' }
         predecessors.each do |pred|
           type =
             case pred

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

@@ -12,6 +12,7 @@ module Nanoc::CLI::Commands
 
       @c = Nanoc::CLI::ANSIStringColorizer
       @rules = site.compiler.rules_collection
+      @reps = site.compiler.reps
 
       site.items.sort_by(&:identifier).each   { |e| explain_item(e) }
       site.layouts.sort_by(&:identifier).each { |e| explain_layout(e) }
@@ -20,7 +21,7 @@ module Nanoc::CLI::Commands
     def explain_item(item)
       puts "#{@c.c('Item ' + item.identifier, :bold, :yellow)}:"
 
-      item.reps.each do |rep|
+      @reps[item].each do |rep|
         rule = @rules.compilation_rule_for(rep)
         puts "  Rep #{rep.name}: #{rule ? rule.pattern : '(none)'}"
       end

data/lib/nanoc/cli/error_handler.rb

@@ -3,23 +3,23 @@ module Nanoc::CLI
   #
   # @api private
   class ErrorHandler
-    # @option params [Nanoc::CLI::Command, nil] command The command that is
+    # @param [Nanoc::CLI::Command, nil] command The command that is
     #   currently being executed, or nil if there is none
-    def initialize(params = {})
-      @command = params[:command]
+    def initialize(command: nil)
+      @command = command
     end
 
     # Enables error handling in the given block.
     #
-    # @option params [Nanoc::CLI::Command, nil] command The command that is
+    # @param [Nanoc::CLI::Command, nil] command The command that is
     #   currently being executed, or nil if there is none
     #
     # @return [void]
-    def self.handle_while(params = {}, &block)
+    def self.handle_while(command: nil, &block)
       if @disabled
         yield
       else
-        new(params).handle_while(&block)
+        new(command: command).handle_while(&block)
       end
     end
 
@@ -247,9 +247,9 @@ module Nanoc::CLI
       defined?(Bundler) && Bundler::SharedHelpers.in_bundle?
     end
 
-    def write_section_header(stream, title, params = {})
+    def write_section_header(stream, title, verbose: false)
       stream.puts
-      if params[:verbose]
+      if verbose
         stream.puts '===== ' + title.upcase + ':'
       else
         stream.puts "\e[1m\e[31m" + title + ':' + "\e[0m"
@@ -257,16 +257,16 @@ module Nanoc::CLI
       stream.puts
     end
 
-    def write_error_message(stream, error, params = {})
-      write_section_header(stream, 'Message', params)
+    def write_error_message(stream, error, verbose: false)
+      write_section_header(stream, 'Message', verbose: verbose)
 
       stream.puts "#{error.class}: #{error.message}"
       resolution = resolution_for(error)
       stream.puts "#{resolution}" if resolution
     end
 
-    def write_compilation_stack(stream, _error, params = {})
-      write_section_header(stream, 'Compilation stack', params)
+    def write_compilation_stack(stream, _error, verbose: false)
+      write_section_header(stream, 'Compilation stack', verbose: verbose)
 
       if stack.empty?
         stream.puts '  (empty)'
@@ -281,16 +281,14 @@ module Nanoc::CLI
       end
     end
 
-    def write_stack_trace(stream, error, params = {})
-      is_verbose = params.fetch(:verbose, false)
+    def write_stack_trace(stream, error, verbose: false)
+      write_section_header(stream, 'Stack trace', verbose: verbose)
 
-      write_section_header(stream, 'Stack trace', params)
-
-      count = is_verbose ? -1 : 10
+      count = verbose ? -1 : 10
       error.backtrace[0...count].each_with_index do |item, index|
         stream.puts "  #{index}. #{item}"
       end
-      if !is_verbose && error.backtrace.size > count
+      if !verbose && error.backtrace.size > count
         stream.puts "  ... #{error.backtrace.size - count} more lines omitted. See full crash log for details."
       end
     end
@@ -303,41 +301,41 @@ module Nanoc::CLI
       stream.puts 'A detailed crash log has been written to ./crash.log.'
     end
 
-    def write_version_information(stream, params = {})
-      write_section_header(stream, 'Version information', params)
+    def write_version_information(stream, verbose: false)
+      write_section_header(stream, 'Version information', verbose: verbose)
       stream.puts Nanoc.version_information
     end
 
-    def write_system_information(stream, params = {})
+    def write_system_information(stream, verbose: false)
       uname = `uname -a`
-      write_section_header(stream, 'System information', params)
+      write_section_header(stream, 'System information', verbose: verbose)
       stream.puts uname
     rescue Errno::ENOENT
     end
 
-    def write_installed_gems(stream, params = {})
-      write_section_header(stream, 'Installed gems', params)
+    def write_installed_gems(stream, verbose: false)
+      write_section_header(stream, 'Installed gems', verbose: verbose)
       gems_and_versions.each do |g|
         stream.puts "  #{g.first} #{g.last.join(', ')}"
       end
     end
 
-    def write_environment(stream, params = {})
-      write_section_header(stream, 'Environment', params)
+    def write_environment(stream, verbose: false)
+      write_section_header(stream, 'Environment', verbose: verbose)
       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, verbose: false)
       if File.exist?('Gemfile.lock')
-        write_section_header(stream, 'Gemfile.lock', params)
+        write_section_header(stream, 'Gemfile.lock', verbose: verbose)
         stream.puts File.read('Gemfile.lock')
       end
     end
 
-    def write_load_paths(stream, params = {})
-      write_section_header(stream, 'Load paths', params)
+    def write_load_paths(stream, verbose: false)
+      write_section_header(stream, 'Load paths', verbose: verbose)
       $LOAD_PATH.each_with_index do |i, index|
         stream.puts "  #{index}. #{i}"
       end

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

@@ -5,7 +5,7 @@ module Nanoc::CLI::StreamCleaners
   class ANSIColors < Abstract
     # @see Nanoc::CLI::StreamCleaners::Abstract#clean
     def clean(s)
-      s.gsub(/\e\[.+?m/, '')
+      s.is_a?(String) ? s.gsub(/\e\[.+?m/, '') : s
     end
   end
 end

data/lib/nanoc/data_sources/filesystem.rb

@@ -192,7 +192,7 @@ module Nanoc::DataSources
     # Returns the extension(s) of filename. Supports multiple extensions.
     # Includes the leading period.
     def ext_of(filename)
-      filename =~ extension_regex ? $1 : ''
+      filename =~ extension_regex ? Regexp.last_match[1] : ''
     end
 
     # Returns a regex that is used for determining the extension of a file

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

@@ -19,11 +19,14 @@ module Nanoc::Extra::Checking
       end
       output_filenames = Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
 
+      # FIXME: ugly
+      view_context = site.compiler.create_view_context
+
       context = {
-        items: Nanoc::ItemCollectionView.new(site.items),
-        layouts: Nanoc::LayoutCollectionView.new(site.layouts),
-        config: Nanoc::ConfigView.new(site.config),
-        site: Nanoc::SiteView.new(site), # TODO: remove me
+        items: Nanoc::ItemCollectionView.new(site.items, view_context),
+        layouts: Nanoc::LayoutCollectionView.new(site.layouts, view_context),
+        config: Nanoc::ConfigView.new(site.config, view_context),
+        site: Nanoc::SiteView.new(site, view_context), # TODO: remove me
         output_filenames: output_filenames,
       }
 
@@ -40,9 +43,7 @@ module Nanoc::Extra::Checking
       raise NotImplementedError.new('Nanoc::Extra::Checking::Check subclasses must implement #run')
     end
 
-    def add_issue(desc, params = {})
-      subject = params.fetch(:subject, nil)
-
+    def add_issue(desc, subject: nil)
       @issues << Issue.new(desc, subject, self.class)
     end
   end

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

@@ -14,7 +14,7 @@ module ::Nanoc::Extra::Checking::Checks
     def run
       # Find all broken external hrefs
       # TODO: de-duplicate this (duplicated in internal links check)
-      filenames = output_filenames.select { |f| File.extname(f) == '.html' }
+      filenames = output_filenames.select { |f| File.extname(f) == '.html' && !excluded_file?(f) }
       hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :external).filenames_per_href
       results = select_invalid(hrefs_with_filenames.keys)
 
@@ -89,6 +89,9 @@ module ::Nanoc::Extra::Checking::Checks
         return Result.new(href, 'invalid URI')
       end
 
+      # Skip excluded URLs
+      return nil if self.excluded?(href)
+
       # Skip non-HTTP URLs
       return nil if url.scheme !~ /^https?$/
 
@@ -161,5 +164,15 @@ module ::Nanoc::Extra::Checking::Checks
       end
       http.request(req)
     end
+
+    def excluded?(href)
+      excludes = @config.fetch(:checks, {}).fetch(:external_links, {}).fetch(:exclude, [])
+      excludes.any? { |pattern| Regexp.new(pattern).match(href) }
+    end
+
+    def excluded_file?(file)
+      excludes = @config.fetch(:checks, {}).fetch(:external_links, {}).fetch(:exclude_files, [])
+      excludes.any? { |pattern| Regexp.new(pattern).match(file) }
+    end
   end
 end

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

@@ -107,7 +107,7 @@ module Nanoc::Extra::Checking
       return [] if classes.empty?
 
       # TODO: remove me
-      @site.compiler.load
+      @site.compiler.build_reps
 
       checks = []
       issues = Set.new

data/lib/nanoc/extra/deployer.rb

@@ -25,12 +25,12 @@ module Nanoc::Extra
     #
     # @return [Hash] config The deployer configuration
     #
-    # @option params [Boolean] :dry_run (false) true if the deployer should
+    # @param [Boolean] dry_run true if the deployer should
     #   only show what would be deployed instead actually deploying
-    def initialize(source_path, config, params = {})
+    def initialize(source_path, config, dry_run: false)
       @source_path  = source_path
       @config       = config
-      @dry_run      = params.fetch(:dry_run) { false }
+      @dry_run      = dry_run
     end
 
     # Performs the actual deployment.

data/lib/nanoc/extra/piper.rb

@@ -14,11 +14,11 @@ module Nanoc::Extra
       end
     end
 
-    # @option [IO] :stdout ($stdout)
-    # @option [IO] :stderr ($stderr)
-    def initialize(params = {})
-      @stdout = params.fetch(:stdout, $stdout)
-      @stderr = params.fetch(:stderr, $stderr)
+    # @param [IO] stdout
+    # @param [IO] stderr
+    def initialize(stdout: $stdout, stderr: $stderr)
+      @stdout = stdout
+      @stderr = stderr
     end
 
     # @param [Array<String>] cmd

data/lib/nanoc/extra/pruner.rb

@@ -9,13 +9,15 @@ module Nanoc::Extra
 
     # @param [Nanoc::Int::Site] site The site for which a pruner is created
     #
-    # @option params [Boolean] :dry_run (false) true if the files to be deleted
+    # @param [Boolean] dry_run true if the files to be deleted
     #   should only be printed instead of actually deleted, false if the files
     #   should actually be deleted.
-    def initialize(site, params = {})
+    #
+    # @param [Enumerable<String>] exclude
+    def initialize(site, dry_run: false, exclude: [])
       @site    = site
-      @dry_run = params.fetch(:dry_run) { false }
-      @exclude = params.fetch(:exclude) { [] }
+      @dry_run = dry_run
+      @exclude = exclude
     end
 
     # Prunes all output files not managed by Nanoc.
@@ -25,9 +27,8 @@ module Nanoc::Extra
       require 'find'
 
       # Get compiled files
-      all_raw_paths = site.items.map do |item|
-        item.reps.map(&:raw_path)
-      end
+      # FIXME: requires #build_reps to have been called
+      all_raw_paths = site.compiler.reps.map(&:raw_path)
       compiled_files = all_raw_paths.flatten.compact.select { |f| File.file?(f) }
 
       # Get present files and dirs

data/lib/nanoc/filters/relativize_paths.rb

@@ -35,30 +35,9 @@ module Nanoc::Filters
       # Filter
       case params[:type]
       when :css
-        # FIXME: parse CSS the proper way using csspool or something
-        content.gsub(/url\((['"]?)(\/(?:[^\/].*?)?)\1\)/) do
-          'url(' + $1 + relative_path_to($2) + $1 + ')'
-        end
+        relativize_css(content)
       when :html, :xml, :xhtml
-        selectors  = params.fetch(:select) { SELECTORS }
-        namespaces = params[:namespaces] || {}
-
-        require 'nokogiri'
-        case params[:type]
-        when :html
-          klass = ::Nokogiri::HTML
-        when :xml
-          klass = ::Nokogiri::XML
-        when :xhtml
-          klass = ::Nokogiri::XML
-          # FIXME: cleanup because it is ugly
-          # this cleans the XHTML namespace to process fragments and full
-          # documents in the same way. At least, Nokogiri adds this namespace
-          # if detects the `html` element.
-          content = content.sub(%r{(<html[^>]+)xmlns="http://www.w3.org/1999/xhtml"}, '\1')
-        end
-
-        nokogiri_process(content, selectors, namespaces, klass, params[:type])
+        relativize_html_like(content, params)
       else
         raise RuntimeError.new(
           'The relativize_paths needs to know the type of content to ' \
@@ -69,6 +48,38 @@ module Nanoc::Filters
 
     protected
 
+    def relativize_css(content)
+      # FIXME: parse CSS the proper way using csspool or something
+      content.gsub(/url\((['"]?)(\/(?:[^\/].*?)?)\1\)/) do
+        quote = Regexp.last_match[1]
+        path = Regexp.last_match[2]
+        'url(' + quote + relative_path_to(path) + quote + ')'
+      end
+    end
+
+    def relativize_html_like(content, params)
+      selectors  = params.fetch(:select, SELECTORS)
+      namespaces = params.fetch(:namespaces, {})
+      type       = params.fetch(:type)
+
+      require 'nokogiri'
+      case type
+      when :html
+        klass = ::Nokogiri::HTML
+      when :xml
+        klass = ::Nokogiri::XML
+      when :xhtml
+        klass = ::Nokogiri::XML
+        # FIXME: cleanup because it is ugly
+        # this cleans the XHTML namespace to process fragments and full
+        # documents in the same way. At least, Nokogiri adds this namespace
+        # if detects the `html` element.
+        content = content.sub(%r{(<html[^>]+)xmlns="http://www.w3.org/1999/xhtml"}, '\1')
+      end
+
+      nokogiri_process(content, selectors, namespaces, klass, type)
+    end
+
     def nokogiri_process(content, selectors, namespaces, klass, type)
       # Ensure that all prefixes are strings
       namespaces = namespaces.reduce({}) { |new, (prefix, uri)| new.merge(prefix.to_s => uri) }
@@ -77,14 +88,7 @@ module Nanoc::Filters
       selectors.map { |sel| "descendant-or-self::#{sel}" }.each do |selector|
         doc.xpath(selector, namespaces).each do |node|
           if node.name == 'comment'
-            content = node.content.dup
-            content = content.sub(%r{^(\s*\[.+?\]>\s*)(.+?)(\s*<!\[endif\])}m) do |_m|
-              fragment = nokogiri_process($2, selectors, namespaces, klass, type)
-              $1 + fragment + $3
-            end
-            comment = Nokogiri::XML::Comment.new(doc, content)
-            # Works w/ Nokogiri 1.5.5 but fails w/ Nokogiri 1.5.2
-            node.replace(comment)
+            nokogiri_process_comment(node, doc, selectors, namespaces, klass, type)
           elsif self.path_is_relativizable?(node.content)
             node.content = relative_path_to(node.content)
           end
@@ -93,8 +97,20 @@ module Nanoc::Filters
       doc.send("to_#{type}")
     end
 
+    def nokogiri_process_comment(node, doc, selectors, namespaces, klass, type)
+      content = node.content.dup.sub(%r{^(\s*\[.+?\]>\s*)(.+?)(\s*<!\[endif\])}m) do |_m|
+        beginning = Regexp.last_match[1]
+        body = Regexp.last_match[2]
+        ending = Regexp.last_match[3]
+
+        beginning + nokogiri_process(body, selectors, namespaces, klass, type) + ending
+      end
+
+      node.replace(Nokogiri::XML::Comment.new(doc, content))
+    end
+
     def path_is_relativizable?(s)
-      s[0, 1] == '/'
+      s.start_with?('/')
     end
   end
 end