nanoc3 3.0.1 → 3.0.2

data/NEWS.rdoc

@@ -1,5 +1,12 @@
 = nanoc News
 
+== 3.0.2
+
+* Children-only identifier patterns no longer erroneously also match parent
+  (e.g. /foo/*/ no longer matches /foo/)
+* The create_site command no longer uses those ugly HTML entities
+* Install message now mentions the IRC channel
+
 == 3.0.1
 
 * The proper exception is now raised when no matching compilation rules can

data/lib/nanoc3.rb

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

data/lib/nanoc3/base/compiler.rb.orig

@@ -0,0 +1,250 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # Nanoc3::Compiler is responsible for compiling a site's item
+  # representations.
+  class Compiler
+
+    # The compilation stack. When the compiler begins compiling a rep or a
+    # layout, it will be placed on the stack; when it is done compiling the
+    # rep or layout, it will be removed from the stack.
+    attr_reader :stack
+
+    # The list of compilation rules that will be used to compile items. This
+    # array will be filled by Nanoc3::Site#load_data.
+    attr_reader :item_compilation_rules
+
+    # The list of routing rules that will be used to give all items a path.
+    # This array will be filled by Nanoc3::Site#load_data.
+    attr_reader :item_routing_rules
+
+    # The hash containing layout-to-filter mapping rules.
+    attr_reader :layout_filter_mapping
+
+    # Creates a new compiler for the given site.
+    def initialize(site)
+      @site = site
+
+      @stack = []
+
+      @item_compilation_rules  = []
+      @item_routing_rules      = []
+      @layout_filter_mapping   = {}
+    end
+
+    # Compiles (part of) the site and writes out the compiled item
+    # representations.
+    #
+    # +items+:: The items that should be compiled, along with their
+    #           dependencies. Pass +nil+ if the entire site should be
+    #           compiled.
+    #
+    # This method also accepts a few optional parameters:
+    #
+    # +:force+:: true if the rep should be compiled even if it is not
+    #            outdated, false if not. Defaults to false.
+    def run(item=nil, params={})
+      # Create output directory if necessary
+      FileUtils.mkdir_p(@site.config[:output_dir])
+
+      # Load dependencies
+      dependency_tracker.load_graph
+      print_dependency_graph if $DEBUG
+
+      # Get items and reps to compile
+      if item
+        items = [ item ] + dependency_tracker.all_inverse_dependencies_for(item)
+        items.uniq!
+      else
+        items = @site.items
+      end
+      reps = items.map { |i| i.reps }.flatten
+
+      # Prepare dependencies
+      remember_old_dependencies
+      @old_dep_graph = dependency_tracker.instance_eval { @graph }.dup
+      mark_outdated_items(reps, params.has_key?(:force) && params[:force])
+      forget_dependencies_if_outdated(items)
+
+      # Compile reps
+      dependency_tracker.start
+      compile_reps(reps)
+      dependency_tracker.stop
+
+      # Store dependencies
+      dependency_tracker.store_graph
+    end
+
+    # Returns the first matching compilation rule for the given rep.
+    def compilation_rule_for(rep)
+      @item_compilation_rules.find do |rule|
+        rule.applicable_to?(rep.item) && rule.rep_name == rep.name
+      end
+    end
+
+    # Returns the first matching routing rule for the given rep.
+    def routing_rule_for(rep)
+      @item_routing_rules.find do |rule|
+        rule.applicable_to?(rep.item) && rule.rep_name == rep.name
+      end
+    end
+
+    # Returns a tuple containing the filter name and the filter arguments for
+    # the given layout.
+    def filter_for_layout(layout)
+      @layout_filter_mapping.each_pair do |layout_identifier, filter_name_and_args|
+        return filter_name_and_args if layout.identifier =~ layout_identifier
+      end
+      nil
+    end
+
+  private
+
+    # Compiles all item representations in the site.
+    def compile_reps(reps)
+      active_reps, skipped_reps = reps.partition { |rep| rep.outdated? || rep.item.dependencies_outdated? }
+      inactive_reps = []
+      compiled_reps = []
+
+      # Repeat as long as something is successfully compiled...
+      changed = true
+      until !changed
+        changed = false
+
+        # Sort by increasing number of inverse dependencies to speed up compilation
+        #active_reps = active_reps.sort_by { |r| dependency_tracker.all_dependencies_for(r.item).size }
+        # 10.times { puts '=' * 80 }
+        # active_reps.each do |r|
+        #   puts r.item.identifier + ' => ' + dependency_tracker.all_dependencies_for(r.item).size.to_s
+        # end
+        # 10.times { puts '=' * 80 }
+
+        # Attempt to compile all active reps
+        until active_reps.empty?
+          @stack.clear
+          begin
+            rep = active_reps.shift
+            puts "*** Attempting to compile #{rep.inspect}" if $DEBUG
+
+            @stack.push(rep)
+            compile_rep(rep)
+          rescue Nanoc3::Errors::UnmetDependency => e
+            puts "*** Attempt failed due to unmet dependency on #{e.rep.inspect}" if $DEBUG
+
+            # Save rep to compile it later
+            inactive_reps << rep
+
+            # Add dependency to list of items to compile
+            unless active_reps.include?(e.rep) || inactive_reps.include?(e.rep)
+              changed = true
+              skipped_reps.delete(e.rep)
+              inactive_reps.unshift(e.rep)
+            end
+
+            # Assume that this page has more dependencies and add those
+            @old_dependencies[rep.item].each do |i|
+              i.reps.each do |r|
+                next if active_reps.include?(r)
+                next if compiled_reps.include?(r)
+                next if inactive_reps.include?(r)
+
+                inactive_reps.unshift(r)
+              end
+            end
+          else
+            puts "*** Attempt succeeded" if $DEBUG
+
+            changed = true
+            compiled_reps << rep
+          end
+          puts if $DEBUG
+        end
+
+        # Retry
+        puts "*** No active reps left; activating all (#{inactive_reps.size}) inactive reps" if $DEBUG
+        puts if $DEBUG
+        active_reps   = inactive_reps
+        inactive_reps = []
+      end
+
+      # Notify skipped reps
+      skipped_reps.each do |rep|
+        Nanoc3::NotificationCenter.post(:compilation_started, rep)
+        Nanoc3::NotificationCenter.post(:compilation_ended,   rep)
+      end
+
+      # Raise error if some active but non-compileable reps are left
+      if !active_reps.empty?
+        raise Nanoc3::Errors::RecursiveCompilation.new(active_reps)
+      end
+    end
+
+    # Compiles the given item representation.
+    #
+    # This method should not be called directly; please use
+    # Nanoc3::Compiler#run instead, and pass this item representation's item as
+    # its first argument.
+    #
+    # +rep+:: The rep that is to be compiled.
+    def compile_rep(rep)
+      # Start
+      Nanoc3::NotificationCenter.post(:compilation_started, rep)
+      Nanoc3::NotificationCenter.post(:visit_started,       rep.item)
+
+      # Apply matching rule
+      compilation_rule_for(rep).apply_to(rep)
+      rep.compiled = true
+
+      # Write if rep is routed
+      rep.write unless rep.raw_path.nil?
+
+      # Stop
+      Nanoc3::NotificationCenter.post(:visit_ended,       rep.item)
+      Nanoc3::NotificationCenter.post(:compilation_ended, rep)
+    end
+
+    # Returns the dependency tracker for this site.
+    def dependency_tracker
+      @dependency_tracker ||= Nanoc3::DependencyTracker.new(@site.items)
+    end
+
+    # Marks the necessary items as outdated.
+    def mark_outdated_items(reps, force)
+      if force
+        reps.each { |r| r.force_outdated = true }
+      else
+        dependency_tracker.mark_outdated_items
+      end
+    end
+
+    # Clears the list of dependencies for items that will be recompiled.
+    def forget_dependencies_if_outdated(items)
+      items.each do |i|
+        if i.outdated? || i.dependencies_outdated?
+          dependency_tracker.forget_dependencies_for(i)
+        end
+      end
+    end
+
+    def remember_old_dependencies
+      @old_dependencies = dependency_tracker.instance_eval { @graph }.dup
+    end
+
+    # Prints the dependency graph.
+    def print_dependency_graph
+      graph = dependency_tracker.instance_eval { @graph }
+      puts "DEPENDENCY GRAPH:"
+      graph.each_pair do |key, values|
+        puts "#{key.inspect} depends on:"
+        values.each do |value|
+          puts "    #{value.inspect}"
+        end
+        puts "    (nothing!)" if values.empty?
+        puts
+      end
+    end
+
+  end
+
+end

data/lib/nanoc3/base/compiler_dsl.rb

@@ -99,7 +99,12 @@ module Nanoc3
     # For example, 'foo/*/bar' is transformed into /^foo\/(.*?)\/bar$/.
     def identifier_to_regex(identifier)
       if identifier.is_a? String
-        /^#{identifier.cleaned_identifier.gsub('*', '(.*?)')}?$/
+        # Add leading/trailing slashes if necessary
+        new_identifier = identifier.dup
+        new_identifier[/^/] = '/' if identifier[0,1] != '/'
+        new_identifier[/$/] = '/' unless [ '*', '/' ].include?(identifier[-1,1])
+
+        /^#{new_identifier.gsub('*', '(.*?)')}$/
       else
         identifier
       end

data/lib/nanoc3/base/item.rb

@@ -2,9 +2,9 @@
 
 module Nanoc3
 
-  # Nanoc3::Item is represents all compileable items in a site. It has content
-  # and attributes, as well as an identifier. It can also store the
-  # modification time to speed up compilation.
+  # Nanoc3::Item represents a compileable item in a site. It has content and
+  # attributes, as well as an identifier. It can also store the modification
+  # time to speed up compilation.
   class Item
 
     # The Nanoc3::Site this item belongs to.

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

@@ -7,13 +7,13 @@ module Nanoc3::CLI::Commands
     DEFAULT_ITEM = <<EOS
 <h1>A Brand New nanoc Site</h1>
 
-<p>You&#8217;ve just created a new nanoc site. The page you are looking at right now is the home page for your site (and it&#8217;s probably the only page).</p>
+<p>You’ve just created a new nanoc site. The page you are looking at right now is the home page for your site (and it’s probably the only page).</p>
 
 <p>To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:</p>
 
 <ul>
-  <li><p><strong>Change this page&#8217;s content</strong> by editing &#8220;content.html&#8221; file in the &#8220;content&#8221; directory. This is the actual page content, and therefore doesn&#8217;t include the header, sidebar or style information (those are part of the layout).</p></li>
-  <li><p><strong>Change the layout</strong>, which is the &#8220;default.txt&#8221; file in the &#8220;layouts/default&#8221; directory, and create something unique (and hopefully less bland).</p></li>
+  <li><p><strong>Change this page’s content</strong> by editing “content.html” file in the “content” directory. This is the actual page content, and therefore doesn’t include the header, sidebar or style information (those are part of the layout).</p></li>
+  <li><p><strong>Change the layout</strong>, which is the “default.txt” file in the “layouts/default” directory, and create something unique (and hopefully less bland).</p></li>
 </ul>
 
 <p>If you need any help with customizing your nanoc web site, be sure to check out the documentation (see sidebar), and be sure to subscribe to the discussion group (also see sidebar). Enjoy!</p>

data/lib/nanoc3/package.rb

@@ -76,6 +76,7 @@ Thanks for installing nanoc 3.0! Here are some resources to help you get started
 * 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>
+* The IRC channel #nanoc on Freenode
 
 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.1
+  version: 3.0.2
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 +02:00
+date: 2009-11-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - bin/nanoc3
 - lib/nanoc3/base/code_snippet.rb
 - lib/nanoc3/base/compiler.rb
+- lib/nanoc3/base/compiler.rb.orig
 - lib/nanoc3/base/compiler_dsl.rb
 - lib/nanoc3/base/core_ext/array.rb
 - lib/nanoc3/base/core_ext/hash.rb
@@ -153,6 +154,7 @@ post_install_message: |
   * 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>
+  * The IRC channel #nanoc on Freenode
   
   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.