RubyGems - nanoc2 - Versions diffs - 2.2.3 - Mend

nanoc2 2.2.3

Files changed (100) hide show

data/ChangeLog +3 -0
data/LICENSE +19 -0
data/README +75 -0
data/Rakefile +76 -0
data/bin/nanoc2 +26 -0
data/lib/nanoc2.rb +73 -0
data/lib/nanoc2/base.rb +26 -0
data/lib/nanoc2/base/asset.rb +117 -0
data/lib/nanoc2/base/asset_defaults.rb +21 -0
data/lib/nanoc2/base/asset_rep.rb +282 -0
data/lib/nanoc2/base/binary_filter.rb +44 -0
data/lib/nanoc2/base/code.rb +41 -0
data/lib/nanoc2/base/compiler.rb +67 -0
data/lib/nanoc2/base/core_ext.rb +2 -0
data/lib/nanoc2/base/core_ext/hash.rb +78 -0
data/lib/nanoc2/base/core_ext/string.rb +8 -0
data/lib/nanoc2/base/data_source.rb +286 -0
data/lib/nanoc2/base/defaults.rb +30 -0
data/lib/nanoc2/base/filter.rb +93 -0
data/lib/nanoc2/base/layout.rb +91 -0
data/lib/nanoc2/base/notification_center.rb +66 -0
data/lib/nanoc2/base/page.rb +132 -0
data/lib/nanoc2/base/page_defaults.rb +20 -0
data/lib/nanoc2/base/page_rep.rb +324 -0
data/lib/nanoc2/base/plugin.rb +71 -0
data/lib/nanoc2/base/proxies.rb +5 -0
data/lib/nanoc2/base/proxies/asset_proxy.rb +29 -0
data/lib/nanoc2/base/proxies/asset_rep_proxy.rb +26 -0
data/lib/nanoc2/base/proxies/layout_proxy.rb +25 -0
data/lib/nanoc2/base/proxies/page_proxy.rb +35 -0
data/lib/nanoc2/base/proxies/page_rep_proxy.rb +28 -0
data/lib/nanoc2/base/proxy.rb +37 -0
data/lib/nanoc2/base/router.rb +72 -0
data/lib/nanoc2/base/site.rb +274 -0
data/lib/nanoc2/base/template.rb +64 -0
data/lib/nanoc2/binary_filters.rb +1 -0
data/lib/nanoc2/binary_filters/image_science_thumbnail.rb +28 -0
data/lib/nanoc2/cli.rb +9 -0
data/lib/nanoc2/cli/base.rb +132 -0
data/lib/nanoc2/cli/commands.rb +10 -0
data/lib/nanoc2/cli/commands/autocompile.rb +80 -0
data/lib/nanoc2/cli/commands/compile.rb +312 -0
data/lib/nanoc2/cli/commands/create_layout.rb +85 -0
data/lib/nanoc2/cli/commands/create_page.rb +85 -0
data/lib/nanoc2/cli/commands/create_site.rb +323 -0
data/lib/nanoc2/cli/commands/create_template.rb +76 -0
data/lib/nanoc2/cli/commands/help.rb +69 -0
data/lib/nanoc2/cli/commands/info.rb +125 -0
data/lib/nanoc2/cli/commands/switch.rb +141 -0
data/lib/nanoc2/cli/commands/update.rb +91 -0
data/lib/nanoc2/cli/logger.rb +72 -0
data/lib/nanoc2/data_sources.rb +2 -0
data/lib/nanoc2/data_sources/filesystem.rb +707 -0
data/lib/nanoc2/data_sources/filesystem_combined.rb +495 -0
data/lib/nanoc2/extra.rb +6 -0
data/lib/nanoc2/extra/auto_compiler.rb +285 -0
data/lib/nanoc2/extra/context.rb +22 -0
data/lib/nanoc2/extra/core_ext.rb +2 -0
data/lib/nanoc2/extra/core_ext/hash.rb +54 -0
data/lib/nanoc2/extra/core_ext/time.rb +13 -0
data/lib/nanoc2/extra/file_proxy.rb +29 -0
data/lib/nanoc2/extra/vcs.rb +48 -0
data/lib/nanoc2/extra/vcses.rb +5 -0
data/lib/nanoc2/extra/vcses/bazaar.rb +21 -0
data/lib/nanoc2/extra/vcses/dummy.rb +20 -0
data/lib/nanoc2/extra/vcses/git.rb +21 -0
data/lib/nanoc2/extra/vcses/mercurial.rb +21 -0
data/lib/nanoc2/extra/vcses/subversion.rb +21 -0
data/lib/nanoc2/filters.rb +16 -0
data/lib/nanoc2/filters/bluecloth.rb +13 -0
data/lib/nanoc2/filters/erb.rb +19 -0
data/lib/nanoc2/filters/erubis.rb +14 -0
data/lib/nanoc2/filters/haml.rb +21 -0
data/lib/nanoc2/filters/markaby.rb +14 -0
data/lib/nanoc2/filters/maruku.rb +14 -0
data/lib/nanoc2/filters/old.rb +19 -0
data/lib/nanoc2/filters/rainpress.rb +13 -0
data/lib/nanoc2/filters/rdiscount.rb +13 -0
data/lib/nanoc2/filters/rdoc.rb +23 -0
data/lib/nanoc2/filters/redcloth.rb +14 -0
data/lib/nanoc2/filters/relativize_paths.rb +16 -0
data/lib/nanoc2/filters/relativize_paths_in_css.rb +16 -0
data/lib/nanoc2/filters/relativize_paths_in_html.rb +16 -0
data/lib/nanoc2/filters/rubypants.rb +14 -0
data/lib/nanoc2/filters/sass.rb +18 -0
data/lib/nanoc2/helpers.rb +9 -0
data/lib/nanoc2/helpers/blogging.rb +217 -0
data/lib/nanoc2/helpers/capturing.rb +63 -0
data/lib/nanoc2/helpers/filtering.rb +54 -0
data/lib/nanoc2/helpers/html_escape.rb +25 -0
data/lib/nanoc2/helpers/link_to.rb +113 -0
data/lib/nanoc2/helpers/render.rb +49 -0
data/lib/nanoc2/helpers/tagging.rb +56 -0
data/lib/nanoc2/helpers/text.rb +38 -0
data/lib/nanoc2/helpers/xml_sitemap.rb +63 -0
data/lib/nanoc2/routers.rb +3 -0
data/lib/nanoc2/routers/default.rb +54 -0
data/lib/nanoc2/routers/no_dirs.rb +66 -0
data/lib/nanoc2/routers/versioned.rb +79 -0
metadata +185 -0

