nanoc 1.4 → 1.5

data/ChangeLog

@@ -1,3 +1,10 @@
+== 1.5
+
+* Added support for custom filters
+* Improved Liquid support -- Liquid is now a first-class nanoc citizen
+* Deprecated assets -- use something like rsync instead
+* Added eruby_engine option, which can be 'erb' or 'erubis'
+
 == 1.4
 
 * nanoc now supports ERB (as well as Erubis); Erubis no longer is a dependency

data/README

@@ -7,31 +7,9 @@ Markdown, etc.
 
 == Documentation
 
-nanoc has a web site at <http://stoneship.org/software/nanoc/>, which contains
-a "Getting Started" guide as well as a reference for nanoc.
+nanoc has a web site at <http://nanoc.stoneship.org/>, which contains a
+"Getting Started" guide as well as a reference for nanoc.
 
 == Contact
 
 You can reach me at <denis.defreyne@stoneship.org>.
-
-== Copyright
-
-Copyright (c) 2007 Denis Defreyne
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Rakefile

@@ -12,7 +12,7 @@ NAME    = 'nanoc'
 VERS    = Nanoc::VERSION
 SUMMARY = 'a CMS that doesn\'t run on your server'
 
-HOMEPAGE  = 'http://stoneship.org/software/nanoc'
+HOMEPAGE  = 'http://nanoc.stoneship.org/'
 EMAIL     = 'denis.defreyne@stoneship.org'
 
 #####

data/bin/nanoc

@@ -69,7 +69,7 @@ case command
       $stderr.puts 'Usage: nanoc create_site [site_name]'
       exit
     end
-    Nanoc::Creator.create_site(ARGV[1])
+    $nanoc_creator.create_site(ARGV[1])
 
   # Create page
   when 'create_page', 'cp'
@@ -77,7 +77,7 @@ case command
       $stderr.puts 'Usage: nanoc create_page [page_name]'
       exit
     end
-    Nanoc::Creator.create_page(ARGV[1], :template => unprocessed_opts['--template'])
+    $nanoc_creator.create_page(ARGV[1], :template => unprocessed_opts['--template'])
 
   # Create template
   when 'create_template', 'ct'
@@ -85,7 +85,7 @@ case command
       $stderr.puts 'Usage: nanoc create_template [template_name]'
       exit
     end
-    Nanoc::Creator.create_template(ARGV[1])
+    $nanoc_creator.create_template(ARGV[1])
 
   # Process site and generate output
   when 'compile', 'compile_site', 'co'
@@ -93,7 +93,7 @@ case command
       $stderr.puts 'Usage: nanoc compile'
       exit
     end
-    Nanoc::Compiler.new.run
+    $nanoc_compiler.run
 
   else
     puts 'Unrecognised command \'' + command + '\''

data/lib/nanoc.rb

@@ -1,5 +1,6 @@
 module Nanoc
-  VERSION = '1.4'
+
+  VERSION = '1.5'
 
   def self.ensure_in_site
     unless in_site?
@@ -23,9 +24,16 @@ module Nanoc
 
     true
   end
+
 end
 
-require File.dirname(__FILE__) + '/page.rb'
-require File.dirname(__FILE__) + '/creator.rb'
-require File.dirname(__FILE__) + '/compiler.rb'
-require File.dirname(__FILE__) + '/enhancements.rb'
+require File.dirname(__FILE__) + '/nanoc/creator.rb'
+require File.dirname(__FILE__) + '/nanoc/compiler.rb'
+
+$nanoc_creator  = Nanoc::Creator.new
+$nanoc_compiler = Nanoc::Compiler.new
+
+require File.dirname(__FILE__) + '/nanoc/core_ext.rb'
+require File.dirname(__FILE__) + '/nanoc/enhancements.rb'
+require File.dirname(__FILE__) + '/nanoc/filters.rb'
+require File.dirname(__FILE__) + '/nanoc/page.rb'

data/lib/{compiler.rb → nanoc/compiler.rb}

@@ -1,7 +1,10 @@
 module Nanoc
   class Compiler
 
-    DEFAULT_CONFIG  = { :output_dir => 'output' }
+    DEFAULT_CONFIG = {
+      :output_dir   => 'output',
+      :eruby_engine => 'erb'
+    }
 
     FILE_TYPES = {
       '.erb'    => :eruby,
@@ -21,13 +24,17 @@ module Nanoc
     }
 
     def initialize
+      @filters = {}
+    end
+
+    def run
+      # Make sure we're in a nanoc site
       Nanoc.ensure_in_site
 
+      # Load some configuration stuff
       @config      = DEFAULT_CONFIG.merge(YAML.load_file_and_clean('config.yaml'))
       @global_page = PAGE_DEFAULTS.merge(YAML.load_file_and_clean('meta.yaml'))
-    end
 
-    def run
       # Require all Ruby source files in lib/
       Dir['lib/*.rb'].each { |f| require f }
 
@@ -37,33 +44,56 @@ module Nanoc
       # Copy assets to output directory
       copy_assets
 
