nanoc 1.0.1 → 1.1

data/Rakefile

@@ -10,14 +10,14 @@ require File.dirname(__FILE__) + '/lib/nanoc.rb'
 
 NAME    = 'nanoc'
 VERS    = Nanoc::VERSION
-SUMMARY = 'a CMS that doesn\'t even run on your server'
+SUMMARY = 'a CMS that doesn\'t run on your server'
 
 HOMEPAGE  = 'http://stoneship.org/software/nanoc'
 EMAIL     = 'denis.defreyne@stoneship.org'
 
 #####
 
-CLEAN.include [ '*.gem', 'pkg', 'tmp' ]
+CLEAN.include [ '*.gem', 'pkg', 'tmp', 'test/fixtures/*/output/*' ]
 
 spec = Gem::Specification.new do |s|
   s.name        = NAME
@@ -32,7 +32,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.glob('{bin,lib,test}/**/*')
+  s.files         = %w( README LICENSE Rakefile ) + Dir.glob('{bin,lib}/**/*')
   s.executables   = [ 'nanoc' ]
   s.require_path  = 'lib'
   s.bindir        = 'bin'

data/lib/compiler.rb

@@ -1,96 +1,54 @@
 module Nanoc
-
   class Compiler
 
-    DEFAULT_CONFIG = {
-      :output_dir => 'output'
-    }
-
-    DEFAULT_PAGE = {
-      :layout    => '<%= @content %>',
-      :filters   => [],
-      :order     => 0,
-      :extension => 'html'
-    }
+    DEFAULT_CONFIG  = { :output_dir => 'output' }
+    DEFAULT_PAGE    = { :filters => [], :extension => 'html', :order => 0, :layout => "default" }
 
     def initialize
       Nanoc.ensure_in_site
-      
-      @config         = DEFAULT_CONFIG.merge(File.read_clean_yaml('config.yaml'))
-      @global_page    = DEFAULT_PAGE.merge(File.read_clean_yaml('meta.yaml'))
-      @default_layout = File.read_file('layouts/' + @global_page[:layout] + '.erb')
+
+      @config      = DEFAULT_CONFIG.merge(YAML.load_file_and_clean('config.yaml'))
+      @global_page = DEFAULT_PAGE.merge(YAML.load_file_and_clean('meta.yaml'))
     end
 
     def run
-      Nanoc.ensure_in_site
-      
-      # Require files in lib/
       Dir.glob('lib/*.rb').each { |f| require f }
 
-      # Compile pages
-      pages = uncompiled_pages.sort { |x,y| x[:order].to_i <=> y[:order].to_i }
-      pages = compile_pages(pages)
-
-      # Put pages in their layout
+      pages = compile_pages(uncompiled_pages)
       pages.each do |page|
-        content_with_layout = layout_for_page(page).eruby(page.merge({ :pages => pages }))
-        FileManager.create_file(path_for_page(page)) { content_with_layout }
+        content = (page[:layout].nil? ? '<%= @page[:content] %>' : File.read("layouts/#{page[:layout]}.erb")).eruby(page.merge({ :page => page, :pages => pages }))
+        FileManager.create_file(path_for_page(page)) { content }
       end
     end
 
     private
 
     def uncompiled_pages
-      # Get all meta file names
-      meta_filenames = Dir.glob('content/**/meta.yaml')
-
-      # Read all meta files
-      pages = meta_filenames.collect do |filename|
-        # Get meta file
-        page = @global_page.merge(File.read_clean_yaml(filename)).merge({:path => filename.sub(/^content/, '').sub('meta.yaml', '')})
+      Dir.glob('content/**/meta.yaml').collect do |filename|
+        page = @global_page.merge(YAML.load_file_and_clean(filename))
+        page[:path] = filename.sub(/^content/, '').sub('meta.yaml', '')
 
