nanoc3 3.2.0b1 → 3.2.0b2

data/NEWS.md

@@ -34,7 +34,7 @@ Extensions:
 ## 3.1.8 (2011-06-25)
 
 * Made link validator accept https: URLs
-* Fixed erronous handling of layouts with names ending in index
+* Fixed erroneous handling of layouts with names ending in index
 * Fixed dependency generation between Sass partials
 * Fixed errors related to thread requires
 * Fixed crash while handling load errors

data/Rakefile

@@ -1,7 +1,10 @@
 # encoding: utf-8
 
-# Load nanoc
+# Set up env
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+require './test/gem_loader.rb'
+
+# Load nanoc
 require 'nanoc3'
 
 # Load tasks

data/lib/nanoc3/cli/command.rb

@@ -47,23 +47,9 @@ module Nanoc3::CLI
     #
     # @return [void]
     def call
-      # Set exit handler
-      [ 'INT', 'TERM' ].each do |signal|
-        Signal.trap(signal) do
-          puts
-          exit!(0)
-        end
+      Nanoc3::CLI::ErrorHandler.handle_while(:command => self) do
+        self.run
       end
-
-      # Set attributes
-
-      # Run
-      self.run
-    rescue Interrupt => e
-      exit(1)
-    rescue StandardError, ScriptError => e
-      self.print_error(e)
-      exit(1)
     end
 
     # Performs the actual execution of the command.
@@ -83,115 +69,6 @@ module Nanoc3::CLI
       Nanoc3::CLI.debug?
     end
 
-    # A hash that contains the name of the gem for a given required file. If a
-    # `#require` fails, the gem name is looked up in this hash.
-    GEM_NAMES = {
-      'adsf'           => 'adsf',
-      'bluecloth'      => 'bluecloth',
-      'builder'        => 'builder',
-      'coderay'        => 'coderay',
-      'cri'            => 'cri',
-      'erubis'         => 'erubis',
-      'escape'         => 'escape',
-      'fssm'           => 'fssm',
-      'haml'           => 'haml',
-      'json'           => 'json',
-      'kramdown'       => 'kramdown',
-      'less'           => 'less',
-      'markaby'        => 'markaby',
-      'maruku'         => 'maruku',
-      'mime/types'     => 'mime-types',
-      'nokogiri'       => 'nokogiri',
-      'rack'           => 'rack',
-      'rack/cache'     => 'rack-cache',
-      'rainpress'      => 'rainpress',
-      'rdiscount'      => 'rdiscount',
-      'redcarpet'      => 'redcarpet',
-      'redcloth'       => 'redcloth',
-      'rubypants'      => 'rubypants',
-      'sass'           => 'sass',
-      'systemu'        => 'systemu',
-      'w3c_validators' => 'w3c_validators'
-    }
-
-    # Prints the given error to stderr. Includes message, possible resolution
-    # (see {#resolution_for}), compilation stack, backtrace, etc.
-    #
-    # @param [Error] error The error that should be described
-    #
-    # @return [void]
-    def print_error(error)
-      $stderr.puts
-
-      # Header
-      $stderr.puts '+--- /!\ ERROR /!\ -------------------------------------------+'
-      $stderr.puts '| An exception occured while running nanoc. If you think this |'
-      $stderr.puts '| is a bug in nanoc, please do report it at                   |'
-      $stderr.puts '| <http://projects.stoneship.org/trac/nanoc/newticket> --     |'
-      $stderr.puts '| thanks in advance!                                          |'
-      $stderr.puts '+-------------------------------------------------------------+'
-
-      # Exception and resolution (if any)
-      $stderr.puts
-      $stderr.puts '=== MESSAGE:'
-      $stderr.puts
-      $stderr.puts "#{error.class}: #{error.message}"
-      resolution = self.resolution_for(error)
-      $stderr.puts "#{resolution}" if resolution
-
-      # Compilation stack
-      $stderr.puts
-      $stderr.puts '=== COMPILATION STACK:'
-      $stderr.puts
-      if self.stack.empty?
-        $stderr.puts "  (empty)"
-      else
-        self.stack.reverse.each do |obj|
-          if obj.is_a?(Nanoc3::ItemRep)
-            $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
-          else # layout
-            $stderr.puts "  - [layout] #{obj.identifier}"
-          end
-        end
-      end
-
-      # Backtrace
-      $stderr.puts
-      $stderr.puts '=== BACKTRACE:'
-      $stderr.puts
-      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
-    end
-
-    # Attempts to find a resolution for the given error, or nil if no
-    # resolution can be automatically obtained.
-    #
-    # @param [Error] error The error to find a resolution for
-    #
-    # @return [String] The resolution for the given error
-    def resolution_for(error)
-      case error
-      when LoadError
-        # Get gem name
-        matches = error.message.match(/no such file to load -- ([^\s]+)/)
-        return nil if matches.size == 0
-        lib_name = matches[1]
-        gem_name = GEM_NAMES[$1]
-
-        # Build message
-        if gem_name
-          "Try installing the '#{gem_name}' gem (`gem install #{gem_name}`) and then re-running the command."
-        end
-      when RuntimeError
-        if error.message =~ /^can't modify frozen/
-          "You attempted to modify immutable data. Some data, such as " \
-          "item/layout attributes and raw item/layout content, can not " \
-          "be modified once compilation has started. (This was " \
-          "unintentionally possible in 3.1.x and before, but has been " \
-          "disabled in 3.2.x in order to allow compiler optimisations.)"
-        end
-      end
-    end
-
     # Asserts that the current working directory contains a site
     # ({Nanoc3::Site} instance). If no site is present, prints an error
     # message and exits.

