nanoc3 3.1.0b1 → 3.1.0b2

data/lib/nanoc3.rb

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

data/lib/nanoc3/base/core_ext/string.rb

@@ -9,6 +9,24 @@ module Nanoc3::StringExtensions
     "/#{self}/".gsub(/^\/+|\/+$/, '/')
   end
 
+  # Replaces Unicode characters with their ASCII decompositions if the
+  # environment does not support Unicode.
+  #
+  # This method is not suited for general usage. If you need similar
+  # functionality, consider using the Iconv library instead.
+  #
+  # @return [String] The decomposed string
+  def make_compatible_with_env
+    # Check whether environment supports Unicode
+    # TODO this is ugly, and there most likely are better ways to do this
+    is_unicode_supported = %w( LC_ALL LC_CTYPE LANG ).any? { |e| ENV[e] =~ /UTF/ }
+    return self if is_unicode_supported
+
+    # Decompose if necessary
+    # TODO this decomposition is not generally usable
+    self.gsub(/“|”/, '"').gsub(/‘|’/, '\'').gsub('…', '...')
+  end
+
 end
 
 class String

data/lib/nanoc3/base/dependency_tracker.rb

@@ -27,6 +27,10 @@ module Nanoc3
     # stored
     attr_accessor :filename
 
+    # @return [Array<Nanoc3::Item>] The list of items that is being tracked
+    # by the dependency tracker
+    attr_reader :items
+
     # The version of the file format used to store dependencies.
     STORE_VERSION = 2
 
@@ -217,14 +221,14 @@ module Nanoc3
 
       # Mark successors of outdated items as outdated
       require 'set'
-      processed   = Set.new
       unprocessed = @items.select { |i| i.outdated? }
+      seen        = Set.new(unprocessed)
       until unprocessed.empty?
         item = unprocessed.shift
-        processed << item
 
         self.direct_successors_of(item).each do |successor|
-          next if successor.outdated? || processed.include?(successor)
+          next if seen.include?(successor)
+          seen << successor
 
           successor.outdated_due_to_dependencies = true
           unprocessed << successor
@@ -241,9 +245,7 @@ module Nanoc3
     #
     # @return [void]
     def forget_dependencies_for(item)
-      @graph.vertices.each do |v|
-        @graph.remove_edge(v, item)
-      end
+      @graph.delete_edges_to(item)
     end
 
     # Prints the dependency graph in human-readable form.

data/lib/nanoc3/base/directed_graph.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 
+require 'set'
+
 module Nanoc3
 
   # Represents a directed graph. It is used by the dependency tracker for
-  # storing and querying dependencies between items. Internally, the graph
-  # will be stored as an adjacency matrix. For this, the
-  # {Nanoc3::DirectedGraph::SquareBooleanMatrix} class is used.
+  # storing and querying dependencies between items.
   #
   # @example Creating and using a directed graph
   #
@@ -33,82 +33,6 @@ module Nanoc3
   #     # => %w( b c )
   class DirectedGraph
 
-    # A square matrix that contains boolean values. It is used as an adjacency
-    # matrix by the {Nanoc3::DirectedGraph} class.
-    #
-    # This class is a helper class, which means that it is not used directly
-    # by nanoc. Future versions of nanoc may no longer contain this class. Do
-    # not depend on this class to be available.
-    class SquareBooleanMatrix
-
-      # Creates a new matrix with the given number of rows/columns.
-      #
-      # @param [Number] size The number of elements along both sides of the
-      # matrix (in other words, the square root of the number of elements)
-      def initialize(size)
-        @size = size
-      end
-
-      # Gets the value at the given x/y coordinates.
-      #
-      # @param [Number] x The X coordinate
-      # @param [Number] y The Y coordinate
-      #
-      # @return The value at the given coordinates
-      def [](x, y)
-        @data ||= {}
-        @data[x] ||= {}
-        @data[x].has_key?(y) ? @data[x][y] : false
-      end
-
-      # Sets the value at the given x/y coordinates.
-      #
-      # @param [Number] x The X coordinate
-      # @param [Number] y The Y coordinate
-      # @param value The value to set at the given coordinates
-      #
-      # @return [void]
-      def []=(x, y, value)
-        @data ||= {}
-        @data[x] ||= {}
-        @data[x][y] = value
-      end
-
-      # Returns a string representing this matrix in ASCII art.
-      #
-      # @return [String] The string representation of this matrix
-      def to_s
-        s = ''
-
-        # Calculate column width
-        width = (@size-1).to_s.size
-
-        # Add header
-        s << ' ' + ' '*width + ' '
-        @size.times { |i| s << '| ' + format("%#{width}i", i) + ' ' }
-        s << "\n"
-
-        # Add rows
-        @size.times do |x|
-          # Add line
-          s << '-' + '-'*width + '-'
-          @size.times { |i| s << '+-' + '-'*width + '-' }
-          s << "\n"
-
-          # Add actual row
-          s << ' ' + format("%#{width}i", x)+ ' '
-          @size.times do |y|
-            s << '| ' + format("%#{width}s", self[x, y] ? '*' : ' ') + ' '
-          end
-          s << "\n"
-        end
-
-        # Done
-        s
-      end
-
-    end
-
     # The list of vertices in this graph.
     #
     # @return [Array]