@@ -0,0 +1,6 @@
+require 'nanoc2/extra/auto_compiler'
+require 'nanoc2/extra/context'
+require 'nanoc2/extra/core_ext'
+require 'nanoc2/extra/file_proxy'
+require 'nanoc2/extra/vcs'
+require 'nanoc2/extra/vcses'

data/lib/nanoc2/extra/auto_compiler.rb ADDED

@@ -0,0 +1,285 @@
+require 'webrick'
+module Nanoc2::Extra
+  # Nanoc2::Extra::AutoCompiler is a web server that will automatically compile
+  # pages as they are requested. It also serves static files such as
+  # stylesheets and images.
+  class AutoCompiler
+    # Error that is raised when the autocompiler is started if the specified
+    # handler cannot be found.
+    class UnknownHandlerError < Nanoc2::Error ; end
+    HANDLER_NAMES = [ :thin, :mongrel, :webrick, :ebb, :cgi, :fastcgi, :lsws, :scgi ]
+    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 message %></p></blockquote>
+		<p>Page compilation stack:</p>
+		<ol>
+<% @site.compiler.stack.reverse.each do |item| %>
+<%   if item.is_a?(Nanoc2::PageRep) # page rep %>
+			<li><strong>Page</strong> <%= item.page.path %> (rep <%= item.name %>)</li>
+<% else # layout %>
+			<li><strong>Layout</strong> <%= item.path %></li>
+<% end %>
+<% end %>
+		</ol>
+		<p>Backtrace:</p>
+		<ol>
+<% exception.backtrace.each do |line| %>
+			<li><%= line %></li>
+<% end %>
+		</ol>
+	</body>
+</html>
+END
+    # Creates a new autocompiler for the given site.
+    def initialize(site, include_outdated=false)
+      # Set site
+      @site = site
+      # Set options
+      @include_outdated = include_outdated
+      # Create mutex to prevent parallel requests
+      @mutex = Mutex.new
+    end
+    # Starts the server on the given port.
+    #
+    # +port+:: The port the autocompiler web server should be started on. Can
+    #          be nil; in this case the server will be started on port 3000.
+    #
+    # +handler_name+:: A symbol containing the name of the handler to use. See
+    #                  HANDLER_NAMES for a list of supported handlers. Can be
+    #                  set to nil; in this case the best handler will be
+    #                  picked.
+    def start(port, handler_name)
+      require 'mime/types'
+      require 'rack'
+      # Determine handler
+      if handler_name.nil?
+        handler = preferred_handler
+      else
+        handler = handler_named(handler_name.to_sym)
+        raise UnknownHandlerError.new(handler_name) if handler.nil?
+      end
+      # Build Rack app
+      app = lambda do |env|
+        begin
+          handle_request(env['PATH_INFO'])
+        rescue Exception => exception
+          return serve_500(nil, exception)
+        end
+      end
+      # Run Rack app
+      port ||= 3000
+      handler.run(app, :Port => port, :port => port) do |server|
+        trap(:INT) { server.stop }
+      end
+    end
+  private
+    def preferred_handler
+      return @preferred_handler unless @preferred_handler.nil?
+      HANDLER_NAMES.each do |handler_name|
+        # Get handler
+        @preferred_handler = handler_named(handler_name)
+        # Make sure we have one
+        break unless @preferred_handler.nil?
+      end
+      @preferred_handler
+    end
+    def handler_named(handler_name)
+      # Build list of handlers
+      @handlers ||= {
+        :cgi => {
+          :proc => lambda { Rack::Handler::CGI }
+        },
+        :fastcgi => { # FIXME buggy
+          :proc => lambda { Rack::Handler::FastCGI }
+        },
+        :lsws => { # FIXME test
+          :proc => lambda { Rack::Handler::LSWS }
+        },
+        :mongrel => {
+          :proc => lambda { Rack::Handler::Mongrel }
+        },
+        :scgi => { # FIXME buggy
+          :proc => lambda { Rack::Handler::SCGI }
+        },
+        :webrick => {
+          :proc => lambda { Rack::Handler::WEBrick }
+        },
+        :thin => {
+          :proc => lambda { Rack::Handler::Thin },
+          :requires => [ 'thin' ]
+        },
+        :ebb => {
+          :proc => lambda { Rack::Handler::Ebb },
+          :requires => [ 'ebb' ]
+        }
+      }
+      begin
+        # Lookup handler
+        handler = @handlers[handler_name]
+        # Load requirements
+        (handler[:requires] || []).each { |r| require r }
+        # Get handler class
+        handler[:proc].call
+      rescue NameError, LoadError
+        nil
+      end
+    end
+    def handle_request(path)
+      @mutex.synchronize do
+        # Reload site data
+        @site.load_data(true)
+        # Get file path
+        file_path = @site.config[:output_dir] + path
+        # Find rep
+        objs = @site.pages + @site.assets
+        reps = objs.map { |o| o.reps }.flatten
+        rep = reps.find { |r| r.web_path == path }
+        if rep.nil?
+          # Get list of possible filenames
+          if file_path =~ /\/$/
+            all_file_paths = @site.config[:index_filenames].map { |f| file_path + f }
+          else
+            all_file_paths = [ file_path ]
+          end
+          good_file_path = all_file_paths.find { |f| File.file?(f) }
+          # Serve file
+          if good_file_path
+            serve_file(good_file_path)
+          else
+            serve_404(path)
+          end
+        else
+          # Serve rep
+          serve_rep(rep)
+        end
+      end
+    end
+    def h(s)
+      ERB::Util.html_escape(s)
+    end
+    def mime_type_of(path, fallback)
+      mime_type = MIME::Types.of(path).first
+      mime_type = mime_type.nil? ? fallback : mime_type.simplified
+    end
+    def serve_404(path)
+      # Build response
+      [
+        404,
+        { 'Content-Type' => 'text/html' },
+        [ ERB.new(ERROR_404).result(binding) ]
+      ]
+    end
+    def serve_500(path, exception)
+      # Build message
+      case exception
+      when Nanoc2::Errors::UnknownLayoutError
+        message = "Unknown layout: #{exception.message}"
+      when Nanoc2::Errors::UnknownFilterError
+        message = "Unknown filter: #{exception.message}"
+      when Nanoc2::Errors::CannotDetermineFilterError
+        message = "Cannot determine filter for layout: #{exception.message}"
+      when Nanoc2::Errors::RecursiveCompilationError
+        message = "Recursive call to page content. Page stack:"
+      when Nanoc2::Errors::NoLongerSupportedError
+        message = "No longer supported: #{exception.message}"
+      else
+        message = "Unknown error: #{exception.message}"
+      end
+      # Build response
+      [
+        500,
+        { 'Content-Type' => 'text/html' },
+        [ ERB.new(ERROR_500).result(binding) ]
+      ]
+    end
+    def serve_file(path)
+      # Build response
+      [
+        200,
+        { 'Content-Type' => mime_type_of(path, 'application/octet-stream') },
+        [ File.open(path, 'rb') { |io| io.read } ]
+      ]
+    end
+    def serve_rep(rep)
+      # Recompile rep
+      begin
+        @site.compiler.run(
+          [ rep.respond_to?(:page) ? rep.page : rep.asset ],
+          :even_when_not_outdated => @include_outdated
+        )
+      rescue Exception => exception
+        return serve_500(rep.web_path, exception)
+      end
+      # Build response
+      [
+        200,
+        { 'Content-Type' => mime_type_of(rep.disk_path, 'text/html') },
+        [ File.read(rep.disk_path) ]
+      ]
+    end
+  end
+end

