nanoc3 3.0.0 → 3.0.1

data/NEWS.rdoc

@@ -1,5 +1,15 @@
 = nanoc News
 
+== 3.0.1
+
+* The proper exception is now raised when no matching compilation rules can
+  be found
+* The autocompile command no longer has a duplicate --port option
+* The #url_for and #feed_url methods now check the presence of the base_url
+  site configuration attribute
+* Several outdated URLs are now up-to-date
+* Error handling has been improved in general
+
 == 3.0
 
 New:

data/README.rdoc

@@ -10,8 +10,9 @@ Markdown, etc.
 nanoc3's web site, which can be found at http://nanoc.stoneship.org, contains a
 few useful resources to help you get started with nanoc:
 
-* The tutorial at http://nanoc.stoneship.org/help/tutorial
-* The manual at http://nanoc.stoneship.org/help/manual
+* The tutorial at http://nanoc.stoneship.org/tutorial
+* The manual at http://nanoc.stoneship.org/manual
+* The migration guide at http://nanoc.stoneship.org/migrating
 
 It is probably also worth checking out and perhaps subscribing to the
 discussion groups:
@@ -40,7 +41,7 @@ The source code is structured in a few directories:
 
 The namespaces (modules) are organised like this:
 
-* *Nanoc* is the namespace for everything nanoc-related (obviously). The
+* *Nanoc3* is the namespace for everything nanoc-related (obviously). The
   classes in 'lib/nanoc3/base' are part of this module (not Nanoc3::Base which
   does not exist)
   * *CLI* containing everything related to the commandline tool.

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 
 end
 

data/lib/nanoc3/base/errors.rb

@@ -68,8 +68,8 @@ module Nanoc3
     # Error that is raised when no compilation rule that can be applied to the
     # current item can be found.
     class NoMatchingCompilationRuleFound < Generic
-      def initialize(rep)
-        super("No compilation rules were found for the '#{rep.item.identifier}' item (rep '#{rep.name}').")
+      def initialize(item)
+        super("No compilation rules were found for the '#{item.identifier}' item.")
       end
     end
 

data/lib/nanoc3/base/site.rb

@@ -273,7 +273,7 @@ module Nanoc3
       @items.each do |item|
         # Find matching rules
         matching_rules = self.compiler.item_compilation_rules.select { |r| r.applicable_to?(item) }
-        raise Nanoc3::Errors::NoMatchingCompilationRuleFound.new(rep) if matching_rules.empty?
+        raise Nanoc3::Errors::NoMatchingCompilationRuleFound.new(item) if matching_rules.empty?
 
         # Create reps
         rep_names = matching_rules.map { |r| r.rep_name }.uniq

data/lib/nanoc3/cli/base.rb

@@ -43,29 +43,6 @@ module Nanoc3::CLI
           @site = Nanoc3::Site.new('.')
         rescue Nanoc3::Errors::UnknownDataSource => e
           $stderr.puts "Unknown data source: #{e}"
-          exit 1
-        rescue StandardError, ScriptError => error
-          # Header
-          $stderr.puts '+--- /!\ ERROR /!\ -------------------------------------------+'
-          $stderr.puts '| An exception occured while loading the site. If you think   |'
-          $stderr.puts '| this 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
-          $stderr.puts
-          $stderr.puts '=== MESSAGE:'
-          $stderr.puts
-          $stderr.puts "#{error.class}: #{error.message}"
-
-          # Backtrace
-          require 'enumerator'
-          $stderr.puts
-          $stderr.puts '=== BACKTRACE:'
-          $stderr.puts
-          $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
-
           exit 1
         end
       end
@@ -73,6 +50,100 @@ module Nanoc3::CLI
       @site
     end
 
