nanoc 2.0 → 2.1

data/lib/nanoc/routers/no_dirs.rb

@@ -0,0 +1,66 @@
+module Nanoc::Routers
+
+  # The no-directories router organises pages very similarly to the default
+  # router, but does not create directories unless necessary. This router will
+  # therefore generate pages with less pretty URLs.
+  #
+  # For example, a page with path /about/ will be written to /about.html
+  # instead of /about/index.html.
+  class NoDirs < Nanoc::Router
+
+    identifier :no_dirs
+
+    def path_for_page_rep(page_rep)
+      # Get data we need
+      filename   = page_rep.attribute_named(:filename)
+      extension  = page_rep.attribute_named(:extension)
+
+      # Initialize path
+      if page_rep.page.path == '/'
+        path = '/' + filename
+      else
+        path = page_rep.page.path[0..-2]
+      end
+
+      # Add rep name if necessary
+      unless page_rep.name == :default
+        path += '-' + page_rep.name.to_s
+      end
+
+      # Add extension
+      path += '.' + extension
+
+      # Done
+      path
+    end
+
+    def path_for_asset_rep(asset_rep)
+      # Get data we need
+      extension     = asset_rep.attribute_named(:extension)
+      modified_path = asset_rep.asset.path[0..-2]
+      version       = asset_rep.attribute_named(:version)
+
+      # Initialize path
+      assets_prefix = @site.config[:assets_prefix] || '/assets'
+      path = assets_prefix + modified_path
+
+      # Add version if necessary
+      unless version.nil?
+        path += '-v' + version.to_s
+      end
+
+      # Add rep name
+      unless asset_rep.name == :default
+        path += '-' + asset_rep.name.to_s
+      end
+
+      # Add extension
+      path += '.' + extension
+
+      # Done
+      path
+    end
+
+  end
+
+end

data/lib/nanoc/routers/versioned.rb

@@ -0,0 +1,79 @@
+module Nanoc::Routers
+
+  # The versioned router behaves pretty much like the default router, with the
+  # exception that asset representations (but not page representations) can
+  # have versions which will be added to generated URLs.
+  #
+  # This is very useful if you want to cache assets aggressively by sending an
+  # +Expires+ header to clients. An +Expires+ header usually has the issue
+  # that clients will not request the asset even if it has changed; giving the
+  # asset a different version will cause the URL to be changed, which in turn
+  # will cause the client to request the new asset.
+  #
+  # = Example
+  #
+  # For example, the URL of a textual asset containing the CSS stylesheet with
+  # its 'version' attribute set to 28 will become /assets/style-v28.css.
+  #
+  # To link to the stylesheet in a DRY way,
+  # give the asset a unique name (such as 'style') and then do something along
+  # this way:
+  #
+  #   <link rel="stylesheet"
+  #         type="text/css"
+  #         media="screen"
+  #         href="<%= @assets.find { |a| a.asset_id == 'style' }.path %>">
+  class Versioned < Nanoc::Router
+
+    identifier :versioned
+
+    def path_for_page_rep(page_rep)
+      # Get data we need
+      filename   = page_rep.attribute_named(:filename)
+      extension  = page_rep.attribute_named(:extension)
+
+      # Initialize path
+      path = page_rep.page.path + filename
+
+      # Add rep name if necessary
+      unless page_rep.name == :default
+        path += '-' + page_rep.name.to_s
+      end
+
+      # Add extension
+      path += '.' + extension
+
+      # Done
+      path
+    end
+
+    def path_for_asset_rep(asset_rep)
+      # Get data we need
+      extension     = asset_rep.attribute_named(:extension)
+      modified_path = asset_rep.asset.path[0..-2]
+      version       = asset_rep.attribute_named(:version)
+
+      # Initialize path
+      assets_prefix = @site.config[:assets_prefix] || '/assets'
+      path = assets_prefix + modified_path
+
+      # Add version if necessary
+      unless version.nil?
+        path += '-v' + version.to_s
+      end
+
+      # Add rep name
+      unless asset_rep.name == :default
+        path += '-' + asset_rep.name.to_s
+      end
+
+      # Add extension
+      path += '.' + extension
+
+      # Done
+      path
+    end
+
+  end
+
+end

data/lib/nanoc.rb

@@ -1,24 +1,95 @@
 module Nanoc
 
-  VERSION = '2.0'
+  # The current nanoc version.
+  VERSION = '2.1'
 
-  def self.load_file(*path)
+  # 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
+
+  # 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)].each { |f| require f }
   end
 
 end
 