data/lib/nanoc2/extra/context.rb ADDED

@@ -0,0 +1,22 @@
+module Nanoc2::Extra
+  # Nanoc2::Extra::Context provides a context and a Binding for use in various
+  # filters, such as the ERB and Haml one.
+  class Context
+    # Creates a new context based off the contents of the hash. Each pair in
+    # the hash will be converted to an instance variable. For example, passing
+    # the hash { :foo => 'bar' } will cause @foo to have the value "bar".
+    def initialize(hash)
+      hash.each_pair do |key, value|
+        instance_variable_set('@' + key.to_s, value)
+      end
+    end
+    # Returns a binding for this context.
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/nanoc2/extra/core_ext.rb ADDED

	@@ -0,0 +1,2 @@
1	+ require 'nanoc2/extra/core_ext/hash'
2	+ require 'nanoc2/extra/core_ext/time'

data/lib/nanoc2/extra/core_ext/hash.rb ADDED

@@ -0,0 +1,54 @@
+class Hash
+  # Converts this hash into YAML format, splitting the YAML output into a
+  # 'builtin' and a 'custom' section. A key that is present in
+  # Nanoc2::Page::DEFAULTS will be considered a 'default' key; all other keys
+  # will be put in the 'Custom' section.
+  #
+  # For example, the hash:
+  #
+  #   {
+  #     :title       => 'My Cool Page',
+  #     :filters_pre => [ 'foo', 'bar' ]
+  #   }
+  #
+  # will be converted into:
+  #
+  #   # Built-in
+  #   filters_pre: [ 'foo', 'bar' ]
+  #
+  #   # Custom
+  #   title: 'My Cool Page'
+  #
+  # as +filters_pre+ is considered a 'default' key while +title+ is not.
+  def to_split_yaml
+    # Skip irrelevant keys
+    hash = self.reject { |k,v| k == :file }
+    # Split keys
+    hashes = { :builtin => {}, :custom => {} }
+    hash.each_pair do |key, value|
+      kind = Nanoc2::Page::DEFAULTS.include?(key) || Nanoc2::Asset::DEFAULTS.include?(key) ? :builtin : :custom
+      hashes[kind][key] = value
+    end
+    # Dump and clean hashes
+    dumps = { :builtin => '', :custom => '' }
+    [ :builtin, :custom ].each do |kind|
+      if hashes[kind].keys.empty?
+        dumps[kind] = "\n"
+      else
+        raw_dump = YAML.dump(hashes[kind].stringify_keys)
+        dumps[kind] = raw_dump.split('---')[1].gsub("\n\n", "\n")
+      end
+    end
+    # Built composite YAML file
+    '# Built-in' +
+    dumps[:builtin] +
+    "\n" +
+    '# Custom' +
+    dumps[:custom]
+  end
+end

