nanoc3 3.0.0

data/lib/nanoc3/helpers/text.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Nanoc3::Helpers
+
+  # Nanoc3::Helpers::Text contains several useful text-related helper functions.
+  module Text
+
+    # Returns an excerpt for the given string. HTML tags are ignored, so if
+    # you don't want them to turn up, they should be stripped from the string
+    # before passing it to the excerpt function.
+    #
+    # +params+ is a hash where the following keys can be set:
+    #
+    # +length+:: The maximum number of characters this excerpt can contain,
+    #            including the omission. Defaults to 25.
+    #
+    # +omission+:: The string to append to the excerpt when the excerpt is
+    #              shorter than the original string. Defaults to '...' (but in
+    #              HTML, you may want to use something more fancy, like
+    #              '…').
+    def excerptize(string, params={})
+      # Initialize params
+      params[:length]   ||= 25
+      params[:omission] ||= '...'
+
+      # Get excerpt
+      length = params[:length] - params[:omission].length
+      length = 0 if length < 0
+      (string.length > params[:length] ? string[0...length] + params[:omission] : string)
+    end
+
+    # Strips all HTML tags out of the given string.
+    def strip_html(string)
+      # FIXME will need something more sophisticated than this, because it sucks
+      string.gsub(/<[^>]*(>+|\s*\z)/m, '').strip
+    end
+
+  end
+
+end

data/lib/nanoc3/helpers/xml_sitemap.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module Nanoc3::Helpers
+
+  # Nanoc3::Helpers::XMLSitemap contains functionality for building XML
+  # sitemaps that will be crawled by search engines. See the Sitemaps protocol
+  # web site, http://www.sitemaps.org, for details.
+  #
+  # To activate this helper, +include+ it, like this:
+  #
+  #   include Nanoc3::Helpers::XMLSitemap
+  module XMLSitemap
+
+    # Returns the XML sitemap as a string.
+    #
+    # The following attributes can optionally be set on items to change the
+    # behaviour of the sitemap:
+    #
+    # * 'changefreq', containing the estimated change frequency as defined by
+    #   the Sitemaps protocol.
+    #
+    # * 'priority', containing the item's priority, ranging from 0.0 to 1.0,
+    #   as defined by the Sitemaps protocol.
+    #
+    # The sitemap will also include dates on which the items were updated.
+    # These are generated automatically; the way this happens depends on the
+    # used data source (the filesystem data source checks the file mtimes, for
+    # instance).
+    #
+    # The site configuration will need to have the following attributes:
+    #
+    # * 'base_url', containing the URL to the site, without trailing slash.
+    #   For example, if the site is at "http://example.com/", the base_url
+    #   would be "http://example.com".
+    def xml_sitemap
+      require 'builder'
+
+      # Create builder
+      buffer = ''
+      xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
+
+      # Check for required attributes
+      if @site.config[:base_url].nil?
+        raise RuntimeError.new("The Nanoc3::Helpers::XMLSitemap helper requires the site configuration to specify the base URL for the site.")
+      end
+
+      # Build sitemap
+      xml.instruct!
+      xml.urlset(:xmlns => 'http://www.google.com/schemas/sitemap/0.84') do
+        # Add item
+        @items.reject { |i| i[:is_hidden] }.each do |item|
+          item.reps.reject { |r| r.raw_path.nil? }.each do |rep|
+            xml.url do
+              xml.loc         @site.config[:base_url] + rep.path
+              xml.lastmod     item.mtime.to_iso8601_date unless item.mtime.nil?
+              xml.changefreq  item[:changefreq] unless item[:changefreq].nil?
+              xml.priority    item[:priority] unless item[:priority].nil?
+            end
+          end
+        end
+      end
+
+      # Return sitemap
+      buffer
+    end
+
+  end
+
+end

data/lib/nanoc3/helpers.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module Nanoc3::Helpers
+
+  autoload 'Blogging',    'nanoc3/helpers/blogging'
+  autoload 'Breadcrumbs', 'nanoc3/helpers/breadcrumbs'
+  autoload 'Capturing',   'nanoc3/helpers/capturing'
+  autoload 'Filtering',   'nanoc3/helpers/filtering'
+  autoload 'HTMLEscape',  'nanoc3/helpers/html_escape'
+  autoload 'LinkTo',      'nanoc3/helpers/link_to'
+  autoload 'Rendering',   'nanoc3/helpers/rendering'
+  autoload 'Tagging',     'nanoc3/helpers/tagging'
+  autoload 'Text',        'nanoc3/helpers/text'
+  autoload 'XMLSitemap',  'nanoc3/helpers/xml_sitemap'
+
+end