@@ -117,10 +41,16 @@ module Nanoc3
     # Creates a new directed graph with the given vertices.
     def initialize(vertices)
       @vertices = vertices
-      generate_indices
-      invalidate_successor_predecessor_cache
 
-      @matrix = SquareBooleanMatrix.new(@vertices.size)
+      @from_graph = {}
+      @to_graph   = {}
+
+      @vertice_indexes = {}
+      vertices.each_with_index do |v, i|
+        @vertice_indexes[v] = i
+      end
+
+      invalidate_caches
     end
 
     # Adds an edge from the first vertex to the second vertex.
@@ -130,9 +60,13 @@ module Nanoc3
     #
     # @return [void]
     def add_edge(from, to)
-      from_index, to_index = indices_of(from, to)
-      @matrix[from_index, to_index] = true
-      invalidate_successor_predecessor_cache
+      @from_graph[from] ||= Set.new
+      @from_graph[from] << to
+
+      @to_graph[to] ||= Set.new
+      @to_graph[to]  << from
+
+      invalidate_caches
     end
 
     # Removes the edge from the first vertex to the second vertex. If the
@@ -143,9 +77,26 @@ module Nanoc3
     #
     # @return [void]
     def remove_edge(from, to)
-      from_index, to_index = indices_of(from, to)
-      @matrix[from_index, to_index] = false
-      invalidate_successor_predecessor_cache
+      @from_graph[from] ||= Set.new
+      @from_graph[from].delete(to)
+
+      @to_graph[to] ||= Set.new
+      @to_graph[to].delete(from)
+
+      invalidate_caches
+    end
+
+    # Deletes all edges going to the given vertex.
+    #
+    # @param to Vertex to which all edges should be removed
+    #
+    # @return [void]
+    def delete_edges_to(to)
+      @to_graph[to] ||= Set.new
+      @to_graph[to].each do |from|
+        @from_graph[from].delete(to)
+      end
+      @to_graph.delete(to)
     end
 
     # Returns the direct predecessors of the given vertex, i.e. the vertices
@@ -155,12 +106,7 @@ module Nanoc3
     #
     # @return [Array] Direct predecessors of the given vertex
     def direct_predecessors_of(to)
-      @direct_predecessors[to] ||= begin
-        @vertices.select do |from|
-          from_index, to_index = indices_of(from, to)
-          @matrix[from_index, to_index] == true
-        end
-      end
+      @to_graph[to].to_a
     end
 
     # Returns the direct successors of the given vertex, i.e. the vertices y
@@ -170,12 +116,7 @@ module Nanoc3
     #
     # @return [Array] Direct successors of the given vertex
     def direct_successors_of(from)
-      @direct_successors[from] ||= begin
-        @vertices.select do |to|
-          from_index, to_index = indices_of(from, to)
-          @matrix[from_index, to_index] == true
-        end
-      end
+      @from_graph[from].to_a
     end
 
     # Returns the predecessors of the given vertex, i.e. the vertices x for
@@ -204,59 +145,30 @@ module Nanoc3
     # @return [Array] The list of all edges in this graph.
     def edges
       result = []
-
-      @vertices.each do |from|
-        @vertices.each do |to|
-          from_index, to_index = indices_of(from, to)
-          next if @matrix[from_index, to_index] == false
-
-          result << [ from_index, to_index ]
+      @vertices.each_with_index do |v, i|
+        direct_successors_of(v).map { |v2| @vertice_indexes[v2] }.each do |i2|
+          result << [ i, i2 ]
         end
       end
-
       result
     end
 
-    # Returns a string representing this graph in ASCII art (or, to be more
-    # precise, the string representation of the matrix backing this graph).
-    #
-    # @return [String] The string representation of this graph
-    def to_s
-      @matrix.to_s
-    end
-
   private
 
-    # Generates vertex-to-index mapping
-    def generate_indices
-      @indices = {}
-      @vertices.each_with_index do |v, i|
-        @indices[v] = i
-      end
-    end
-
-    # Invalidates the cache that contains successors and predecessors (both
-    # direct and indirect).
-    def invalidate_successor_predecessor_cache
-      @successors          = {}
-      @direct_successors   = {}
-      @predecessors        = {}
-      @direct_predecessors = {}
-    end
-
-    # Returns an array of indices for the given vertices. Raises an error if
-    # one or more given objects are not vertices.
-    def indices_of(*vertices)
-      vertices.map { |v| @indices[v] or raise RuntimeError, "#{v.inspect} not a vertex" }
+    # Invalidates cached data. This method should be called when the internal
+    # graph representation is changed.
+    def invalidate_caches
+      @predecessors = {}
+      @successors   = {}
     end
 
     # Recursively finds vertices, starting at the vertex start, using the
     # given method, which should be a symbol to a method that takes a vertex
     # and returns related vertices (e.g. predecessors, successors).
     def recursively_find_vertices(start, method)
