nanoc3 3.2.0a4 → 3.2.0b1

data/lib/nanoc3/cli/commands/autocompile.rb

@@ -1,59 +1,31 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
-
-  class Autocompile < Cri::Command
-
-    def name
-      'autocompile'
-    end
-
-    def aliases
-      [ 'aco' ]
-    end
-
-    def short_desc
-      'start the autocompiler'
-    end
-
-    def long_desc
-      'Start the autocompiler web server. Unless specified, the web ' +
-      'server will run on port 3000 and listen on all IP addresses. ' +
-      'Running the autocompiler requires \'mime/types\' and \'rack\'.'
-    end
+usage       'autocompile [options]'
+summary     'start the autocompiler'
+aliases     :aco
+description <<-EOS
+Start the autocompiler web server. Unless specified, the web server will run
+on port 3000 and listen on all IP addresses. Running the autocompiler requires
+the 'mime/types' and 'rack' gems.
+EOS
+
+option :H, :handler, 'specify the handler to use (webrick/mongrel/...)'
+option :o, :host,    'specify the host to listen on (default: 0.0.0.0)'
+option :p, :port,    'specify the port to listen on (default: 3000)'
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::AutoCompile.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 autocompile [options]"
-    end
+module Nanoc3::CLI::Commands
 
-    def option_definitions
-      [
-        # --handler
-        {
-          :long => 'handler', :short => 'H', :argument => :required,
-          :desc => 'specify the handler to use (webrick/mongrel/...)'
-        },
-        # --host
-        {
-          :long => 'host', :short => 'o', :argument => :required,
-          :desc => 'specify the host to listen on (default: 0.0.0.0)'
-        },
-        # --port
-        {
-          :long => 'port', :short => 'p', :argument => :required,
-          :desc => 'specify the port to listen on (default: 3000)'
-        }
-      ]
-    end
+  class AutoCompile < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       require 'rack'
 
-      # Warn
-      warn 'WARNING: As of nanoc 3.2, the autocompiler is deprecated. Consider using the new and much faster “nanoc watch” command that recompiles the site on change rather than on request.'
-
       # Make sure we are in a nanoc site directory