data/lib/nanoc3/package.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require 'singleton'
+
+module Nanoc3
+
+  # Nanoc3::Package is a singleton that contains metadata about the nanoc
+  # project, which is used for packaging releases.
+  class Package
+
+    include Singleton
+
+    # The name of the application.
+    def name
+      'nanoc3'
+    end
+
+    # The files to include in the package. This is also the list of files that
+    # will be included in the documentation (with the exception of the files
+    # in undocumented_files).
+    def files
+      @files ||= (%w( ChangeLog LICENSE NEWS.rdoc Rakefile README.rdoc ) +
+        Dir['bin/**/*'] +
+        Dir['lib/**/*'] +
+        Dir['vendor/**/*']).reject { |f| File.directory?(f) }
+    end
+
+    # The files that are included in the documentation by default.
+    def files_documented_by_default
+      Dir['lib/**/*'].reject { |f| File.directory?(f) }
+    end
+
+    # The files that should not be included in the documentation.
+    def files_not_in_documentation
+      Dir['lib/**/*.rake'] +
+      Dir['vendor/**/*'].reject { |f| File.directory?(f) }
+    end
+
+    # The files that should be included in the documentation.
+    def files_in_documentation
+      files - files_not_in_documentation
+    end
+
+    # The files that are not documented by RDoc by default, but should still
+    # be included in the documentation.
+    def extra_rdoc_files
+      files_in_documentation - files_documented_by_default
+    end
+
+    # The name of the file that should be used as entry point for the
+    # documentation.
+    def main_documentation_file
+      'README.rdoc'
+    end
+
+    # The Gem::Specification used for packaging.
+    def gem_spec
+      @gem_spec ||= Gem::Specification.new do |s|
+        s.name                  = self.name
+        s.version               = Nanoc3::VERSION
+        s.platform              = Gem::Platform::RUBY
+        s.summary               = 'a tool that runs on your local computer ' +
+                                  'and compiles Markdown, Textile, Haml, ' +
+                                  '... documents into static web pages'
+        s.description           = s.summary
+        s.homepage              = 'http://nanoc.stoneship.org/'
+        s.rubyforge_project     = 'nanoc3'
+
+        s.author                = 'Denis Defreyne'
+        s.email                 = 'denis.defreyne@stoneship.org'
+
+        s.post_install_message  = <<EOS
+------------------------------------------------------------------------------
+Thanks for installing nanoc 3.0! 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 3.0 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!
+------------------------------------------------------------------------------
+EOS
+
+        s.required_ruby_version = '>= 1.8.5'
+
+        s.has_rdoc              = true
+        s.extra_rdoc_files      = self.extra_rdoc_files
+        s.rdoc_options          = []
+        s.rdoc_options          += [ '--title', self.name                    ]
+        s.rdoc_options          += [ '--main',  self.main_documentation_file ]
+        self.files_not_in_documentation.each do |file|
+          s.rdoc_options        += [ '--exclude', file ]
+        end
+
+        s.files                 = self.files
+        s.executables           = [ 'nanoc3' ]
+        s.require_path          = 'lib'
+        s.bindir                = 'bin'
+      end
+    end
+
+  end
+
+end

data/lib/nanoc3/tasks/clean.rake

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+desc 'Remove output files generated by nanoc3'
+task :clean do
+  # Load site
+  site = Nanoc3::Site.new('.')
+  if site.nil?
+    $stderr.puts 'The current working directory does not seem to be a ' +
+                 'valid/complete nanoc site directory; aborting.'
+    exit 1
+  end
+
+  # Clean
+  clean = ::Nanoc3::Tasks::Clean.new(site)
+  clean.run
+end

data/lib/nanoc3/tasks/clean.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module Nanoc3::Tasks
+
+  class Clean
+
+    def initialize(site)
+      @site = site
+    end
+
+    def run
+      # Load site data
+      @site.load_data
+
+      # Delete all compiled item reps
+      filenames.each do |filename|
+        FileUtils.rm_f filename unless filename.nil?
+      end
+    end
+
+  private
+
+    def filenames
+      @site.items.map do |item|
+        item.reps.map do |rep|
+          rep.raw_path
+        end
+      end.flatten
+    end
+
+  end
+
+end

data/lib/nanoc3/tasks/deploy/rsync.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+namespace :deploy do
+
+  desc 'Upload the compiled site using rsync'
+  task :rsync do
+    deployer = Nanoc3::Extra::Deployers::Rsync.new
+    deployer.run :dry_run => !!ENV['DRY_RUN']
+  end
+
+end

