nanoc 1.6.2 → 2.0

data/ChangeLog

@@ -1,6 +1,33 @@
 nanoc Release Notes
 ===================
 
+2.0
+---
+
+New:
+
+* Support for custom layout processors
+* Support for custom data sources
+* Database data source
+* Auto-compiler
+* Pages have `parent` and `children`
+
+Changed:
+
+* The source has been restructured and cleaned up a great deal
+* Filters are defined in a different way now
+* The 'eruby' filter now uses ERB instead of Erubis
+
+Removed:
+
+* The `filters` property; use `filters_pre` instead
+* Support for Liquid
+
+1.6.2
+-----
+
+* Fixed an issue which prevented the content capturing plugin from working
+
 1.6.1
 -----
 

data/Rakefile

@@ -1,3 +1,5 @@
+##### Requirements
+
 require 'rake'
 
 require 'rake/clean'
@@ -6,50 +8,47 @@ require 'rake/testtask'
 
 require File.dirname(__FILE__) + '/lib/nanoc.rb'
 
-#####
+##### General details
 
 NAME    = 'nanoc'
 VERS    = Nanoc::VERSION
-SUMMARY = 'a CMS that doesn\'t run on your server'
-
+SUMMARY = 'a tool that runs on your local computer and compiles Markdown, ' +
+          'Textile, Haml, ... documents into static web pages'
 HOMEPAGE  = 'http://nanoc.stoneship.org/'
+
+AUTHOR    = 'Denis Defreyne'
 EMAIL     = 'denis.defreyne@stoneship.org'
 
-#####
+##### Cleaning
 
 CLEAN.include [ 'tmp', 'test/fixtures/*/output/*', 'test/fixtures/*/tmp' ]
 CLOBBER.include [ 'pkg' ]
 
+##### Packaging
+
 spec = Gem::Specification.new do |s|
-  s.name        = NAME
-  s.version     = VERS
-  s.platform    = Gem::Platform::RUBY
-  s.summary     = SUMMARY
-  s.description = s.summary
-  s.homepage    = HOMEPAGE
-  s.email       = EMAIL
+  s.name                  = NAME
+  s.version               = VERS
+  s.platform              = Gem::Platform::RUBY
+  s.summary               = SUMMARY
+  s.description           = s.summary
+  s.homepage              = HOMEPAGE
 
-  s.required_ruby_version = '>= 1.8.2'
+  s.author                = AUTHOR
+  s.email                 = EMAIL
 
-  s.has_rdoc      = false
-  s.files         = %w( README LICENSE ChangeLog Rakefile ) + Dir['{bin,lib}/**/*']
-  s.executables   = [ 'nanoc' ]
-  s.require_path  = 'lib'
-  s.bindir        = 'bin'
-end
+  s.rubyforge_project     = 'nanoc'
 
-Rake::GemPackageTask.new(spec) do |task|
-  task.need_tar = true
-  task.gem_spec = spec
-end
+  s.required_ruby_version = '>= 1.8.2'
 
-Rake::TestTask.new(:test) do |test|
-  test.test_files = Dir['test/test_*.rb']
+  s.has_rdoc              = false
+  s.files                 = %w( README LICENSE ChangeLog Rakefile ) + Dir['{bin,lib}/**/*']
+  s.executables           = [ 'nanoc' ]
+  s.require_path          = 'lib'
+  s.bindir                = 'bin'
 end
 
-#####
-
-task :default => [ :test ]
+Rake::GemPackageTask.new(spec) { |task| }
 
 task :install_gem do
   sh %{rake package}
@@ -59,3 +58,11 @@ end
 task :uninstall_gem do
   sh %{sudo gem uninstall #{NAME}}
 end
+
+### Testing
+
+Rake::TestTask.new(:test) do |test|
+  test.test_files = Dir['test/test_*.rb']
+end
+
+task :default => [ :test ]

data/bin/nanoc

@@ -1,26 +1,35 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../lib/nanoc.rb'
+# Get what we need
 
+require File.dirname(__FILE__) + '/../lib/nanoc.rb'
 require 'getoptlong'
 
-try_require 'rubygems'
+# Helper functions
+
+def usage(s)
+  error(s, 'Usage')
+end
 
 # Define some texts
+
 version_text = "nanoc #{Nanoc::VERSION} (c) 2007 Denis Defreyne."
-usage_text   = "Usage: nanoc [options] [command] [parameters]"
 help_text    = <<EOT
-Usage: nanoc [-chv]
-       nanoc create_site <name>
-       nanoc create_page <name> [-t template]
-       nanoc create_template <name>
+Usage: nanoc [-chvV]
        nanoc compile
+       nanoc autocompile
+       nanoc create_layout [layout_name]
+       nanoc create_page [page_name] [-t template]
+       nanoc create_site [site_name]
+       nanoc create_template [template_name]
 
 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)