+    # Inherited from ::Cri::Base
+    def run(args)
+      super(args)
+    rescue Interrupt => e
+      exit(1)
+    rescue StandardError, ScriptError => e
+      print_error(e)
+      exit(1)
+    end
+
+    # Prints the given error to stderr. Includes message, possible resolution,
+    # compilation stack, backtrace, etc.
+    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.site && self.site.compiler.stack) || []).empty?
+        $stderr.puts "  (empty)"
+      else
+        self.site.compiler.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
+      require 'enumerator'
+      $stderr.puts
+      $stderr.puts '=== BACKTRACE:'
+      $stderr.puts
+      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
+    end
+
+    # Returns a string containing hints for resolving the given error, or nil
+    # if no resolution can be automatically obtained.
+    def resolution_for(error)
+      # FIXME this should probably go somewhere else so that 3rd-party code can add other gem names too
+      gem_names = {
+        'bluecloth'      => 'bluecloth',
+        'builder'        => 'builder',
+        'coderay'        => 'coderay',
+        'cri'            => 'cri',
+        'erubis'         => 'erubis',
+        'haml'           => 'haml',
+        'json'           => 'json',
+        'less'           => 'less',
+        'markaby'        => 'markaby',
+        'maruku'         => 'maruku',
+        'mime/types'     => 'mime-types',
+        'rack'           => 'rack',
+        'rack/cache'     => 'rack-cache',
+        'rainpress'      => 'rainpress',
+        'rdiscount'      => 'rdiscount',
+        'redcloth'       => 'redcloth',
+        'rubypants'      => 'rubypants',
+        'sass'           => 'sass',
+        'w3c_validators' => 'w3c_validators'
+      }
+
+      case error
+      when LoadError
+        # Get gem name
+        lib_name = error.message.match(/no such file to load -- ([^\s]+)/)[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
+      end
+    end
+
     # 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
     # implement #vcs=).

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

@@ -28,11 +28,6 @@ module Nanoc3::CLI::Commands
 
     def option_definitions
       [
-        # --port
-        {
-          :long => 'port', :short => 'p', :argument => :required,
-          :desc => 'specify a port number for the autocompiler'
-        },
         # --server
         {
           :long => 'server', :short => 's', :argument => :required,

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

@@ -105,11 +105,6 @@ module Nanoc3::CLI::Commands
         print_state_feedback(reps)
         print_profiling_feedback(reps)
       end
-    rescue Interrupt => e
-      exit(1)
-    rescue StandardError, ScriptError => e
-      print_error(e)
-      exit(1)
     end
 
   private
@@ -188,47 +183,6 @@ module Nanoc3::CLI::Commands
       end
     end
 
-    def print_error(error)
-      $stderr.puts
-
-      # Header
-      $stderr.puts '+--- /!\ ERROR /!\ -------------------------------------------+'
-      $stderr.puts '| An exception occured while compiling the site. If you think |'
-      $stderr.puts '| this 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
-      $stderr.puts
-      $stderr.puts '=== MESSAGE:'
-      $stderr.puts
-      $stderr.puts "#{error.class}: #{error.message}"
-
-      # Compilation stack
-      $stderr.puts
-      $stderr.puts '=== COMPILATION STACK:'
-      $stderr.puts
-      if ((@base.site && @base.site.compiler.stack) || []).empty?
-        $stderr.puts "  (empty)"
-      else
-        @base.site.compiler.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
-      require 'enumerator'
-      $stderr.puts
-      $stderr.puts '=== BACKTRACE:'
-      $stderr.puts
-      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
-    end
-
     def rep_compilation_started(rep)
       # Profile compilation
       @rep_times ||= {}

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

@@ -75,7 +75,7 @@ module Nanoc3::CLI::Commands
       data_source.create_layout(
         "<html>\n" +
         "  <head>\n" +
-        "    <title><%= @item.title %></title>\n" +
+        "    <title><%= @item[:title] %></title>\n" +
         "  </head>\n" +
         "  <body>\n" +
         "    <p>Hi, I'm a new layout. Please customize me!</p>\n" +

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

@@ -135,8 +135,8 @@ EOS
     <div id="sidebar">
       <h2>Documentation</h2>
       <ul>
-        <li><a href="http://nanoc.stoneship.org/help/tutorial/">Tutorial</a></li>
-        <li><a href="http://nanoc.stoneship.org/help/manual/">Manual</a></li>
+        <li><a href="http://nanoc.stoneship.org/tutorial/">Tutorial</a></li>
+        <li><a href="http://nanoc.stoneship.org/manual/">Manual</a></li>
       </ul>
       <h2>Community</h2>
       <ul>

data/lib/nanoc3/helpers/blogging.rb

@@ -199,12 +199,22 @@ module Nanoc3::Helpers
     # Returns the URL for the given item. It will return the URL containing
     # the custom path in the feed if possible, otherwise the normal path.
     def url_for(item)
+      # Check attributes
+      if @site.config[:base_url].nil?
+        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
+      end
+
       @site.config[:base_url] + (item[:custom_path_in_feed] || item.reps[0].path)
     end
 
     # Returns the URL of the feed. It will return the custom feed URL if set,
     # or otherwise the normal feed URL.
     def feed_url
+      # Check attributes
+      if @site.config[:base_url].nil?
+        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
+      end
+
       @item[:feed_url] || @site.config[:base_url] + @item.reps[0].path
     end
 

data/lib/nanoc3/helpers/capturing.rb

@@ -33,7 +33,7 @@ module Nanoc3::Helpers
   # this item, the purpose of nanoc is described, blah blah blah,” as
   # expected.
   #
-  # This helper likely only works with ERB (and perhaps Erubis).
+  # This helper has been tested with ERB and Haml.
   #
   # To activate this helper, +include+ it, like this:
   #

data/lib/nanoc3/helpers/filtering.rb

@@ -13,7 +13,7 @@ module Nanoc3::Helpers
   #     <p>Consectetur adipisicing elit...</p>
   #   <% end %>
   #
-  # This helper likely only works with ERB (and perhaps Erubis).
+  # This helper has been tested with ERB and Haml.
   #
   # To activate this helper, +include+ it, like this:
   #

data/lib/nanoc3/package.rb

@@ -64,7 +64,7 @@ module Nanoc3
                                   '... documents into static web pages'
         s.description           = s.summary
         s.homepage              = 'http://nanoc.stoneship.org/'
-        s.rubyforge_project     = 'nanoc3'
+        s.rubyforge_project     = 'nanoc'
 
         s.author                = 'Denis Defreyne'
         s.email                 = 'denis.defreyne@stoneship.org'
@@ -73,8 +73,8 @@ module Nanoc3
 ------------------------------------------------------------------------------
 Thanks for installing nanoc 3.0! Here are some resources to help you get started:
 
-* The tutorial at <http://nanoc.stoneship.org/help/tutorial/>
-* The manual at <http://nanoc.stoneship.org/help/manual/>
+* The tutorial at <http://nanoc.stoneship.org/tutorial/>
+* The manual at <http://nanoc.stoneship.org/manual/>
 * The discussion group at <http://groups.google.com/group/nanoc>
 
 Because nanoc 3.0 has a lot of new features, be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for details about this release.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-14 00:00:00 +02:00
+date: 2009-10-05 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -150,8 +150,8 @@ post_install_message: |
   ------------------------------------------------------------------------------
   Thanks for installing nanoc 3.0! Here are some resources to help you get started:
   
-  * The tutorial at <http://nanoc.stoneship.org/help/tutorial/>
-  * The manual at <http://nanoc.stoneship.org/help/manual/>
+  * The tutorial at <http://nanoc.stoneship.org/tutorial/>
+  * The manual at <http://nanoc.stoneship.org/manual/>
   * The discussion group at <http://groups.google.com/group/nanoc>
   
   Because nanoc 3.0 has a lot of new features, be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for details about this release.
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: nanoc3
+rubyforge_project: nanoc
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3