-      @base.require_site
+      self.require_site
 
       # Set options
       options_for_rack = {

data/lib/nanoc3/cli/commands/compile.rb

@@ -1,52 +1,37 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
+usage       'compile [options]'
+summary     'compile items of this site'
+description <<-EOS
+Compile all items of the current site.
 
-  class Compile < Cri::Command
+The compile command will show all items of the site as they are processed. The time spent compiling the item will be printed, as well as a status message, which can be one of the following:
 
-    def name
-      'compile'
-    end
+CREATED - The compiled item did not yet exist and has been created
 
-    def aliases
-      []
-    end
+UPDATED - The compiled item did already exist and has been modified
 
-    def short_desc
-      'compile items of this site'
-    end
+IDENTICAL - The item was deemed outdated and has been recompiled, but the compiled version turned out to be identical to the already existing version
 
-    def long_desc
-      'Compile all items of the current site.' +
-      "\n\n" +
-      'By default, only item that are outdated will be compiled. This can ' +
-      'speed up the compilation process quite a bit, but items that include ' +
-      'content from other items may have to be recompiled manually.'
-    end
+SKIP - The item was deemed not outdated and was therefore not recompiled
 
-    def usage
-      "nanoc3 compile [options]"
-    end
+EOS
 
-    def option_definitions
-      [
-        # --all
-        {
-          :long => 'all', :short => 'a', :argument => :forbidden,
-          :desc => '(ignored)'
-        },
-        # --force
-        {
-          :long => 'force', :short => 'f', :argument => :forbidden,
-          :desc => '(ignored)'
-        }
-      ]
-    end
+option :a, :all,   '(ignored)'
+option :f, :force, '(ignored)'
 
-    def run(options, arguments)
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::Compile.call(opts, args, cmd)
+end
+
+module Nanoc3::CLI::Commands
+
+  class Compile < ::Nanoc3::CLI::Command
+
+    def run
       # Make sure we are in a nanoc site directory
       puts "Loading site data..."
-      @base.require_site
+      self.require_site
 
       # Check presence of --all option
       if options.has_key?(:all) || options.has_key?(:force)
@@ -73,10 +58,10 @@ module Nanoc3::CLI::Commands
       setup_diffs
 
       # Compile
-      @base.site.compile
+      self.site.compile
 
       # Find reps
-      reps = @base.site.items.map { |i| i.reps }.flatten
+      reps = self.site.items.map { |i| i.reps }.flatten
 
       # Show skipped reps
       reps.select { |r| !r.compiled? }.each do |rep|
@@ -100,8 +85,6 @@ module Nanoc3::CLI::Commands
       end
     end
 
-  private
-
     def setup_notifications
       # File notifications
       Nanoc3::NotificationCenter.on(:will_write_rep) do |rep, snapshot|
@@ -115,16 +98,16 @@ module Nanoc3::CLI::Commands
 
       # Debug notifications
       Nanoc3::NotificationCenter.on(:compilation_started) do |rep|
-        puts "*** Started compilation of #{rep.inspect}" if @base.debug?
+        puts "*** Started compilation of #{rep.inspect}" if self.debug?
       end
       Nanoc3::NotificationCenter.on(:compilation_ended) do |rep|
-        puts "*** Ended compilation of #{rep.inspect}" if @base.debug?
+        puts "*** Ended compilation of #{rep.inspect}" if self.debug?
       end
       Nanoc3::NotificationCenter.on(:compilation_failed) do |rep|
-        puts "*** Suspended compilation of #{rep.inspect} due to unmet dependencies" if @base.debug?
+        puts "*** Suspended compilation of #{rep.inspect} due to unmet dependencies" if self.debug?
       end
       Nanoc3::NotificationCenter.on(:cached_content_used) do |rep|
-        puts "*** Used cached compiled content for #{rep.inspect} instead of recompiling" if @base.debug?
+        puts "*** Used cached compiled content for #{rep.inspect} instead of recompiling" if self.debug?
       end
 
       # Timing notifications
@@ -135,11 +118,12 @@ module Nanoc3::CLI::Commands
         @rep_times[rep.raw_path] = Time.now - @rep_times[rep.raw_path]
       end
       Nanoc3::NotificationCenter.on(:filtering_started) do |rep, filter_name|
-        @filter_times[filter_name] = Time.now
+        @filter_times[filter_name] ||= []
+        @filter_times[filter_name] << Time.now
         start_filter_progress(rep, filter_name)
       end
       Nanoc3::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
-        @filter_times[filter_name] = Time.now - @filter_times[filter_name]
+        @filter_times[filter_name] << Time.now - @filter_times[filter_name].pop
         stop_filter_progress(rep, filter_name)
       end
     end
@@ -155,7 +139,7 @@ module Nanoc3::CLI::Commands
     end
 
     def generate_diff_for(rep, snapshot)
-      return if !@base.site.config[:enable_output_diff]
+      return if !self.site.config[:enable_output_diff]
       return if !File.file?(rep.raw_path(:snapshot => snapshot))
       return if rep.binary?
 

data/lib/nanoc3/cli/commands/create_item.rb

@@ -1,43 +1,27 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
-
-  class CreateItem < Cri::Command
-
-    def name
-      'create_item'
-    end
-
-    def aliases
-      [ 'ci' ]
-    end
-
-    def short_desc
-      'create a item'
-    end
-
-    def long_desc
-      'Create a new item in the current site. The first data source in the site configuration will be used.'
-    end
+usage       'create_item [options] identifier'
+summary     'create an item'
+aliases     :ci
+description <<-EOS
+Create a new item in the current site. The first data source in the site
+configuration will be used.
+EOS
+
+option :c, :vcs, 'specify the VCS to use'
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::CreateItem.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 create_item [options] identifier"
-    end
+module Nanoc3::CLI::Commands
 
-    def option_definitions
-      [
-        # --vcs
-        {
-          :long => 'vcs', :short => 'c', :argument => :required,
-          :desc => 'select the VCS to use'
-        }
-      ]
-    end
+  class CreateItem < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       # Check arguments
       if arguments.length != 1
-        $stderr.puts "usage: #{usage}"
+        $stderr.puts "usage: #{command.usage}"
         exit 1
       end
 
@@ -45,13 +29,13 @@ module Nanoc3::CLI::Commands
       identifier = arguments[0].cleaned_identifier
 
       # Make sure we are in a nanoc site directory
-      @base.require_site
+      self.require_site
 
       # Set VCS if possible
-      @base.set_vcs(options[:vcs])
+      self.set_vcs(options[:vcs])
 
       # Check whether item is unique
-      if !@base.site.items.find { |i| i.identifier == identifier }.nil?
+      if !self.site.items.find { |i| i.identifier == identifier }.nil?
         $stderr.puts "An item already exists at #{identifier}. Please " +
                      "pick a unique name for the item you are creating."
         exit 1
@@ -63,7 +47,7 @@ module Nanoc3::CLI::Commands
       end
 
       # Create item
-      data_source = @base.site.data_sources[0]
+      data_source = self.site.data_sources[0]
       data_source.create_item(
         "Hi, I'm a new item!\n",
         { :title => "A New Item" },

data/lib/nanoc3/cli/commands/create_layout.rb

@@ -1,40 +1,22 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
-
-  class CreateLayout < Cri::Command
-
-    def name
-      'create_layout'
-    end
-
-    def aliases
-      [ 'cl' ]
-    end
-
-    def short_desc
-      'create a layout'
-    end
-
-    def long_desc
-      'Create a new layout in the current site. The first data source in the site configuration will be used.'
-    end
+usage       'create_layout [options] identifier'
+aliases     'cl'
+summary     'create a layout'
+description <<-EOS
+Create a new layout in the current site. The first data source in the site
+configuration will be used.
+EOS
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::CreateLayout.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 create_layout [options] identifier"
-    end
+module Nanoc3::CLI::Commands
 
-    def option_definitions
-      [
-        # --vcs
-        {
-          :long => 'vcs', :short => 'c', :argument => :required,
-          :desc => 'select the VCS to use'
-        }
-      ]
-    end
+  class CreateLayout < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       # Check arguments
       if arguments.length != 1
         $stderr.puts "usage: #{usage}"
@@ -45,13 +27,13 @@ module Nanoc3::CLI::Commands
       identifier = arguments[0].cleaned_identifier
 
       # Make sure we are in a nanoc site directory
-      @base.require_site
+      self.require_site
 
       # Set VCS if possible
-      @base.set_vcs(options[:vcs])
+      self.set_vcs(options[:vcs])
 
       # Check whether layout is unique
-      if !@base.site.layouts.find { |l| l.identifier == identifier }.nil?
+      if !self.site.layouts.find { |l| l.identifier == identifier }.nil?
         $stderr.puts "A layout already exists at #{identifier}. Please " +
                      "pick a unique name for the layout you are creating."
         exit 1
@@ -70,7 +52,7 @@ module Nanoc3::CLI::Commands
       end
 
       # Create layout
-      data_source = @base.site.data_sources[0]
+      data_source = self.site.data_sources[0]
       data_source.create_layout(
         "<html>\n" +
         "  <head>\n" +

data/lib/nanoc3/cli/commands/create_site.rb

@@ -1,8 +1,21 @@
 # encoding: utf-8
 
+usage       'create_site [options] path'
+aliases     'cs'
+summary     'create a site'
+description <<-EOS
+Create a new site at the given path. The site will use the filesystem_unified data source by default, but this can be changed using the --datasource commandline option.
+EOS
+
+required :d, :datasource, 'specify the data source for the new site'
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::CreateSite.call(opts, args, cmd)
+end
+
 module Nanoc3::CLI::Commands
 
-  class CreateSite < Cri::Command
+  class CreateSite < ::Nanoc3::CLI::Command
 
     class << self
 
@@ -270,39 +283,7 @@ EOS
 </html>
 EOS
 
-    def name
-      'create_site'
-    end
-
-    def aliases
-      [ 'cs' ]
-    end
-
-    def short_desc
-      'create a site'
-    end
-
-    def long_desc
-      'Create a new site at the given path. The site will use the ' +
-      'filesystem_unified data source by default, but this can be ' +
-      'changed using the --datasource commandline option.'
-    end
-
-    def usage
-      "nanoc3 create_site [options] path"
-    end
-
-    def option_definitions
-      [
-        # --datasource
-        {
-          :long => 'datasource', :short => 'd', :argument => :required,
-          :desc => 'specify the data source for the new site'
-        }
-      ]
-    end
-
-    def run(options, arguments)
+    def run
       # Check arguments
       if arguments.length != 1
         $stderr.puts "usage: #{usage}"