data/lib/nanoc3/cli/commands/watch.rb

@@ -62,7 +62,7 @@ module Nanoc3::CLI::Commands
           end
 
           puts
-          base.print_error(e)
+          self.print_error(e)
           puts
         end
       end

data/lib/nanoc3/cli/error_handler.rb

@@ -0,0 +1,182 @@
+# encoding: utf-8
+
+module Nanoc3::CLI
+
+  # Catches errors and prints nice diagnostic messages, then exits.
+  class ErrorHandler
+
+    # @option params [Nanoc3::CLI::Command, nil] command The command that is
+    #   currently being executed, or nil if there is none
+    def initialize(params={})
+      @command = params[:command]
+    end
+
+    # Enables error handling in the given block.
+    #
+    # @option params [Nanoc3::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)
+      self.new(params).handle_while(&block)
+    end
+
+    # Enables error handling in the given block. This method should not be
+    # called directly; use {Nanoc3::CLI::ErrorHandler.handle_while} instead.
+    #
+    # @return [void]
+    #
+    # @api private
+    def handle_while(&block)
+      # Set exit handler
+      [ 'INT', 'TERM' ].each do |signal|
+        Signal.trap(signal) do
+          puts
+          exit!(0)
+        end
+      end
+
+      # Run
+      yield
+    rescue Interrupt => e
+      exit(1)
+    rescue StandardError, ScriptError => e
+      self.print_error(e)
+      exit(1)
+    end
+
+  protected
+
+    # @return [Boolean] true if debug output is enabled, false if not
+    #
+    # @see Nanoc3::CLI.debug?
+    def debug?
+      Nanoc3::CLI.debug?
+    end
+
+    # @return [Nanoc3::Site] The site that is currently being processed
+    def site
+      @command && @command.site
+    end
+
+    # @return [Nanoc3::Compiler] The compiler for the current site
+    def compiler
+      site && site.compiler
+    end
+
+    # @return [Array] The current compilation stack
+    def stack
+      (compiler && compiler.stack) || []
+    end
+
+    # A hash that contains the name of the gem for a given required file. If a
+    # `#require` fails, the gem name is looked up in this hash.
+    GEM_NAMES = {
+      'adsf'           => 'adsf',
+      'bluecloth'      => 'bluecloth',
+      'builder'        => 'builder',
+      'coderay'        => 'coderay',
+      'cri'            => 'cri',
+      'erubis'         => 'erubis',
+      'escape'         => 'escape',
+      'fssm'           => 'fssm',
+      'haml'           => 'haml',
+      'json'           => 'json',
+      'kramdown'       => 'kramdown',
+      'less'           => 'less',
+      'markaby'        => 'markaby',
+      'maruku'         => 'maruku',
+      'mime/types'     => 'mime-types',
+      'nokogiri'       => 'nokogiri',
+      'rack'           => 'rack',
+      'rack/cache'     => 'rack-cache',
+      'rainpress'      => 'rainpress',
+      'rdiscount'      => 'rdiscount',
+      'redcarpet'      => 'redcarpet',
+      'redcloth'       => 'redcloth',
+      'rubypants'      => 'rubypants',
+      'sass'           => 'sass',
+      'systemu'        => 'systemu',
+      'w3c_validators' => 'w3c_validators'
+    }
+
+    # Prints the given error to stderr. Includes message, possible resolution
+    # (see {#resolution_for}), compilation stack, backtrace, etc.
+    #
+    # @param [Error] error The error that should be described
+    #
+    # @return [void]
+    def print_error(error)
+      # Header
+      $stderr.puts
+      $stderr.puts "Captain! We’ve been hit!"
+
+      # Exception and resolution (if any)
+      $stderr.puts
+      $stderr.puts '=== MESSAGE:'
+      $stderr.puts
+      $stderr.puts "#{error.class}: #{error.message}"
+      resolution = self.resolution_for(error)
+      $stderr.puts "#{resolution}" if resolution
+
+      # Compilation stack
+      $stderr.puts
+      $stderr.puts '=== COMPILATION STACK:'
+      $stderr.puts
+      if self.stack.empty?
+        $stderr.puts "  (empty)"
+      else
+        self.stack.reverse.each do |obj|
+          if obj.is_a?(Nanoc3::ItemRep)
+            $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
+          else # layout
+            $stderr.puts "  - [layout] #{obj.identifier}"
+          end
+        end
+      end
+
+      # Backtrace
+      $stderr.puts
+      $stderr.puts '=== BACKTRACE:'
+      $stderr.puts
+      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
+
+      # Issue link
+      $stderr.puts
+      $stderr.puts "If you believe this is a bug in nanoc, please do report it at"
+      $stderr.puts "<https://github.com/ddfreyne/nanoc/issues/new>--thanks!"
+    end
+
+    # Attempts to find a resolution for the given error, or nil if no
+    # resolution can be automatically obtained.
+    #
+    # @param [Error] error The error to find a resolution for
+    #
+    # @return [String] The resolution for the given error
+    def resolution_for(error)
+      case error
+      when LoadError
+        # Get gem name
+        matches = error.message.match(/no such file to load -- ([^\s]+)/)
+        return nil if matches.size == 0
+        lib_name = matches[1]
+        gem_name = GEM_NAMES[$1]
+
+        # Build message
+        if gem_name
+          "Try installing the '#{gem_name}' gem (`gem install #{gem_name}`) and then re-running the command."
+        end
+      when RuntimeError
+        if error.message =~ /^can't modify frozen/
+          "You attempted to modify immutable data. Some data, such as " \
+          "item/layout attributes and raw item/layout content, can not " \
+          "be modified once compilation has started. (This was " \
+          "unintentionally possible in 3.1.x and before, but has been " \
+          "disabled in 3.2.x in order to allow compiler optimisations.)"
+        end
+      end
+    end
+
+  end
+
+end