-      all_vertices = []
+      all_vertices = Set.new
 
-      processed_vertices   = []
+      processed_vertices   = Set.new
       unprocessed_vertices = [ start ]
 
       until unprocessed_vertices.empty?
@@ -272,7 +184,7 @@ module Nanoc3
         end
       end
 
-      all_vertices
+      all_vertices.to_a
     end
 
   end

data/lib/nanoc3/base/errors.rb

@@ -16,7 +16,7 @@ module Nanoc3
       # @param [String] data_source_name The data source name for which no
       # data source could be found
       def initialize(data_source_name)
-        super("The data source specified in the site's configuration file, #{data_source_name}, does not exist.")
+        super("The data source specified in the site’s configuration file, “#{data_source_name}”, does not exist.".make_compatible_with_env)
       end
 
     end
@@ -28,7 +28,7 @@ module Nanoc3
       # @param [String] layout_identifier The layout identifier for which no
       # layout could be found
       def initialize(layout_identifier)
-        super("The site does not have a layout with identifier '#{layout_identifier}'.")
+        super("The site does not have a layout with identifier “#{layout_identifier}”.".make_compatible_with_env)
       end
 
     end
@@ -40,7 +40,7 @@ module Nanoc3
       # @param [Symbol] filter_name The filter name for which no filter could
       # be found
       def initialize(filter_name)
-        super("The requested filter, #{filter_name}, does not exist.")
+        super("The requested filter, “#{filter_name}”, does not exist.".make_compatible_with_env)
       end
 
     end
@@ -53,7 +53,7 @@ module Nanoc3
       # @param [String] layout_identifier The identifier of the layout for
       # which the filter could not be determined
       def initialize(layout_identifier)
-        super("The filter to be used for the '#{layout_identifier}' could not be determined. Make sure the layout does have a filter.")
+        super("The filter to be used for the “#{layout_identifier}” layout could not be determined. Make sure the layout does have a filter.".make_compatible_with_env)
       end
 
     end
@@ -70,7 +70,7 @@ module Nanoc3
       # example, if the given type is `"site"`, plural would be `false`; if
       # the given type is `"items"`, plural would be `true`.
       def initialize(type, plural)
-        super("#{type} #{plural ? 'are' : 'is'} not available yet. You may be missing a Nanoc3::Site#load_data call.")
+        super("#{type} #{plural ? 'are' : 'is'} not available yet. You may be missing a Nanoc3::Site#load_data call.".make_compatible_with_env)
       end
 
     end
@@ -82,7 +82,7 @@ module Nanoc3
       # @param [Array<Nanoc3::ItemRep>] reps A list of item representations
       # that mutually depend on each other
       def initialize(reps)
-        super("The site cannot be compiled because the following items mutually depend on each other: #{reps.inspect}.")
+        super("The site cannot be compiled because the following items mutually depend on each other: #{reps.inspect}.".make_compatible_with_env)
       end
 
     end
@@ -92,7 +92,7 @@ module Nanoc3
     class NoRulesFileFound < Generic
 
       def initialize
-        super("This site does not have a rules file, which is required for nanoc sites.")
+        super("This site does not have a rules file, which is required for nanoc sites.".make_compatible_with_env)
       end
 
     end
@@ -104,7 +104,7 @@ module Nanoc3
       # @param [Nanoc3::Item] item The item for which no compilation rule
       # could be found
       def initialize(item)
-        super("No compilation rules were found for the '#{item.identifier}' item.")
+        super("No compilation rules were found for the “#{item.identifier}” item.".make_compatible_with_env)
       end
 
     end
@@ -116,7 +116,7 @@ module Nanoc3
       # @param [Nanoc3::Item] item The item for which no routing rule could be
       # found
       def initialize(rep)
-        super("No routing rules were found for the '#{rep.item.identifier}' item (rep '#{rep.name}').")
+        super("No routing rules were found for the “#{rep.item.identifier}” item (rep “#{rep.name}”).".make_compatible_with_env)
       end
 
     end
@@ -133,7 +133,7 @@ module Nanoc3
       # compiled
       def initialize(rep)
         @rep = rep
-        super("The '#{rep.item.identifier}' item (rep '#{rep.name}') cannot currently be compiled yet due to an unmet dependency.")
+        super("The “#{rep.item.identifier}” item (rep “#{rep.name}”) cannot currently be compiled yet due to an unmet dependency.".make_compatible_with_env)
       end
 
     end
@@ -144,7 +144,7 @@ module Nanoc3
       # @param [Nanoc3::ItemRep] The item representation that was attempted to
       # be laid out
       def initialize(rep)