data/lib/nanoc3/tasks/validate.rake

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+namespace :validate do
+
+  desc 'Validate the site\'s HTML files'
+  task :html do
+    # Load site
+    site = Nanoc3::Site.new('.')
+    if site.nil?
+      $stderr.puts 'The current working directory does not seem to be a ' +
+                   'valid/complete nanoc site directory; aborting.'
+      exit 1
+    end
+
+    # Validate
+    validator = ::Nanoc3::Extra::Validators::W3C.new(site, :html)
+    validator.run
+  end
+
+  desc 'Validate the site\'s CSS files'
+  task :css do
+    # Load site
+    site = Nanoc3::Site.new(YAML.load_file(File.join(Dir.getwd, 'config.yaml')))
+    if site.nil?
+      $stderr.puts 'The current working directory does not seem to be a ' +
+                   'valid/complete nanoc site directory; aborting.'
+      exit 1
+    end
+
+    # Validate
+    validator = ::Nanoc3::Extra::Validators::W3C.new(site, :css)
+    validator.run
+  end
+
+end

data/lib/nanoc3/tasks.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'nanoc3'
+
+module Nanoc3::Tasks
+end
+
+Dir[File.dirname(__FILE__) + '/tasks/**/*.rb'].each   { |f| load f }
+Dir[File.dirname(__FILE__) + '/tasks/**/*.rake'].each { |f| load f }

data/lib/nanoc3.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # The current nanoc version.
+  VERSION = '3.0.0'
+
+end
+
+# Load requirements
+require 'yaml'
+require 'fileutils'
+
+# Load nanoc
+require 'nanoc3/base'
+require 'nanoc3/extra'
+require 'nanoc3/data_sources'
+require 'nanoc3/filters'
+require 'nanoc3/helpers'

data/vendor/cri/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 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/vendor/cri/README

@@ -0,0 +1,4 @@
+Cri
+===
+
+Cri is a library for building easy-to-use commandline tools.

data/vendor/cri/Rakefile

@@ -0,0 +1,25 @@
+##### Requirements
+
+# Rake etc
+require 'rake'
+require 'minitest/unit'
+
+# Cri itself
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+require 'cri'
+
+##### Testing
+
+desc 'Runs all tests'
+task :test do
+  ENV['QUIET'] ||= 'true'
+
+  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+  MiniTest::Unit.autorun
+
+  test_files = Dir['test/test_*.rb']
+  test_files.each { |f| require f }
+end
+
+task :default => :test

data/vendor/cri/lib/cri/base.rb

@@ -0,0 +1,153 @@
+module Cri
+
+  # Cri::Base is the central class representing a commandline tool. It has a
+  # list of commands.
+  class Base
+
+    # The CLI's list of commands (should also contain the help command)
+    attr_reader :commands
+
+    # The CLI's help command (required)
+    attr_accessor :help_command
+
+    # Creates a new instance of the commandline tool.
+    def initialize(tool_name)
+      @tool_name = tool_name
+
+      @commands = []
+    end
+
+    # Parses the given commandline arguments and executes the requested
+    # command.
+    def run(args)
+      # Check arguments
+      if args.length == 0
+        @help_command.run([], [])
+        exit 1
+      end
+
+      # Partition options
+      opts_before_command         = []
+      command_name                = nil
+      opts_and_args_after_command = []
+      stage = 0
+      args.each do |arg|
+        # Update stage if necessary
+        stage = 1 if stage == 0 && !is_option?(arg)
+
+        # Add
+        opts_before_command << arg         if stage == 0
+        command_name = arg                 if stage == 1
+        opts_and_args_after_command << arg if stage == 2
+
+        # Update stage if necessary
+        stage = 2 if stage == 1
+      end
+
+      # Handle options before command
+      begin
+        parsed_arguments = Cri::OptionParser.parse(opts_before_command, global_option_definitions)
+      rescue Cri::OptionParser::IllegalOptionError => e
+        $stderr.puts "illegal option -- #{e}"
+        exit 1
+      end
+      parsed_arguments[:options].keys.each do |option|
+        handle_option(option)
+      end
+
+      # Get command
+      if command_name.nil?
+        $stderr.puts "no command given"
+        exit 1
+      end
+      command = command_named(command_name)
+      if command.nil?
+        $stderr.puts "no such command: #{command_name}"
+        exit 1
+      end
+
+      # Parse arguments
+      option_definitions = command.option_definitions + global_option_definitions
+      begin
+        parsed_arguments = Cri::OptionParser.parse(opts_and_args_after_command, option_definitions)
+      rescue Cri::OptionParser::IllegalOptionError => e
+        $stderr.puts "illegal option -- #{e}"
+        exit 1
+      rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
+        $stderr.puts "option requires an argument -- #{e}"
+        exit 1
+      end
+
+      # Handle global options
+      global_options = global_option_definitions.map { |o| o[:long] }
+      global_options.delete_if { |o| !parsed_arguments[:options].keys.include?(o.to_sym) }
+      global_options.each { |o| handle_option(o.to_sym) }
+
+      if parsed_arguments[:options].has_key?(:help)
+        # Show help for this command
+        show_help(command)
+      else
+        # Run command
+        command.run(parsed_arguments[:options], parsed_arguments[:arguments])
+      end
+    end
+
+    # Returns the command with the given name.
+    def command_named(name)
+      # Find by exact name or alias
+      command = @commands.find { |c| c.name == name or c.aliases.include?(name) }
+      return command unless command.nil?
+
+      # Find by approximation
+      commands = @commands.select { |c| c.name[0, name.length] == name }
+      if commands.length > 1
+        $stderr.puts "#{@tool_name}: '#{name}' is ambiguous:"
+        $stderr.puts "  #{commands.map { |c| c.name }.join(' ') }"
+        exit 1
+      elsif commands.length == 0
+        $stderr.puts "#{@tool_name}: unknown command '#{name}'\n"
+        show_help
+        exit 1
+      else
+        return commands[0]
+      end
+    end
+
+    # Shows the help text for the given command, or shows the general help
+    # text if no command is given.
+    def show_help(command=nil)
+      if command.nil?
+        @help_command.run([], [])
+      else
+        @help_command.run([], [ command.name ])
+      end
+    end
+
+    # Returns the list of global option definitions.
+    def global_option_definitions
+      []
+    end
+
+    # Adds the given command to the list of commands. Adding a command will
+    # also cause the command's +base+ to be set to this instance.
+    def add_command(command)
+      @commands << command
+      command.base = self
+    end
+
+    # Handles the given option.
+    def handle_option(option)
+      false
+    end
+
+  private
+
+    # Returns true if the given string is an option (i.e. -foo or --foo),
+    # false otherwise.
+    def is_option?(string)
+      string =~ /^-/
+    end
+
+  end
+
+end