-        # Get index filename
-        index_filenames = Dir.glob(File.dirname(filename) + '/index.*')
-        index_filenames.ensure_single('index files', File.dirname(filename))
-        page[:_index_filename] = index_filenames[0]
+        content_filenames = Dir.glob(filename.sub('meta.yaml', File.basename(File.dirname(filename)) + '.*'))
+        content_filenames += Dir.glob("#{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
     end
 
     def path_for_page(a_page)
-      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
-
-    def layout_for_page(a_page)
-      if a_page[:layout] == 'none'
-        '<%= @content %>'
-      elsif @global_page[:layout] != a_page[:layout]
-        File.read_file('layouts/' + a_page[:layout] + '.erb')
-      else
-        @default_layout
-      end
+      @config[:output_dir] + ( a_page[:custom_path].nil? ? a_page[:path] + 'index.' + a_page[:extension] : a_page[:custom_path] )
     end
 
     def compile_pages(a_pages)
-      pages = []
-
-      a_pages.each do |page|
-        # Read and filter page
-        content = File.read_file(page[:_index_filename])
-        content.filter!(page[:filters], :eruby_context => { :pages => pages }) unless page[:filters].nil?
-
-        # Store page
-        pages << page.merge( { :content => content })
+      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 }) ]
       end
-
-      pages
     end
 
   end
-
 end

data/lib/creator.rb

@@ -7,7 +7,7 @@ module Nanoc
         FileManager.create_dir 'output'
 
         FileManager.create_file 'config.yaml' do
-          "output_dir: output\n"
+          "output_dir: \"output\"\n"
         end
 
         FileManager.create_file 'meta.yaml' do
@@ -15,9 +15,10 @@ module Nanoc
           "# Other metafiles can override the contents of this one.\n" +
           "\n" +
           "# Built-in\n" +
-          "layout:  default\n" +
-          "order:   0\n" +
-          "filters: []\n" +
+          "layout:    \"default\"\n" +
+          "order:     0\n" +
+          "filters:   []\n" +
+          "extension: \"html\"\n" +
           "\n" +
           "# Custom\n"
         end
@@ -34,10 +35,10 @@ module Nanoc
           FileManager.create_file 'default.erb' do
             "<html>\n" +
             "  <head>\n" +
-            "    <title><%= @title %></title>\n" +
+            "    <title><%= @page[:title] %></title>\n" +
             "  </head>\n" +
             "  <body>\n" +
-            "<%= @content %>\n" +
+            "<%= @page[:content] %>\n" +
             "  </body>\n" +
             "</html>\n"
           end
@@ -65,7 +66,7 @@ module Nanoc
 
         FileManager.create_dir 'templates' do
           FileManager.create_dir 'default' do
-            FileManager.create_file 'index.txt' do
+            FileManager.create_file "default.txt" do
               "This is a new page. Please edit me!\n"
             end
             FileManager.create_file 'meta.yaml' do
@@ -78,7 +79,7 @@ module Nanoc
         end
 
         FileManager.create_dir 'content' do
-          FileManager.create_file 'index.txt' do
+          FileManager.create_file 'content.txt' do
             "This is a sample root page. Please edit me!\n"
           end
           FileManager.create_file 'meta.yaml' do
@@ -93,23 +94,26 @@ module Nanoc
 
     def self.create_page(a_pagename, a_params={})
       Nanoc.ensure_in_site
-      
+
       # Sanitize page name
       if a_pagename =~ /^[\/\.]+/
-        $stderr.puts 'ERROR: page name starts with dots and/or slashes, aborting'
+        $stderr.puts 'ERROR: page name starts with dots and/or slashes, aborting' unless $quiet == true
         return
       end
 
       # Read template
       template_index = nil
       template_meta = nil
+      template_content_filename = nil
       template = a_params[:template] || 'default'
       begin
-        template_meta = File.read_file('templates/' + template + '/meta.yaml')
-        template_index_filename = Dir.glob('templates/' + template + '/index.*')[0]
-        template_index = File.read_file(template_index_filename)
+        template_meta = File.read("templates/#{template}/meta.yaml")
+        template_content_filenames = Dir.glob("templates/#{template}/#{template}.*")
+        template_content_filenames += Dir.glob("templates/#{template}/index.*")
+        template_content_filename = template_content_filenames[0]
+        template_index = File.read(template_content_filename)
       rescue
-        $stderr.puts 'ERROR: no such template'
+        $stderr.puts 'ERROR: no such template' unless $quiet == true
         exit
       end
       template_meta = template_meta.eruby
@@ -118,7 +122,7 @@ module Nanoc
       # Create index and yaml file
       FileManager.create_dir 'content' do
         FileManager.create_dir a_pagename do
-          FileManager.create_file 'index.txt' do
+          FileManager.create_file "#{a_pagename}#{File.extname(template_content_filename)}" do
             template_index
           end
           FileManager.create_file 'meta.yaml' do
@@ -130,10 +134,10 @@ module Nanoc
 
     def self.create_template(a_templatename)
       Nanoc.ensure_in_site