data/lib/nanoc3/cli.rb

@@ -7,6 +7,10 @@ module Nanoc3::CLI
   module Commands
   end
 
+  autoload 'Logger',             'nanoc3/cli/logger'
+  autoload 'Command',            'nanoc3/cli/command'
+  autoload 'ErrorHandler',       'nanoc3/cli/error_handler'
+
   # @return [Boolean] true if debug output is enabled, false if not
   #
   # @since 3.2.0
@@ -24,18 +28,17 @@ module Nanoc3::CLI
     @debug = boolean
   end
 
-  autoload 'Logger',             'nanoc3/cli/logger'
-  autoload 'Command',            'nanoc3/cli/command'
-
   # Invokes the nanoc commandline tool with the given arguments.
   #
   # @param [Array<String>] args An array of commandline arguments
   #
   # @return [void]
   def self.run(args)
-    self.setup
-    self.load_custom_commands
-    self.root_command.run(args)
+    Nanoc3::CLI::ErrorHandler.handle_while do
+      self.setup
+      self.load_custom_commands
+      self.root_command.run(args)
+    end
   end
 
   # Adds the given command to the collection of available commands.
@@ -53,8 +56,8 @@ protected
   #
   # @return [void]
   def self.setup
-    # Don’t set up twice
-    return if @setup
+    # Reinit
+    @root_command = nil
 
     # Add help command
     help_cmd = Cri::Command.new_basic_help
