nanoc3 3.2.0a4 → 3.2.0b1

data/lib/nanoc3/base/source_data/layout.rb

@@ -85,7 +85,8 @@ module Nanoc3
       "<#{self.class}:0x#{self.object_id.to_s(16)} identifier=#{self.identifier}>"
     end
 
-    # TODO document
+    # @return [String] The checksum for this object. If its contents change,
+    #   the checksum will change as well.
     def checksum
       attributes = @attributes.dup
       attributes.delete(:file)
@@ -93,6 +94,32 @@ module Nanoc3
     end
     memoize :checksum
 
+    def hash
+      self.class.hash ^ self.identifier.hash
+    end
+
+    def eql?(other)
+      self.class == other.class && self.identifier == other.identifier
+    end
+
+    def ==(other)
+      self.eql?(other)
+    end
+
+    def marshal_dump
+      [
+        @raw_content,
+        @attributes,
+        @identifier
+      ]
+    end
+
+    def marshal_load(source)
+      @raw_content,
+      @attributes,
+      @identifier = *source
+    end
+
     # @deprecated Access the modification time using `layout[:mtime]` instead.
     def mtime
       self[:mtime]

data/lib/nanoc3/base/source_data/site.rb

@@ -179,11 +179,22 @@ module Nanoc3
     # @return [void]
     def setup_child_parent_links
       teardown_child_parent_links
-      @items.each do |item|
+
+      items = @items.sort_by { |i| i.identifier }
+      items.each_with_index do |item, index|
         # Get parent
+        next if index == 0
         parent_identifier = item.identifier.sub(/[^\/]+\/$/, '')
-        parent = @items.find { |p| p.identifier == parent_identifier }
-        next if parent.nil? or item.identifier == '/'
+        parent = nil
+        (0..index-1).reverse_each do |candidate_index|
+          candidate = items[candidate_index]
+          if candidate.identifier == parent_identifier
+            parent = candidate
+          elsif candidate.identifier[0..parent_identifier.size-1] != parent_identifier
+            break
+          end
+        end
+        next if parent.nil?
 
         # Link
         item.parent = parent

data/lib/nanoc3/cli.rb

@@ -1,12 +1,104 @@
 # encoding: utf-8
 
-# Load Cri
 require 'cri'
 
 module Nanoc3::CLI
-end
 
-# Load CLI
-require 'nanoc3/cli/logger'
-require 'nanoc3/cli/commands'
-require 'nanoc3/cli/base'
+  module Commands
+  end
+
+  # @return [Boolean] true if debug output is enabled, false if not
+  #
+  # @since 3.2.0
+  def self.debug?
+    @debug || false
+  end
+
+  # @param [Boolean] boolean true if debug output should be enabled,
+  #   false if it should not
+  #
+  # @return [void]
+  #
+  # @since 3.2.0
+  def self.debug=(boolean)
+    @debug = boolean
+  end
+
+  autoload 'Logger',             'nanoc3/cli/logger'
+  autoload 'Command',            'nanoc3/cli/command'
+
+  # Invokes the nanoc commandline tool with the given arguments.
+  #
+  # @param [Array<String>] args An array of commandline arguments
+  #
+  # @return [void]
+  def self.run(args)
+    self.setup
+    self.load_custom_commands
+    self.root_command.run(args)
+  end
+
+  # Adds the given command to the collection of available commands.
+  #
+  # @param [Cri::Command] cmd The command to add
+  #
+  # @return [void]
+  def self.add_command(cmd)
+    self.root_command.add_command(cmd)
+  end
+
+protected
+
+  # Makes the commandline interface ready for using by loading the commands.
+  #
+  # @return [void]
+  def self.setup
+    # Don’t set up twice
+    return if @setup
+
+    # Add help command
+    help_cmd = Cri::Command.new_basic_help
+    self.add_command(help_cmd)
+
+    # Add other commands
+    cmd_filenames = Dir[File.dirname(__FILE__) + '/cli/commands/*.rb']
+    cmd_filenames.each do |filename|
+      next if File.basename(filename, '.rb') == 'nanoc'
+      cmd = self.load_command_at(filename)
+      self.add_command(cmd)
+    end
+
+    @setup = true
+  end
+
+  # Loads the commands in `commands/`.
+  #
+  # @return [void]
+  def self.load_custom_commands
+    Dir['commands/*.rb'].each do |filename|
+      cmd = Nanoc3::CLI.load_command_at(filename)
+      Nanoc3::CLI.root_command.add_command(cmd)
+    end
+  end
+
+  # Loads the command in the file with the given filename.
+  #
+  # @param [String] filename The name of the file that contains the command
+  #
+  # @return [Cri::Command] The loaded command
+  def self.load_command_at(filename)
+    code = File.read(filename)
+    cmd = Cri::Command.define(code)
+    cmd.modify { name File.basename(filename, '.rb') }
+    cmd
+  end
+
+  # @return [Cri::Command] The root command, i.e. the commandline tool itself
+  def self.root_command
+    @root_command ||= begin
+      filename = File.dirname(__FILE__) + "/cli/commands/nanoc.rb"
+      self.load_command_at(filename)
+    end
+  end
+
+end