-      
+
       FileManager.create_dir 'templates' do
         FileManager.create_dir a_templatename do
-          FileManager.create_file 'index.txt' do
+          FileManager.create_file "#{a_templatename}.txt" do
             "This is a new page. Please edit me!\n"
           end
           FileManager.create_file 'meta.yaml' do

data/lib/enhancements.rb

@@ -11,26 +11,17 @@ require 'yaml'
 class Array
   # Ensures that the array contains only one element
   def ensure_single(a_noun, a_context)
-    raise "ERROR: expected 1 #{a_noun}, found #{self.size} (#{a_context})" if self.size != 1
+    if self.size != 1
+      $stderr.puts "ERROR: expected 1 #{a_noun}, found #{self.size} (#{a_context})" unless $quiet == true
+      exit
+    end
   end
 end
 
-class File
-  # Reads the contents of the entire file
-  def self.read_file(a_filename)
-    content = ''
-    File.open(a_filename) { |io| content = io.read }
-    content
-  end
-
-  # Returns the contents of an entire file interpreted as YAML
-  def self.read_yaml(a_filename)
-    YAML::load(self.read_file(a_filename)) || {}
-  end
-
+module YAML
   # Returns the contents of an entire file interpreted as YAML and cleaned
-  def self.read_clean_yaml(a_filename)
-    self.read_yaml(a_filename).clean
+  def self.load_file_and_clean(a_filename)
+    (YAML.load_file(a_filename) || {}).clean
   end
 end
 
@@ -38,9 +29,7 @@ class Hash
   # Converts all keys to symbols, and converts *_at and *_on
   # keys to Times and Dates, respectively
   def clean
-    hash = {}
-
-    self.each_pair do |key, value|
+    inject({}) do |hash, (key, value)|
       if key =~ /_on$/
         hash[key.to_sym] = Date.parse(value)
       elsif key =~ /_at$/
@@ -49,27 +38,28 @@ class Hash
         hash[key.to_sym] = true
       elsif value == 'false'
         hash[key.to_sym] = false
+      elsif value == 'none'
+        hash[key.to_sym] = nil
       else
         hash[key.to_sym] = value
       end
+      hash
     end
-
-    hash
   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={})
-    a_filters.each do |filter|
+  def filter(a_filters, a_params={})
+    a_filters.inject(self) do |result, filter|
       case filter
       when 'markdown'
-        self.replace(self.markdown)
+        result.replace(result.markdown)
       when 'smartypants'
-        self.replace(self.smartypants)
+        result.replace(result.smartypants)
       when 'eruby'
-        self.replace(self.eruby(a_params[:eruby_context]))
+        result.replace(result.eruby(a_params[:eruby_context]))
       end
     end
   end
@@ -78,7 +68,7 @@ class String
   def markdown
     BlueCloth::new(self).to_html
   rescue NameError
-    $stderr.puts 'ERROR: String#markdown failed: BlueCloth not installed'
+    $stderr.puts 'ERROR: String#markdown failed: BlueCloth not installed' unless $quiet == true
     exit
   end
 
@@ -86,7 +76,7 @@ class String
   def smartypants
     RubyPants::new(self).to_html
   rescue NameError
-    $stderr.puts 'ERROR: String#smartypants failed: RubyPants not installed'
+    $stderr.puts 'ERROR: String#smartypants failed: RubyPants not installed' unless $quiet == true
     exit
   end
 
@@ -99,25 +89,50 @@ end
 class FileManager
   @@stack = []
 
+  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 self.create_dir(a_name)
     @@stack.push(a_name)
-    unless File.directory?(File.join(@@stack))
-      puts '     create ' + @@stack.join('/')
-      FileUtils.mkdir_p(@@stack.join('/'))
+    path = File.join(@@stack)
+    unless File.directory?(path)
+      FileUtils.mkdir_p(path)
+      log('create', path)
     end
     yield if block_given?
     @@stack.pop
   end
 
   def self.create_file(a_name)
-    path = @@stack.empty? ? a_name : @@stack.join('/') + '/' + a_name
+    path = @@stack.empty? ? a_name : File.join(@@stack + [ a_name ])
     FileManager.create_dir(path.sub(/\/[^\/]+$/, '')) if @@stack.empty?