-        super("The '#{rep.item.identifier}' item (rep '#{rep.name}') cannot be laid out because it is a binary item.")
+        super("The “{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item.".make_compatible_with_env)
       end
 
     end
@@ -158,7 +158,7 @@ module Nanoc3
       #
       # @param [Class] filter_class The filter class that was used
       def initialize(rep, filter_class)
-        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because textual filters cannot be used on binary items.")
+        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because textual filters cannot be used on binary items.".make_compatible_with_env)
       end
 
     end
@@ -172,7 +172,7 @@ module Nanoc3
       #
       # @param [Class] filter_class The filter class that was used
       def initialize(rep, filter_class)
-        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items.")
+        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items.".make_compatible_with_env)
       end
 
     end

data/lib/nanoc3/base/filter.rb

@@ -94,7 +94,7 @@ module Nanoc3
     #
     # @param [String] content_or_filename The unprocessed content that should
     # be filtered (if the item is a textual item) or the path to the file that
-    # should be fitlered (if the item is a binar item)
+    # should be fitlered (if the item is a binary item)
     #
     # @param [Hash] params A hash containing parameters. Filter subclasses can
     # use these parameters to allow modifying the filter's behaviour.

data/lib/nanoc3/base/item.rb

@@ -111,14 +111,16 @@ module Nanoc3
     # from which the compiled content should be fetched. By default, the
     # compiled content will be fetched from the default representation.
     #
-    # @option params [String] :snapshot (:last) The name of the snapshot from
-    # which to fetch the compiled content. By default, the fully compiled
-    # content will be fetched, with all filters and layouts applied--not the
-    # pre-layout content.
+    # @option params [String] :snapshot The name of the snapshot from which to
+    # fetch the compiled content. By default, the returned compiled content
+    # will be the content compiled right before the first layout call (if
+    # any).
     #
     # @return [String] The compiled content of the given rep (or the default
     # rep if no rep is specified) at the given snapshot (or the default
     # snapshot if no snapshot is specified)
+    #
+    # @see ItemRep#compiled_content
     def compiled_content(params={})
       # Get rep
       rep_name = params[:rep] || :default

data/lib/nanoc3/base/item_rep.rb

@@ -192,6 +192,11 @@ module Nanoc3
         snapshot_name ||= :last
       end
 
+      # Check presence of snapshot
+      if @content[snapshot_name].nil?
+        warn "WARNING: The “#{self.item.identifier}” item (rep “#{self.name}”) does not have the requested snapshot named #{snapshot_name.inspect}.\n\n* Make sure that you are requesting the correct snapshot.\n* It is not possible to request the compiled content of a binary item representation; if this item is marked as binary even though you believe it should be textual, you may need to add the extension of this item to the site configuration’s `text_extensions` array.".make_compatible_with_env
+      end
+
       # Get content
       @content[snapshot_name]
     end
@@ -333,6 +338,9 @@ module Nanoc3
         File.open(self.raw_path, 'w') { |io| io.write(@content[:last]) }
         @written = true
 
+        # Generate diff
+        generate_diff
+
         # Check if file was modified
         @modified = File.read(self.raw_path) != @old_content
       end
@@ -346,20 +354,18 @@ module Nanoc3
     # content in `diff(1)` format, or nil if there is no previous compiled
     # content
     def diff
-      # Check if content can be diffed
       # TODO allow binary diffs
-      return nil if self.binary?
 
-      # Check if old content exists
-      if @old_content.nil? or self.raw_path.nil?
+      if self.binary?
         nil
       else
-        diff_strings(@old_content, @content[:last])
+         @diff_thread.join if @diff_thread
+        @diff
       end
     end
 
     def inspect
-      "<#{self.class}:0x#{self.object_id.to_s(16)} name=#{self.name} binary=#{self.binary?} item.identifier=#{self.item.identifier}>"
+      "<#{self.class}:0x#{self.object_id.to_s(16)} name=#{self.name} binary=#{self.binary?} raw_path=#{self.raw_path} item.identifier=#{self.item.identifier}>"
     end
 
   private
@@ -390,6 +396,18 @@ module Nanoc3
       [ filter, filter_name, filter_args ]
     end
 
+    def generate_diff
+      if @old_content.nil? or self.raw_path.nil?
+        @diff = nil
+      else
+        @diff_thread = Thread.new do
+          @diff = diff_strings(@old_content, @content[:last])
+          sleep 2
+          @diff_thread = nil
+        end
+      end
+    end
+
     def diff_strings(a, b)
       # TODO Rewrite this string-diffing method in pure Ruby. It should not
       # use the "diff" executable, because this will most likely not work on
@@ -406,9 +424,11 @@ module Nanoc3
           new_file.write(b)
 
           # Diff
-          stdin, stdout, stderr = Open3.popen3('diff', '-u', old_file.path, new_file.path)
-          result = stdout.read
-          result == '' ? nil : result
+          cmd = [ 'diff', '-u', old_file.path, new_file.path ]
+          Open3.popen3(*cmd) do |stdin, stdout, stderr|
+            result = stdout.read
+            return (result == '' ? nil : result)
+          end
         end
       end
     rescue Errno::ENOENT

