nanoc 1.1.3 → 1.2

data/ChangeLog

@@ -0,0 +1,34 @@
+== 1.2
+
+* Sites now have an 'assets' directory, whose contents are copied to the 'output' directory when compiling
+* Added support for non-eRuby layouts (Markaby, Haml, Liquid, ...)
+* Added many more filters
+* Improved error reporting
+* Accessing page attributes using instance variables, and not through @page, is no longer possible
+* Page attributes can now be accessed using dot notation, i.e. @page.title as well as @page[:title]
+
+== 1.1.3
+
+* Fixed bug which would cause pages without layouts to be outputed incorrectly
+
+== 1.1.2
+
+* Backup files (files ending with a “~”) are now ignored
+* Fixed bug which would cause subpages not to be generated correctly
+
+== 1.1
+
+* Added support for nested layouts
+* Added coloured logging
+* @page now hold the page that is currently being processed
+* Index files are now called “content” files and are now named after the directory they are in [Colin Barrett]
+* It is now possible to access @page in the page’s content file
+
+== 1.0.1
+
+* Fixed a bug which would cause a “no such template” error to be displayed when the template existed but compiling it would raise an exception
+* Fixed bug which would cause pages not to be sorted by order before compiling
+
+== 1.0
+
+* Initial release

data/Rakefile

@@ -17,7 +17,8 @@ EMAIL     = 'denis.defreyne@stoneship.org'
 
 #####
 
-CLEAN.include [ '*.gem', 'pkg', 'tmp', 'test/fixtures/*/output/*' ]
+CLEAN.include [ 'tmp', 'test/fixtures/*/output/*', 'test/fixtures/*/tmp' ]
+CLOBBER.include [ 'pkg' ]
 
 spec = Gem::Specification.new do |s|
   s.name        = NAME
@@ -32,7 +33,7 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.8.2'
 
   s.has_rdoc      = false
-  s.files         = %w( README LICENSE Rakefile ) + Dir['{bin,lib}/**/*']
+  s.files         = %w( README LICENSE ChangeLog Rakefile ) + Dir['{bin,lib}/**/*']
   s.executables   = [ 'nanoc' ]
   s.require_path  = 'lib'
   s.bindir        = 'bin'

data/bin/nanoc

@@ -1,29 +1,32 @@
 #!/usr/bin/env ruby
 
-# Available options:
-# 
-# -h, --help:
-#   prints the help
-# 
-# -t <template>, --template <template>
-#   Uses the specified template when creating a page
-# 
-# -v, --version:
-#   prints the version information
+require File.dirname(__FILE__) + '/../lib/nanoc.rb'
 
-require 'rubygems' rescue nil
 require 'getoptlong'
 
-require File.dirname(__FILE__) + '/../lib/nanoc.rb'
+try_require 'rubygems'
 
 # Define some texts
 version_text = "nanoc #{Nanoc::VERSION} (c) 2007 Denis Defreyne."
+usage_text   = "Usage: nanoc [options] [command] [parameters]"
 help_text    = <<EOT
-usage: nanoc [-hv]
+Usage: nanoc [-chv]
        nanoc create_site <name>
        nanoc create_page <name> [-t template]
        nanoc create_template <name>
        nanoc compile
+
+Options:
+    -h, --help        Show this help message and quit.
+    -v, --version     Show the nanoc version number and quit.
+    -t, --template    Template that should be used when creating a page.
+                      (can only be used with create_page)
+
+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/>
 EOT
 
 # Parse options
@@ -47,13 +50,13 @@ begin
     end
   end
 rescue GetoptLong::InvalidOption
-  $stderr.puts help_text
+  $stderr.puts usage_text
   exit
 end
 
 # Make sure we have at least one argument
 if ARGV.size == 0
-  $stderr.puts help_text
+  $stderr.puts usage_text
   exit
 end
 

data/lib/compiler.rb

@@ -2,51 +2,157 @@ module Nanoc
   class Compiler
 
     DEFAULT_CONFIG  = { :output_dir => 'output' }
