nanoc3 3.0.0

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/nanoc/shortlog). For release notes,
+please see the NEWS file.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2009 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/NEWS.rdoc

@@ -0,0 +1,262 @@
+= nanoc News
+
+== 3.0
+
+New:
+
+* Multiple data sources
+* Dependency tracking between items
+* Filters can now optionally take arguments
+* create_page and create_layout methods in data sources
+* A new way to specify compilation/routing rules using a Rules file
+* Coderay filter
+* A filesystem_compact data source which uses less directories
+
+Changed:
+
+* Pages and textual assets are now known as "items"
+
+Removed:
+
+* Support for drafts
+* Support for binary assets
+* Support for templates
+* Everything that was deprecated in nanoc 2.x
+* save_*, move_* and delete_* methods in data sources
+* Processing instructions in metadata
+
+== 2.2.2
+
+* Removed relativize_paths filter; use relativize_paths_in_html or
+  relativize_paths_in_css instead
+* Fixed bug which could cause nanoc to eat massive amounts of memory when an
+  exception occurs
+* Fixed bug which would cause nanoc to complain about the open file limit
+  being reached when using a large amount of assets
+
+== 2.2.1
+
+* Fixed bug which prevented relative_path_to from working
+* Split relativize_paths filter into two filter: relativize_paths_in_html
+  and relativize_paths_in_css
+* Removed bundled mime-types library
+
+== 2.2
+
+New:
+
+* --pages and --assets compiler options
+* --no-color commandline option
+* Filtering helper
+* relative_path_to function in LinkTo helper
+* Rainpress filter
+* RelativizePaths filter
+* The current layout is now accessible through the @layout variable
+* Much more informative stack traces when something goes wrong
+
+Changed:
+
+* The commandline option parser is now a lot more reliable
+* atom_feed now takes optional :content_proc, :excerpt_proc and :articles
+  parameters
+* The compile command show non-written items (those with skip_output: true)
+* The compile command compiles everything by default
+* Added --only-outdated option to compile only outdated pages
+
+Removed:
+
+* deprecated extension-based code
+
+== 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

data/README.rdoc

@@ -0,0 +1,80 @@
+= nanoc 3
+
+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
+
+nanoc3'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
+    * *cli* contains the commandline interface
+    * *data_sources* contains the standard data sources (Nanoc3::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 VCSes.
+    * *filters* contains the standard filters (Nanoc3::Filter subclasses) such
+      as ERB, Markdown, Haml, ...
+* *test* contains 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/nanoc3/base' are part of this module (not Nanoc3::Base which
+  does not exist)
+  * *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
+
+The central class in nanoc is Nanoc3::Site, so you should start there if you
+want to explore nanoc from a technical perspective.
+
+== Dependencies
+
+nanoc itself can be used without installing any dependencies. Some components, however, do have dependencies:
+
+autocompiler::             +mime-types+, +rack+
+documentation generation:: +rdoc+ (2.4 or newer), +yardoc+
+packaging::                +rubygems+ (1.3 or newer)
+
+You may need to manually install the rdoc gem and update the rubygems installation.
+
+== Contributors
+
+(In alphabetical order)
+
+* Christian Plessl
+* 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,11 @@
+# encoding: utf-8
+
+# Load nanoc
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+require 'nanoc3'
+
+# Load tasks
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
+
+# Set default talk
+task :default => [ :fetch_dependencies, :test ]

data/bin/nanoc3

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# Add lib to load path
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+# Load nanoc
+require 'nanoc3'
+require 'nanoc3/cli'
+
+# Load custom code that can't be load later
+Dir['lib/commands/*.rb'].sort.each     { |f| require f }
+Dir['lib/data_sources/*.rb'].sort.each { |f| require f }
+
+# Run base
+Nanoc3::CLI::Base.shared_base.run(ARGV)

