nanoc 1.3.1 → 1.4

data/ChangeLog

@@ -1,3 +1,12 @@
+== 1.4
+
+* nanoc now supports ERB (as well as Erubis); Erubis no longer is a dependency
+* meta.yaml can now have haml_options property, which is passed to Haml
+* Pages can now have a 'filename' property, which defaults to 'index' [Dennis
+  Sutch]
+* Pages now know in what order they should be compiled, eliminating the need
+  for custom page ordering [Dennis Sutch]
+
 == 1.3.1
 
 * The contents of the 'assets' directory are now copied into the output
@@ -16,9 +25,9 @@
 == 1.2
 
 * Sites now have an 'assets' directory, whose contents are copied to the 
-  'output' directory when compiling
+  'output' directory when compiling [Soryu]
 * Added support for non-eRuby layouts (Markaby, Haml, Liquid, ...)
-* Added many more filters
+* Added more filters (Markaby, Haml, Liquid, RDoc [Dmitry Bilunov])
 * Improved error reporting
 * Accessing page attributes using instance variables, and not through @page,
   is no longer possible

data/Rakefile

@@ -29,7 +29,6 @@ spec = Gem::Specification.new do |s|
   s.homepage    = HOMEPAGE
   s.email       = EMAIL
 
-  s.add_dependency('erubis')
   s.required_ruby_version = '>= 1.8.2'
 
   s.has_rdoc      = false

data/bin/nanoc

@@ -26,7 +26,7 @@ Description:
     The 'nanoc' command is used for creating nanoc-powered sites, as well as
     managing them: creating pages and templates and compiling the site.
 
-    Read more about nanoc on the site: <http://stoneship.org/software/nanoc/>
+    Read more about nanoc on the site: <http://nanoc.stoneship.org/>
 EOT
 
 # Parse options

data/lib/compiler.rb

@@ -13,11 +13,11 @@ module Nanoc
 
     PAGE_DEFAULTS = {
       :custom_path  => nil,
+      :filename     => 'index',
       :extension    => 'html',
       :filters      => [],
       :is_draft     => false,
-      :layout       => 'default',
-      :order        => 0
+      :layout       => 'default'
     }
 
     def initialize
@@ -31,6 +31,9 @@ module Nanoc
       # Require all Ruby source files in lib/
       Dir['lib/*.rb'].each { |f| require f }
 
+      # Create output assets directory if necessary
+      FileUtils.mkdir_p(@config[:output_dir])
+
       # Copy assets to output directory
       copy_assets
 
@@ -49,28 +52,27 @@ module Nanoc
           # Write page with layout
           FileManager.create_file(path_for_page(page)) { content }
         rescue => exception
-          $stderr.puts "Exception occured while layouting page " +
-            "'#{page[:_content_filename]}' in layout '#{page[:layout]}':" unless $quiet
-          $stderr.puts exception unless $quiet
-          $stderr.puts exception.backtrace.join("\n") unless $quiet
-          exit
+          p = page[:_content_filename]
+          l = page[:layout]
+          handle_exception(exception, "layouting page '#{p}' in layout '#{l}'")
         end
 
       end
     end
 
-    private
+  private
 
     # Copies the contents of the assets directory into the output directory
     def copy_assets
-      # Create output assets directory if necessary
-      FileUtils.mkdir_p(@config[:output_dir])
-
       # Remove existing assets
-      Dir['assets/*'].each { |f| FileUtils.remove_entry_secure(f.sub('assets/', @config[:output_dir] + '/'), true) }
+      Dir['assets/*'].each do |f|
+        FileUtils.remove_entry_secure(f.sub('assets/', @config[:output_dir] + '/'), true)
+      end
 
       # Copy assets
-      FileUtils.cp_r(Dir['assets/*'], @config[:output_dir]) if File.directory?('assets') and !Dir['assets/*'].empty?
+      if File.directory?('assets') and !Dir['assets/*'].empty?
+        FileUtils.cp_r(Dir['assets/*'], @config[:output_dir])
+      end
     end
 
     # Returns a list of uncompiled pages
@@ -84,7 +86,8 @@ module Nanoc
         page[:path] = filename.sub(/^content/, '').sub('meta.yaml', '')
 
         # Get the content filename
-        content_filenames = Dir[filename.sub('meta.yaml', File.basename(File.dirname(filename)) + '.*')].reject { |f| f =~ /~$/ }
+        content_filenames = Dir[filename.sub('meta.yaml', File.basename(File.dirname(filename)) + '.*')]
+        content_filenames.reject! { |f| f =~ /~$/ }
         content_filenames += Dir["#{File.dirname(filename)}/index.*"] # fallback for nanoc 1.0
         content_filenames.ensure_single('content files', File.dirname(filename))
         page[:_content_filename] = content_filenames[0]