-    DEFAULT_PAGE    = { :filters => [], :extension => 'html', :order => 0, :layout => "default" }
+
+    FILE_TYPES = {
+      '.erb'    => :eruby,
+      '.rhtml'  => :eruby,
+      '.haml'   => :haml,
+      '.mab'    => :markaby,
+      '.liquid' => :liquid
+    }
+
+    PAGE_DEFAULTS = {
+      :custom_path  => nil,
+      :extension    => 'html',
+      :filters      => [],
+      :is_draft     => false,
+      :layout       => 'default',
+      :order        => 0
+    }
 
     def initialize
       Nanoc.ensure_in_site
 
       @config      = DEFAULT_CONFIG.merge(YAML.load_file_and_clean('config.yaml'))
-      @global_page = DEFAULT_PAGE.merge(YAML.load_file_and_clean('meta.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 }
 
+      # Copy assets to output directory
+      copy_assets
+
+      # Compile all pages
       pages = compile_pages(uncompiled_pages)
+
+      # Put pages in their layouts
       pages.each do |page|
-        content = (page[:layout].nil? ? "<%= @page[:content] %>" : File.read("layouts/#{page[:layout]}.erb")).eruby(page.merge({ :page => page, :pages => pages })) # fallback for nanoc 1.0
+        # Prepare layout content
+        content = nil
+        context = { :page => page.merge(:_content_filename => nil), :pages => pages }
+        layout = layout_for_page(page)
+        begin
+          case layout[:type]
+          when :eruby
+            content = layout[:content].eruby(context)
+          when :haml
+            content = layout[:content].haml(context)
+          when :markaby
+            content = layout[:content].markaby(context)
+          when :liquid
+            content = layout[:content].liquid(context)
+          end
+        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
+        end
+
+        # Write page with layout
         FileManager.create_file(path_for_page(page)) { content }
       end
     end
 
     private
 
+    # Copies the contents of the assets directory into the output directory
+    def copy_assets
+      Dir['assets/*'].each { |f| FileUtils.remove_entry_secure(f.sub('assets/', 'output/'), true) }
+      FileUtils.cp_r(Dir['assets/*'], 'output') if File.directory?('assets') and !Dir['assets/*'].empty?
+    end
+
+    # Returns a list of uncompiled pages
     def uncompiled_pages
-      Dir['content/**/meta.yaml'].collect do |filename|
+      # Read all meta files
+      pages = Dir['content/**/meta.yaml'].collect do |filename|
+        # Read the meta file
         page = @global_page.merge(YAML.load_file_and_clean(filename))
+
+        # Fix the path
         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["#{File.dirname(filename)}/index.*"] # fallback for nanoc 1.0
         content_filenames.ensure_single('content files', File.dirname(filename))
         page[:_content_filename] = content_filenames[0]
 
         page
-      end.compact.reject { |page| page[:is_draft] }.sort do |x,y|
-        x[:order].to_i == y[:order].to_i ? x[:path] <=> y[:path] : x[:order].to_i <=> y[:order].to_i
+      end
+
+      # 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
+
+    # 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)
-      @config[:output_dir] + ( a_page[:custom_path].nil? ? a_page[:path] + 'index.' + a_page[:extension] : a_page[:custom_path] )
+      if a_page[:custom_path].nil?
+        @config[:output_dir] + a_page[:path] + 'index.' + 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)
       a_pages.inject([]) do |pages, page|
-        content = File.read(page[:_content_filename]).filter(page[:filters], :eruby_context => { :page => page, :pages => pages })
-        pages + [ page.merge( { :content => content, :_content_filename => nil }) ]
+        # Read page
+        content = File.read(page[:_content_filename])
+
+        # Filter page
+        begin
+          content = content.filter(page[:filters], :assigns => { :page => Page.new(page), :pages => 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
+
+        # Create compiled page
+        compiled_page = page.merge( :content => content )
+
+        # Remember page
+        pages + [ Page.new(compiled_page) ]
       end
     end
 

data/lib/creator.rb

@@ -4,6 +4,7 @@ module Nanoc
 
     def self.create_site(a_sitename)
       FileManager.create_dir a_sitename do
+        FileManager.create_dir 'assets'
         FileManager.create_dir 'output'
 
         FileManager.create_file 'config.yaml' do

data/lib/enhancements.rb

@@ -1,18 +1,24 @@
 def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
 
 try_require 'rubygems'
-try_require 'bluecloth'
-try_require 'rubypants'
 
 require 'erubis'
 require 'fileutils'
 require 'yaml'
 
+try_require 'bluecloth'
+try_require 'rubypants'
+try_require 'markaby'
+try_require 'liquid'
+try_require 'haml'
+try_require 'rdoc/markup/simple_markup'
+try_require 'rdoc/markup/simple_markup/to_html'
+
 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 == true
+      $stderr.puts "ERROR: expected 1 #{a_noun}, found #{self.size} (#{a_context})" unless $quiet
       exit
     end
   end
@@ -46,6 +52,13 @@ class Hash
       hash
     end
   end
+
+  def stringify_keys
+    inject({}) do |hash, (key, value)|
+      hash[key.to_s] = value
+      hash
+    end
+  end
 end
 
 class String
@@ -54,47 +67,134 @@ class String
   def filter(a_filters, a_params={})
     a_filters.inject(self) do |result, filter|
       case filter
+      when 'eruby'
+        result.replace(result.eruby(a_params[:assigns]))
+      when 'haml'
+        result.replace(result.haml(a_params[:assigns]))
+      when 'liquid'
+        result.replace(result.liquid(a_params[:assigns]))
+      when 'markaby'
+        result.replace(result.markaby(a_params[:assigns]))
       when 'markdown'
         result.replace(result.markdown)
+      when 'rdoc'
+        result.replace(result.rdoc)
       when 'smartypants'
         result.replace(result.smartypants)
-      when 'eruby'
-        result.replace(result.eruby(a_params[:eruby_context]))
       end
     end
   end
 
-  # Converts the string to HTML using Markdown.
+  # Converts the string using eRuby.
+  def eruby(a_assigns={})
+    Erubis::Eruby.new(self).evaluate(a_assigns)
+  end
+
+  # Converts the string using Haml
+  def haml(a_assigns={})
+    Haml::Engine.new(self, :locals => a_assigns).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)
+  rescue NameError
+    $stderr.puts 'ERROR: String#liquid failed (Liquid not installed?)' unless $quiet
+    exit
+  end
+
+  # 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
+  rescue NameError
+    $stderr.puts 'ERROR: String#markaby failed (Markaby not installed?)' unless $quiet
+    exit
+  end
+
+  # Converts the string to HTML using BlueCloth/Markdown.
   def markdown
-    BlueCloth::new(self).to_html
+    BlueCloth.new(self).to_html
   rescue NameError
-    $stderr.puts 'ERROR: String#markdown failed: BlueCloth not installed' unless $quiet == true
+    $stderr.puts 'ERROR: String#markdown failed: BlueCloth not installed' unless $quiet
     exit
   end
 
-  # Styles the string as HTML by converting quotes, dashes, ... using RubyPants
+  # Converts the string using RDoc
+  def rdoc
+    SM::SimpleMarkup.new.convert(self, SM::ToHtml.new)
+  end
+
+  # Converts the string using RedCloth/Textile
+  def textile
+    RedCloth.new(self).to_html
+  rescue NameError
+    $stderr.puts 'ERROR: String#textile failed (RedCloth not installed?)' unless $quiet
+    exit
+  end
+
+  # Converts the string using RubyPants/SmartyPants
   def smartypants
-    RubyPants::new(self).to_html
+    RubyPants.new(self).to_html
   rescue NameError
-    $stderr.puts 'ERROR: String#smartypants failed: RubyPants not installed' unless $quiet == true
+    $stderr.puts 'ERROR: String#smartypants failed (RubyPants not installed?)' unless $quiet
     exit
   end
+end
+
+class FileLogger
+  COLORS = {
+    :reset   => "\e[0m",
+
+    :bold    => "\e[1m",
+
+    :black   => "\e[30m",
+    :red     => "\e[31m",
+    :green   => "\e[32m",
+    :yellow  => "\e[33m",
+    :blue    => "\e[34m",
+    :magenta => "\e[35m",
+    :cyan    => "\e[36m",
+    :white   => "\e[37m"
+  }
+
+  ACTION_COLORS = {
+    :create     => COLORS[:bold] + COLORS[:green],
+    :update     => COLORS[:bold] + COLORS[:yellow],
+    :move       => COLORS[:bold] + COLORS[:blue],
+    :identical  => COLORS[:bold]
+  }
+
+  attr_reader :out
+
+  def initialize(a_out = $stdout)
+    @out = a_out
+  end
 
-  # Converts the string using eRuby.
-  def eruby(a_context={})
-    Erubis::Eruby.new(self).evaluate(a_context)
+  def log(a_action, a_path)
+    @out.puts('%s%12s%s  %s' % [ACTION_COLORS[a_action.to_sym], a_action, COLORS[:reset], a_path]) unless $quiet
+  end
+
+  private
+
+  def method_missing(a_method, *a_args)
+    log(a_method.to_s, a_args.first)
   end
 end
 
 class FileManager
   @@stack = []
+  @@logger = FileLogger.new
 
   def self.create_dir(a_name)
     @@stack.push(a_name)
     path = File.join(@@stack)
     unless File.directory?(path)
       FileUtils.mkdir_p(path)
-      log('create', path)
+      @@logger.create(path)
     end
     yield if block_given?
     @@stack.pop
@@ -104,35 +204,19 @@ class FileManager
     path = File.join(@@stack + [ a_name ])
     FileManager.create_dir(path.sub(/\/[^\/]+$/, '')) if @@stack.empty?
     content = block_given? ? yield : nil
-    File.exist?(path) ? ( block_given? and File.read(path) == content ? log('identical', path) : log('update', path) ) : log('create', path)
+    if File.exist?(path)
+      if block_given? and File.read(path) == content
+        @@logger.identical(path)
+      else
+        @@logger.update(path)
+      end
+    else
+      @@logger.create(path)
+    end
     open(path, 'w') { |io| io.write(content) unless content.nil? }
   end
 end
 
-COLORS = {
-  :reset   => "\e[0m",
-
-  :bold    => "\e[1m",
-
-  :black   => "\e[30m",
-  :red     => "\e[31m",
-  :green   => "\e[32m",
-  :yellow  => "\e[33m",
-  :blue    => "\e[34m",
-  :magenta => "\e[35m",
-  :cyan    => "\e[36m",
-  :white   => "\e[37m"
-}
-ACTION_COLORS = {
-  :create     => COLORS[:bold] + COLORS[:green],
-  :update     => COLORS[:bold] + COLORS[:yellow],
-  :identical  => COLORS[:bold]
-}
-
-def log(a_action, a_path)
-  puts format('%s%12s%s %s', ACTION_COLORS[a_action.to_sym], a_action, COLORS[:reset], a_path) unless $quiet == true
-end
-
 def render(a_name, a_context={})
-  File.read('layouts/' + a_name + '.erb').eruby(a_context.merge({ :page => @page, :pages => @pages }))
+  File.read('layouts/' + a_name.to_s + '.erb').eruby(a_context.merge({ :page => @page, :pages => @pages }))
 end

data/lib/nanoc.rb

@@ -1,9 +1,10 @@
 module Nanoc
-  VERSION = '1.1.3'
+  VERSION = '1.2'
 
   def self.ensure_in_site
     unless in_site?
-      $stderr.puts 'ERROR: The current working directory does not seem to be a valid/complete nanoc site directory; aborting.' unless $quiet
+      $stderr.puts 'ERROR: The current working directory does not seem to ' +
+        'be a valid/complete nanoc site directory; aborting.' unless $quiet
       exit
     end
   end
@@ -17,7 +18,6 @@ module Nanoc
     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')
     return false unless File.exist?('meta.yaml')
     return false unless File.exist?('Rakefile')
@@ -26,6 +26,7 @@ module Nanoc
   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'

data/lib/page.rb

@@ -0,0 +1,30 @@
+module Nanoc
+  class Page
+
+    def initialize(a_hash={})
+      @attributes = a_hash
+    end
+
+    def [](a_key)
+      @attributes[a_key]
+    end
+
+    def []=(a_key, a_value)
+      @attributes[a_key] = a_value
+    end
+
+    def merge(a_other)
+      @attributes.merge(a_other.to_hash)
+      self
+    end
+
+    def to_hash
+      @attributes
+    end
+
+    def method_missing(a_method, *a_args)
+      @attributes[a_method.to_sym]
+    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.1.3
-date: 2007-05-18 00:00:00 +02:00
+  version: "1.2"
+date: 2007-06-05 00:00:00 +02:00
 summary: a CMS that doesn't run on your server
 require_paths: 
 - lib
@@ -31,12 +31,14 @@ authors: []
 files: 
 - README
 - LICENSE
+- ChangeLog
 - Rakefile
 - bin/nanoc
 - lib/compiler.rb
 - lib/creator.rb
 - lib/enhancements.rb
 - lib/nanoc.rb
+- lib/page.rb
 test_files: []
 
 rdoc_options: []