nanoc3 3.0.0

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

@@ -0,0 +1,89 @@
+# 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
+
+    def usage
+      "nanoc3 autocompile [options]"
+    end
+
+    def option_definitions
+      [
+        # --port
+        {
+          :long => 'port', :short => 'p', :argument => :required,
+          :desc => 'specify a port number for the autocompiler'
+        },
+        # --server
+        {
+          :long => 'server', :short => 's', :argument => :required,
+          :desc => 'specify the server 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
+
+    def run(options, arguments)
+      require 'rack'
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set options
+      options_for_rack = {
+        :Port      => (options[:port] || 3000).to_i,
+        :Host      => (options[:host] || '0.0.0.0')
+      }
+
+      # Guess which handler we should use
+      unless handler = Rack::Handler.get(options[:server])
+        begin
+          handler = Rack::Handler::Mongrel
+        rescue LoadError => e
+          handler = Rack::Handler::WEBrick
+        end
+      end
+
+      # Build app
+      autocompiler = Nanoc3::Extra::AutoCompiler.new('.')
+      app = Rack::Builder.new do
+        use Rack::CommonLogger, $stderr
+        use Rack::ShowExceptions
+        run autocompiler
+      end.to_app
+
+      # Run autocompiler
+      handler.run(app, options_for_rack)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,279 @@
+# encoding: utf-8
+
+module Nanoc3::CLI::Commands
+
+  class Compile < Cri::Command
+
+    def name
+      'compile'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'compile items of this site'
+    end
+
+    def long_desc
+      'Compile all items of the current site. If an identifier is given, ' +
+      'only the item with the given identifier will be compiled. ' +
+      "\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. In ' +
+      'order to compile items even when they are outdated, use the --force option.'
+    end
+
+    def usage
+      "nanoc3 compile [options] [identifier]"
+    end
+
+    def option_definitions
+      [
+        # --all
+        {
+          :long => 'all', :short => 'a', :argument => :forbidden,
+          :desc => 'alias for --force (DEPRECATED)'
+        },
+        # --force
+        {
+          :long => 'force', :short => 'f', :argument => :forbidden,
+          :desc => 'compile items even when they are not outdated'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Make sure we are in a nanoc site directory
+      puts "Loading site data..."
+      @base.require_site
+      @base.site.load_data
+
+      # Check presence of --all option
+      if options.has_key?(:all)
+        $stderr.puts "Warning: the --all option is deprecated; please use --force instead."
+      end
+
+      # Find item(s) to compile
+      if arguments.size == 0
+        item = nil
+      elsif arguments.size == 1
+        # Find item
+        identifier = arguments[0].cleaned_identifier
+        item = @base.site.items.find { |item| item.identifier == identifier }
+
+        # Ensure item
+        if item.nil?
+          $stderr.puts "Unknown item: #{identifier}"
+          exit 1
+        end
+      end
+
+      # Give feedback
+      puts "Compiling #{item.nil? ? 'site' : 'item'}..."
+
+      # Initialize profiling stuff
+      time_before = Time.now
+      @filter_times ||= {}
+      @times_stack  ||= []
+      setup_notifications
+
+      # Compile
+      @base.site.compiler.run(
+        item,
+        :force => options.has_key?(:all) || options.has_key?(:force)
+      )
+
+      # Find reps
+      reps = @base.site.items.map  { |i| i.reps }.flatten
+
+      # Show skipped reps
+      reps.select { |r| !r.compiled? }.each do |rep|
+        next if rep.raw_path.nil?
+        duration = @rep_times[rep.raw_path]
+        Nanoc3::CLI::Logger.instance.file(:low, :skip, rep.raw_path, duration)
+      end
+
+      # Give general feedback
+      puts
+      puts "No items were modified." unless reps.any? { |r| r.modified? }
+      puts "#{item.nil? ? 'Site' : 'Item'} compiled in #{format('%.2f', Time.now - time_before)}s."
+
+      if options.has_key?(:verbose)
+        print_state_feedback(reps)
+        print_profiling_feedback(reps)
+      end
+    rescue Interrupt => e
+      exit(1)
+    rescue StandardError, ScriptError => e
+      print_error(e)
+      exit(1)
+    end
+
+  private
+
+    def setup_notifications
+      Nanoc3::NotificationCenter.on(:compilation_started) do |rep|
+        rep_compilation_started(rep)
+      end
+      Nanoc3::NotificationCenter.on(:compilation_ended) do |rep|
+        rep_compilation_ended(rep)
+      end
+      Nanoc3::NotificationCenter.on(:filtering_started) do |rep, filter_name|
+        rep_filtering_started(rep, filter_name)
+      end
+      Nanoc3::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
+        rep_filtering_ended(rep, filter_name)
+      end
+    end
+
+    def print_state_feedback(reps)
+      # Categorise reps
+      rest              = reps
+      created, rest     = *rest.partition { |r| r.created? }
+      modified, rest    = *rest.partition { |r| r.modified? }
+      skipped, rest     = *rest.partition { |r| !r.compiled? }
+      not_written, rest = *rest.partition { |r| r.compiled? && !r.written? }
+      identical         = rest
+
+      # Print
+      puts
+      puts format('  %4d  created',     created.size)
+      puts format('  %4d  modified',    modified.size)
+      puts format('  %4d  skipped',     skipped.size)
+      puts format('  %4d  not written', not_written.size)
+      puts format('  %4d  identical',   identical.size)
+    end
+
+    def print_profiling_feedback(reps)
+      # Get max filter length
+      max_filter_name_length = @filter_times.keys.map { |k| k.to_s.size }.max
+      return if max_filter_name_length.nil?
+
+      # Print warning if necessary
+      if reps.any? { |r| !r.compiled? }
+        $stderr.puts
+        $stderr.puts "Warning: profiling information may not be accurate because " +
+                     "some items were not compiled."
+      end
+
+      # Print header
+      puts
+      puts ' ' * max_filter_name_length + ' | count    min    avg    max     tot'
+      puts '-' * max_filter_name_length + '-+-----------------------------------'
+
+      @filter_times.to_a.sort_by { |r| r[1] }.each do |row|
+        # Extract data
+        filter_name, samples = *row
+
+        # Calculate stats
+        count = samples.size
+        min   = samples.min
+        tot   = samples.inject { |memo, i| memo + i}
+        avg   = tot/count
+        max   = samples.max
+
+        # Format stats
+        count = format('%4d',   count)
+        min   = format('%4.2f', min)
+        avg   = format('%4.2f', avg)
+        max   = format('%4.2f', max)
+        tot   = format('%5.2f', tot)
+
+        # Output stats
+        filter_name = format("%#{max_filter_name_length}s", filter_name)
+        puts "#{filter_name} |  #{count}  #{min}s  #{avg}s  #{max}s  #{tot}s"
+      end
+    end
+
+    def print_error(error)
+      $stderr.puts
+
+      # Header
+      $stderr.puts '+--- /!\ ERROR /!\ -------------------------------------------+'
+      $stderr.puts '| An exception occured while compiling the site. If you think |'
+      $stderr.puts '| this is a bug in nanoc, please do report it at              |'
+      $stderr.puts '| <http://projects.stoneship.org/trac/nanoc/newticket> --     |'
+      $stderr.puts '| thanks in advance!                                          |'
+      $stderr.puts '+-------------------------------------------------------------+'
+
+      # Exception
+      $stderr.puts
+      $stderr.puts '=== MESSAGE:'
+      $stderr.puts
+      $stderr.puts "#{error.class}: #{error.message}"
+
+      # Compilation stack
+      $stderr.puts
+      $stderr.puts '=== COMPILATION STACK:'
+      $stderr.puts
+      if ((@base.site && @base.site.compiler.stack) || []).empty?
+        $stderr.puts "  (empty)"
+      else
+        @base.site.compiler.stack.reverse.each do |obj|
+          if obj.is_a?(Nanoc3::ItemRep)
+            $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
+          else # layout
+            $stderr.puts "  - [layout] #{obj.identifier}"
+          end
+        end
+      end
+
+      # Backtrace
+      require 'enumerator'
+      $stderr.puts
+      $stderr.puts '=== BACKTRACE:'
+      $stderr.puts
+      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
+    end
+
+    def rep_compilation_started(rep)
+      # Profile compilation
+      @rep_times ||= {}
+      @rep_times[rep.raw_path] = Time.now
+    end
+
+    def rep_compilation_ended(rep)
+      # Profile compilation
+      @rep_times ||= {}
+      @rep_times[rep.raw_path] = Time.now - @rep_times[rep.raw_path]
+
+      # Skip if not outputted
+      return unless rep.written?
+
+      # Get action and level
+      action, level = *if rep.created?
+        [ :create, :high ]
+      elsif rep.modified?
+        [ :update, :high ]
+      elsif !rep.compiled?
+        [ nil, nil ]
+      else
+        [ :identical, :low ]
+      end
+
+      # Log
+      unless action.nil?
+        duration = @rep_times[rep.raw_path]
+        Nanoc3::CLI::Logger.instance.file(level, action, rep.raw_path, duration)
+      end
+    end
+
+    def rep_filtering_started(rep, filter_name)
+      @times_stack.push(Time.now)
+    end
+
+    def rep_filtering_ended(rep, filter_name)
+      # Get last time
+      time_start = @times_stack.pop
+
+      # Update times
+      @filter_times[filter_name.to_sym] ||= []
+      @filter_times[filter_name.to_sym] << Time.now - time_start
+    end
+
+  end
+
+end

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

@@ -0,0 +1,79 @@
+# 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
+
+    def usage
+      "nanoc3 create_item [options] [identifier]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.length != 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Extract arguments and options
+      identifier = arguments[0].cleaned_identifier
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+      @base.site.load_data
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Check whether item is unique
+      if !@base.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
+      end
+
+      # Setup notifications
+      Nanoc3::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc3::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create item
+      data_source = @base.site.data_sources[0]
+      data_source.create_item(
+        "Hi, I'm a new item!\n",
+        { :title => "A New Item" },
+        identifier
+      )
+
+      puts "An item has been created at #{identifier}."
+    end
+
+  end
+
+end

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

@@ -0,0 +1,94 @@
+# 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
+
+    def usage
+      "nanoc3 create_layout [identifier]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.length != 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Extract arguments
+      identifier = arguments[0].cleaned_identifier
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+      @base.site.load_data
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Check whether layout is unique
+      if !@base.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
+      end
+
+      # Check whether layout is not at /
+      if identifier == '/'
+        $stderr.puts "There cannot be a layout with the identifier '/'; " +
+                     "please pick a different identifier for this layout."
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc3::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc3::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create layout
+      data_source = @base.site.data_sources[0]
+      data_source.create_layout(
+        "<html>\n" +
+        "  <head>\n" +
+        "    <title><%= @item.title %></title>\n" +
+        "  </head>\n" +
+        "  <body>\n" +
+        "    <p>Hi, I'm a new layout. Please customize me!</p>\n" +
+        "<%= yield %>\n" +
+        "  </body>\n" +
+        "</html>\n",
+        {},
+        identifier
+      )
+
+      puts "A layout has been created at #{identifier}."
+    end
+
+  end
+
+end