nanoc 2.0.4 → 2.1

data/ChangeLog

@@ -1,6 +1,36 @@
 nanoc Release Notes
 ===================
 
+2.1
+---
+
+This is only a short summary of all changes in 2.1. For details, see the nanoc
+web site at <http://nanoc.stoneship.org/> -- especially the blog and the
+updated manual will be useful.
+
+New:
+
+* New filters: RDiscount, Maruku, Erubis
+* A better commandline frontend
+* A new filesystem data source named "filesystem_combined"
+* Routers, which decide where compiled pages should be written to
+* Page/layout mtimes can now be retrieved through page.mtime/layout.mtime
+
+Changed:
+
+* Already compiled pages will no longer be re-compiled unless outdated
+* Layout processors and filters have been merged
+* Layouts no longer rely on file extensions to determine the layout processor
+* Greatly improved source code documentation
+* Greatly improved unit test suite
+
+Removed:
+
+* Several filters have been removed and replaced by newer filters:
+	* `eruby`: use `erb` or `erubis` instead
+	* `markdown`: use `bluecloth`, `rdiscount` or `maruku` instead
+	* `textile`: use `redcloth` instead
+
 2.0.4
 -----
 
@@ -11,7 +41,7 @@ nanoc Release Notes
 2.0.3
 -----
 
-* The utocompiler now honors custom paths
+* The autocompiler now honors custom paths
 * The autocompiler now attempts to serve pages with the most appropriate MIME
   type, instead of always serving everything as "text/html"
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Denis Defreyne
+Copyright (c) 2007-2008 Denis Defreyne and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -1,14 +1,74 @@
 == Overview
 
-nanoc is a simple but very flexible content management system written in Ruby.
+nanoc is a simple but very flexible static site generator written in Ruby.
 It operates on local files, and therefore does not run on the server. nanoc
 "compiles" the local source files into HTML (usually), by evaluating eRuby,
 Markdown, etc.
 
 == Documentation
 
-nanoc has a web site at <http://nanoc.stoneship.org/>, which contains a
-"Getting Started" guide as well as a reference for nanoc.
+nanoc's web site, which can be found at http://nanoc.stoneship.org, contains a
+few useful resources to help you get started with nanoc:
+
+* The tutorial at http://nanoc.stoneship.org/help/tutorial
+* The manual at http://nanoc.stoneship.org/help/manual
+
+It is probably also worth checking out and perhaps subscribing to the
+discussion groups:
+
+* The discussion group in English at http://groups.google.com/group/nanoc
+* The discussion group in Spanish at http://groups.google.com/group/nanoc-es
+
+=== Source Code Documentation
+
+The source code is structured in a few directories:
+
+* *bin* contains the commandline tool aptly named +nanoc+
+* *lib*
+  * *nanoc*
+    * *base* contains the bare essentials necessary for nanoc to function
+    * *binary_filters* contains the standard binary filters
+      (Nanoc::BinaryFilter subclasses) such as the thumbnail filter
+    * *cli* contains the commandline interface
+    * *data_sources* contains the standard data sources (Nanoc::DataSource
+      subclasses), such as the filesystem data source
+    * *helpers* contains helpers, which provide functionality some sites
+      may find useful, such as the blogging and tagging helpers
+    * *extra* contains stuff that is not needed by nanoc itself, but which may
+      be used by helpers, data sources, filters or routers.
+    * *filters* contains the standard filters (Nanoc::Filter subclasses) such
+      as ERB, Markdown, Haml, ...
+    * *routers* contains the standard routers (Nanoc::Router subclasses)
+* *test* contains test fixtures as well as testing code, structured in the
+  same way as lib/nanoc
+
+The namespaces (modules) are organised like this:
+
+* *Nanoc* is the namespace for everything nanoc-related (obviously). The
+  classes in 'lib/nanoc/base' are part of this module (not Nanoc::Base which
+  does not exist)
+  * *BinaryFilters* contains the binary filters
+  * *CLI* containing everything related to the commandline tool.
+  * *DataSources* contains the data sources
+  * *Helpers* contains the helpers
+  * *Extra* contains useful stuff not needed by nanoc itself
+  * *Filters* contains the (textual) filters
+  * *Routers* contains the routers
+
+The central class in nanoc is Nanoc::Site, so you should start there if you
+want to explore nanoc from a technical perspective.
+
+== Contributors
+
+(In alphabetical order)
+
+* Colin Barrett
+* Dmitry Bilunov
+* Šime Ramov
+* "Soryu"
+* Dennis Sutch
+
+Special thanks to Ale Muñoz.
 
 == Contact
 

data/Rakefile

@@ -4,25 +4,44 @@ require 'rake'
 
 require 'rake/clean'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 require 'rake/testtask'
 
 require File.dirname(__FILE__) + '/lib/nanoc.rb'
 
 ##### General details
 
-NAME    = 'nanoc'
-VERS    = Nanoc::VERSION
-SUMMARY = 'a tool that runs on your local computer and compiles Markdown, ' +
-          'Textile, Haml, ... documents into static web pages'
+NAME      = 'nanoc'
+VERS      = Nanoc::VERSION
+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'
 