data/vendor/cri/lib/cri/command.rb

@@ -0,0 +1,105 @@
+module Cri
+
+  # Cri::Command represents a command that can be executed on the commandline.
+  # It is an abstract superclass for all commands.
+  class Command
+
+    attr_accessor :base
+
+    # Returns a string containing the name of thi command. Subclasses must
+    # implement this method.
+    def name
+      raise NotImplementedError.new("Command subclasses should override #name")
+    end
+
+    # Returns an array of strings containing the aliases for this command.
+    # Subclasses must implement this method.
+    def aliases
+      raise NotImplementedError.new("Command subclasses should override #aliases")
+    end
+
+    # Returns a string containing this command's short description, which
+    # should not be longer than 50 characters. Subclasses must implement this
+    # method.
+    def short_desc
+      raise NotImplementedError.new("Command subclasses should override #short_desc")
+    end
+
+    # Returns a string containing this command's complete description, which
+    # should explain what this command does and how it works in detail.
+    # Subclasses must implement this method.
+    def long_desc
+      raise NotImplementedError.new("Command subclasses should override #long_desc")
+    end
+
+    # Returns a string containing this command's usage. Subclasses must
+    # implement this method.
+    def usage
+      raise NotImplementedError.new("Command subclasses should override #usage")
+    end
+
+    # Returns an array containing this command's option definitions. See the
+    # documentation for Cri::OptionParser for details on what option
+    # definitions look like. Subclasses may implement this method if the
+    # command has options.
+    def option_definitions
+      []
+    end
+
+    # Executes the command. Subclasses must implement this method
+    # (obviously... what's the point of a command that can't be run?).
+    #
+    # +options+:: A hash containing the parsed commandline options. For
+    #             example, '--foo=bar' will be converted into { :foo => 'bar'
+    #             }. See the Cri::OptionParser documentation for details.
+    #
+    # +arguments+:: An array of strings representing the commandline arguments
+    #               given to this command.
+    def run(options, arguments)
+      raise NotImplementedError.new("Command subclasses should override #run")
+    end
+
+    # Returns the help text for this command.
+    def help
+      text = ''
+
+      # Append usage
+      text << usage + "\n"
+
+      # Append aliases
+      unless aliases.empty?
+        text << "\n"
+        text << "aliases: #{aliases.join(' ')}\n"
+      end
+
+      # Append short description
+      text << "\n"
+      text << short_desc + "\n"
+
+      # Append long description
+      text << "\n"
+      text << long_desc.wrap_and_indent(78, 4) + "\n"
+
+      # Append options
+      all_option_definitions = base.global_option_definitions + option_definitions
+      unless all_option_definitions.empty?
+        text << "\n"
+        text << "options:\n"
+        text << "\n"
+        all_option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          text << sprintf("    -%1s --%-10s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+        end
+      end
+
+      # Return text
+      text
+    end
+
+    # Compares this command's name to the other given command's name.
+    def <=>(other)
+      self.name <=> other.name
+    end
+
+  end
+
+end