nanoc 2.1.6 → 2.2

data/ChangeLog

@@ -1,221 +1,3 @@
-nanoc Release Notes
-===================
-
-2.1.6
------
-
-* The FilesystemCombined data source now supports empty metadata sections
-* The RDoc filter now works for both RDoc 1.x and 2.x
-* The autocompiler now serves a 500 when an exception occurs outside
-  compilation
-* The autocompiler no longer serves index files when the request path does not
-  end with a slash
-* The autocompiler now always serves asset content correctly
-
-2.1.5
------
-
-* Added Ruby 1.9 compatibility
-* The Filesystem and FilesystemCombined data sources now preserve custom
-  extensions
-
-2.1.4
------
-
-* Fixed an issue where the autocompiler in Windows would serve broken assets
-
-2.1.3
------
-
-* The Haml and Sass filters now correctly take their options from assets
-* Autocompiler now serves index files instead of 404s
-* Layouts named "index" are now handled correctly
-* filesystem_combined now properly handles assets
-
-2.1.2
------
-
-* Autocompiler now compiles assets as well
-* Sass filter now takes options (just like the Haml filter)
-* Haml/Sass options are now taken from the page *rep* instead of the page
-
-2.1.1
------
-
-* Fixed issue which would cause files not to be required in the right order
-
-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
------
-
-* Fixed default.rb's `html_escape`
-* Updated Haml filter and layout processor so that @page, @pages and @config
-  are now available as instance variables instead of local variables
-
-2.0.3
------
-
-* 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"
-
-2.0.2
------
-
-* nanoc now requires Ruby 1.8.5 instead of 1.8.6
-
-2.0.1
------
-
-* Fixed a "too many open files" error that could appear during (auto)compiling
-
-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
------
-
-* Removed a stray debug message
-
-1.6
----
-
-* Added support for post-layout filters
-* Added support for getting a File object for the page, so you can now e.g.
-  easily get the modification time for a given page (`@page.file.mtime`)
-* Cleaned up the source code a lot
-* Removed deprecated asset-copying functionality
-
-1.5
----
-
-* Added support for custom filters
-* Improved Liquid support -- Liquid is now a first-class nanoc citizen
-* Deprecated assets -- use something like rsync instead
-* Added eruby_engine option, which can be 'erb' or 'erubis'
-
-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
-  directory specified in 'config.yaml'
-
-1.3
----
-
-* The @pages array now also contains uncompiled pages
-* Pages with 'skip_output' set to true will not be outputted
-* Added new filters
-	* Textile/RedCloth
-	* Sass
-* nanoc now warns before overwriting in create_site, create_page and
-  create_template (but not in compile)
-
-1.2
----
-
-* Sites now have an 'assets' directory, whose contents are copied to the
-  'output' directory when compiling [Soryu]
-* Added support for non-eRuby layouts (Markaby, Haml, Liquid, ...)
-* 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
-* 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 layoutless pages to be outputted 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
+For a list of all changes, please see the changelog on the project repository
+instead (http://projects.stoneship.org/hg/shared/nanoc/shortlog). For release
+notes, please see the NEWS file.

data/Rakefile

@@ -2,13 +2,11 @@
 
 # Rake etc
 require 'rake'
-require 'rake/clean'
 require 'rake/gempackagetask'
-require 'rake/testtask'
-require 'rake/rdoctask'
 
 # nanoc itself
-require File.dirname(__FILE__) + '/lib/nanoc.rb'
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+require 'nanoc'
 
 ##### Test Ruby 1.9
 
@@ -33,31 +31,21 @@ 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:
+Thanks for installing nanoc 2.2! 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.
+Be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for
+details about this release.
 
 Enjoy!
 EOS
 
-##### Cleaning
-
-CLEAN.include([
-  'coverage',
-  'rdoc',
-  'tmp',
-  File.join('test', 'fixtures', '*', 'output', '*'),
-  File.join('test', 'fixtures', '*', 'tmp')
-])
-CLOBBER.include([ 'pkg' ])
-
 ##### Packaging
 
-spec = Gem::Specification.new do |s|
+GemSpec = Gem::Specification.new do |s|
   s.name                  = NAME
   s.version               = VERS
   s.platform              = Gem::Platform::RUBY
@@ -88,42 +76,12 @@ spec = Gem::Specification.new do |s|
                               '--exclude' << 'vendor'                   <<
                               '--line-numbers'
 
-  s.files                 = %w( README LICENSE ChangeLog Rakefile ) + Dir[File.join('{bin,lib}', '**', '*')]
+  s.files                 = %w( README LICENSE ChangeLog Rakefile ) + Dir[File.join('{bin,lib,vendor}', '**', '*')]
   s.executables           = [ 'nanoc' ]
   s.require_path          = 'lib'
   s.bindir                = 'bin'
 end
 
-Rake::GemPackageTask.new(spec) { |task| }
-
-task :install_gem do
-  sh %{rake package}
-  sh %{gem install pkg/#{NAME}-#{VERS}}
-end
-
-task :uninstall_gem do
-  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
-
-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
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
 
-task :default => [ :test ]
+task :default => [ :fetch_dependencies, :test ]

data/bin/nanoc

@@ -1,8 +1,11 @@
 #!/usr/bin/env ruby
 
+# Add lib to load path
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
 # Load nanoc
-require File.dirname(__FILE__) + '/../lib/nanoc.rb'
-require File.dirname(__FILE__) + '/../lib/nanoc/cli.rb'
+require 'nanoc'
+require 'nanoc/cli'
 
 # Load custom code that can't be load later
 Dir['lib/commands/*.rb'].each     { |f| require f }

data/lib/nanoc.rb

@@ -1,7 +1,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '2.1.6'
+  VERSION = '2.2'
 
   # Generic error. Superclass for all nanoc-specific errors.
   class Error < RuntimeError ; end
@@ -57,39 +57,17 @@ module Nanoc
   module Routers # :nodoc:
   end
 
-  # Requires the given Ruby files at the specified path.
-  #
-  # +path+:: An array containing path segments. This path is relative to the
-  #          directory this file (nanoc.rb) is in. Can contain wildcards.
-  def self.load(*path)
-    full_path = [ File.dirname(__FILE__), 'nanoc' ] + path
-    Dir[File.join(full_path)].sort.each { |f| require f }
-  end
-
 end
 
 # Load requirements
-begin ; require 'rubygems' ; rescue LoadError ; end
 require 'yaml'
 require 'fileutils'
 
-# Load base
-Nanoc.load('base', 'enhancements.rb')
-Nanoc.load('base', 'defaults.rb')
-Nanoc.load('base', 'proxy.rb')
-Nanoc.load('base', 'proxies', '*.rb')
-Nanoc.load('base', 'core_ext', '*.rb')
-Nanoc.load('base', 'plugin.rb')
-Nanoc.load('base', '*.rb')
-
-# Load extra's
-Nanoc.load('extra', 'core_ext', '*.rb')
-Nanoc.load('extra', '*.rb')
-Nanoc.load('extra', 'vcses', '*.rb')
-
-# Load plugins
-Nanoc.load('data_sources', '*.rb')
-Nanoc.load('filters', '*.rb')
-Nanoc.load('binary_filters', '*.rb')
-Nanoc.load('routers', '*.rb')
-Nanoc.load('helpers', '*.rb')
+# Load nanoc
+require 'nanoc/base'
+require 'nanoc/extra'
+require 'nanoc/data_sources'
+require 'nanoc/binary_filters'
+require 'nanoc/filters'
+require 'nanoc/routers'
+require 'nanoc/helpers'

data/lib/nanoc/base.rb

@@ -0,0 +1,26 @@
+module Nanoc
+
+  autoload :Asset,              'nanoc/base/asset'
+  autoload :AssetDefaults,      'nanoc/base/asset_defaults'
+  autoload :AssetRep,           'nanoc/base/asset_rep'
+  autoload :BinaryFilter,       'nanoc/base/binary_filter'
+  autoload :Code,               'nanoc/base/code'
+  autoload :Compiler,           'nanoc/base/compiler'
+  autoload :DataSource,         'nanoc/base/data_source'
+  autoload :Defaults,           'nanoc/base/defaults'
+  autoload :Filter,             'nanoc/base/filter'
+  autoload :Layout,             'nanoc/base/layout'
+  autoload :NotificationCenter, 'nanoc/base/notification_center'
+  autoload :Page,               'nanoc/base/page'
+  autoload :PageDefaults,       'nanoc/base/page_defaults'
+  autoload :PageRep,            'nanoc/base/page_rep'
+  autoload :Plugin,             'nanoc/base/plugin'
+  autoload :Proxy,              'nanoc/base/proxy'
+  autoload :Router,             'nanoc/base/router'
+  autoload :Site,               'nanoc/base/site'
+  autoload :Template,           'nanoc/base/template'
+
+  require 'nanoc/base/core_ext'
+  require 'nanoc/base/proxies'
+
+end

data/lib/nanoc/base/core_ext.rb

@@ -0,0 +1,2 @@
+require 'nanoc/base/core_ext/hash'
+require 'nanoc/base/core_ext/string'

data/lib/nanoc/base/filter.rb

@@ -74,48 +74,18 @@ module Nanoc
       })
     end
 