-      # Compile all pages
-      pages = compile_pages(uncompiled_pages)
+      # Compile and layout pages
+      pages = find_uncompiled_pages
+      pages = layout(compile(pages))
+    end
 
-      # Put pages in their layouts
-      pages.each do |page|
-        # Skip pages that should not be outputed
-        next if page.skip_output
+    def register_filter(name, &block)
+      @filters[name.to_sym] = block
+    end
 
-        begin
-          # Prepare layout content
-          content = layouted_page(page, pages)
+    def filter_named(name)
+      @filters[name.to_sym]
+    end
 
-          # Write page with layout
-          FileManager.create_file(path_for_page(page)) { content }
-        rescue => exception
-          p = page[:_content_filename]
-          l = page[:layout]
-          handle_exception(exception, "layouting page '#{p}' in layout '#{l}'")
-        end
+    def config
+      @config
+    end
+
+  private
 
+    # Returns the path for the given page
+    def path_for_page(page)
+      if page.attributes[:custom_path].nil?
+        @config[:output_dir] + page.attributes[:path] +
+          page.attributes[:filename] + '.' + page.attributes[:extension]
+      else
+        @config[:output_dir] + page.attributes[:custom_path]
       end
     end
 
-  private
+    # Returns the layout for the given page
+    def layout_for_page(page)
+      if page.attributes[:layout].nil?
+        { :type => :eruby, :content => "<%= @page.content %>" }
+      else
+        filenames = Dir["layouts/#{page.attributes[:layout]}.*"]
+        filenames.ensure_single('layout files', page.attributes[:layout])
+        filename = filenames[0]
+
+        { :type => FILE_TYPES[File.extname(filename)], :content => File.read(filename) }
+      end
+    end
 
-    # Copies the contents of the assets directory into the output directory
     def copy_assets
+      # Check for assets
+      if Dir['assets/*'].size > 0
+        deprecate 'Asset-copying functionality is deprecated as of nanoc 1.5,' +
+                  'and will be removed in nanoc 1.6. Please use a Rake task that' +
+                  'copies assets using something like rsync instead.'
+      end
+
       # Remove existing assets
       Dir['assets/*'].each do |f|
         FileUtils.remove_entry_secure(f.sub('assets/', @config[:output_dir] + '/'), true)
@@ -75,8 +105,7 @@ module Nanoc
       end
     end
 
-    # Returns a list of uncompiled pages
-    def uncompiled_pages
+    def find_uncompiled_pages
       # Read all meta files
       pages = Dir['content/**/meta.yaml'].collect do |filename|
         # Read the meta file
@@ -101,30 +130,7 @@ module Nanoc
       pages
     end
 
-    # Returns the layout for the given page
-    def layout_for_page(a_page)
-      if a_page[:layout].nil?
-        { :type => :eruby, :content => "<%= @page[:content] %>" }
-      else
-        filenames = Dir["layouts/#{a_page[:layout]}.*"]
-        filenames.ensure_single('layout files', a_page[:layout])
-        filename = filenames[0]
-
-        { :type => FILE_TYPES[File.extname(filename)], :content => File.read(filename) }
-      end
-    end
-
-    # Returns the path for the given page
-    def path_for_page(a_page)
-      if a_page[:custom_path].nil?
-        @config[:output_dir] + a_page[:path] + a_page[:filename] + '.' + a_page[:extension]
-      else
-        @config[:output_dir] + a_page[:custom_path]
-      end
-    end
-
-    # Compiles the given pages and returns the compiled pages
-    def compile_pages(pages)
+    def compile(pages)
       # Create page objects from given pages
       given_pages = []
       pages.each { |page| given_pages << Page.new(page) }
@@ -135,15 +141,20 @@ module Nanoc
       given_pages
     end
 
-    # Layouts the page
-    def layouted_page(a_page, a_pages)
+    def layouted_page(page, pages)
       # Find layout
-      layout = layout_for_page(a_page)
+      layout = layout_for_page(page)
 
       # Build params
-      assigns = { :page => a_page.merge(:_content_filename => nil), :pages => a_pages }
-      params = { :assigns => assigns }
-      params[:haml_options] = (a_page[:haml_options] || {}).symbolize_keys
+      if layout[:type] == :liquid
+        public_page   = page.to_liquid
+        public_pages  = pages.map { |p| p.to_liquid }
+      else
+        public_page   = page.to_proxy
+        public_pages  = pages.map { |p| p.to_proxy }
+      end
+      params = { :assigns => { :page => public_page, :pages => public_pages } }
+      params[:haml_options] = (page.attributes[:haml_options] || {}).symbolize_keys
 
       # Layout
       case layout[:type]
@@ -162,5 +173,21 @@ module Nanoc
       content
     end
 
+    def layout(pages)
+      pages.reject { |page| page.attributes[:skip_output] }.each do |page|
+        begin
+          # Prepare layout content
+          content = layouted_page(page, pages)
+
+          # Write page with layout
+          FileManager.create_file(path_for_page(page)) { content }
+        rescue => exception
+          p = page.attributes[:_content_filename]
+          l = page.attributes[:layout]
+          handle_exception(exception, "layouting page '#{p}' in layout '#{l}'")
+        end
+      end
+    end
+
   end
 end