data/lib/nanoc3/base/site.rb

@@ -28,7 +28,7 @@ module Nanoc3
     # The default configuration for a data source. A data source's
     # configuration overrides these options.
     DEFAULT_DATA_SOURCE_CONFIG = {
-      :type         => 'filesystem_compact',
+      :type         => 'filesystem_unified',
       :items_root   => '/',
       :layouts_root => '/',
       :config       => {}
@@ -161,8 +161,8 @@ module Nanoc3
       return if instance_variable_defined?(:@data_loaded) && @data_loaded && !force
 
       # Load all data
-      data_sources.each { |ds| ds.use }
       load_code_snippets(force)
+      data_sources.each { |ds| ds.use }
       load_rules
       load_items
       load_layouts
@@ -230,7 +230,7 @@ module Nanoc3
       @code_snippets = Dir['lib/**/*.rb'].sort.map do |filename|
         Nanoc3::CodeSnippet.new(
           File.read(filename),
-          filename.sub(/^lib\//, ''),
+          filename,
           File.stat(filename).mtime
         )
       end
@@ -252,7 +252,7 @@ module Nanoc3
       @rules_mtime = File.stat(rules_filename).mtime
 
       # Load DSL
-      dsl.instance_eval(@rules)
+      dsl.instance_eval(@rules, "./#{rules_filename}")
     end
 
     # Loads this site’s items, sets up item child-parent relationships and

data/lib/nanoc3/cli/base.rb

@@ -203,8 +203,10 @@ module Nanoc3::CLI
     def handle_option(option)
       case option
       when :version
+        gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : "without RubyGems"
+
         puts "nanoc #{Nanoc3::VERSION} (c) 2007-2010 Denis Defreyne."
-        puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM}"
+        puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM} #{gem_info}"
         exit 0
       when :verbose
         Nanoc3::CLI::Logger.instance.level = :low

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

@@ -4,6 +4,56 @@ module Nanoc3::CLI::Commands
 
   class CreateSite < Cri::Command
 
+    class << self
+
+    protected
+
+      # Converts the given array to YAML format
+      def array_to_yaml(array)
+        '[ ' + array.map { |s| "'" + s + "'" }.join(', ') + ' ]'
+      end
+
+    end
+
+    DEFAULT_CONFIG = <<EOS
+# A list of file extensions that nanoc will consider to be textual rather than
+# binary. If an item with an extension not in this list is found,  the file
+# will be considered as binary.
+text_extensions: #{array_to_yaml(Nanoc3::Site::DEFAULT_CONFIG[:text_extensions])}
+
+# The path to the directory where all generated files will be written to. This
+# can be an absolute path starting with a slash, but it can also be path
+# relative to the site directory.
+output_dir: #{Nanoc3::Site::DEFAULT_CONFIG[:output_dir]}
+
+# A list of index filenames, i.e. names of files that will be served by a web
+# server when a directory is requested. Usually, index files are named
+# “index.hml”, but depending on the web server, this may be something else,
+# such as “default.htm”. This list is used by nanoc to generate pretty URLs.
+index_filenames: #{array_to_yaml(Nanoc3::Site::DEFAULT_CONFIG[:index_filenames])}
+
+# The data sources where nanoc loads its data from. This is an array of
+# hashes; each array element represents a single data source. By default,
+# there is only a single data source that reads data from the “content/” and
+# “layout/” directories in the site directory.
+data_sources:
+  -
+    # The type is the identifier of the data source. By default, this will be
+    # `filesystem_unified`.
+    type: #{Nanoc3::Site::DEFAULT_DATA_SOURCE_CONFIG[:type]}
+
+    # The path where items should be mounted (comparable to mount points in
+    # Unix-like systems). This is “/” by default, meaning that items will have
+    # “/” prefixed to their identifiers. If the items root were “/en/”
+    # instead, an item at content/about.html would have an identifier of
+    # “/en/about/” instead of just “/about/”.
+    items_root: #{Nanoc3::Site::DEFAULT_DATA_SOURCE_CONFIG[:items_root]}
+
+    # The path where layouts should be mounted. The layouts root behaves the
+    # same as the items root, but applies to layouts rather than items.
+    layouts_root: #{Nanoc3::Site::DEFAULT_DATA_SOURCE_CONFIG[:layouts_root]}
+EOS
+
     DEFAULT_RULES = <<EOS
 #!/usr/bin/env ruby
 
@@ -262,18 +312,7 @@ EOS
       FileUtils.mkdir_p('output')
 
       # Create config