data/lib/nanoc3/base/code_snippet.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # Nanoc3::CodeSnippet represent a piece of custom code of a nanoc site. It
+  # contains the textual source code as well as a mtime, which is used to
+  # speed up site compilation.
+  class CodeSnippet
+
+    # The Nanoc3::Site this code snippet belongs to.
+    attr_accessor :site
+
+    # A string containing the actual code in this code snippet.
+    attr_reader :data
+
+    # The filename corresponding to this code snippet.
+    attr_reader :filename
+
+    # The time where this code snippet was last modified.
+    attr_reader :mtime
+
+    # Creates a new code snippet.
+    #
+    # +data+::     The raw source code which will be executed before compilation.
+    #
+    # +filename+:: The filename corresponding to this code snippet.
+    #
+    # +mtime+::    The time when the code was last modified (can be nil).
+    def initialize(data, filename, mtime=nil)
+      @data     = data
+      @filename = filename
+      @mtime    = mtime
+    end
+
+    # Loads the code by executing it.
+    def load
+      eval(@data, TOPLEVEL_BINDING, @filename)
+    end
+
+  end
+
+end

data/lib/nanoc3/base/compiler.rb

@@ -0,0 +1,225 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # Nanoc3::Compiler is responsible for compiling a site's item
+  # representations.
+  class Compiler
+
+    # The compilation stack. When the compiler begins compiling a rep or a
+    # layout, it will be placed on the stack; when it is done compiling the
+    # rep or layout, it will be removed from the stack.
+    attr_reader :stack
+
+    # The list of compilation rules that will be used to compile items. This
+    # array will be filled by Nanoc3::Site#load_data.
+    attr_reader :item_compilation_rules
+
+    # The list of routing rules that will be used to give all items a path.
+    # This array will be filled by Nanoc3::Site#load_data.
+    attr_reader :item_routing_rules
+
+    # The hash containing layout-to-filter mapping rules.
+    attr_reader :layout_filter_mapping
+
+    # Creates a new compiler for the given site.
+    def initialize(site)
+      @site = site
+
+      @stack = []
+
+      @item_compilation_rules  = []
+      @item_routing_rules      = []
+      @layout_filter_mapping   = {}
+    end
+
+    # Compiles (part of) the site and writes out the compiled item
+    # representations.
+    #
+    # +items+:: The items that should be compiled, along with their
+    #           dependencies. Pass +nil+ if the entire site should be
+    #           compiled.
+    #
+    # This method also accepts a few optional parameters:
+    #
+    # +:force+:: true if the rep should be compiled even if it is not
+    #            outdated, false if not. Defaults to false.
+    def run(item=nil, params={})
+      # Create output directory if necessary
+      FileUtils.mkdir_p(@site.config[:output_dir])
+
+      # Load dependencies
+      dependency_tracker.load_graph
+      print_dependency_graph if $DEBUG
+
+      # Get items and reps to compile
+      if item
+        items = [ item ] + dependency_tracker.all_inverse_dependencies_for(item)
+        items.uniq!
+      else
+        items = @site.items
+      end
+      reps = items.map { |i| i.reps }.flatten
+
+      # Prepare dependencies
+      mark_outdated_items(reps, params.has_key?(:force) && params[:force])
+      forget_dependencies_if_outdated(items)
+
+      # Compile reps
+      dependency_tracker.start
+      compile_reps(reps)
+      dependency_tracker.stop
+
+      # Store dependencies
+      dependency_tracker.store_graph
+    end
+
+    # Returns the first matching compilation rule for the given rep.
+    def compilation_rule_for(rep)
+      @item_compilation_rules.find do |rule|
+        rule.applicable_to?(rep.item) && rule.rep_name == rep.name
+      end
+    end
+
+    # Returns the first matching routing rule for the given rep.
+    def routing_rule_for(rep)
+      @item_routing_rules.find do |rule|
+        rule.applicable_to?(rep.item) && rule.rep_name == rep.name
+      end
+    end
+
+    # Returns a tuple containing the filter name and the filter arguments for
+    # the given layout.
+    def filter_for_layout(layout)
+      @layout_filter_mapping.each_pair do |layout_identifier, filter_name_and_args|
+        return filter_name_and_args if layout.identifier =~ layout_identifier
+      end
+      nil
+    end
+
+  private
+
+    # Compiles all item representations in the site.
+    def compile_reps(reps)
+      active_reps, skipped_reps = reps.partition { |rep| rep.outdated? || rep.item.dependencies_outdated? }
+      inactive_reps = []
+      compiled_reps = []
+
+      # Repeat as long as something is successfully compiled...
+      changed = true
+      until !changed
+        changed = false
+
+        # Attempt to compile all active reps
+        until active_reps.empty?
+          @stack.clear
+          begin
+            rep = active_reps.shift
+            puts "*** Attempting to compile #{rep.inspect}" if $DEBUG
+
+            @stack.push(rep)
+            compile_rep(rep)
+          rescue Nanoc3::Errors::UnmetDependency => e
+            puts "*** Attempt failed due to unmet dependency on #{e.rep.inspect}" if $DEBUG
+
+            # Save rep to compile it later
+            inactive_reps << rep
+
+            # Add dependency to list of items to compile
+            unless active_reps.include?(e.rep) || inactive_reps.include?(e.rep)
+              changed = true
+              skipped_reps.delete(e.rep)
+              inactive_reps.unshift(e.rep)
+            end
+          else
+            puts "*** Attempt succeeded" if $DEBUG
+
+            changed = true
+            compiled_reps << rep
+          end
+          puts if $DEBUG
+        end
+
+        # Retry
+        puts "*** No active reps left; activating all (#{inactive_reps.size}) inactive reps" if $DEBUG
+        puts if $DEBUG
+        active_reps   = inactive_reps
+        inactive_reps = []
+      end
+
+      # Notify skipped reps
+      skipped_reps.each do |rep|
+        Nanoc3::NotificationCenter.post(:compilation_started, rep)
+        Nanoc3::NotificationCenter.post(:compilation_ended,   rep)
+      end
+
+      # Raise error if some active but non-compileable reps are left
+      if !active_reps.empty?
+        raise Nanoc3::Errors::RecursiveCompilation.new(active_reps)
+      end
+    end
+
+    # Compiles the given item representation.
+    #
+    # This method should not be called directly; please use
+    # Nanoc3::Compiler#run instead, and pass this item representation's item as
+    # its first argument.
+    #
+    # +rep+:: The rep that is to be compiled.
+    def compile_rep(rep)
+      # Start
+      Nanoc3::NotificationCenter.post(:compilation_started, rep)
+      Nanoc3::NotificationCenter.post(:visit_started,       rep.item)
+
+      # Apply matching rule
+      compilation_rule_for(rep).apply_to(rep)
+      rep.compiled = true
+
+      # Write if rep is routed
+      rep.write unless rep.raw_path.nil?
+
+      # Stop
+      Nanoc3::NotificationCenter.post(:visit_ended,       rep.item)
+      Nanoc3::NotificationCenter.post(:compilation_ended, rep)
+    end
+
+    # Returns the dependency tracker for this site.
+    def dependency_tracker
+      @dependency_tracker ||= Nanoc3::DependencyTracker.new(@site.items)
+    end
+
+    # Marks the necessary items as outdated.
+    def mark_outdated_items(reps, force)
+      if force
+        reps.each { |r| r.force_outdated = true }
+      else
+        dependency_tracker.mark_outdated_items
+      end
+    end
+
+    # Clears the list of dependencies for items that will be recompiled.
+    def forget_dependencies_if_outdated(items)
+      items.each do |i|
+        if i.outdated? || i.dependencies_outdated?
+          dependency_tracker.forget_dependencies_for(i)
+        end
+      end
+    end
+
+    # Prints the dependency graph.
+    def print_dependency_graph
+      graph = dependency_tracker.instance_eval { @graph }
+      puts "DEPENDENCY GRAPH:"
+      graph.each_pair do |key, values|
+        puts "#{key.inspect} depends on:"
+        values.each do |value|
+          puts "    #{value.inspect}"
+        end
+        puts "    (nothing!)" if values.empty?
+        puts
+      end
+    end
+
+  end
+
+end