+# Load requirements
+begin ; require 'rubygems' ; rescue LoadError ; end
+require 'yaml'
+require 'fileutils'
+
 # 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.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 plugins
-Nanoc.load_file('data_sources', '*.rb')
-Nanoc.load_file('filters', '*.rb')
-Nanoc.load_file('layout_processors', '*.rb')
+# Load extra's
+Nanoc.load('extra', 'core_ext', '*.rb')
+Nanoc.load('extra', '*.rb')
+Nanoc.load('extra', 'vcses', '*.rb')
 
-# Get global binding
-$nanoc_binding = binding
+# Load plugins
+Nanoc.load('data_sources', '*.rb')
+Nanoc.load('filters', '*.rb')
+Nanoc.load('binary_filters', '*.rb')
+Nanoc.load('routers', '*.rb')
+Nanoc.load('helpers', '*.rb')

metadata

@@ -1,33 +1,26 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: nanoc
 version: !ruby/object:Gem::Version 
-  version: "2.0"
-date: 2007-12-25 00:00:00 +01:00
-summary: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
-require_paths: 
-- lib
-email: denis.defreyne@stoneship.org
-homepage: http://nanoc.stoneship.org/
-rubyforge_project: nanoc
-description: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.2
-  version: 
+  version: "2.1"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Denis Defreyne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-17 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
+email: denis.defreyne@stoneship.org
+executables: 
+- nanoc
+extensions: []
+
+extra_rdoc_files: 
+- README
 files: 
 - README
 - LICENSE
@@ -36,47 +29,151 @@ files:
 - bin/nanoc
 - lib/nanoc
 - lib/nanoc/base
-- lib/nanoc/base/auto_compiler.rb
+- lib/nanoc/base/asset.rb
+- lib/nanoc/base/asset_defaults.rb
+- lib/nanoc/base/asset_rep.rb
+- lib/nanoc/base/binary_filter.rb
+- lib/nanoc/base/code.rb
 - lib/nanoc/base/compiler.rb
 - lib/nanoc/base/core_ext
 - lib/nanoc/base/core_ext/hash.rb
+- lib/nanoc/base/core_ext/string.rb
 - lib/nanoc/base/data_source.rb
+- lib/nanoc/base/defaults.rb
 - lib/nanoc/base/enhancements.rb
 - lib/nanoc/base/filter.rb
-- lib/nanoc/base/layout_processor.rb
+- lib/nanoc/base/layout.rb
+- lib/nanoc/base/notification_center.rb
 - lib/nanoc/base/page.rb
-- lib/nanoc/base/page_proxy.rb
+- lib/nanoc/base/page_defaults.rb
+- lib/nanoc/base/page_rep.rb
 - lib/nanoc/base/plugin.rb
-- lib/nanoc/base/plugin_manager.rb
+- lib/nanoc/base/proxies
+- lib/nanoc/base/proxies/asset_proxy.rb
+- lib/nanoc/base/proxies/asset_rep_proxy.rb
+- lib/nanoc/base/proxies/layout_proxy.rb
+- lib/nanoc/base/proxies/page_proxy.rb
+- lib/nanoc/base/proxies/page_rep_proxy.rb
+- lib/nanoc/base/proxy.rb
+- lib/nanoc/base/router.rb
 - lib/nanoc/base/site.rb
+- lib/nanoc/base/template.rb
+- lib/nanoc/binary_filters
+- lib/nanoc/binary_filters/image_science_thumbnail.rb
+- lib/nanoc/cli
+- lib/nanoc/cli/base.rb
+- lib/nanoc/cli/cli.rb
+- lib/nanoc/cli/command.rb
+- lib/nanoc/cli/commands
+- lib/nanoc/cli/commands/autocompile.rb
+- lib/nanoc/cli/commands/compile.rb
+- lib/nanoc/cli/commands/create_layout.rb
+- lib/nanoc/cli/commands/create_page.rb
+- lib/nanoc/cli/commands/create_site.rb
+- lib/nanoc/cli/commands/create_template.rb
+- lib/nanoc/cli/commands/help.rb
+- lib/nanoc/cli/commands/info.rb
+- lib/nanoc/cli/commands/switch.rb
+- lib/nanoc/cli/commands/update.rb
+- lib/nanoc/cli/ext.rb
+- lib/nanoc/cli/logger.rb
+- lib/nanoc/cli/option_parser.rb
+- lib/nanoc/cli.rb
 - lib/nanoc/data_sources
-- lib/nanoc/data_sources/database.rb
 - lib/nanoc/data_sources/filesystem.rb