data/lib/nanoc3/cli/{base.rb → command.rb}

@@ -2,7 +2,86 @@
 
 module Nanoc3::CLI
 
-  class Base < Cri::Base
+  # An abstract superclass for commands that can be executed. These are not
+  # the same as Cri commands, but are used in conjuction with Cri commands.
+  # nanoc commands will be called by Cri commands and will perform the actual
+  # execution of the command, as well as perform error handling if necessary.
+  class Command
+
+    # @return [Hash] A hash contain the options and their values
+    attr_reader :options
+
+    # @return [Array] The list of arguments
+    attr_reader :arguments
+
+    # @return [Cri::Command] The Cri command
+    attr_reader :command
+
+    # @param [Hash] options A hash contain the options and their values
+    #
+    # @param [Array] arguments The list of arguments
+    #
+    # @param [Cri::Command] command The Cri command
+    def initialize(options, arguments, command)
+      @options   = options
+      @arguments = arguments
+      @command   = command
+    end
+
+    # Runs the command with the given options, arguments and Cri command. This
+    # is a convenience method so that no individual command needs to be
+    # created.
+    #
+    # @param [Hash] options A hash contain the options and their values
+    #
+    # @param [Array] arguments The list of arguments
+    #
+    # @param [Cri::Command] command The Cri command
+    #
+    # @return [void]
+    def self.call(options, arguments, command)
+      self.new(options, arguments, command).call
+    end
+
+    # Runs the command.
+    #
+    # @return [void]
+    def call
+      # Set exit handler
+      [ 'INT', 'TERM' ].each do |signal|
+        Signal.trap(signal) do
+          puts
+          exit!(0)
+        end
+      end
+
+      # Set attributes
+
+      # Run
+      self.run
+    rescue Interrupt => e
+      exit(1)
+    rescue StandardError, ScriptError => e
+      self.print_error(e)
+      exit(1)
+    end
+
+    # Performs the actual execution of the command.
+    #
+    # @return [void]
+    #
+    # @abstract
+    def run
+    end
+
+  protected
+
+    # @return [Boolean] true if debug output is enabled, false if not
+    #
+    # @see Nanoc3::CLI.debug?
+    def debug?
+      Nanoc3::CLI.debug?
+    end
 
     # A hash that contains the name of the gem for a given required file. If a
     # `#require` fails, the gem name is looked up in this hash.
@@ -35,93 +114,6 @@ module Nanoc3::CLI
       'w3c_validators' => 'w3c_validators'
     }
 
-    def initialize
-      super('nanoc3')
-
-      @debug = false
-
-      # Add help command
-      self.help_command = Nanoc3::CLI::Commands::Help.new
-      add_command(self.help_command)
-
-      # Add other commands
-      add_command(Nanoc3::CLI::Commands::Autocompile.new)
-      add_command(Nanoc3::CLI::Commands::Compile.new)
-      add_command(Nanoc3::CLI::Commands::CreateLayout.new)
-      add_command(Nanoc3::CLI::Commands::CreateItem.new)
-      add_command(Nanoc3::CLI::Commands::CreateSite.new)
-      add_command(Nanoc3::CLI::Commands::Debug.new)
-      add_command(Nanoc3::CLI::Commands::Info.new)
-      add_command(Nanoc3::CLI::Commands::Update.new)
-      add_command(Nanoc3::CLI::Commands::View.new)
-      add_command(Nanoc3::CLI::Commands::Watch.new)
-    end
-
-    # Returns a fully initialised base instance. It is recommended to use this
-    # shared instance than to create new ones, as this will be the instance
-    # that will be used when reading all code from the `lib/` directory.
-    #
-    # @return [Nanoc3::CLI::Base]
-    def self.shared_base
-      @shared_base ||= Nanoc3::CLI::Base.new
-    end
-
-    # @return [Boolean] true if debug output is enabled, false if not
-    #
-    # @since 3.2.0
-    def debug?
-      @debug
-    end
-
-    # Asserts that the current working directory contains a site
-    # ({Nanoc3::Site} instance). If no site is present, prints an error
-    # message and exits.
-    #
-    # @return [void]
-    def require_site
-      if site.nil?
-        $stderr.puts 'The current working directory does not seem to be a ' +
-                     'valid/complete nanoc site directory; aborting.'
-        exit 1
-      end
-    end
-
-    # Gets the site ({Nanoc3::Site} instance) in the current directory and
-    # loads its data.
-    #
-    # @return [Nanoc3::Site] The site in the current working directory
-    def site
-      # Load site if possible
-      if File.file?('config.yaml') && (!self.instance_variable_defined?(:@site) || @site.nil?)
-        begin
-          @site = Nanoc3::Site.new('.')
-        rescue Nanoc3::Errors::UnknownDataSource => e
-          $stderr.puts "Unknown data source: #{e}"
-          exit 1
-        end
-      end
-
-      @site
-    end
-
-    # @see ::Cri::Base#run
-    def run(args)
-      # Set exit handler
-      [ 'INT', 'TERM' ].each do |signal|
-        Signal.trap(signal) do
-          puts
-          exit!(0)
-        end
-      end
-
-      super(args)
-    rescue Interrupt => e
-      exit(1)
-    rescue StandardError, ScriptError => e
-      print_error(e)
-      exit(1)
-    end
-
     # Prints the given error to stderr. Includes message, possible resolution
     # (see {#resolution_for}), compilation stack, backtrace, etc.
     #