@@ -67,17 +70,29 @@ protected
       cmd = self.load_command_at(filename)
       self.add_command(cmd)
     end
-
-    @setup = true
   end
 
   # Loads the commands in `commands/`.
   #
   # @return [void]
   def self.load_custom_commands
-    Dir['commands/*.rb'].each do |filename|
-      cmd = Nanoc3::CLI.load_command_at(filename)
-      Nanoc3::CLI.root_command.add_command(cmd)
+    self.recursive_contents_of('commands').each do |filename|
+      # Create command
+      command = Nanoc3::CLI.load_command_at(filename)
+
+      # Get supercommand
+      pieces = filename.gsub(/^commands\/|\.rb$/, '').split('/')
+      pieces = pieces[0, pieces.size-1] || []
+      root = Nanoc3::CLI.root_command
+      supercommand = pieces.inject(root) do |cmd, piece|
+        cmd.nil? ? nil : cmd.command_named(piece)
+      end
+
+      # Add to supercommand
+      if supercommand.nil?
+        raise "Cannot load command at #{filename} because its supercommand cannot be found"
+      end
+      supercommand.add_command(command)
     end
   end
 
@@ -86,10 +101,16 @@ 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)
+  def self.load_command_at(filename, command_name=nil)
+    # Load
     code = File.read(filename)
     cmd = Cri::Command.define(code)
-    cmd.modify { name File.basename(filename, '.rb') }
+
+    # Set name
+    command_name ||= File.basename(filename, '.rb')
+    cmd.modify { name command_name }
+
+    # Done
     cmd
   end
 
@@ -101,4 +122,12 @@ protected
     end
   end
 
+  # @return [Array] The directory contents
+  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) }
+    files
+  end
+
 end

data/lib/nanoc3/helpers/xml_sitemap.rb

@@ -53,7 +53,7 @@ module Nanoc3::Helpers
 
       # Build sitemap
       xml.instruct!