data/lib/nanoc/core_ext.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'core_ext', '*.rb')].each { |f| require f }

data/lib/nanoc/core_ext/array.rb

@@ -0,0 +1,17 @@
+class Array
+  # Ensures that the array contains only one element
+  def ensure_single(a_noun, a_context)
+    if self.size != 1
+      $stderr.puts "ERROR: expected 1 #{a_noun}, found #{self.size} (#{a_context})" unless $quiet
+      exit
+    end
+  end
+
+  # Pushes the object on the stack, yields, and pops stack
+  def pushing(obj)
+    push(obj)
+    yield
+  ensure
+    pop
+  end
+end

data/lib/nanoc/core_ext/hash.rb

@@ -0,0 +1,41 @@
+class Hash
+  # Cleans up the hash by performing the following operations:
+  # * Values with keys ending in _at and _on are converted into Times and
+  #   Dates, respectively
+  # * All keys are converted to symbols
+  # * Value strings 'true', 'false', and 'none' are converted into
+  #   true, false, and nil, respectively
+  def clean
+    symbolize_keys.inject({}) do |hash, (key, value)|
+      if key.to_s =~ /_on$/
+        hash.merge(key => Date.parse(value))
+      elsif key.to_s =~ /_at$/
+        hash.merge(key => Time.parse(value))
+      elsif value == 'true'
+        hash.merge(key => true)
+      elsif value == 'false'
+        hash.merge(key => false)
+      elsif value == 'none'
+        hash.merge(key => nil)
+      else
+        hash.merge(key => value)
+      end
+    end
+  end
+
+  # Converts all keys in the hash to symbols and returns the result
+  def symbolize_keys
+    inject({}) do |hash, (key, value)|
+      new_value = value.respond_to?(:symbolize_keys) ? value.symbolize_keys : value
+      hash.merge({ key.to_sym => new_value })
+    end
+  end
+
+  # Converts all keys in the hash to strings and returns the result
+  def stringify_keys
+    inject({}) do |hash, (key, value)|
+      new_value = value.respond_to?(:stringify_keys) ? value.stringify_keys : value
+      hash.merge({ key.to_s => new_value })
+    end
+  end
+end

data/lib/nanoc/core_ext/string.rb

@@ -0,0 +1,13 @@
+class String
+
+  # Returns true if the string starts with str
+  def starts_with?(str)
+    str == self[0, str.length]
+  end
+
+  # Returns true if the string ends with str
+  def ends_with?(str)
+    str == self[-str.length, str.length]
+  end
+
+end

data/lib/nanoc/core_ext/yaml.rb

@@ -0,0 +1,8 @@
+require 'yaml'
+
+module YAML
+  # Loads a YAML file, cleans it using Hash#clean, and returns the result
+  def self.load_file_and_clean(a_filename)
+    (YAML.load_file(a_filename) || {}).clean
+  end
+end

data/lib/{creator.rb → nanoc/creator.rb}

@@ -2,7 +2,7 @@ module Nanoc
 
   class Creator
 
-    def self.create_site(a_sitename)
+    def create_site(a_sitename)
       ensure_nonexistant(a_sitename)
 
       FileManager.create_dir a_sitename do
@@ -38,10 +38,10 @@ module Nanoc
           FileManager.create_file 'default.erb' do
             "<html>\n" +
             "  <head>\n" +
-            "    <title><%= @page[:title] %></title>\n" +
+            "    <title><%= @page.title %></title>\n" +
             "  </head>\n" +
             "  <body>\n" +
-            "<%= @page[:content] %>\n" +
+            "<%= @page.content %>\n" +
             "  </body>\n" +
             "</html>\n"
           end
@@ -53,7 +53,7 @@ module Nanoc
             "\# before nanoc starts compiling.\n" +
             "\n" +
             "def html_escape(a_string)\n" +
-            "  a_string.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;').gsub('\\'', '&apos;').gsub('\"', '&quot;')\n" +
+            "  a_string.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;').gsub('\"', '&quot;')\n" +
             "end\n" +
             "alias h html_escape\n"
           end
@@ -95,7 +95,7 @@ module Nanoc
       end
     end
 
-    def self.create_page(a_pagename, a_params={})
+    def create_page(a_pagename, a_params={})
       Nanoc.ensure_in_site
       ensure_nonexistant(File.join(['content', a_pagename]))
 
@@ -135,7 +135,7 @@ module Nanoc
       end
     end
 
-    def self.create_template(a_templatename)
+    def create_template(a_templatename)
       Nanoc.ensure_in_site
       ensure_nonexistant(File.join(['templates', a_templatename]))
 
@@ -156,7 +156,7 @@ module Nanoc
 
   private
 
-    def self.ensure_nonexistant(filename)
+    def ensure_nonexistant(filename)
       if File.exist?(filename)
         $stderr.puts "ERROR: A file or directory named #{filename} already exists." unless $quiet
         exit