nanoc 2.2.2 → 3.0.0a1

data/lib/nanoc/routers.rb

@@ -1,3 +0,0 @@
-require 'nanoc/routers/default'
-require 'nanoc/routers/no_dirs'
-require 'nanoc/routers/versioned'

data/lib/nanoc/routers/default.rb

@@ -1,54 +0,0 @@
-module Nanoc::Routers
-
-  # The default router organises pages in the most obvious, but sometimes
-  # slightly restrictive, way: the hierarchy of compiled pages and assets is
-  # the same as the hierarchy of uncompiled pages and assets.
-  class Default < Nanoc::Router
-
-    identifier :default
-
-    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 rep name if necessary
-      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/no_dirs.rb

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

@@ -1,79 +0,0 @@
-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/vendor/cri/LICENSE

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

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

data/vendor/cri/Rakefile

@@ -1,25 +0,0 @@
-##### 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.rb

@@ -1,12 +0,0 @@
-module Cri
-
-  # The current Cri version.
-  VERSION = '1.0'
-
-end
-
-# Load Cri
-require 'cri/base'
-require 'cri/command'
-require 'cri/core_ext'
-require 'cri/option_parser'

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

@@ -1,153 +0,0 @@
-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 definitionss.
-    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 optio
-    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

@@ -1,104 +0,0 @@
-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
-      unless option_definitions.empty?
-        text << "\n"
-        text << "options:\n"
-        text << "\n"
-        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