-    class << self
-
-      # Deprecated
-      def extensions(*extensions) # :nodoc:
-        # Initialize
-        if !instance_variables.include?('@extensions') && !instance_variables.include?(:'@extensions')
-          @extensions = []
-        end
-
-        if extensions.empty?
-          @extensions
-        else
-          @extensions = extensions
-          @extensions.each { |e| register_extension(e, self) }
-        end
-      end
-
-      # Deprecated
-      def extension(extension=nil) # :nodoc:
-        # Initialize
-        if !instance_variables.include?('@extensions') && !instance_variables.include?(:'@extensions')
-          @extensions = []
-        end
-
-        if extension.nil?
-          @extensions.first
-        else
-          @extensions = [ extension ]
-          register_extension(extension, self)
-        end
-      end
-
-      # Deprecated
-      def register_extension(extension, klass)
-        EXTENSIONS_MAP[extension] = klass
-      end
-
-      # Deprecated
-      def with_extension(extension)
-        EXTENSIONS_MAP[extension]
+    # Returns the filename associated with the item that is being filtered.
+    # The returned filename is in the format "page <path> (rep <name>)".
+    def filename
+      if assigns[:layout]
+        "layout #{assigns[:layout].path}"
+      elsif assigns[:page]
+        "page #{assigns[:_obj].path} (rep #{assigns[:_obj_rep].name})"
+      elsif assigns[:asset]
+        "asset #{assigns[:_obj].path} (rep #{assigns[:_obj_rep].name})"
+      else
+        '?'
       end
-
     end
 
   end