@@ -95,15 +98,6 @@ module Nanoc
       # Ignore drafts
       pages.reject! { |page| page[:is_draft] }
 
-      # Sort pages by order and by path
-      pages.sort! do |x,y|
-        if x[:order].to_i == y[:order].to_i
-          x[:path] <=> y[:path]
-        else
-          x[:order].to_i <=> y[:order].to_i
-        end
-      end
-
       pages
     end
 
@@ -123,66 +117,46 @@ module Nanoc
     # 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] + 'index.' + a_page[:extension]
+        @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(a_pages)
+    def compile_pages(pages)
       # Create page objects from given pages
-      given_pages       = []
-      a_pages.each { |page| given_pages << Page.new(page) }
+      given_pages = []
+      pages.each { |page| given_pages << Page.new(page) }
 
-      # Create arrays for two kinds of pages
-      compiled_pages    = []
-      uncompiled_pages  = []
-      given_pages.each { |page| uncompiled_pages << page }
+      # Compile pages
+      Page.compile(given_pages)
 
-      # Compile all pages
-      given_pages.each do |page|
-        # Read page
-        content = File.read(page._content_filename)
-
-        # Compile page
-        begin
-          content = content.filter(page.filters, :assigns => { :page => page, :pages => uncompiled_pages + compiled_pages })
-        rescue Exception => exception
-          $stderr.puts "Exception occured while compiling page " +
-            "'#{page[:_content_filename]}':" unless $quiet
-            $stderr.puts exception unless $quiet
-            $stderr.puts exception.backtrace.join("\n") unless $quiet
-          exit
-        end
-
-        # Move from uncompiled to compiled
-        uncompiled_pages  -= [ page ]
-        compiled_pages    += [ page ]
-
-        # Create compiled page
-        page[:content] = content
-      end
-
-      # Return all pages
-      compiled_pages
+      given_pages
     end
 
     # Layouts the page
     def layouted_page(a_page, a_pages)
-      context = { :page => a_page.merge(:_content_filename => nil), :pages => a_pages }
+      # Find layout
       layout = layout_for_page(a_page)
 
-      content = nil
+      # 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
+
+      # Layout
       case layout[:type]
       when :eruby
-        content = layout[:content].eruby(context)
+        content = layout[:content].eruby(params)
       when :haml
-        content = layout[:content].haml(context)
+        content = layout[:content].haml(params)
       when :markaby
-        content = layout[:content].markaby(context)
+        content = layout[:content].markaby(params)
       when :liquid
-        content = layout[:content].liquid(context)
+        content = layout[:content].liquid(params)
+      else
+        content = nil
       end
 
       content

data/lib/creator.rb

@@ -3,12 +3,7 @@ module Nanoc
   class Creator
 
     def self.create_site(a_sitename)
-      # Make sure we're not accidentally overwriting anything
-      if File.exist?(a_sitename)
-        $stderr.puts 'ERROR: A file or directory named ' + a_sitename +
-          ' already exists.' unless $quiet
-        exit
-      end
+      ensure_nonexistant(a_sitename)
 
       FileManager.create_dir a_sitename do
         FileManager.create_dir 'assets'
@@ -24,8 +19,8 @@ module Nanoc
           "\n" +
           "# Built-in\n" +
           "layout:    \"default\"\n" +
-          "order:     0\n" +
           "filters:   []\n" +
+          "filename:  \"index\"\n" + 
           "extension: \"html\"\n" +
           "\n" +
           "# Custom\n"
@@ -102,13 +97,7 @@ module Nanoc
 
     def self.create_page(a_pagename, a_params={})
       Nanoc.ensure_in_site
-
-      # Make sure we're not accidentally overwriting anything
-      if File.exist?(File.join(['content', a_pagename]))
-        $stderr.puts 'ERROR: A file or directory named ' + a_pagename +
-          ' already exists.' unless $quiet
-        exit
-      end
+      ensure_nonexistant(File.join(['content', a_pagename]))
 
       # Sanitize page name
       if a_pagename =~ /^[\/\.]+/
@@ -117,9 +106,6 @@ module Nanoc
       end
 
       # Read template
-      template_index = nil
-      template_meta = nil
-      template_content_filename = nil
       template = a_params[:template] || 'default'
       begin
         template_meta = File.read("templates/#{template}/meta.yaml")
@@ -137,7 +123,9 @@ module Nanoc
       # Create index and yaml file
       FileManager.create_dir 'content' do
         FileManager.create_dir a_pagename do
-          FileManager.create_file "#{a_pagename.sub(/.*\/([^\/]+)/, '\1')}#{File.extname(template_content_filename)}" do
+          page_name = a_pagename.sub(/.*\/([^\/]+)/, '\1')
+          extension = File.extname(template_content_filename)
+          FileManager.create_file "#{page_name}#{extension}" do
             template_index
           end
           FileManager.create_file 'meta.yaml' do