-- lib/nanoc/data_sources/trivial.rb
+- lib/nanoc/data_sources/filesystem_combined.rb
+- lib/nanoc/extra
+- lib/nanoc/extra/auto_compiler.rb
+- lib/nanoc/extra/context.rb
+- lib/nanoc/extra/core_ext
+- lib/nanoc/extra/core_ext/hash.rb
+- lib/nanoc/extra/core_ext/time.rb
+- lib/nanoc/extra/file_proxy.rb
+- lib/nanoc/extra/vcs.rb
+- lib/nanoc/extra/vcses
+- lib/nanoc/extra/vcses/bazaar.rb
+- lib/nanoc/extra/vcses/dummy.rb
+- lib/nanoc/extra/vcses/git.rb
+- lib/nanoc/extra/vcses/mercurial.rb
+- lib/nanoc/extra/vcses/subversion.rb
 - lib/nanoc/filters
+- lib/nanoc/filters/bluecloth.rb
 - lib/nanoc/filters/erb.rb
+- lib/nanoc/filters/erubis.rb
 - lib/nanoc/filters/haml.rb
 - lib/nanoc/filters/markaby.rb
-- lib/nanoc/filters/markdown.rb
+- lib/nanoc/filters/maruku.rb
+- lib/nanoc/filters/old.rb
+- lib/nanoc/filters/rdiscount.rb
 - lib/nanoc/filters/rdoc.rb
-- lib/nanoc/filters/smartypants.rb
-- lib/nanoc/filters/textile.rb
-- lib/nanoc/layout_processors
-- lib/nanoc/layout_processors/erb.rb
-- lib/nanoc/layout_processors/haml.rb
-- lib/nanoc/layout_processors/markaby.rb
+- lib/nanoc/filters/redcloth.rb
+- lib/nanoc/filters/rubypants.rb
+- lib/nanoc/filters/sass.rb
+- lib/nanoc/helpers
+- lib/nanoc/helpers/blogging.rb
+- lib/nanoc/helpers/capturing.rb
+- lib/nanoc/helpers/html_escape.rb
+- lib/nanoc/helpers/link_to.rb
+- lib/nanoc/helpers/render.rb
+- lib/nanoc/helpers/tagging.rb
+- lib/nanoc/helpers/xml_sitemap.rb
+- lib/nanoc/routers
+- lib/nanoc/routers/default.rb
+- lib/nanoc/routers/no_dirs.rb
+- lib/nanoc/routers/versioned.rb
 - lib/nanoc.rb
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: 
+has_rdoc: true
+homepage: http://nanoc.stoneship.org/
+post_install_message: |-
+  ------------------------------------------------------------------------------
+  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!
+  ------------------------------------------------------------------------------
+rdoc_options: 
+- --title
 - nanoc
-extensions: []
-
+- --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
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.5
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: nanoc
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
+test_files: []
 

data/lib/nanoc/base/auto_compiler.rb

@@ -1,124 +0,0 @@
-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

data/lib/nanoc/base/layout_processor.rb

@@ -1,33 +0,0 @@
-module Nanoc
-  class LayoutProcessor < Plugin
-
-    def initialize(page, pages, config, site, other_assigns={})
-      @page          = page
-      @pages         = pages
-      @config        = config
-      @site          = site
-      @other_assigns = other_assigns
-    end
-
-    def run(layout)
-      error 'LayoutProcessor#run must be overridden'
-    end
-
-    # Extensions
-
-    class << self
-      attr_accessor :_extensions
-    end
-
-    def self.extensions(*extensions)
-      self._extensions = [] unless instance_variable_defined?(:@_extensions)
-      extensions.empty? ? self._extensions || [] : self._extensions = (self._extensions || []) + extensions
-    end
-
-    def self.extension(extension=nil)
-      self._extensions = [] unless instance_variable_defined?(:@_extensions)
-      extension.nil? ? self.extensions.first : self.extensions(extension)
-    end
-
-  end
-end

data/lib/nanoc/base/page_proxy.rb

@@ -1,31 +0,0 @@
-module Nanoc
-  class PageProxy
-
-    def initialize(page)
-      @page = page
-    end
-
-    def [](key)
-      real_key = key.to_s.sub(/\?$/, '').to_sym
-
-      if real_key == :content
-        @page.content
-      elsif real_key == :parent
-        @page.parent.nil? ? nil : @page.parent.to_proxy
-      elsif real_key == :children
-        @page.children.map { |page| page.to_proxy }
-      else
-        @page.attribute_named(real_key)
-      end
-    end
-
-    def []=(key, value)
-      @page.attributes[key.to_sym] = value
-    end
-
-    def method_missing(method, *args)
-      self[method]
-    end
-
-  end
-end