nanoc3 3.1.9 → 3.2.0a1

data/lib/nanoc3/filters/less.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'less'
-
 module Nanoc3::Filters
   class Less < Nanoc3::Filter
 
@@ -12,56 +10,9 @@ module Nanoc3::Filters
     #
     # @return [String] The filtered content
     def run(content, params={})
-      # Find imports (hacky)
-      imports = []
-      imports.concat(content.scan(/^@import\s+(["'])([^\1]+?)\1;/))
-      imports.concat(content.scan(/^@import\s+url\((["']?)([^)]+?)\1\);/))
-      imported_filenames = imports.map do |i|
-        i[1].match(/\.(less|css)$/) ? i[1] : i[1] + '.less'
-      end
-
-      # Convert to items
-      imported_items = imported_filenames.map do |filename|
-        # Find directory for this item
-        current_dir_pathname = Pathname.new(@item[:content_filename]).dirname.realpath
-
-        # Find absolute pathname for imported item
-        imported_pathname    = Pathname.new(filename)
-        if imported_pathname.relative?
-          imported_pathname = current_dir_pathname + imported_pathname
-        end
-        next if !imported_pathname.exist?
-        imported_filename = imported_pathname.realpath
-
-        # Find matching item
-        @items.find do |i|
-          next if i[:content_filename].nil?
-          Pathname.new(i[:content_filename]).realpath == imported_filename
-        end
-      end.compact
-
-      # Create dependencies
-      depend_on(imported_items)
-
-      # Add filename to load path
-      paths = [ File.dirname(@item[:content_filename]) ]
-      parser = ::Less::Parser.new(:paths => paths)
-      parser.parse(content).to_css
-    end
-
-    # @todo Remove me in nanoc 3.2.x
-    def depend_on(items)
-      # Notify
-      items.each do |item|
-        Nanoc3::NotificationCenter.post(:visit_started, item)
-        Nanoc3::NotificationCenter.post(:visit_ended,   item)
-      end
+      require 'less'
 
-      # Raise unmet dependency error if necessary
-      items.each do |item|
-        rep = item.reps.find { |r| !r.compiled? }
-        raise Nanoc3::Errors::UnmetDependency.new(rep) if rep
-      end
+      ::Less::Engine.new(content).to_css
     end
 
   end

data/lib/nanoc3/filters/mustache.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Mustache < Nanoc3::Filter
+
+    # Runs the content through
+    # [Mustache](http://github.com/defunkt/mustache). This method takes no
+    # options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      require 'mustache'
+
+      # Get result
+      ::Mustache.render(content, item.attributes)
+    end
+
+  end
+end

data/lib/nanoc3/filters/rdiscount.rb

@@ -4,8 +4,7 @@ module Nanoc3::Filters
   class RDiscount < Nanoc3::Filter
 
     # Runs the content through [RDiscount](http://github.com/rtomayko/rdiscount).
-    #
-    # @option params [Array] symbol ([]) A list of RDiscount extensions
+    # This method takes no options.
     #
     # @param [String] content The content to filter
     #

data/lib/nanoc3/filters/relativize_paths.rb

@@ -14,7 +14,8 @@ module Nanoc3::Filters
     #
     # @param [String] content The content to filter
     #
-    # @option params [Symbol] :type The type of content to filter; can be either `:html` or `:css`.
+    # @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={})
@@ -22,7 +23,7 @@ module Nanoc3::Filters
       @item_rep = assigns[:item_rep] if @item_rep.nil?
 
       # Filter
-      # TODO use nokogiri or csspool instead of regular expressions
+      # FIXME use nokogiri or csspool instead of regular expressions
       case params[:type]
       when :html
         content.gsub(/(<[^>]+\s+(src|href))=(['"]?)(\/.*?)\3([ >])/) do

data/lib/nanoc3/filters/sass.rb

@@ -1,38 +1,8 @@
 # encoding: utf-8
 
-require 'sass'
-require 'set'
-
 module Nanoc3::Filters
   class Sass < Nanoc3::Filter
 
-    class << self
-      # The current filter. This is definitely going to bite me if I ever get
-      # to multithreading nanoc.
-      attr_accessor :current
-    end
-
-    # Essentially the {Sass::Importers::Filesystem} but registering each
-    # import file path.
-    class SassFilesystemImporter < ::Sass::Importers::Filesystem
-
-      private
-
-      def _find(dir, name, options)
-        full_filename, syntax = find_real_file(dir, name)
-        return unless full_filename && File.readable?(full_filename)
-
-        filter = Nanoc3::Filters::Sass.current
-        item = filter.imported_filename_to_item(full_filename)
-        filter.depend_on([ item ]) unless item.nil?
-
-        options[:syntax] = syntax
-        options[:filename] = full_filename
-        options[:importer] = self
-        ::Sass::Engine.new(File.read(full_filename), options)
-      end
-    end
-
     # Runs the content through [Sass](http://sass-lang.com/).
     # Parameters passed to this filter will be passed on to Sass.
     #
@@ -40,41 +10,65 @@ module Nanoc3::Filters
     #
     # @return [String] The filtered content
     def run(content, params={})
-      # Build options
-      options = params.dup
-      sass_filename = options[:filename] ||
-        (@item && @item[:content_filename])
-      options[:filename] ||= sass_filename
-      options[:filesystem_importer] ||=
-        Nanoc3::Filters::Sass::SassFilesystemImporter
+      require 'sass'
+
+      # Add imported_filename read accessor to ImportNode
+      # … but… but… nex3 said I could monkey patch it! :(
+      methods = ::Sass::Tree::ImportNode.instance_methods
+      if !methods.include?(:import_filename) && !methods.include?('import_filename')
+        ::Sass::Tree::ImportNode.send(:attr_reader, :imported_filename)
+      end
+
+      # Get options
+      options = params.merge(:filename => filename)
 
-      # Render
+      # Build engine
       engine = ::Sass::Engine.new(content, options)
-      self.class.current = self
-      engine.render
-    end
 
-    def imported_filename_to_item(filename)
-      path = Pathname.new(filename).realpath
-      @items.find do |i|
-        next if i[:content_filename].nil?
-        Pathname.new(i[:content_filename]).realpath == path
+      # Get import nodes
+      require 'set'
+      imported_nodes = []
+      unprocessed_nodes = Set.new([ engine.to_tree ])
+      until unprocessed_nodes.empty?
+        # Get an unprocessed node
+        node = unprocessed_nodes.each { |n| break n }
+        unprocessed_nodes.delete(node)
+
+        # Add to list of import nodes if necessary
+        imported_nodes << node if node.is_a?(::Sass::Tree::ImportNode)
+
+        # Mark children of this node for processing
+        node.children.each { |c| unprocessed_nodes << c }
       end
-    end
 
-    # @todo Remove me in nanoc 3.2.x
-    def depend_on(items)
-      # Notify
-      items.each do |item|
+      # Get import paths
+      import_paths = (options[:load_paths] || []).dup
+      import_paths.unshift(File.dirname(options[:filename])) if options[:filename]
+
+      # Get imported filenames
+      imported_filenames = imported_nodes.map do |node|
+        ::Sass::Files.find_file_to_import(node.imported_filename, import_paths)
+      end
+
+      # Convert to items
+      imported_items = imported_filenames.map do |filename|
+        normalized_filename = Pathname.new(filename).realpath
+        @items.find { |i| i[:filename] && Pathname.new(i[:filename]).realpath == normalized_filename }
+      end.compact
+
+      # Require compilation of each item
+      imported_items.each do |item|
+        # Notify
         Nanoc3::NotificationCenter.post(:visit_started, item)
         Nanoc3::NotificationCenter.post(:visit_ended,   item)
-      end
 
-      # Raise unmet dependency error if necessary
-      items.each do |item|
-        rep = item.reps.find { |r| !r.compiled? }
-        raise Nanoc3::Errors::UnmetDependency.new(rep) if rep
+        # Raise unmet dependency error if item is not yet compiled
+        any_uncompiled_rep = item.reps.find { |r| !r.compiled? }
+        raise Nanoc3::Errors::UnmetDependency.new(any_uncompiled_rep) if any_uncompiled_rep
       end
+
+      # Done
+      engine.render
     end
 
   end

data/lib/nanoc3/filters.rb

@@ -12,6 +12,7 @@ module Nanoc3::Filters
   autoload 'Less',            'nanoc3/filters/less'
   autoload 'Markaby',         'nanoc3/filters/markaby'
   autoload 'Maruku',          'nanoc3/filters/maruku'
+  autoload 'Mustache',        'nanoc3/filters/mustache'
   autoload 'Rainpress',       'nanoc3/filters/rainpress'
   autoload 'RDiscount',       'nanoc3/filters/rdiscount'
   autoload 'RDoc',            'nanoc3/filters/rdoc'
@@ -30,6 +31,7 @@ module Nanoc3::Filters
   Nanoc3::Filter.register '::Nanoc3::Filters::Less',            :less
   Nanoc3::Filter.register '::Nanoc3::Filters::Markaby',         :markaby
   Nanoc3::Filter.register '::Nanoc3::Filters::Maruku',          :maruku
+  Nanoc3::Filter.register '::Nanoc3::Filters::Mustache',        :mustache
   Nanoc3::Filter.register '::Nanoc3::Filters::Rainpress',       :rainpress
   Nanoc3::Filter.register '::Nanoc3::Filters::RDiscount',       :rdiscount
   Nanoc3::Filter.register '::Nanoc3::Filters::RDoc',            :rdoc

data/lib/nanoc3/helpers/blogging.rb

@@ -39,7 +39,8 @@ module Nanoc3::Helpers
     def sorted_articles
       require 'time'
       articles.sort_by do |a|
-        attribute_to_time(a[:created_at])
+        time = a[:created_at]
+        time.is_a?(String) ? Time.parse(time) : time
       end.reverse
     end
 
@@ -119,28 +120,28 @@ module Nanoc3::Helpers
     #   <%= atom_feed :limit => 5 %>
     #
     # @option params [Number] :limit (5) The maximum number of articles to
-    # show
+    #   show
     #
     # @option params [Array] :articles (sorted_articles) A list of articles to
-    # include in the feed
+    #   include in the feed
     #
     # @option params [Proc] :content_proc (->{ |article|
-    # article.compiled_content(:snapshot => :pre) }) A proc that returns the
-    # content of the given article, which is passed as a parameter. This
-    # function may not return nil.
+    #   article.compiled_content(:snapshot => :pre) }) A proc that returns the
+    #   content of the given article, which is passed as a parameter. This
+    #   function may not return nil.
     #
     # @option params [proc] :excerpt_proc (->{ |article| article[:excerpt] })
-    # A proc that returns the excerpt of the given article, passed as a
-    # parameter. This function should return nil if there is no excerpt.
+    #   A proc that returns the excerpt of the given article, passed as a
+    #   parameter. This function should return nil if there is no excerpt.
     #
     # @option params [String] :title The feed’s title, if it is not given in
-    # the item attributes.
+    #   the item attributes.
     #
     # @option params [String] :author_name The name of the feed’s author, if
-    # it is not given in the item attributes.
+    #   it is not given in the item attributes.
     #
     # @option params [String] :author_uri The URI of the feed’s author, if it
-    # is not given in the item attributes.
+    #   is not given in the item attributes.
     #
     # @return [String] The generated feed content
     def atom_feed(params={})
@@ -182,7 +183,8 @@ module Nanoc3::Helpers
 
       # Get sorted relevant articles
       sorted_relevant_articles = relevant_articles.sort_by do |a|
-        attribute_to_time(a[:created_at])
+        time = a[:created_at]
+        time.is_a?(String) ? Time.parse(time) : time
       end.reverse.first(limit)
 
       # Get most recent article
@@ -202,7 +204,8 @@ module Nanoc3::Helpers
         xml.title   title
 
         # Add date
-        xml.updated(attribute_to_time(last_article[:created_at]).to_iso8601_time)
+        time = last_article[:created_at]
+        xml.updated((time.is_a?(String) ? Time.parse(time) : time).to_iso8601_time)
 
         # Add links
         xml.link(:rel => 'alternate', :href => root_url)
@@ -226,8 +229,10 @@ module Nanoc3::Helpers
             xml.title     a[:title], :type => 'html'
 
             # Add dates
-            xml.published attribute_to_time(a[:created_at]).to_iso8601_time
-            xml.updated   attribute_to_time(a[:updated_at] || a[:created_at]).to_iso8601_time
+            create_time = a[:created_at]
+            update_time = a[:updated_at] || a[:created_at]
+            xml.published((create_time.is_a?(String) ? Time.parse(create_time) : create_time).to_iso8601_time)
+            xml.updated(  (update_time.is_a?(String) ? Time.parse(update_time) : update_time).to_iso8601_time)
 
             # Add link
             xml.link(:rel => 'alternate', :href => url)
@@ -292,24 +297,12 @@ module Nanoc3::Helpers
 
       hostname, base_dir = %r{^.+?://([^/]+)(.*)$}.match(@site.config[:base_url])[1..2]
 
-      formatted_date = attribute_to_time(item[:created_at]).to_iso8601_date
+      time = item[:created_at]
+      formatted_date = (time.is_a?(String) ? Time.parse(time) : time).to_iso8601_date
 
       'tag:' + hostname + ',' + formatted_date + ':' + base_dir + (item.path || item.identifier)
     end
 
-    # Converts the given attribute (which can be a string, a Time or a Date)
-    # into a Time.
-    #
-    # @param [String, Time, Date] time Something that contains time
-    #   information but is not necessarily a Time instance yet
-    #
-    # @return [Time] The Time instance corresponding to the given input
-    def attribute_to_time(time)
-      time = Time.local(time.year, time.month, time.day) if time.is_a?(Date)
-      time = Time.parse(time) if time.is_a?(String)
-      time
-    end
-
   end
 
 end

data/lib/nanoc3/helpers/breadcrumbs.rb

@@ -13,7 +13,7 @@ module Nanoc3::Helpers
     # will contain a `nil` element.
     #
     # @return [Array] The breadcrumbs, starting with the root item and ending
-    # with the item itself
+    #   with the item itself
     def breadcrumbs_trail
       breadcrumbs_for_identifier(@item.identifier)
     end

data/lib/nanoc3/helpers/capturing.rb

@@ -31,7 +31,7 @@ module Nanoc3::Helpers
     # content of the block itself will not be outputted.
     #
     # @param [Symbol, String] The base name of the attribute into which the
-    # content should be stored
+    #   content should be stored
     #
     # @return [void]
     def content_for(name, &block)

data/lib/nanoc3/helpers/filtering.rb

@@ -23,7 +23,7 @@ module Nanoc3::Helpers
     #   <% end %>
     #
     # @param [Symbol] filter_name The name of the filter to run on the
-    # contents of the block
+    #   contents of the block
     #
     # @param [Hash] argument Arguments to pass to the filter
     #

data/lib/nanoc3/helpers/link_to.rb

@@ -17,10 +17,10 @@ module Nanoc3::Helpers
     # @param [String] text The visible link text
     #
     # @param [String, Nanoc3::Item, Nanoc3::ItemRep] target The path/URL,
-    # item or item representation that should be linked to
+    #   item or item representation that should be linked to
     #
     # @param [Hash] attributes A hash containing HTML attributes (e.g.
-    # `rel`, `title`, …) that will be added to the link.
+    #   `rel`, `title`, …) that will be added to the link.
     #
     # @return [String] The link text
     #
@@ -47,12 +47,7 @@ module Nanoc3::Helpers
     #   # => '<a title="My super cool blog" href="/blog/">Blog</a>'
     def link_to(text, target, attributes={})
       # Find path
-      if target.is_a?(String)
-        path = target
-      else
-        path = target.path
-        raise RuntimeError, "Cannot create a link to #{target.inspect} because this target is not outputted (its routing rule returns nil)" if path.nil?
-      end
+      path = target.is_a?(String) ? target : target.path
 
       # Join attributes
       attributes = attributes.inject('') do |memo, (key, value)|
@@ -71,10 +66,10 @@ module Nanoc3::Helpers
     # @param [String] text The visible link text
     #
     # @param [String, Nanoc3::Item, Nanoc3::ItemRep] target The path/URL,
-    # item or item representation that should be linked to
+    #   item or item representation that should be linked to
     #
     # @param [Hash] attributes A hash containing HTML attributes (e.g.
-    # `rel`, `title`, …) that will be added to the link.
+    #   `rel`, `title`, …) that will be added to the link.
     #
     # @return [String] The link text
     #
@@ -103,8 +98,8 @@ module Nanoc3::Helpers
     # item representation. The returned path will not be HTML-escaped.
     #
     # @param [String, Nanoc3::Item, Nanoc3::ItemRep] target The path/URL,
-    # item or item representation to which the relative path should be
-    # generated
+    #   item or item representation to which the relative path should be
+    #   generated
     #
     # @return [String] The relative path to the target
     #
@@ -117,20 +112,14 @@ module Nanoc3::Helpers
       require 'pathname'
 
       # Find path
-      if target.is_a?(String)
-        path = target
-      else
-        path = target.path
-        raise RuntimeError, "Cannot get the relative path to #{target.inspect} because this target is not outputted (its routing rule returns nil)" if path.nil?
-      end
+      path = target.is_a?(String) ? target : target.path
 
       # Get source and destination paths
       dst_path   = Pathname.new(path)
-      raise RuntimeError, "Cannot get the relative path to #{path} because the current item representation, #{@item_rep.inspect}, is not outputted (its routing rule returns nil)" if @item_rep.path.nil?
       src_path   = Pathname.new(@item_rep.path)
 
-      # Calculate the relative path (method depends on whether destination is
-      # a directory or not).
+      # Calculate elative path (method depends on whether destination is a
+      # directory or not).
       if src_path.to_s[-1,1] != '/'
         relative_path = dst_path.relative_path_from(src_path.dirname).to_s
       else

data/lib/nanoc3/helpers/rendering.rb

@@ -7,18 +7,7 @@ module Nanoc3::Helpers
 
     include Nanoc3::Helpers::Capturing
 
-    # Returns a string containing the rendered given layout. The given layout
-    # will first be run through the matching layout rule.
-    #
-    # The assigns (`@item`, `@config`, …) will not be available in the
-    # partial, but it is possible to pass custom assigns to the method. These
-    # assigns will be made available as instance variables inside the partial.
-    #
-    # The method can also take a block. In this case, the content of the block
-    # will be captured (using the {Nanoc3::Helpers::Capturing} helper) and
-    # this content will be made available with `yield`. In other words, a
-    # `yield` inside the partial will output the content of the block passed
-    # to the method.
+    # Returns a string containing the rendered given layout.
     #
     # @param [String] identifier The identifier of the layout that should be
     #   rendered
@@ -40,18 +29,6 @@ module Nanoc3::Helpers
     #   <%= render 'head', :title => 'Foo' %>
     #   # => "<h1>Foo</h1>"
     #
-    # @example Yielding inside a partial
-    #
-    #   # The 'box' partial
-    #   <div class="box">
-    #     <%= yield %>
-    #   </div>
-    #
-    #   # The item/layout where the partial is rendered
-    #   <% render 'box' do %>
-    #     I'm boxy! Luvz!
-    #   <% end %>
-    #
     # @raise [Nanoc3::Errors::UnknownLayout] if the given layout does not
     #   exist
     #
@@ -61,6 +38,10 @@ module Nanoc3::Helpers
       layout = @site.layouts.find { |l| l.identifier == identifier.cleaned_identifier }
       raise Nanoc3::Errors::UnknownLayout.new(identifier.cleaned_identifier) if layout.nil?
 
+      # Visit
+      Nanoc3::NotificationCenter.post(:visit_started, layout)
+      Nanoc3::NotificationCenter.post(:visit_ended,   layout)
+
       # Capture content, if any
       captured_content = block_given? ? capture(&block) : nil
 

data/lib/nanoc3/helpers/tagging.rb

@@ -20,14 +20,14 @@ module Nanoc3::Helpers
     # HTML-escaping rules for {#link_for_tag} apply here as well.
     #
     # @option params [String] base_url ("http://technorati.com/tag/") The URL
-    # to which the tag will be appended to construct the link URL. This URL
-    # must have a trailing slash.
+    #   to which the tag will be appended to construct the link URL. This URL
+    #   must have a trailing slash.
     #
     # @option params [String] none_text ("(none)") The text to display when
-    # the item has no tags
+    #   the item has no tags
     #
     # @option params [String] separator (", ") The separator to put between
-    # tags
+    #   tags
     #
     # @return [String] A hyperlinked list of tags for the given item
     def tags_for(item, params={})
@@ -56,10 +56,10 @@ module Nanoc3::Helpers
     # escaped, as will the content of the `a` element.
     #
     # @param [String] tag The name of the tag, which should consist of letters
-    # and numbers (no spaces, slashes, or other special characters).
+    #   and numbers (no spaces, slashes, or other special characters).
     #
     # @param [String] base_url The URL to which the tag will be appended to
-    # construct the link URL. This URL must have a trailing slash.
+    #   construct the link URL. This URL must have a trailing slash.
     #
     # @return [String] A link for the given tag and the given base URL
     def link_for_tag(tag, base_url)

data/lib/nanoc3/helpers/text.rb

@@ -12,10 +12,10 @@ module Nanoc3::Helpers
     # @param [String] string The string for which to build an excerpt
     #
     # @option params [Number] length (25) The maximum number of characters
-    # this excerpt can contain, including the omission.
+    #   this excerpt can contain, including the omission.
     #
     # @option params [String] omission ("...") The string to append to the
-    # excerpt when the excerpt is shorter than the original string
+    #   excerpt when the excerpt is shorter than the original string
     #
     # @return [String] The excerpt of the given string
     def excerptize(string, params={})

data/lib/nanoc3.rb

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