@@ -149,13 +137,7 @@ module Nanoc
 
     def self.create_template(a_templatename)
       Nanoc.ensure_in_site
-
-      # Make sure we're not accidentally overwriting anything
-      if File.exist?(File.join(['templates', a_templatename]))
-        $stderr.puts 'ERROR: A file or directory named ' + a_templatename +
-          ' already exists.' unless $quiet
-        exit
-      end
+      ensure_nonexistant(File.join(['templates', a_templatename]))
 
       FileManager.create_dir 'templates' do
         FileManager.create_dir a_templatename do
@@ -172,5 +154,14 @@ module Nanoc
       end
     end
 
+  private
+
+    def self.ensure_nonexistant(filename)
+      if File.exist?(filename)
+        $stderr.puts "ERROR: A file or directory named #{filename} already exists." unless $quiet
+        exit
+      end
+    end
+
   end
 end

data/lib/enhancements.rb

@@ -2,11 +2,12 @@ def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
 
 try_require 'rubygems'
 
-require 'erubis'
+require 'erb'
 require 'fileutils'
 require 'yaml'
 
 try_require 'bluecloth'
+try_require 'erubis'
 try_require 'redcloth'
 try_require 'rubypants'
 try_require 'markaby'
@@ -15,6 +16,15 @@ try_require 'haml'
 try_require 'rdoc/markup/simple_markup'
 try_require 'rdoc/markup/simple_markup/to_html'
 
+def handle_exception(exception, text)
+  unless $quiet or exception.class == SystemExit
+    $stderr.puts "ERROR: Exception occured while #{text}:\n"
+    $stderr.puts exception
+    $stderr.puts exception.backtrace.join("\n")
+  end
+  exit
+end
+
 class Array
   # Ensures that the array contains only one element
   def ensure_single(a_noun, a_context)
@@ -54,6 +64,13 @@ class Hash
     end
   end
 
+  def symbolize_keys
+    inject({}) do |hash, (key, value)|
+      hash[key.intern] = value
+      hash
+    end
+  end
+
   def stringify_keys
     inject({}) do |hash, (key, value)|
       hash[key.to_s] = value
@@ -62,20 +79,33 @@ class Hash
   end
 end
 
+class ERBContext
+  def initialize(hash)
+    hash.each_pair do |key, value|
+      instance_variable_set('@' + key.to_s, value)
+    end
+  end
+
+  def get_binding
+    binding
+  end
+end
+
 class String
   # Runs the string through the filters as given by the array of
   # filter names. Available filters include 'markdown', 'smartypants' and 'eruby'.
   def filter(a_filters, a_params={})
+    assigns = a_params[:assigns]
     a_filters.inject(self) do |result, filter|
       case filter
       when 'eruby'
-        result.replace(result.eruby(a_params[:assigns]))
+        result.replace(result.eruby(:assigns => assigns))
       when 'haml'
-        result.replace(result.haml(a_params[:assigns]))
+        result.replace(result.haml(:assigns => assigns))
       when 'liquid'
-        result.replace(result.liquid(a_params[:assigns]))
+        result.replace(result.liquid(:assigns => assigns))
       when 'markaby'
-        result.replace(result.markaby(a_params[:assigns]))
+        result.replace(result.markaby(:assigns => assigns))
       when 'markdown', 'bluecloth'
         result.replace(result.markdown)
       when 'rdoc'
@@ -90,22 +120,36 @@ class String
     end
   end
 
-  # Converts the string using eRuby.
-  def eruby(a_assigns={})
-    Erubis::Eruby.new(self).evaluate(a_assigns)
+  # Converts the string using eRuby
+  def eruby(a_params={})
+    erubis(a_params)
+  rescue NameError
+    erb(a_params)
+  end
+
+  # Converts the string using Erubis
+  def erubis(a_params={})
+    Erubis::Eruby.new(self).evaluate(a_params[:assigns] || {})
+  end
+
+  # Converts the string using ERB
+  def erb(a_params={})
+    ERB.new(self).result(ERBContext.new(a_params[:assigns] || {}).get_binding)
   end
 
   # Converts the string using Haml
-  def haml(a_assigns={})
-    Haml::Engine.new(self, :locals => a_assigns).to_html
+  def haml(a_params={})
+    options = (a_params[:haml_options] || {})
+    options[:locals] = a_params[:assigns] unless a_params[:assigns].nil?
+    Haml::Engine.new(self, options).to_html
   rescue NameError
     $stderr.puts 'ERROR: String#haml failed (Haml not installed?)' unless $quiet
     exit
   end
 
   # Converts the string using Liquid