+    -h, --help          Show this help message and quit.
+    -p, --port          Port the autocompiler should be run on.
+    -t, --template      Template that should be used when creating a page.
+                        (can only be used with create_page)
+    -V, --verbose       Display more verbose log messages.
+    -v, --version       Show the nanoc version number and quit.
 
 Description:
     The 'nanoc' command is used for creating nanoc-powered sites, as well as
@@ -29,72 +38,167 @@ Description:
     Read more about nanoc on the site: <http://nanoc.stoneship.org/>
 EOT
 
+# Create site
+
+$nanoc_site = Nanoc::Site.from_cwd
+
 # Parse options
+
 opts = GetoptLong.new(
-  [ '--help',       '-h', GetoptLong::NO_ARGUMENT ],
-  [ '--template',   '-t', GetoptLong::REQUIRED_ARGUMENT ],
-  [ '--version',    '-v', GetoptLong::NO_ARGUMENT ]
+  [ '--help',     '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--port',     '-p', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--template', '-t', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--verbose',  '-V', GetoptLong::NO_ARGUMENT ],
+  [ '--version',  '-v', GetoptLong::NO_ARGUMENT ],
+  [ '--yes',      '-y', GetoptLong::NO_ARGUMENT ]
 )
-unprocessed_opts = {}
+$unprocessed_opts = {}
 begin
   opts.each do |opt, arg|
     case opt
     when '--help'
       $stderr.puts help_text
       exit
+    when '--verbose'
+      $log_level = :low
     when '--version'
       puts version_text
       exit
     else
-      unprocessed_opts[opt] = arg
+      $unprocessed_opts[opt] = arg
     end
   end
 rescue GetoptLong::InvalidOption
   $stderr.puts usage_text
-  exit
+  exit(1)
 end
 
 # Make sure we have at least one argument
-if ARGV.size == 0
-  $stderr.puts usage_text
-  exit
+
+usage 'nanoc [options] [command] [parameters]' if ARGV.size == 0
+
+# Functions for handing commands
+
+def setup
+  # Check syntax
+  usage 'Usage: nanoc setup' if ARGV.size != 1
+
+  # Make sure we are in a nanoc site directory
+  unless $nanoc_site
+    error 'The current working directory does not seem to ' +
+      'be a valid/complete nanoc site directory; aborting.'
+  end
+
+  # Check for -y switch
+  unless $unprocessed_opts.has_key?('--yes')
+    error 'Are you absolutely sure you want to set up the data source for ' +
+          'this site? Setting up the data source will remove existing ' +
+          'data. To continue, use the -y switch, like "nanoc setup -y".'
+  end
+
+  # Setup
+  $nanoc_site.setup
 end
 
-# Handle command
-command = ARGV[0]
-case command
+def create_site
+  # Check syntax
+  usage 'Usage: nanoc create_site [site_name] [options]' if ARGV.size != 2
+
   # Create site
-  when 'create_site', 'cs'
-    if ARGV.size != 2
-      $stderr.puts 'Usage: nanoc create_site [site_name]'
-      exit
-    end
-    $nanoc_creator.create_site(ARGV[1])
+  Nanoc::Site.create(ARGV[1])
+end
+
+def create_page
+  # Check syntax
+  usage 'Usage: nanoc create_page [page_name] [options]' if ARGV.size != 2
+
+  # Make sure we are in a nanoc site directory
+  unless $nanoc_site
+    error 'The current working directory does not seem to ' +
+      'be a valid/complete nanoc site directory; aborting.'
+  end
 
   # Create page