-      File.open('config.yaml', 'w') do |io|
-        io.write(YAML.dump(
-          'output_dir' => 'output',
-          'data_sources' => [
-            {
-              'type'         => data_source,
-              'items_root'   => '/',
-              'layouts_root' => '/'
-            }
-          ]
-        ))
-      end
+      File.open('config.yaml', 'w') { |io| io.write(DEFAULT_CONFIG.make_compatible_with_env) }
       Nanoc3::NotificationCenter.post(:file_created, 'config.yaml')
 
       # Create rakefile
@@ -284,7 +323,7 @@ EOS
 
       # Create rules
       File.open('Rules', 'w') do |io|
-        io.write DEFAULT_RULES
+        io.write DEFAULT_RULES.make_compatible_with_env
       end
       Nanoc3::NotificationCenter.post(:file_created, 'Rules')
     end
@@ -310,14 +349,14 @@ EOS
 
       # Create home page
       data_source.create_item(
-        DEFAULT_ITEM,
+        DEFAULT_ITEM.make_compatible_with_env,
         { :title => "Home" },
         '/'
       )
 
       # Create stylesheet
       data_source.create_item(
-        DEFAULT_STYLESHEET,
+        DEFAULT_STYLESHEET.make_compatible_with_env,
         {},
         '/stylesheet/',
         :extension => '.css'
@@ -325,7 +364,7 @@ EOS
 
       # Create layout
       data_source.create_layout(
-        DEFAULT_LAYOUT,
+        DEFAULT_LAYOUT.make_compatible_with_env,
         {},
         '/default/'
       )

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

@@ -42,27 +42,34 @@ module Nanoc3::CLI::Commands
       reps    = items.map { |i| i.reps }.flatten
       layouts = @base.site.layouts
 
-      # Calculate prettification data
-      identifier_length = items.map { |i| i.identifier.size }.max
-      rep_name_length   = reps.map  { |r| r.name.size }.max
+      # Get dependency tracker
+      # FIXME clean this up
+      dependency_tracker = @base.site.compiler.send(:dependency_tracker)
+      dependency_tracker.load_graph
 
       # Print items
       puts '=== Items'
       puts
       row = 0
       items.sort_by { |i| i.identifier }.each do |item|
+        puts "item #{item.identifier}:"
+
+        # Print item dependencies
+        puts "  dependencies:"
+        predecessors = dependency_tracker.direct_predecessors_of(item).sort_by { |i| i.identifier }
+        predecessors.each do |pred|
+          puts "    #{pred.identifier}"
+        end
+        puts "    (nothing)" if predecessors.empty?
+
+        # Print item representations
+        puts "  representations:"
         item.reps.sort_by { |r| r.name.to_s }.each do |rep|
-          # Determine filler
-          filler = (row % 3 == 0 ? '· ' : ' ')
-          row += 1
-
-          # Print rep
-          puts "* %s %s -> %s" % [
-            fill(item.identifier, identifier_length, filler),
-            fill(rep.name.to_s,   rep_name_length,   ' '),
-            rep.raw_path || '-'
-          ]
+          puts "    #{rep.name} -> #{rep.raw_path || '(not written)'}"
         end
+
+        # Done
+        puts
       end
       puts
 
@@ -70,31 +77,10 @@ module Nanoc3::CLI::Commands
       puts '=== Layouts'
       puts
       layouts.each do |layout|
-        puts "* #{layout.identifier}"
+        puts "layout #{layout.identifier}"
       end
     end
 
-  private
-
-    # Returns a string that is exactly `length` long, starting with `text` and
-    # filling up any unused space by repeating the string `filler`.
-    def fill(text, length, filler)
-      res = text.dup
-
-      filler_length = (length - 1 - text.length)
-      if filler_length >= 0
-        # Append spacer to ensure alignment
-        spacer_length = text.size % filler.length
-        filler_length -= spacer_length
-        res << ' ' * (spacer_length + 1)
-
-        # Append leader
-        res << filler*(filler_length/filler.length)
-      end
-
-      res
-    end
-
   end
 
 end

data/lib/nanoc3/extra/auto_compiler.rb

@@ -43,23 +43,25 @@ module Nanoc3::Extra
             r.raw_path == site.config[:output_dir] + path
         end
 
-        if rep
-          serve(rep)
+        # Recompile rep
+        site.compiler.run(rep.item) if rep
+
+        # Get paths by appending index filenames
+        if path =~ /\/$/
+          possible_paths = site.config[:index_filenames].map { |f| path + f }
         else
-          # Get paths by appending index filenames
-          if path =~ /\/$/
-            possible_paths = site.config[:index_filenames].map { |f| path + f }
-          else
-            possible_paths = [ path ]
-          end
-
-          # Find matching file
-          modified_path = possible_paths.find { |f| File.file?(site.config[:output_dir] + f) }
-          modified_path ||= path
-
-          # Serve using Rack::File
-          file_server.call(env.merge('PATH_INFO' => modified_path))
+          possible_paths = [ path ]
         end
+
+        # Find matching file
+        modified_path = possible_paths.find { |f| File.file?(site.config[:output_dir] + f) }
+        modified_path ||= path
+
+        # Serve using Rack::File
+        puts "*** serving file #{modified_path}"
+        res = file_server.call(env.merge('PATH_INFO' => modified_path))
+        puts "*** done serving file #{modified_path}"
+        res
       end
     rescue StandardError, ScriptError => e
       # Add compilation stack to env
@@ -92,18 +94,6 @@ module Nanoc3::Extra
       @file_server ||= ::Rack::File.new(site.config[:output_dir])
     end
 
-    def serve(rep)
-      # Recompile rep
-      site.compiler.run(rep.item, :force => true)
-
-      # Build response
-      [
-        200,
-        { 'Content-Type' => mime_type_of(rep.raw_path, 'text/html') },
-        [ rep.content_at_snapshot(:last) ]
-      ]
-    end
-
   end
 
 end

data/lib/nanoc3/filters/bluecloth.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class BlueCloth < Nanoc3::Filter
 
+    # Runs the content through [BlueCloth](http://deveiate.org/projects/BlueCloth).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'bluecloth'
 

data/lib/nanoc3/filters/coderay.rb

@@ -3,9 +3,13 @@
 module Nanoc3::Filters
   class CodeRay < Nanoc3::Filter
 
+    # @deprecated Use the `:colorize_syntax` filter instead.
     def run(content, params={})
       require 'coderay'
 
+      # Warn
+      warn 'The :coderay filter is deprecated; consider using the :colorize_syntax filter instead.'
+
       # Check params
       raise ArgumentError, "CodeRay filter requires a :language argument which is missing" if params[:language].nil?
 

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -3,8 +3,44 @@
 module Nanoc3::Filters
   class ColorizeSyntax < Nanoc3::Filter
 
+    # The default colorizer to use for a language if the colorizer for that
+    # language is not overridden.
     DEFAULT_COLORIZER = :coderay
 
+    # Syntax-highlights code blocks in the given content. Code blocks should
+    # be enclosed in `pre` elements that contain a `code` element. The code
+    # element should have a class starting with `language-` and followed by
+    # the programming language, as specified by HTML5.
+    #
+    # Options for individual colorizers will be taken from the {#run}
+    # options’ value for the given colorizer. For example, if the filter is
+    # invoked with a `:coderay => coderay_options_hash` option, the
+    # `coderay_options_hash` hash will be passed to the CodeRay colorizer.
+    #
+    # Currently, only the `:coderay` and `:pygmentize` colorizers are
+    # implemented. Additional colorizer implementations are welcome!
+    #
+    # @example Content that will be highlighted
+    #
+    #     <pre><code class="language-ruby">
+    #     def foo
+    #       "asdf"
+    #     end
+    #     </code></pre>
+    #
+    # @example Invoking the filter with custom parameters
+    #
+    #     filter :colorize_syntax,
+    #            :colorizers => { :ruby => :coderay },
+    #            :coderay    => { :line_numbers => :list }
+    #
+    # @param [String] content The content to filter
+    #
+    # @option params [Hash] :colorizers (DEFAULT_COLORIZER) A hash containing
+    #   a mapping of programming languages (symbols, not strings) onto
+    #   colorizers (symbols).
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'nokogiri'
 

data/lib/nanoc3/filters/erb.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class ERB < Nanoc3::Filter
 
+    # Runs the content through [ERB](http://ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'erb'
 

data/lib/nanoc3/filters/erubis.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Erubis < Nanoc3::Filter
 
+    # Runs the content through [Erubis](http://www.kuwata-lab.com/erubis/).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'erubis'
 

data/lib/nanoc3/filters/haml.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Haml < Nanoc3::Filter
 
+    # Runs the content through [Haml](http://haml-lang.com/).
+    # Parameters passed to this filter will be passed on to Haml.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'haml'
 

data/lib/nanoc3/filters/kramdown.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Kramdown < Nanoc3::Filter
 
+    # Runs the content through [Kramdown](http://kramdown.rubyforge.org/).
+    # Parameters passed to this filter will be passed on to Kramdown.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'kramdown'
 

data/lib/nanoc3/filters/less.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Less < Nanoc3::Filter
 
+    # Runs the content through [LESS](http://lesscss.org/).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'less'
 

data/lib/nanoc3/filters/markaby.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Markaby < Nanoc3::Filter
 
+    # Runs the content through [Markaby](http://markaby.rubyforge.org/).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'markaby'
 

data/lib/nanoc3/filters/maruku.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Maruku < Nanoc3::Filter
 
+    # Runs the content through [Maruku](http://maruku.rubyforge.org/).
+    # Parameters passed to this filter will be passed on to Maruku.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'maruku'
 

data/lib/nanoc3/filters/rainpress.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Rainpress < Nanoc3::Filter
 
+    # Runs the content through [Rainpress](http://code.google.com/p/rainpress/).
+    # Parameters passed to this filter will be passed on to Rainpress.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'rainpress'
 

data/lib/nanoc3/filters/rdiscount.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class RDiscount < Nanoc3::Filter
 
+    # Runs the content through [RDiscount](http://github.com/rtomayko/rdiscount).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'rdiscount'
 

data/lib/nanoc3/filters/rdoc.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class RDoc < Nanoc3::Filter
 
+    # Runs the content through [RDoc::Markup](http://rdoc.rubyforge.org/RDoc/Markup.html).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       begin
         # new RDoc

data/lib/nanoc3/filters/redcloth.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class RedCloth < Nanoc3::Filter
 
+    # Runs the content through [RedCloth](http://redcloth.org/).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'redcloth'
 

data/lib/nanoc3/filters/relativize_paths.rb

@@ -6,11 +6,23 @@ module Nanoc3::Filters
     require 'nanoc3/helpers/link_to'
     include Nanoc3::Helpers::LinkTo
 
+    # Relativizes all paths in the given content, which can be either HTML or
+    # CSS. This filter is quite useful if a site needs to be hosted in a
+    # subdirectory instead of a subdomain. In HTML, all `href` and `src`
+    # attributes will be relativized. In CSS, all `url()` references will be
+    # relativized.
+    #
+    # @param [String] content The content to filter
+    #
+    # @option params [Symbol] :type The type of content to filter; can be either `:html` or `:css`.
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       # Set assigns so helper function can be used
       @item_rep = assigns[:item_rep] if @item_rep.nil?
 
       # Filter
+      # TODO use nokogiri or csspool instead of regular expressions
       case params[:type]
       when :html
         content.gsub(/(<[^>]+\s+(src|href))=(['"]?)(\/.*?)\3([ >])/) do

data/lib/nanoc3/filters/rubypants.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class RubyPants < Nanoc3::Filter
 
+    # Runs the content through [RubyPants](http://chneukirchen.org/blog/static/projects/rubypants.html).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'rubypants'
 

data/lib/nanoc3/filters/sass.rb

@@ -3,6 +3,12 @@
 module Nanoc3::Filters
   class Sass < Nanoc3::Filter
 
+    # Runs the content through [Sass](http://sass-lang.com/).
+    # Parameters passed to this filter will be passed on to Sass.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
     def run(content, params={})
       require 'sass'
 

data/lib/nanoc3/helpers/blogging.rb

@@ -64,6 +64,11 @@ module Nanoc3::Helpers
     #   non-outputted items in a feed; such items could have their custom feed
     #   path set to the blog path instead, for example.
     #
+    # * `custom_url_in_feed` — The url that will be used instead of the
+    #   normal url in the feed (generated from the site’s base url + the item
+    #   rep’s path). This can be useful when building a link-blog where the
+    #   URL of article is a remote location.
+    #
     # * `updated_at` — The time when the article was last modified. If this
     #   attribute is not present, the `created_at` attribute will be used as
     #   the time when the article was last modified.
@@ -255,12 +260,14 @@ module Nanoc3::Helpers
         raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
       end
 
-      # Get path
-      path = item[:custom_path_in_feed] || item.path
-      return nil if path.nil?
-
       # Build URL
-      @site.config[:base_url] + path
+      if item[:custom_url_in_feed]
+        item[:custom_url_in_feed]
+      elsif item[:custom_path_in_feed]
+        @site.config[:base_url] + item[:custom_path_in_feed]
+      elsif item.path
+        @site.config[:base_url] + item.path
+      end
     end
 
     # Returns the URL of the feed. It will return the custom feed URL if set,

data/lib/nanoc3/helpers/breadcrumbs.rb

@@ -15,17 +15,24 @@ module Nanoc3::Helpers
     # @return [Array] The breadcrumbs, starting with the root item and ending
     # with the item itself
     def breadcrumbs_trail
-      trail = []
-      current_identifier = @item.identifier
-
-      loop do
-        item = @items.find { |i| i.identifier == current_identifier }
-        trail.unshift(item)
-        break if current_identifier == '/'
-        current_identifier = current_identifier.sub(/[^\/]+\/$/, '')
+      breadcrumbs_for_identifier(@item.identifier)
+    end
+
+    def item_with_identifier(identifier)
+      @identifier_cache ||= {}
+      @identifier_cache[identifier] ||= begin
+        @items.find { |i| i.identifier == identifier }
       end
+    end
 
-      trail
+    def breadcrumbs_for_identifier(identifier)
+      @breadcrumbs_cache ||= {}
+      @breadcrumbs_cache[identifier] ||= begin
+        head = (identifier == '/' ? [] :  breadcrumbs_for_identifier(identifier.sub(/[^\/]+\/$/, '')) )
+        tail = [ item_with_identifier(identifier) ]
+
+        head + tail
+      end
     end
 
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 1
-  - 0b1
-  version: 3.1.0b1
+  - 0b2
+  version: 3.1.0b2
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +01:00
+date: 2010-03-22 00:00:00 +01:00
 default_executable: nanoc3
 dependencies: 
 - !ruby/object:Gem::Dependency