-  def liquid(a_assigns={})
-    Liquid::Template.parse(self).render(a_assigns.stringify_keys)
+  def liquid(a_params={})
+    Liquid::Template.parse(self).render((a_params[:assigns] || {}).stringify_keys)
   rescue NameError
     $stderr.puts 'ERROR: String#liquid failed (Liquid not installed?)' unless $quiet
     exit
@@ -113,8 +157,8 @@ class String
 
   # Converts the string using Markaby
   # TODO perhaps add support for helpers
-  def markaby(a_assigns={})
-    Markaby::Builder.new(a_assigns).instance_eval(self).to_s
+  def markaby(a_params={})
+    Markaby::Builder.new((a_params[:assigns] || {})).instance_eval(self).to_s
   rescue NameError
     $stderr.puts 'ERROR: String#markaby failed (Markaby not installed?)' unless $quiet
     exit
@@ -228,5 +272,6 @@ class FileManager
 end
 
 def render(a_name, a_context={})
-  File.read('layouts/' + a_name.to_s + '.erb').eruby(a_context.merge({ :page => @page, :pages => @pages }))
+  assigns = a_context.merge({ :page => @page, :pages => @pages })
+  File.read('layouts/' + a_name.to_s + '.erb').eruby(:assigns => assigns)
 end

data/lib/nanoc.rb

@@ -1,5 +1,5 @@
 module Nanoc
-  VERSION = '1.3.1'
+  VERSION = '1.4'
 
   def self.ensure_in_site
     unless in_site?
@@ -15,7 +15,6 @@ module Nanoc
     return false unless File.directory?('content')
     return false unless File.directory?('layouts')
     return false unless File.directory?('lib')
-    return false unless File.directory?('output')
     return false unless File.directory?('tasks')
     return false unless File.directory?('templates')
     return false unless File.exist?('config.yaml')

data/lib/page.rb

@@ -1,20 +1,14 @@
 module Nanoc
   class Page
 
-    def initialize(a_hash={})
-      @attributes = a_hash
-    end
-
-    def [](a_key)
-      @attributes[a_key]
-    end
+    @@compilation_stack = []
 
-    def []=(a_key, a_value)
-      @attributes[a_key] = a_value
+    def initialize(hash={})
+      @attributes = hash
     end
 
-    def merge(a_other)
-      @attributes.merge(a_other.to_hash)
+    def merge(other)
+      @attributes.merge(other.to_hash)
       self
     end
 
@@ -22,8 +16,75 @@ module Nanoc
       @attributes
     end
 
-    def method_missing(a_method, *a_args)
-      @attributes[a_method.to_sym]
+    # Accessing data
+
+    def [](key)
+      @attributes[key]
+    end
+
+    def []=(key, value)
+      @attributes[key] = value
+    end
+
+    def method_missing(method, *args)
+      @attributes[method.to_sym]
+    end
+
+    def content
+      compile!
+      @attributes[:content]
+    end
+
+    # Compiling
+
+    def self.compile(pages)
+      @@pages = pages
+      
+      # Compile all pages
+      pages.each do |page|
+        page.compile!
+      end
+    end
+
+    def compile!
+      # Check for recursive call
+      if @@compilation_stack.include?(self)
+        # Print compilation stack
+        unless $quiet
+          $stderr.puts 'ERROR: Recursive call to page content. Page compilation stack:'
+
+          # Determine relevant part of compilation stack
+          stack_begin = @@compilation_stack.index(self)
+          stack_end   = @@compilation_stack.size
+          relevant_stack_part = @@compilation_stack.last(stack_end - stack_begin)
+
+          # Print relevant part of compilation stack
+          relevant_stack_part.each_with_index do |page, i|
+            $stderr.puts "#{i}  #{page._content_filename}"
+          end
+        end
+        exit
+      # Compile if not yet compiled
+      elsif self[:content].nil?
+        # Add to stack
+        @@compilation_stack.push(self)
+
+        # Read page
+        content = File.read(self._content_filename)
+
+        # Compile page
+        begin
+          assigns = { :page => self, :pages => @@pages }
+          # TODO set more custom options
+          params = { :assigns => assigns }
+          params[:haml_options] = (self[:haml_options] || {}).symbolize_keys
+          content = content.filter(self.filters, params)
+        rescue Exception => exception
+          handle_exception(exception, "compiling page '#{self[:_content_filename]}'")
+        end
+        @attributes[:content] = content
+        @@compilation_stack.pop
+      end
     end
 
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: nanoc
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
-date: 2007-06-30 00:00:00 +02:00
+  version: "1.4"
+date: 2007-07-06 00:00:00 +02:00
 summary: a CMS that doesn't run on your server
 require_paths: 
 - lib
@@ -51,13 +51,5 @@ extensions: []
 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: erubis
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
+dependencies: []
+