data/lib/nanoc2/extra/core_ext/time.rb ADDED

@@ -0,0 +1,13 @@
+class Time
+  # Returns a string with the time in an ISO-8601 date format.
+  def to_iso8601_date
+    self.strftime("%Y-%m-%d")
+  end
+  # Returns a string with the time in an ISO-8601 time format.
+  def to_iso8601_time
+    self.gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
+  end
+end

data/lib/nanoc2/extra/file_proxy.rb ADDED

@@ -0,0 +1,29 @@
+module Nanoc2::Extra
+  # A FileProxy is a proxy for a File object. It is used to prevent a File
+  # object from being created until it is actually necessary.
+  #
+  # For example, a site with a few thousand pages would fail to compile
+  # because the massive amount of file descriptors necessary, but the file
+  # proxy will make sure the File object is not created until it is used.
+  class FileProxy
+    instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
+    # Creates a new file proxy for the given path. This is similar to
+    # creating a File object with the same path, except that the File object
+    # will not be created until it is accessed.
+    def initialize(path)
+      @path = path
+    end
+    # Makes sure all method calls are relayed to a File object, which will
+    # be created right before the method call takes place and destroyed
+    # right after.
+    def method_missing(sym, *args, &block)
+      File.new(@path).__send__(sym, *args, &block)
+    end
+  end
+end