@@ -151,10 +143,10 @@ module Nanoc3::CLI
       $stderr.puts
       $stderr.puts '=== COMPILATION STACK:'
       $stderr.puts
-      if stack.empty?
+      if self.stack.empty?
         $stderr.puts "  (empty)"
       else
-        stack.reverse.each do |obj|
+        self.stack.reverse.each do |obj|
           if obj.is_a?(Nanoc3::ItemRep)
             $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
           else # layout
@@ -181,7 +173,7 @@ module Nanoc3::CLI
       when LoadError
         # Get gem name
         matches = error.message.match(/no such file to load -- ([^\s]+)/)
-        return nil if matches.empty?
+        return nil if matches.size == 0
         lib_name = matches[1]
         gem_name = GEM_NAMES[$1]
 
@@ -200,6 +192,39 @@ module Nanoc3::CLI
       end
     end
 
+    # Asserts that the current working directory contains a site
+    # ({Nanoc3::Site} instance). If no site is present, prints an error
+    # message and exits.
+    #
+    # @return [void]
+    def require_site
+      @site = nil
+      if site.nil?
+        $stderr.puts 'The current working directory does not seem to be a ' +
+                     'valid/complete nanoc site directory; aborting.'
+        exit 1
+      end
+    end
+
+    # Gets the site ({Nanoc3::Site} instance) in the current directory and
+    # loads its data.
+    #
+    # @return [Nanoc3::Site] The site in the current working directory
+    def site
+      # Load site if possible
+      @site ||= nil
+      if File.file?('config.yaml') && @site.nil?
+        begin
+          @site = Nanoc3::Site.new('.')
+        rescue Nanoc3::Errors::UnknownDataSource => e
+          $stderr.puts "Unknown data source: #{e}"
+          exit 1
+        end
+      end
+
+      @site
+    end
+
     # Sets the data source's VCS to the VCS with the given name. Does nothing
     # when the site's data source does not support VCSes (i.e. does not
     # implement #vcs=).
@@ -227,68 +252,7 @@ module Nanoc3::CLI
       end
     end
 
-    # @return [Array] The list of global option definitions
-    def global_option_definitions
-      [
-        {
-          :long => 'help', :short => 'h', :argument => :forbidden,
-          :desc => 'show this help message and quit'
-        },
-        {
-          :long => 'color', :short => 'l', :argument => :forbidden,
-          :desc => 'enable color'
-        },
-        {
-          :long => 'no-color', :short => 'C', :argument => :forbidden,
-          :desc => 'disable color'
-        },
-        {
-          :long => 'version', :short => 'v', :argument => :forbidden,
-          :desc => 'show version information and quit'
-        },
-        {
-          :long => 'verbose', :short => 'V', :argument => :forbidden,
-          :desc => 'make nanoc output more detailed'
-        },
-        {
-          :long => 'debug', :short => 'd', :argument => :forbidden,
-          :desc => 'enable debugging'
-        },
-        {
-          :long => 'warn', :short => 'w', :argument => :forbidden,
-          :desc => 'enable warnings'
-        }
-      ]
-    end
-
-    # @see Cri::Base#handle_option
-    def handle_option(option)
-      case option
-      when :version
-        gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : "without RubyGems"
-        engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
-
-        puts "nanoc #{Nanoc3::VERSION} (c) 2007-2011 Denis Defreyne."
-        puts "Running #{engine} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} #{gem_info}"
-        exit 0
-      when :verbose
-        Nanoc3::CLI::Logger.instance.level = :low
-      when :debug
-        @debug = true
-      when :warn
-        $-w = true
-      when :color
-        Nanoc3::CLI::Logger.instance.color = true
-      when :'no-color'
-        Nanoc3::CLI::Logger.instance.color = false
-      when :help
-        show_help
-        exit 0
-      end
-    end
-
-  protected
-
+    # @return [Array] The compilation stack.
     def stack
       (self.site && self.site.compiler.stack) || []
     end