-  when 'create_page', 'cp'
-    if ARGV.size != 2
-      $stderr.puts 'Usage: nanoc create_page [page_name]'
-      exit
-    end
-    $nanoc_creator.create_page(ARGV[1], :template => unprocessed_opts['--template'])
+  if $unprocessed_opts['--template'].nil?
+    $nanoc_site.create_page(ARGV[1])
+  else
+    $nanoc_site.create_page(ARGV[1], $unprocessed_opts['--template'])
+  end
+end
+
+def create_layout
+  # Check syntax
+  usage 'nanoc create_layout [layout_name]' if ARGV.size != 2
+
+  # Make sure we are in a nanoc site directory
+  unless $nanoc_site
+    error 'The current working directory does not seem to ' +
+      'be a valid/complete nanoc site directory; aborting.'
+  end
 
   # Create template
-  when 'create_template', 'ct'
-    if ARGV.size != 2
-      $stderr.puts 'Usage: nanoc create_template [template_name]'
-      exit
-    end
-    $nanoc_creator.create_template(ARGV[1])
+  $nanoc_site.create_layout(ARGV[1])
+end
 
-  # Process site and generate output
-  when 'compile', 'compile_site', 'co'
-    if ARGV.size != 1
-      $stderr.puts 'Usage: nanoc compile'
-      exit
-    end
-    $nanoc_compiler.run
+def create_template
+  # Check syntax
+  usage 'nanoc create_template [template_name]' if ARGV.size != 2
+
+  # Make sure we are in a nanoc site directory
+  unless $nanoc_site
+    error 'The current working directory does not seem to ' +
+      'be a valid/complete nanoc site directory; aborting.'
+  end
+
+  # Create template
+  $nanoc_site.create_template(ARGV[1])
+end
 
+def compile_site
+  # Check syntax
+  usage 'nanoc compile' if ARGV.size != 1
+
+  # Make sure we are in a nanoc site directory
+  unless $nanoc_site
+    error 'The current working directory does not seem to ' +
+      'be a valid/complete nanoc site directory; aborting.'
+  end
+
+  # Compile site
+  $nanoc_site.compile
+end
+
+def autocompile_site
+  # Check syntax
+  usage 'nanoc compile' if ARGV.size != 1
+
+  # Make sure we are in a nanoc site directory
+  unless $nanoc_site
+    error 'The current working directory does not seem to ' +
+      'be a valid/complete nanoc site directory; aborting.'
+  end
+
+  # Autocompile site
+  $nanoc_site.autocompile($unprocessed_opts['--port'])
+end
+
+# Handle command
+
+case ARGV[0]
+  when 'autocompile_site', 'autocompile', 'aco'
+    autocompile_site
+  when 'create_site', 'cs'
+    create_site
+  when 'create_page', 'cp'
+    create_page
+  when 'create_layout', 'cl'
+    create_layout
+  when 'create_template', 'ct'
+    create_template
+  when 'compile_site', 'compile', 'co'
+    compile_site
+  when 'setup', 's'
+    setup
   else
-    puts 'Unrecognised command \'' + command + '\''
+    error 'Unrecognised command \'' + ARGV[0] + '\''
 end

data/lib/nanoc.rb

@@ -1,42 +1,24 @@
 module Nanoc
 
-  VERSION = '1.6.2'
+  VERSION = '2.0'
 
-  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
-      exit
-    end
-  end
-
-  private
-
-  def self.in_site?
-    return false unless File.directory?('content')
-    return false unless File.directory?('layouts')
-    return false unless File.directory?('lib')
-    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
+  def self.load_file(*path)
+    full_path = [ File.dirname(__FILE__), 'nanoc' ] + path
+    Dir[File.join(full_path)].each { |f| require f }
   end
 
 end
 
-require File.dirname(__FILE__) + '/nanoc/enhancements.rb'
-
-require File.dirname(__FILE__) + '/nanoc/creator.rb'
-require File.dirname(__FILE__) + '/nanoc/compiler.rb'
+# Load base
+Nanoc.load_file('base', 'enhancements.rb')
+Nanoc.load_file('base', 'core_ext', '*.rb')
+Nanoc.load_file('base', 'plugin.rb')
+Nanoc.load_file('base', '*.rb')
 
