nanoc 2.0 → 2.1

data/lib/nanoc/cli/command.rb

@@ -0,0 +1,105 @@
+module Nanoc::CLI
+
+  # Nanoc::CLI::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 Nanoc::CLI::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 Nanoc::CLI::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

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

@@ -0,0 +1,80 @@
+module Nanoc::CLI
+
+  class AutocompileCommand < Command # :nodoc:
+
+    def name
+      'autocompile'
+    end
+
+    def aliases
+      [ 'aco', 'autocompile_site' ]
+    end
+
+    def short_desc
+      'start the autocompiler'
+    end
+
+    def long_desc
+      handler_names = Nanoc::Extra::AutoCompiler::HANDLER_NAMES.join(', ')
+
+      '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\'.' +
+      "\n" +
+      'Available handlers are (in order of preference): ' + handler_names +
+      ' (default is ' + Nanoc::Extra::AutoCompiler::HANDLER_NAMES[0].to_s + ').'
+    end
+
+    def usage
+      "nanoc autocompile [options]"
+    end
+
+    def option_definitions
+      [
+        # --all
+        {
+          :long => 'all', :short => 'a', :argument => :forbidden,
+          :desc => 'compile all pages, even those that aren\'t outdated'
+        },
+        # --port
+        {
+          :long => 'port', :short => 'p', :argument => :required,
+          :desc => 'specify a port number for the autocompiler'
+        },
+        # --handler
+        {
+          :long => 'handler', :short => 'H', :argument => :required,
+          :desc => 'specify the handler to use'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size != 0
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Autocompile site
+      begin
+        autocompiler = Nanoc::Extra::AutoCompiler.new(@base.site, options.has_key?(:all))
+        autocompiler.start(
+          options[:port],
+          options[:handler]
+        )
+      rescue LoadError
+        $stderr.puts "'mime/types' and 'rack' are required to autocompile sites. " +
+                     "You may want to install the 'mime-types' and 'rack' gems by " +
+                     "running 'gem install mime-types' and 'gem install rack'."
+      rescue Nanoc::Extra::AutoCompiler::UnknownHandlerError
+        $stderr.puts "The requested handler, #{options[:handler]}, is not available."
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,273 @@
+module Nanoc::CLI
+
+  class CompileCommand < Command # :nodoc:
+
+    def name
+      'compile'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'compile pages and assets of this site'
+    end
+
+    def long_desc
+      'Compile all pages and all assets of the current site. If a path is ' +
+      'given, only the page or asset with the given path will be compiled. ' +
+      'Additionally, only pages and assets that are outdated will be ' +
+      'compiled, unless specified otherwise with the -a option.'
+    end
+
+    def usage
+      "nanoc compile [options] [path]"
+    end
+
+    def option_definitions
+      [
+        # --all
+        {
+          :long => 'all', :short => 'a', :argument => :forbidden,
+          :desc => 'compile all pages and assets, even those that aren\'t outdated'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Find object with given path
+      if arguments.size == 0
+        objs = nil
+      else
+        objs = arguments.map do |path|
+          # Find object
+          path = path.cleaned_path
+          obj = @base.site.pages.find { |page| page.path == path }
+          obj = @base.site.assets.find { |asset| asset.path == path } if obj.nil?
+
+          # Ensure object
+          if obj.nil?
+            $stderr.puts "Unknown page or asset: #{path}"
+            exit 1
+          end
+
+          obj
+        end
+      end
+
+      # Compile site
+      begin
+        # Give feedback
+        puts "Compiling #{objs.nil? ? 'site' : 'objects'}..."
+
+        # Initialize profiling stuff
+        time_before = Time.now
+        @filter_times ||= {}
+        @times_stack  ||= []
+        setup_notifications
+
+        # Compile
+        @base.site.compiler.run(
+          objs,
+          :even_when_not_outdated => options.has_key?(:all)
+        )
+
+        # Find reps
+        page_reps  = @base.site.pages.map { |p| p.reps }.flatten
+        asset_reps = @base.site.assets.map { |a| a.reps }.flatten
+        reps       = page_reps + asset_reps
+
+        # Show skipped reps
+        reps.select { |r| !r.compiled? }.each do |rep|
+          duration = @rep_times[rep.disk_path]
+          Nanoc::CLI::Logger.instance.file(:low, :skip, rep.disk_path, duration)
+        end
+
+        # Give general feedback
+        puts
+        puts "No objects were modified." unless reps.any? { |r| r.modified? }
+        puts "#{objs.nil? ? 'Site' : 'Object'} 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
+      rescue Exception => e
+        print_error(e)
+      end
+    end
+
+  private
+
+    def setup_notifications
+      Nanoc::NotificationCenter.on(:compilation_started) do |rep|
+        rep_compilation_started(rep)
+      end
+      Nanoc::NotificationCenter.on(:compilation_ended) do |rep|
+        rep_compilation_ended(rep)
+      end
+      Nanoc::NotificationCenter.on(:filtering_started) do |rep, filter_name|
+        rep_filtering_started(rep, filter_name)
+      end
+      Nanoc::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? }
+      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  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 objects 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)
+      # Get rep
+      rep = @base.site.compiler.stack.select { |i| i.is_a?(Nanoc::PageRep) || i.is_a?(Nanoc::AssetRep) }[-1]
+      rep_name = rep.nil? ? 'the site' : "#{rep.is_a?(Nanoc::PageRep) ? rep.page.path : rep.asset.path} (rep #{rep.name})"
+
+      # Build message
+      case error
+      when Nanoc::Errors::UnknownLayoutError
+        message = "Unknown layout: #{error.message}"
+      when Nanoc::Errors::UnknownFilterError
+        message = "Unknown filter: #{error.message}"
+      when Nanoc::Errors::CannotDetermineFilterError
+        message = "Cannot determine filter for layout: #{error.message}"
+      when Nanoc::Errors::RecursiveCompilationError
+        message = "Recursive call to page content."
+      when Nanoc::Errors::NoLongerSupportedError
+        message = "No longer supported: #{error.message}"
+      else
+        message = "Error: #{error.message}"
+      end
+
+      # Print message
+      $stderr.puts
+      $stderr.puts "ERROR: An exception occured while compiling #{rep_name}."
+      $stderr.puts
+      $stderr.puts "If you think this is a bug in nanoc, please do report it at " +
+                   "<http://nanoc.stoneship.org/trac/newticket> -- thanks!"
+      $stderr.puts
+      $stderr.puts 'Message:'
+      $stderr.puts '  ' + message
+      $stderr.puts
+      $stderr.puts 'Compilation stack:'
+      @base.site.compiler.stack.reverse.each do |item|
+        if item.is_a?(Nanoc::PageRep) # page rep
+          $stderr.puts "  - [page]   #{item.page.path} (rep #{item.name})"
+        elsif item.is_a?(Nanoc::AssetRep) # asset rep
+          $stderr.puts "  - [asset]  #{item.asset.path} (rep #{item.name})"
+        else # layout
+          $stderr.puts "  - [layout] #{item.path}"
+        end
+      end
+      $stderr.puts
+      $stderr.puts 'Backtrace:'
+      $stderr.puts error.backtrace.map { |t| '  - ' + t }.join("\n")
+    end
+
+    def rep_compilation_started(rep)
+      # Profile compilation
+      @rep_times ||= {}
+      @rep_times[rep.disk_path] = Time.now
+    end
+
+    def rep_compilation_ended(rep)
+      # Profile compilation
+      @rep_times ||= {}
+      @rep_times[rep.disk_path] = Time.now - @rep_times[rep.disk_path]
+
+      # Skip if not outputted
+      return if rep.attribute_named(:skip_output)
+
+      # 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.disk_path]
+        Nanoc::CLI::Logger.instance.file(level, action, rep.disk_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/nanoc/cli/commands/create_layout.rb

@@ -0,0 +1,85 @@
+module Nanoc::CLI
+
+  class CreateLayoutCommand < Command # :nodoc:
+
+    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.'
+    end
+
+    def usage
+      "nanoc create_layout [path]"
+    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
+      path = arguments[0].cleaned_path
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Check whether layout is unique
+      if !@base.site.layouts.find { |l| l.path == path }.nil?
+        $stderr.puts "A layout already exists at #{path}. Please pick a unique name " +
+                     "for the layout you are creating."
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create layout
+      layout = Nanoc::Layout.new(
+        "<html>\n" +
+        "  <head>\n" +
+        "    <title><%= @page.title %></title>\n" +
+        "  </head>\n" +
+        "  <body>\n" +
+        "    <p>Hi, I'm a new layout. Please customize me!</p>\n" +
+        "<%= @page.content %>\n" +
+        "  </body>\n" +
+        "</html>\n",
+        { :filter => 'erb' },
+        path
+      )
+      layout.site = @base.site
+      layout.save
+
+      puts "A layout has been created at #{path}."
+    end
+
+  end
+
+end

data/lib/nanoc/cli/commands/create_page.rb

@@ -0,0 +1,85 @@
+module Nanoc::CLI
+
+  class CreatePageCommand < Command # :nodoc:
+
+    def name
+      'create_page'
+    end
+
+    def aliases
+      [ 'cp' ]
+    end
+
+    def short_desc
+      'create a page'
+    end
+
+    def long_desc
+      'Create a new page in the current site. The template that will be ' +
+      'used for generating the page will be \'default\', unless otherwise ' +
+      'specified.'
+    end
+
+    def usage
+      "nanoc create_page [options] [path]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        },
+        # --template
+        {
+          :long => 'template', :short => 't', :argument => :required,
+          :desc => 'specify the template for the new page'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.length != 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Extract arguments and options
+      path          = arguments[0].cleaned_path
+      template_name = options[:template] || 'default'
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Find template
+      template = @base.site.templates.find { |t| t.name == template_name }
+      if template.nil?
+        $stderr.puts "A template named '#{template_name}' was not found; aborting."
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create page
+      page = Nanoc::Page.new(
+        template.page_content,
+        template.page_attributes,
+        path
+      )
+      page.site = @base.site
+      page.save
+
+      puts "A page has been created at #{path}."
+    end
+
+  end
+
+end