-      xml.urlset(:xmlns => 'http://www.google.com/schemas/sitemap/0.84') do
+      xml.urlset(:xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9') do
         # Add item
         items.each do |item|
           item.reps.reject { |r| r.raw_path.nil? }.each do |rep|

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.2.0b1'
+  VERSION = '3.2.0b2'
 
 end
 

data/nanoc3.gemspec

@@ -25,6 +25,11 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('cri', '~> 2.0')
 
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('rdiscount')
+  s.add_development_dependency('yard')
+
   s.post_install_message = %q{------------------------------------------------------------------------------
 Thanks for installing nanoc 3.2! Here are some resources to help you get
 started:

data/test/cli/test_cli.rb

@@ -14,6 +14,18 @@ description 'longer meh'
 run do |opts, args, cmd|
   File.open('_test.out', 'w') { |io| io.write('It works!') }
 end
+EOS
+
+  SUBCOMMAND_CODE = <<EOS
+# encoding: utf-8
+
+usage       '_sub [options]'
+summary     'meh sub'
+description 'longer meh sub'
+
+run do |opts, args, cmd|
+  File.open('_test_sub.out', 'w') { |io| io.write('It works sub!') }
+end
 EOS
 
   def test_load_custom_commands
@@ -37,4 +49,53 @@ EOS
     end
   end
 
+  def test_load_custom_commands_nested
+    Nanoc3::CLI.run %w( create_site foo )
+    FileUtils.cd('foo') do
+      # Create command
+      FileUtils.mkdir_p('commands')
+      File.open('commands/_test.rb', 'w') do |io|
+        io.write(COMMAND_CODE)
+      end
+
+      # Create subcommand
+      FileUtils.mkdir_p('commands/_test')
+      File.open('commands/_test/_sub.rb', 'w') do |io|
+        io.write(SUBCOMMAND_CODE)
+      end
+
+      # Run command
+      begin
+        Nanoc3::CLI.run %w( _test _sub )
+      rescue SystemExit
+        assert false, 'Running _test sub should not cause system exit'
+      end
+
+      # Check
+      assert File.file?('_test_sub.out')
+      assert_equal 'It works sub!', File.read('_test_sub.out')
+    end
+  end
+
+  def test_load_custom_commands_broken
+    Nanoc3::CLI.run %w( create_site foo )
+
+    FileUtils.cd('foo') do
+      # Create command
+      FileUtils.mkdir_p('commands')
+      File.open('commands/_test.rb', 'w') { |io| io.write('raise "meh"') }
+
+      # Run command
+      position_before = $stderr.tell
+      assert_raises SystemExit do
+        Nanoc3::CLI.run %w( _test )
+      end
+      position_after = $stderr.tell
+
+      # Check error output
+      stderr_addition = $stderr.string[position_before, position_after]
+      assert_match(/=== BACKTRACE:/, stderr_addition)
+    end
+  end
+
 end

data/test/cli/test_error_handler.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+class Nanoc3::CLI::ErrorHandlerTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_resolution_for_with_unknown_gem
+    error = LoadError.new('no such file to load -- afjlrestjlsgrshter')
+    assert_nil handler.send(:resolution_for, error)
+  end
+
+  def test_resolution_for_with_known_gem
+    $loud = true
+    error = LoadError.new('no such file to load -- kramdown')
+    assert_match /^Try installing /, handler.send(:resolution_for, error)
+  ensure
+    $loud = false
+  end
+
+  def test_resolution_for_with_not_load_error
+    error = RuntimeError.new('nuclear meltdown detected')
+    assert_nil handler.send(:resolution_for, error)
+  end
+
+  def handler
+    Nanoc3::CLI::ErrorHandler.new
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: nanoc3
 version: !ruby/object:Gem::Version 
   prerelease: 5
-  version: 3.2.0b1
+  version: 3.2.0b2
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 Z
+date: 2011-07-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cri
@@ -23,6 +23,50 @@ dependencies:
         version: "2.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: "nanoc is a simple but very flexible static site generator written in Ruby. It operates on local files, and therefore does not run on the server. nanoc \xE2\x80\x9Ccompiles\xE2\x80\x9D the local source files into HTML (usually), by evaluating eRuby, Markdown, etc."
 email: denis.defreyne@stoneship.org
 executables: 
@@ -90,6 +134,7 @@ files:
 - lib/nanoc3/cli/commands/update.rb
 - lib/nanoc3/cli/commands/view.rb
 - lib/nanoc3/cli/commands/watch.rb
+- lib/nanoc3/cli/error_handler.rb
 - lib/nanoc3/cli/logger.rb
 - lib/nanoc3/cli.rb
 - lib/nanoc3/data_sources/deprecated/delicious.rb
@@ -192,6 +237,7 @@ files:
 - test/cli/commands/test_info.rb
 - test/cli/commands/test_update.rb
 - test/cli/test_cli.rb
+- test/cli/test_error_handler.rb
 - test/cli/test_logger.rb
 - test/data_sources/test_filesystem.rb
 - test/data_sources/test_filesystem_unified.rb