-$nanoc_creator  = Nanoc::Creator.new
-$nanoc_compiler = Nanoc::Compiler.new
+# Load plugins
+Nanoc.load_file('data_sources', '*.rb')
+Nanoc.load_file('filters', '*.rb')
+Nanoc.load_file('layout_processors', '*.rb')
 
-require File.dirname(__FILE__) + '/nanoc/core_ext.rb'
-require File.dirname(__FILE__) + '/nanoc/filters.rb'
-require File.dirname(__FILE__) + '/nanoc/page.rb'
-require File.dirname(__FILE__) + '/nanoc/page_drop.rb'
-require File.dirname(__FILE__) + '/nanoc/page_proxy.rb'
+# Get global binding
+$nanoc_binding = binding

data/lib/nanoc/base/auto_compiler.rb

@@ -0,0 +1,124 @@
+require 'webrick'
+
+module Nanoc
+
+  class AutoCompiler
+
+    ERROR_404 = <<END
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+	<head>
+		<title>404 File Not Found</title>
+		<style type="text/css">
+			body { padding: 10px; border: 10px solid #f00; margin: 10px; font-family: Helvetica, Arial, sans-serif; }
+		</style>
+	</head>
+	<body>
+		<h1>404 File Not Found</h1>
+		<p>The file you requested, <i><%=h path %></i>, was not found on this server.</p>
+	</body>
+</html>
+END
+
+    ERROR_500 = <<END
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+	<head>
+		<title>500 Server Error</title>
+		<style type="text/css">
+			body { padding: 10px; border: 10px solid #f00; margin: 10px; font-family: Helvetica, Arial, sans-serif; }
+		</style>
+	</head>
+	<body>
+		<h1>500 Server Error</h1>
+		<p>An error occurred while compiling the page you requested, <i><%=h path %></i>.</p>
+		<p>If you think this is a bug in nanoc, please do <a href="http://nanoc.stoneship.org/trac/newticket">report it</a>&mdash;thanks!</p>
+		<p>Message:</p>
+		<blockquote><p><%=h exception.message %></p></blockquote>
+		<p>Backtrace:</p>
+		<ol>
+<% exception.backtrace.each do |line| %>
+			<li><%= line %></li>
+<% end %>
+		</ol>
+	</body>
+</html>
+END
+
+    def initialize(site)
+      # Set site
+      @site = site
+    end
+
+    def start(port)
+      nanoc_require('mime/types', "'mime/types' is required to autocompile sites.")
+      
+      # Create server
+      @server = WEBrick::HTTPServer.new(:Port => port || 3000)
+      @server.mount_proc("/") { |request, response| handle_request(request, response) }
+
+      # Start server
+      trap('INT') { @server.shutdown }
+      @server.start
+    end
+
+    def handle_request(request, response)
+      # Reload site data
+      @site.load_data(true)
+
+      # Get page or file
+      page      = @site.pages.find { |page| page.path == request.path }
+      file_path = @site.config[:output_dir] + request.path
+
+      if page.nil?
+        # Serve file
+        if File.exist?(file_path)
+          serve_file(file_path, response)
+        else
+          serve_404(request.path, response)
+        end
+      else
+        # Serve page
+        serve_page(page, response)
+      end
+    end
+
+    def h(s)
+      ERB::Util.html_escape(s)
+    end
+
+    def serve_404(path, response)
+      response.status           = 404
+      response['Content-Type']  = 'text/html'
+      response.body             = ERB.new(ERROR_404).result(binding)
+    end
+
+    def serve_500(path, exception, response)
+      response.status           = 500
+      response['Content-Type']  = 'text/html'
+      response.body             = ERB.new(ERROR_500).result(binding)
+    end
+
+    def serve_file(path, response)
+      response.status           = 200
+      response['Content-Type']  = MIME::Types.of(path).first || 'application/octet-stream'
+      response.body             = File.read(path)
+    end
+
+    def serve_page(page, response)
+      # Recompile page
+      begin
+        @site.compiler.run(page)
+      rescue => exception
+        serve_500(page.path, exception, response)
+        return
+      end
+
+      response.status           = 200
+      response['Content-Type']  = 'text/html'
+      response.body             = page.layouted_content
+    end
+
+  end
+
+end