-    puts "     #{File.exist?(a_name) ? 'update' : 'create'} " + path
-    if block_given?
-      open(path, 'w') { |io| io.write(yield) }
-    else
-      open(path, 'w') { |io| }
-    end
+    content = block_given? ? yield : nil
+    File.exist?(path) ? ( block_given? and File.read(path) == content ? log('identical', path) : log('update', path) ) : log('create', path)
+    open(path, 'w') { |io| io.write(content) unless content.nil? }
   end
 
+  def self.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
+end
+
+def render(a_name, a_context={})
+  File.read('layouts/' + a_name + '.erb').eruby(a_context.merge({ :page => @page, :pages => @pages }))
 end

data/lib/nanoc.rb

@@ -1,15 +1,15 @@
 module Nanoc
-  VERSION = '1.0.1'
-  
+  VERSION = '1.1'
+
   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.'
       exit
     end
   end
-  
+
   private
-  
+
   def self.in_site?
     return false unless File.directory?('content')
     return false unless File.directory?('layouts')
@@ -17,11 +17,11 @@ 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')
-    
+
     true
   end
 end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: nanoc
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2007-05-05 00:00:00 +02:00
-summary: a CMS that doesn't even run on your server
+  version: "1.1"
+date: 2007-05-08 00:00:00 +02:00
+summary: a CMS that doesn't run on your server
 require_paths: 
 - lib
 email: denis.defreyne@stoneship.org
 homepage: http://stoneship.org/software/nanoc
 rubyforge_project: 
-description: a CMS that doesn't even run on your server
+description: a CMS that doesn't run on your server
 autorequire: 
 default_executable: 
 bindir: bin
@@ -37,9 +37,6 @@ files:
 - lib/creator.rb
 - lib/enhancements.rb
 - lib/nanoc.rb
-- test/test_compile.rb
-- test/test_create.rb
-- test/test_enhancements.rb
 test_files: []
 
 rdoc_options: []

data/test/test_compile.rb

@@ -1,26 +0,0 @@
-require 'test/unit'
-
-require File.dirname(__FILE__) + '/../lib/nanoc.rb'
-
-class CompileTest < Test::Unit::TestCase
-  def setup
-    FileManager.create_dir 'tmp'
-  end
-
-  def teardown
-    FileUtils.rm_rf 'tmp'
-  end
-
-  def test_compile
-    FileUtils.cd('tmp')
-    Nanoc::Creator.create_site('site')
-    FileUtils.cd('site')
-    Nanoc::Creator.create_page('moo')
-    Nanoc::Compiler.new.run
-    FileUtils.cd('..')
-    FileUtils.cd('..')
-
-    assert File.file?('tmp/site/output/index.html')
-    assert File.file?('tmp/site/output/moo/index.html')
-  end
-end

data/test/test_create.rb

@@ -1,71 +0,0 @@
-require 'test/unit'
-
-require File.dirname(__FILE__) + '/../lib/nanoc.rb'
-
-class CreateTest < Test::Unit::TestCase
-  def setup
-    FileManager.create_dir 'tmp'
-  end
-
-  def teardown
-    FileUtils.rm_rf 'tmp'
-  end
-
-  def test_create_site
-    FileUtils.cd('tmp')
-    Nanoc::Creator.create_site('site')
-    FileUtils.cd('..')
-
-    assert File.directory?('tmp/site/')
-
-    assert File.file?('tmp/site/config.yaml')
-    assert File.file?('tmp/site/meta.yaml')
-    assert File.file?('tmp/site/Rakefile')
-
-    assert File.directory?('tmp/site/content/')
-    assert File.file?('tmp/site/content/index.txt')
-    assert File.file?('tmp/site/content/meta.yaml')
-
-    assert File.directory?('tmp/site/layouts/')
-    assert File.file?('tmp/site/layouts/default.erb')
-
-    assert File.directory?('tmp/site/lib/')
-    assert File.file?('tmp/site/lib/default.rb')
-
-    assert File.directory?('tmp/site/output/')
-
-    assert File.directory?('tmp/site/templates/')
-    assert File.directory?('tmp/site/templates/default/')
-    assert File.file?('tmp/site/templates/default/index.txt')
-    assert File.file?('tmp/site/templates/default/meta.yaml')
-
-    assert File.directory?('tmp/site/tasks/')
-    assert File.file?('tmp/site/tasks/default.rake')
-  end
-
-  def test_create_page
-    FileUtils.cd('tmp')
-    Nanoc::Creator.create_site('site')
-    FileUtils.cd('site')
-    Nanoc::Creator.create_page('moo')
-    FileUtils.cd('..')
-    FileUtils.cd('..')
-
-    assert File.directory?('tmp/site/content/moo/')
-    assert File.file?('tmp/site/content/moo/index.txt')
-    assert File.file?('tmp/site/content/moo/meta.yaml')
-  end
-
-  def test_create_template
-    FileUtils.cd('tmp')
-    Nanoc::Creator.create_site('site')
-    FileUtils.cd('site')
-    Nanoc::Creator.create_template('moo')
-    FileUtils.cd('..')
-    FileUtils.cd('..')
-
-    assert File.directory?('tmp/site/templates/moo/')
-    assert File.file?('tmp/site/templates/moo/index.txt')
-    assert File.file?('tmp/site/templates/moo/meta.yaml')
-  end
-end