data/lib/nanoc2/extra/vcs.rb ADDED

@@ -0,0 +1,48 @@
+module Nanoc2::Extra
+  # Nanoc2::Extra::VCS is a very simple representation of a version control
+  # system that abstracts the add, remove and move operations. It does not
+  # commit. This class is primarily used by data sources that store data as
+  # flat files on the disk.
+  #
+  # This is the abstract superclass for all VCSes. Subclasses should implement
+  # the indicated methods.
+  class VCS < Nanoc2::Plugin
+    # Adds the file with the given filename to the working copy.
+    #
+    # Subclasses must implement this method.
+    def add(filename)
+      not_implemented('add')
+    end
+    # Removes the file with the given filename from the working copy. When
+    # this method is executed, the file should no longer be present on the
+    # disk.
+    #
+    # Subclasses must implement this method.
+    def remove(filename)
+      not_implemented('remove')
+    end
+    # Moves the file with the given filename to a new location. When this
+    # method is executed, the original file should no longer be present on the
+    # disk.
+    #
+    # Subclasses must implement this method.
+    def move(src, dst)
+      not_implemented('move')
+    end
+  private
+    def not_implemented(name)
+      raise NotImplementedError.new(
+        "#{self.class} does not override ##{name}, which is required for " +
+        "this data source to be used."
+      )
+    end
+  end
+end