+MESSAGE   = <<EOS
+Thanks for installing nanoc 2.1! Here are some resources to help you get started:
+
+* The tutorial at <http://nanoc.stoneship.org/help/tutorial/>
+* The manual at <http://nanoc.stoneship.org/help/manual/>
+* The discussion group at <http://groups.google.com/group/nanoc>
+
+Because nanoc 2.1 has a lot of new features, be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for details about this release.
+
+Enjoy!
+EOS
+
 ##### Cleaning
 
-CLEAN.include [ 'tmp', 'test/fixtures/*/output/*', 'test/fixtures/*/tmp' ]
-CLOBBER.include [ 'pkg' ]
+CLEAN.include([
+  'coverage',
+  'rdoc',
+  'tmp',
+  File.join('test', 'fixtures', '*', 'output', '*'),
+  File.join('test', 'fixtures', '*', 'tmp')
+])
+CLOBBER.include([ 'pkg' ])
 
 ##### Packaging
 
@@ -37,12 +56,25 @@ spec = Gem::Specification.new do |s|
   s.author                = AUTHOR
   s.email                 = EMAIL
 
+  s.post_install_message  = '-' * 78 + "\n" + MESSAGE + '-' * 78
+
   s.rubyforge_project     = 'nanoc'
 
   s.required_ruby_version = '>= 1.8.5'
 
-  s.has_rdoc              = false
-  s.files                 = %w( README LICENSE ChangeLog Rakefile ) + Dir['{bin,lib}/**/*']
+  s.has_rdoc              = true
+  s.extra_rdoc_files      = [ 'README' ]
+  s.rdoc_options          <<  '--title'   << 'nanoc'                    <<
+                              '--main'    << 'README'                   <<
+                              '--charset' << 'utf-8'                    <<
+                              '--exclude' << 'lib/nanoc/cli/commands'   <<
+                              '--exclude' << 'lib/nanoc/binary_filters' <<
+                              '--exclude' << 'lib/nanoc/extra/vcses'    <<
+                              '--exclude' << 'lib/nanoc/filters'        <<
+                              '--exclude' << 'test'                     <<
+                              '--line-numbers'
+
+  s.files                 = %w( README LICENSE ChangeLog Rakefile ) + Dir[File.join('{bin,lib}', '**', '*')]
   s.executables           = [ 'nanoc' ]
   s.require_path          = 'lib'
   s.bindir                = 'bin'
@@ -52,17 +84,32 @@ Rake::GemPackageTask.new(spec) { |task| }
 
 task :install_gem do
   sh %{rake package}
-  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+  sh %{gem install pkg/#{NAME}-#{VERS}}
 end
 
 task :uninstall_gem do
-  sh %{sudo gem uninstall #{NAME}}
+  sh %{gem uninstall #{NAME}}
+end
+
+### Documentation
+
+Rake::RDocTask.new do |task|
+  task.rdoc_files.include(spec.extra_rdoc_files + [ 'lib' ])
+  task.rdoc_dir = 'rdoc'
+  task.options = spec.rdoc_options
 end
 
 ### Testing
 
-Rake::TestTask.new(:test) do |test|
-  test.test_files = Dir['test/test_*.rb']
+task :rcov do
+  sh %{rcov test/**/test_*.rb -I test -x /Library}
+end
+
+Rake::TestTask.new(:test) do |task|
+  ENV['QUIET'] = 'true'
+
+  task.libs       = [ 'lib', 'test' ]
+  task.test_files = Dir[ 'test/**/test_*.rb' ]
 end
 
 task :default => [ :test ]

data/bin/nanoc

@@ -1,204 +1,12 @@
 #!/usr/bin/env ruby
 
-# Get what we need
-
+# Load nanoc
 require File.dirname(__FILE__) + '/../lib/nanoc.rb'
-require 'getoptlong'
-
-# Helper functions
-
-def usage(s)
-  error(s, 'Usage')
-end
-
-# Define some texts
-
-version_text = "nanoc #{Nanoc::VERSION} (c) 2007-2008 Denis Defreyne."
-help_text    = <<EOT
-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.
-    -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
-    managing them: creating pages and templates and compiling the site.
-
-    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 ],
-  [ '--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 = {}
-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
-    end
-  end
-rescue GetoptLong::InvalidOption
-  $stderr.puts usage_text
-  exit(1)
-end
-
-# Make sure we have at least one argument
-
-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
-
-def create_site
-  # Check syntax
-  usage 'Usage: nanoc create_site [site_name] [options]' if ARGV.size != 2
-
-  # Create site
-  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
-  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
-  $nanoc_site.create_layout(ARGV[1])
-end
-
-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
+require File.dirname(__FILE__) + '/../lib/nanoc/cli.rb'
 
-# Handle command
+# Load custom code that can't be load later
+Dir['lib/commands/*.rb'].each     { |f| require f }
+Dir['lib/data_sources/*.rb'].each { |f| require f }
 
-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
-    error 'Unrecognised command \'' + ARGV[0] + '\''
-end
+# Run base
+Nanoc::CLI::Base.new.run(ARGV)