nanoc 2.1.6 → 2.2

data/lib/nanoc/cli/logger.rb

@@ -7,21 +7,27 @@ module Nanoc::CLI
   class Logger
 
     ACTION_COLORS = {
-      :create     => "\e[1m" + "\e[32m", # bold + green
-      :update     => "\e[1m" + "\e[33m", # bold + yellow
-      :identical  => "\e[1m",            # bold
-      :skip       => "\e[1m"             # bold
+      :create         => "\e[1m" + "\e[32m", # bold + green
+      :update         => "\e[1m" + "\e[33m", # bold + yellow
+      :identical      => "\e[1m",            # bold
+      :skip           => "\e[1m",            # bold
+      :'not written'  => "\e[1m"             # bold
     }
 
     include Singleton
 
-    # The log leve, which can be :high, :low or :off (which will log all
+    # The log level, which can be :high, :low or :off (which will log all
     # messages, only high-priority messages, or no messages at all,
     # respectively).
     attr_accessor :level
 
+    # Whether to use color in log messages or not
+    attr_accessor :color
+    alias_method :color?, :color
+
     def initialize # :nodoc:
       @level = :high
+      @color = true
     end
 
     # Logs a file-related action.
@@ -36,9 +42,9 @@ module Nanoc::CLI
       log(
         level,
         '%s%12s%s  %s%s' % [
-          ACTION_COLORS[action.to_sym],
+          color? ? ACTION_COLORS[action.to_sym] : '',
           action,
-          "\e[0m",
+          color? ? "\e[0m" : '',
           duration.nil? ? '' : "[%2.2fs]  " % [ duration ],
           path
         ]

data/lib/nanoc/data_sources.rb

@@ -0,0 +1,2 @@
+require 'nanoc/data_sources/filesystem'
+require 'nanoc/data_sources/filesystem_combined'

data/lib/nanoc/data_sources/filesystem.rb

@@ -120,7 +120,6 @@ module Nanoc::DataSources
     def update # :nodoc:
       update_page_defaults
       update_pages
-      update_layouts
       update_templates
     end
 
@@ -368,8 +367,9 @@ module Nanoc::DataSources
       if is_old_school
         # Warn about deprecation
         warn(
-          'nanoc 2.1 changes the way layouts are stored. Future versions will not support these outdated sites. To update your site, issue \'nanoc update\'.',
-          'DEPRECATION WARNING'
+          'DEPRECATION WARNING: nanoc 2.1 changes the way layouts are ' +
+          'stored. Future versions will not support these outdated sites. ' +
+          'To update your site, issue \'nanoc update\'.'
         )
 
         Dir[File.join('layouts', '*')].reject { |f| f =~ /~$/ }.map do |filename|
@@ -679,41 +679,6 @@ module Nanoc::DataSources
       end
     end
 
-    # Updates outdated layouts.
-    def update_layouts
-      # layouts/abc.ext -> layouts/abc/abc.{html,yaml}
-      Dir[File.join('layouts', '*')].select { |f| File.file?(f) }.each do |filename|
-        # Get filter class
-        filter_class = Nanoc::Filter.with_extension(File.extname(filename))
-
-        # Get data
-        content     = File.read(filename)
-        attributes  = { :filter => filter_class.identifier.to_s }
-        path        = File.basename(filename, File.extname(filename))
-
-        # Get layout
-        tmp_layout = Nanoc::Layout.new(content, attributes, path)
-
-        # Get filenames
-        last_component    = tmp_layout.path.split('/')[-1]
-        dir_path          = 'layouts' + tmp_layout.path
-        meta_filename     = dir_path + last_component + '.yaml'
-        content_filename  = dir_path + last_component +  File.extname(filename)
-
-        # Create new files
-        FileUtils.mkdir_p(dir_path)
-        File.open(meta_filename,    'w') { |io| io.write(tmp_layout.attributes.to_split_yaml) }
-        File.open(content_filename, 'w') { |io| io.write(tmp_layout.content) }
-
-        # Add
-        vcs.add(meta_filename)
-        vcs.add(content_filename)
-
-        # Delete old files
-        vcs.remove(filename)
-      end
-    end
-
     # Updates outdated templates (both content and meta file names).
     def update_templates
       # Update content files

data/lib/nanoc/extra.rb

@@ -0,0 +1,6 @@
+require 'nanoc/extra/auto_compiler'
+require 'nanoc/extra/context'
+require 'nanoc/extra/core_ext'
+require 'nanoc/extra/file_proxy'
+require 'nanoc/extra/vcs'
+require 'nanoc/extra/vcses'

data/lib/nanoc/extra/core_ext.rb

@@ -0,0 +1,2 @@
+require 'nanoc/extra/core_ext/hash'
+require 'nanoc/extra/core_ext/time'

data/lib/nanoc/extra/vcses.rb

@@ -0,0 +1,5 @@
+require 'nanoc/extra/vcses/bazaar'
+require 'nanoc/extra/vcses/dummy'
+require 'nanoc/extra/vcses/git'
+require 'nanoc/extra/vcses/mercurial'
+require 'nanoc/extra/vcses/subversion'

data/lib/nanoc/filters.rb

@@ -0,0 +1,14 @@
+require 'nanoc/filters/bluecloth'
+require 'nanoc/filters/erb'
+require 'nanoc/filters/erubis'
+require 'nanoc/filters/haml'
+require 'nanoc/filters/markaby'
+require 'nanoc/filters/maruku'
+require 'nanoc/filters/old'
+require 'nanoc/filters/rainpress'
+require 'nanoc/filters/rdiscount'
+require 'nanoc/filters/rdoc'
+require 'nanoc/filters/redcloth'
+require 'nanoc/filters/relativize_paths'
+require 'nanoc/filters/rubypants'
+require 'nanoc/filters/sass'

data/lib/nanoc/filters/erb.rb

@@ -2,7 +2,6 @@ module Nanoc::Filters
   class ERB < Nanoc::Filter
 
     identifiers :erb
-    extensions  '.erb', '.rhtml'
 
     def run(content)
       require 'erb'
@@ -11,7 +10,9 @@ module Nanoc::Filters
       context = ::Nanoc::Extra::Context.new(assigns)
 
       # Get result
-      ::ERB.new(content).result(context.get_binding)
+      erb = ::ERB.new(content)
+      erb.filename = filename
+      erb.result(context.get_binding)
     end
 
   end

data/lib/nanoc/filters/haml.rb

@@ -2,13 +2,13 @@ module Nanoc::Filters
   class Haml < Nanoc::Filter
 
     identifiers :haml
-    extensions  '.haml'
 
     def run(content)
       require 'haml'
 
       # Get options
       options = @obj_rep.attribute_named(:haml_options) || {}
+      options[:filename] = filename
 
       # Create context
       context = ::Nanoc::Extra::Context.new(assigns)

data/lib/nanoc/filters/markaby.rb

@@ -2,7 +2,6 @@ module Nanoc::Filters
   class Markaby < Nanoc::Filter
 
     identifiers :markaby
-    extensions  '.mab'
 
     def run(content)
       require 'markaby'

data/lib/nanoc/filters/rainpress.rb

@@ -0,0 +1,13 @@
+module Nanoc::Filters
+  class Rainpress < Nanoc::Filter
+
+    identifier :rainpress
+
+    def run(content)
+      require 'rainpress'
+
+      ::Rainpress.compress(content)
+    end
+
+  end
+end

data/lib/nanoc/filters/relativize_paths.rb

@@ -0,0 +1,25 @@
+module Nanoc::Filters
+  class RelativizePaths < Nanoc::Filter
+
+    identifier :relativize_paths
+
+    require 'nanoc/helpers/link_to'
+    include Nanoc::Helpers::LinkTo
+
+    def run(content, params={})
+      type = params[:type] || :html
+
+      case type
+      when :html
+        content.gsub(/(src|href)=(['"]?)(\/.+?)\2([ >])/) do
+          $1 + '=' + $2 + relative_path_to($3) + $2 + $4
+        end
+      when :css
+        content.gsub(/url\((['"]?)(\/.+?)\1\)/) do
+          'url(' + $1 + relative_path_to($2) + $1 + ')'
+        end
+      end
+    end
+
+  end
+end

data/lib/nanoc/filters/sass.rb

@@ -8,6 +8,7 @@ module Nanoc::Filters
 
       # Get options
       options = @obj_rep.attribute_named(:sass_options) || {}
+      options[:filename] = filename
 
       # Get result
       ::Sass::Engine.new(content, options).render

data/lib/nanoc/helpers.rb

@@ -0,0 +1,9 @@
+require 'nanoc/helpers/blogging'
+require 'nanoc/helpers/capturing'
+require 'nanoc/helpers/filtering'
+require 'nanoc/helpers/html_escape'
+require 'nanoc/helpers/link_to'
+require 'nanoc/helpers/render'
+require 'nanoc/helpers/tagging'
+require 'nanoc/helpers/text'
+require 'nanoc/helpers/xml_sitemap'

data/lib/nanoc/helpers/blogging.rb

@@ -21,14 +21,15 @@ module Nanoc::Helpers
   #   include Nanoc::Helpers::Blogging
   module Blogging
 
-    # Returns the list of articles, sorted by descending creation date (so
-    # newer articles appear first).
+    # Returns an unsorted list of articles.
+    def articles
+      @pages.select { |page| page.kind == 'article' }
+    end
+
+    # Returns a list of articles, sorted by descending creation date (so newer
+    # articles appear first).
     def sorted_articles
-      @pages.select do |page|
-        page.kind == 'article'
-      end.sort do |x,y|
-        y.created_at <=> x.created_at
-      end
+      articles.sort_by { |a| a.created_at }.reverse
     end
 
     # Returns a string representing the atom feed containing recent articles,
@@ -37,6 +38,19 @@ module Nanoc::Helpers
     #
     # +limit+:: The maximum number of articles to show. Defaults to 5.
     #
+    # +articles+:: A list of articles to include in the feed. Defaults to the
+    #              list of articles returned by the articles function.
+    #
+    # +content_proc+:: A proc that returns the content of the given article,
+    #                  passed as a parameter. By default, given the argument
+    #                  +article+, this proc will return +article.content+.
+    #                  This function may not return nil.
+    #
+    # +excerpt_proc+:: A proc that returns the excerpt of the given article,
+    #                  passed as a parameter. By default, given the argument
+    #                  +article+, this proc will return +article.excerpt+.
+    #                  This function may return nil.
+    #
     # The following attributes must be set on blog articles:
     #
     # * 'title', containing the title of the blog post.
@@ -93,10 +107,38 @@ module Nanoc::Helpers
       require 'builder'
 
       # Extract parameters
-      limit = params[:limit] || 5
+      limit             = params[:limit] || 5
+      relevant_articles = params[:articles] || articles || []
+      content_proc      = params[:content_proc] || lambda { |a| a.content }
+      excerpt_proc      = params[:excerpt_proc] || lambda { |a| a.excerpt }
+
+      # Check feed page attributes
+      if @page.base_url.nil?
+        raise RuntimeError.new('Cannot build Atom feed: feed page has no base_url')
+      end
+      if @page.title.nil?
+        raise RuntimeError.new('Cannot build Atom feed: feed page has no title')
+      end
+      if @page.author_name.nil?
+        raise RuntimeError.new('Cannot build Atom feed: feed page has no author_name')
+      end
+      if @page.author_uri.nil?
+        raise RuntimeError.new('Cannot build Atom feed: feed page has no author_uri')
+      end
+
+      # Check article attributes
+      if relevant_articles.empty?
+        raise RuntimeError.new('Cannot build Atom feed: no articles')
+      end
+      if relevant_articles.any? { |a| a.created_at.nil? }
+        raise RuntimeError.new('Cannot build Atom feed: one or more articles lack created_at')
+      end
+
+      # Get sorted relevant articles
+      sorted_relevant_articles = relevant_articles.sort_by { |a| a.created_at }.reverse.first(limit)
 
       # Get most recent article
-      last_article = sorted_articles.first
+      last_article = sorted_relevant_articles.first
 
       # Create builder
       buffer = ''
@@ -123,7 +165,7 @@ module Nanoc::Helpers
         end
 
         # Add articles
-        sorted_articles.first(limit).each do |a|
+        sorted_relevant_articles.each do |a|
           xml.entry do
             # Add primary attributes
             xml.id        atom_tag_for(a)
@@ -137,8 +179,9 @@ module Nanoc::Helpers
             xml.link(:rel => 'alternate', :href => url_for(a))
 
             # Add content
-            xml.content   a.content, :type => 'html'
-            xml.summary   a.excerpt, :type => 'html' unless a.excerpt.nil?
+            summary = excerpt_proc.call(a)
+            xml.content   content_proc.call(a), :type => 'html'
+            xml.summary   summary, :type => 'html' unless summary.nil?
           end
         end
       end

data/lib/nanoc/helpers/filtering.rb

@@ -0,0 +1,54 @@
+module Nanoc::Helpers
+
+  # Nanoc::Helpers::Filtering provides a filter method, which allows parts of
+  # a page to be filtered.
+  #
+  # For example, the following piece of code only runs the "rubypants" filter
+  # on the second paragraph:
+  #
+  #   <p>Lorem ipsum dolor sit amet...</p>
+  #   <% filter :rubypants do %>
+  #     <p>Consectetur adipisicing elit...</p>
+  #   <% end %>
+  #
+  # This helper likely only works with ERB (and perhaps Erubis).
+  #
+  # To activate this helper, +include+ it, like this:
+  #
+  #   include Nanoc::Helpers::Filtering
+  module Filtering
+
+    # Filters the content in the given block and outputs it.
+    def filter(filter_name, &block)
+      # Capture block
+      data = capture(&block)
+
+      # Find filter
+      filter = Nanoc::Filter.named(filter_name).new(@_obj_rep)
+
+      # Filter captured data
+      filtered_data = filter.run(data)
+
+      # Append filtered data to buffer
+      buffer = eval('_erbout', block.binding)
+      buffer << filtered_data
+    end
+
+  private
+
+    def capture(*args, &block)
+      buffer = eval('_erbout', block.binding)
+
+      pos = buffer.length
+      block.call(*args)
+
+      data = buffer[pos..-1]
+
+      buffer[pos..-1] = ''
+
+      data
+    end
+
+  end
+
+end

data/lib/nanoc/helpers/link_to.rb

@@ -7,6 +7,7 @@ module Nanoc::Helpers
   #   include Nanoc::Helpers::LinkTo
   module LinkTo
 
+    require 'nanoc/helpers/html_escape'
     include Nanoc::Helpers::HTMLEscape
 
     # Creates a HTML link to the given path or page/asset representation, and
@@ -68,6 +69,45 @@ module Nanoc::Helpers
       end
     end
 
+    # Returns the relative path from the current page to the given path or
+    # page/asset representation.
+    #
+    # +path_or_rep+:: the URL or path (a String) to where the relative should
+    #                 point, or the page or asset representation to which the
+    #                 relative should point.
+    #
+    # Example:
+    #
+    #   # if the current item's path is /foo/bar/
+    #   relative_path('/foo/qux/')
+    #   # => '../qux/'
+    def relative_path_to(path_or_rep)
+      require 'pathname'
+
+      # Find path
+      path = path_or_rep.is_a?(String) ? path_or_rep : path_or_rep.path
+
+      # Get source and destination paths
+      dst_path   = Pathname.new(path)
+      src_path   = Pathname.new(@item.path)
+
+      # 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
+        relative_path = dst_path.relative_path_from(src_path).to_s
+      end
+
+      # Add trailing slash if necessary
+      if dst_path.to_s[-1,1] == '/'
+        relative_path += '/'
+      end
+
+      # Done
+      relative_path
+    end
+
   end
 
 end