data/test/test_enhancements.rb

@@ -1,114 +0,0 @@
-require 'test/unit'
-require 'fileutils'
-require 'time'
-
-require File.dirname(__FILE__) + '/../lib/nanoc.rb'
-
-class EnhancementsTest < Test::Unit::TestCase
-  def setup
-    open('test.yaml', 'w') do |io|
-      io.write('created_at: 12/07/04')
-    end
-  end
-
-  def teardown
-    FileUtils.rm('test.yaml')
-  end
-
-  def test_array_ensure_single
-    assert_raise RuntimeError do
-      [ ].ensure_single('moofs', 'blargh')
-    end
-    assert_raise RuntimeError do
-      [ 1, 2 ].ensure_single('moofs', 'blargh')
-    end
-    assert_nothing_raised do
-      [ 1 ].ensure_single('moofs', 'blargh')
-    end
-  end
-
-  def test_file_read_file
-    assert_equal 'created_at: 12/07/04', File.read_file('test.yaml')
-  end
-
-  def test_file_read_yaml
-    assert_equal({ 'created_at' => '12/07/04' }, File.read_yaml('test.yaml'))
-  end
-
-  def test_file_read_clean_yaml
-    assert_equal({ :created_at => Time.parse('12/07/04') }, File.read_clean_yaml('test.yaml'))
-  end
-
-  def test_hash_clean
-    hash1         = { 'foo' => 'bar' }
-    hash1_cleaned = { :foo => 'bar' }
-
-    hash2         = { 'created_at' => '12/07/2004' }
-    hash2_cleaned = { :created_at => Time.parse('12/07/2004') }
-
-    assert_equal hash1_cleaned, hash1.clean
-    assert_equal hash2_cleaned, hash2.clean
-  end
-
-  def test_string_filter!
-    text = '<%= @foo %>'
-    context = { :foo => 'Te\'st' }
-
-    text.filter!([ 'eruby' ], :eruby_context => context)
-    assert_equal 'Te\'st', text
-
-    begin
-      text.filter!([ 'markdown', 'smartypants' ])
-      assert_equal '<p>Te&#8217;st</p>', text
-    rescue NameError
-      $stderr.puts 'WARNING: Unable to test String#filter! (BlueCloth or RubyPants not installed)'
-    end
-  end
-
-  def test_string_markdown
-    begin
-      assert_equal 'Hello!'.markdown, '<p>Hello!</p>'
-    rescue NameError
-      $stderr.puts 'WARNING: Unable to test String#markdown (BlueCloth not installed)'
-    end
-  end
-
-  def test_string_smartypants
-    begin
-      assert_equal 'Te\'st'.smartypants, 'Te&#8217;st'
-    rescue NameError
-      $stderr.puts 'WARNING: Unable to test String#smartypants (RubyPants not installed)'
-    end
-  end
-
-  def test_string_eruby
-    assert_equal '<%= "moo" %>'.eruby, 'moo'
-    assert_equal '<%= @foo %>'.eruby(:foo => 'bar'), 'bar'
-  end
-
-  def test_filemanager_create_dir
-    FileManager.create_dir 'tmp' do
-      FileManager.create_dir 'foo'
-    end
-
-    assert File.exist?('tmp')
-    assert File.directory?('tmp')
-
-    assert File.exist?('tmp/foo')
-    assert File.directory?('tmp/foo')
-
-    assert !File.exist?('foo')
-  end
-
-  def test_filemanager_create_file
-    FileManager.create_dir 'tmp' do
-      FileManager.create_file 'bar' do
-        "asdf"
-      end
-    end
-
-    assert File.exist?('tmp/bar')
-    assert File.file?('tmp/bar')
-    assert_equal 'asdf', File.read_file('tmp/bar')
-  end
-end