nanoc2 2.2.3

data/ChangeLog

@@ -0,0 +1,3 @@
+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/LICENSE

@@ -0,0 +1,19 @@
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,75 @@
+== Overview
+
+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'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
+      (Nanoc2::BinaryFilter subclasses) such as the thumbnail filter
+    * *cli* contains the commandline interface
+    * *data_sources* contains the standard data sources (Nanoc2::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 (Nanoc2::Filter subclasses) such
+      as ERB, Markdown, Haml, ...
+    * *routers* contains the standard routers (Nanoc2::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:
+
+* *Nanoc2* is the namespace for everything nanoc-related (obviously). The
+  classes in 'lib/nanoc2/base' are part of this module (not Nanoc2::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 Nanoc2::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
+
+You can reach me at <denis.defreyne@stoneship.org>.

data/Rakefile

@@ -0,0 +1,76 @@
+##### Requirements
+
+# Rake etc
+require 'rake'
+require 'rake/gempackagetask'
+
+# nanoc itself
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+require 'nanoc2'
+
+##### General details
+
+NAME      = 'nanoc2'
+VERS      = Nanoc2::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.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>
+
+Be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for
+details about this release.
+
+Enjoy!
+EOS
+
+##### Packaging
+
+GemSpec = 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.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              = true
+  s.extra_rdoc_files      = [ 'README' ]
+  s.rdoc_options          <<  '--title'   << 'nanoc2'                    <<
+                              '--main'    << 'README'                    <<
+                              '--charset' << 'utf-8'                     <<
+                              '--exclude' << 'lib/nanoc2/cli/commands'   <<
+                              '--exclude' << 'lib/nanoc2/binary_filters' <<
+                              '--exclude' << 'lib/nanoc2/extra/vcses'    <<
+                              '--exclude' << 'lib/nanoc2/filters'        <<
+                              '--exclude' << 'doc'                       <<
+                              '--exclude' << 'test'                      <<
+                              '--exclude' << 'vendor'                    <<
+                              '--line-numbers'
+
+  s.files                 = %w( README LICENSE ChangeLog Rakefile ) + Dir[File.join('{bin,lib,vendor}', '**', '*')]
+  s.executables           = [ 'nanoc2' ]
+  s.require_path          = 'lib'
+  s.bindir                = 'bin'
+end
+
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
+
+task :default => [ :fetch_dependencies, :test ]

data/bin/nanoc2

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+# Add lib to load path
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+# Print deprecation warning
+$stderr.puts <<-EOS
++----------------------------------------------------------------------------+
+| WARNING: nanoc 2.x has been superseded by nanoc 3.x and is no longer main- |
+| tained. There will be no future updates to nanoc 2.x. Consider upgrading   |
+| to nanoc 3.x. For more information, see the nanoc 2.x-to-3.x migration     |
+| guide at <http://nanoc.stoneship.org/migrating/>.                          |
++----------------------------------------------------------------------------+
+EOS
+$stderr.puts
+
+# Load nanoc
+require 'nanoc2'
+require 'nanoc2/cli'
+
+# 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 }
+
+# Run base
+Nanoc2::CLI::Base.new.run(ARGV)

data/lib/nanoc2.rb

@@ -0,0 +1,73 @@
+module Nanoc2
+
+  # The current nanoc version.
+  VERSION = '2.2.3'
+
+  # Generic error. Superclass for all nanoc-specific errors.
+  class Error < RuntimeError ; end
+
+  module Errors # :nodoc:
+
+    # Error that is raised when a site is loaded that uses a data source with
+    # an unknown identifier.
+    class UnknownDataSourceError < Error ; end
+
+    # Error that is raised when a site is loaded that uses a data source with
+    # an unknown identifier.
+    class UnknownRouterError < Error ; end
+
+    # Error that is raised during site compilation when a page uses a layout
+    # that is not present in the site.
+    class UnknownLayoutError < Error ; end
+
+    # Error that is raised during site compilation when a page uses a filter
+    # that is not known.
+    class UnknownFilterError < Error ; end
+
+    # Error that is raised during site compilation when a layout is compiled
+    # for which the filter cannot be determined. This is similar to the
+    # UnknownFilterError, but specific for filters for layouts.
+    class CannotDetermineFilterError < Error ; end
+
+    # Error that is raised during site compilation when a page (directly or
+    # indirectly) includes its own page content, leading to endless recursion.
+    class RecursiveCompilationError < Error ; end
+
+    # Error that is raised when a certain function or feature is used that is
+    # no longer supported by nanoc.
+    class NoLongerSupportedError < Error ; end
+
+  end
+
+  module BinaryFilters # :nodoc:
+  end
+
+  module DataSources # :nodoc:
+  end
+
+  module Helpers # :nodoc:
+  end
+
+  module Extra # :nodoc:
+  end
+
+  module Filters # :nodoc:
+  end
+
+  module Routers # :nodoc:
+  end
+
+end
+
+# Load requirements
+require 'yaml'
+require 'fileutils'
+
+# Load nanoc
+require 'nanoc2/base'
+require 'nanoc2/extra'
+require 'nanoc2/data_sources'
+require 'nanoc2/binary_filters'
+require 'nanoc2/filters'
+require 'nanoc2/routers'
+require 'nanoc2/helpers'

data/lib/nanoc2/base.rb

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

data/lib/nanoc2/base/asset.rb

@@ -0,0 +1,117 @@
+module Nanoc2
+
+  # A Nanoc2::Asset represents an asset in a nanoc site. It has a file object
+  # (File instance) and attributes, as well as a path. It can also store the
+  # modification time to speed up compilation.
+  #
+  # Each asset has a list of asset representations or reps (Nanoc2::AssetRep);
+  # compiling an asset actually compiles all of its assets.
+  class Asset
+
+    # Defaults values for assets.
+    DEFAULTS = {
+      :extension  => 'dat',
+      :binary     => true,
+      :filters    => []
+    }
+
+    # The Nanoc2::Site this asset belongs to.
+    attr_accessor :site
+
+    # This assets's file.
+    attr_reader   :file
+
+    # A hash containing this asset's attributes.
+    attr_accessor :attributes
+
+    # This asset's path.
+    attr_reader   :path
+
+    # The time when this asset was last modified.
+    attr_reader   :mtime
+
+    # This asset's list of asset representations.
+    attr_reader   :reps
+
+    # Creates a new asset.
+    #
+    # +file+:: An instance of File representing the uncompiled asset.
+    #
+    # +attributes+:: A hash containing this asset's attributes.
+    #
+    # +path+:: This asset's path.
+    #
+    # +mtime+:: The time when this asset was last modified.
+    def initialize(file, attributes, path, mtime=nil)
+      # Set primary attributes
+      @file           = file
+      @attributes     = attributes.clean
+      @path           = path.cleaned_path
+      @mtime          = mtime
+    end
+
+    # Builds the individual asset representations (Nanoc2::AssetRep) for this
+    # asset.
+    def build_reps
+      # Get list of rep names
+      rep_names_default = (@site.asset_defaults.attributes[:reps] || {}).keys
+      rep_names_this    = (@attributes[:reps] || {}).keys + [ :default ]
+      rep_names         = rep_names_default | rep_names_this
+
+      # Get list of reps
+      reps = rep_names.inject({}) do |memo, rep_name|
+        rep = (@attributes[:reps] || {})[rep_name]
+        is_bad = (@attributes[:reps] || {}).has_key?(rep_name) && rep.nil?
+        is_bad ? memo : memo.merge(rep_name => rep || {})
+      end
+
+      # Build reps
+      @reps = []
+      reps.each_pair do |name, attrs|
+        @reps << AssetRep.new(self, attrs, name)
+      end
+    end
+
+    # Returns a proxy (Nanoc2::AssetProxy) for this asset.
+    def to_proxy
+      @proxy ||= AssetProxy.new(self)
+    end
+
+    # Returns the attribute with the given name.
+    def attribute_named(name)
+      return @attributes[name] if @attributes.has_key?(name)
+      return @site.asset_defaults.attributes[name] if @site.asset_defaults.attributes.has_key?(name)
+      return DEFAULTS[name]
+    end
+
+    # Saves the asset in the database, creating it if it doesn't exist yet or
+    # updating it if it already exists. Tells the site's data source to save
+    # the asset.
+    def save
+      @site.data_source.loading do
+        @site.data_source.save_asset(self)
+      end
+    end
+
+    # Moves the asset to a new path. Tells the site's data source to move the
+    # asset.
+    def move_to(new_path)
+      @site.data_source.loading do
+        @site.data_source.move_asset(self, new_path)
+      end
+    end
+
+    # Deletes the asset. Tells the site's data source to delete the asset.
+    def delete
+      @site.data_source.loading do
+        @site.data_source.delete_asset(self)
+      end
+    end
+
+    def inspect
+      "<#{self.class} path=#{self.path}>"
+    end
+
+  end
+
+end

data/lib/nanoc2/base/asset_defaults.rb

@@ -0,0 +1,21 @@
+module Nanoc2
+
+  # Nanoc2::AssetDefaults represent the default attributes for all assets in
+  # the site. If a specific asset attribute is requested, but not found, then
+  # the asset defaults will be queried for this attribute. (If the attribute
+  # doesn't even exist in the asset defaults, hardcoded defaults will be
+  # used.)
+  class AssetDefaults < Defaults
+
+    # Saves the asset defaults in the database, creating it if it doesn't
+    # exist yet or updating it if it already exists. Tells the site's data
+    # source to save the asset defaults.
+    def save
+      @site.data_source.loading do
+        @site.data_source.save_asset_defaults(self)
+      end
+    end
+
+  end
+
+end