nanoc3 3.1.9 → 3.2.0a1

data/lib/nanoc3/cli/base.rb

@@ -4,9 +4,39 @@ module Nanoc3::CLI
 
   class Base < Cri::Base
 
+    # 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.
+    GEM_NAMES = {
+      'adsf'           => 'adsf',
+      'bluecloth'      => 'bluecloth',
+      'builder'        => 'builder',
+      'coderay'        => 'coderay',
+      'cri'            => 'cri',
+      'erubis'         => 'erubis',
+      'fssm'           => 'fssm',
+      'haml'           => 'haml',
+      'json'           => 'json',
+      'kramdown'       => 'kramdown',
+      'less'           => 'less',
+      'markaby'        => 'markaby',
+      'maruku'         => 'maruku',
+      'mime/types'     => 'mime-types',
+      'nokogiri'       => 'nokogiri',
+      'rack'           => 'rack',
+      'rack/cache'     => 'rack-cache',
+      'rainpress'      => 'rainpress',
+      'rdiscount'      => 'rdiscount',
+      'redcloth'       => 'redcloth',
+      'rubypants'      => 'rubypants',
+      'sass'           => 'sass',
+      '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)
@@ -21,22 +51,20 @@ module Nanoc3::CLI
       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
 
-    # 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]
+    # @return [Boolean] true if debug output is enabled, false if not
+    def debug?
+      @debug
+    end
+
+    # Helper function which can be called when a command is executed that
+    # requires a site, such as the compile command.
     def require_site
       if site.nil?
         $stderr.puts 'The current working directory does not seem to be a ' +
@@ -45,10 +73,7 @@ module Nanoc3::CLI
       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
+    # Gets the site (Nanoc3::Site) in the current directory and loads its data.
     def site
       # Load site if possible
       if File.file?('config.yaml') && (!self.instance_variable_defined?(:@site) || @site.nil?)
@@ -63,16 +88,8 @@ module Nanoc3::CLI
       @site
     end
 
-    # @see ::Cri::Base#run
+    # Inherited from ::Cri::Base
     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)
@@ -81,12 +98,8 @@ module Nanoc3::CLI
       exit(1)
     end
 
-    # Prints the given error to stderr. Includes message, possible resolution
-    # (see {#resolution_for}), compilation stack, backtrace, etc.
-    #
-    # @param [Error] error The error that should be described
-    #
-    # @return [void]
+    # Prints the given error to stderr. Includes message, possible resolution,
+    # compilation stack, backtrace, etc.
     def print_error(error)
       $stderr.puts
 
@@ -130,44 +143,14 @@ module Nanoc3::CLI
       $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
     end
 
-    # Attempts to find a resolution for the given error, or nil if no
-    # resolution can be automatically obtained.
-    #
-    # @param [Error] error The error to find a resolution for
-    #
-    # @return [String] The resolution for the given error
+    # Returns a string containing hints for resolving the given error, or nil
+    # if no resolution can be automatically obtained.
     def resolution_for(error)
-      # FIXME this should probably go somewhere else so that 3rd-party code can add other gem names too
-      gem_names = {
-        'adsf'           => 'adsf',
-        'bluecloth'      => 'bluecloth',
-        'builder'        => 'builder',
-        'coderay'        => 'coderay',
-        'cri'            => 'cri',
-        'erubis'         => 'erubis',
-        'haml'           => 'haml',
-        'json'           => 'json',
-        'less'           => 'less',
-        'markaby'        => 'markaby',
-        'maruku'         => 'maruku',
-        'mime/types'     => 'mime-types',
-        'rack'           => 'rack',
-        'rack/cache'     => 'rack-cache',
-        'rainpress'      => 'rainpress',
-        'rdiscount'      => 'rdiscount',
-        'redcloth'       => 'redcloth',
-        'rubypants'      => 'rubypants',
-        'sass'           => 'sass',
-        'w3c_validators' => 'w3c_validators'
-      }
-
       case error
       when LoadError
         # Get gem name
-        matches = error.message.match(/no such file to load -- ([^\s]+)/)
-        return nil if matches.empty?
-        lib_name = matches[1]
-        gem_name = gem_names[$1]
+        lib_name = error.message.match(/no such file to load -- ([^\s]+)/)[1]
+        gem_name = GEM_NAMES[$1]
 
         # Build message
         if gem_name
@@ -179,10 +162,6 @@ module Nanoc3::CLI
     # 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=).
-    #
-    # @param [String] vcs_name The name of the VCS that should be used
-    #
-    # @return [void]
     def set_vcs(vcs_name)
       # Skip if not possible
       return if vcs_name.nil? || site.nil?
@@ -203,7 +182,7 @@ module Nanoc3::CLI
       end
     end
 
-    # @return [Array] The list of global option definitions
+    # Returns the list of global option definitionss.
     def global_option_definitions
       [
         {
@@ -224,7 +203,7 @@ module Nanoc3::CLI
         },
         {
           :long => 'debug', :short => 'd', :argument => :forbidden,
-          :desc => 'enable debugging (set $DEBUG to true)'
+          :desc => 'enable debugging'
         },
         {
           :long => 'warn', :short => 'w', :argument => :forbidden,
@@ -233,20 +212,18 @@ module Nanoc3::CLI
       ]
     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}"
+        puts "nanoc #{Nanoc3::VERSION} (c) 2007-2010 Denis Defreyne."
+        puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM} #{gem_info}"
         exit 0
       when :verbose
         Nanoc3::CLI::Logger.instance.level = :low
       when :debug
-        $DEBUG = true
+        @debug = true
       when :warn
         $-w = true
       when :'no-color'

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

@@ -49,6 +49,9 @@ module Nanoc3::CLI::Commands
     def run(options, arguments)
       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
 

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

@@ -76,8 +76,8 @@ module Nanoc3::CLI::Commands
 
       # Initialize profiling stuff
       time_before = Time.now
-      @filter_times ||= {}
-      @times_stack  ||= []
+      @rep_times     = {}
+      @filter_times  = {}
       setup_notifications
 
       # Compile
@@ -91,9 +91,11 @@ module Nanoc3::CLI::Commands
 
       # 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(:high, :skip, rep.raw_path, duration)
+        rep.raw_paths.each do |snapshot_name, filename|
+          next if filename.nil?
+          duration = @rep_times[filename]
+          Nanoc3::CLI::Logger.instance.file(:high, :skip, filename, duration)
+        end
       end
 
       # Show diff
@@ -101,11 +103,10 @@ module Nanoc3::CLI::Commands
 
       # 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."
 
+      # Give detailed feedback
       if options.has_key?(:verbose)
-        print_state_feedback(reps)
         print_profiling_feedback(reps)
       end
     end
@@ -113,17 +114,39 @@ module Nanoc3::CLI::Commands
   private
 
     def setup_notifications
+      # File notifications
+      Nanoc3::NotificationCenter.on(:rep_written) do |rep, path, is_created, is_modified|
+        action = (is_created ? :create : (is_modified ? :update : :identical))
+        duration = Time.now - @rep_times[rep.raw_path] if @rep_times[rep.raw_path]
+        Nanoc3::CLI::Logger.instance.file(:high, action, path, duration)
+      end
+
+      # Debug notifications
       Nanoc3::NotificationCenter.on(:compilation_started) do |rep|
-        rep_compilation_started(rep)
+        puts "*** Started compilation of #{rep.inspect}" if @base.debug?
       end
       Nanoc3::NotificationCenter.on(:compilation_ended) do |rep|
-        rep_compilation_ended(rep)
+        puts "*** Ended compilation of #{rep.inspect}" if @base.debug?
+      end
+      Nanoc3::NotificationCenter.on(:compilation_failed) do |rep|
+        puts "*** Suspended compilation of #{rep.inspect} due to unmet dependencies" if @base.debug?
+      end
+      Nanoc3::NotificationCenter.on(:cached_content_used) do |rep|
+        puts "*** Used cached compiled content for #{rep.inspect} instead of recompiling" if @base.debug?
+      end
+
+      # Timing notifications
+      Nanoc3::NotificationCenter.on(:compilation_started) do |rep|
+        @rep_times[rep.raw_path] = Time.now
+      end
+      Nanoc3::NotificationCenter.on(:compilation_ended) do |rep|
+        @rep_times[rep.raw_path] = Time.now - @rep_times[rep.raw_path]
       end
       Nanoc3::NotificationCenter.on(:filtering_started) do |rep, filter_name|
-        rep_filtering_started(rep, filter_name)
+        @filter_times[filter_name] = Time.now
       end
       Nanoc3::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
-        rep_filtering_ended(rep, filter_name)
+        @filter_times[filter_name] = Time.now - @filter_times[filter_name]
       end
     end
 
@@ -141,6 +164,7 @@ module Nanoc3::CLI::Commands
         next if diff.nil?
 
         # Fix header
+        # FIXME this may break for other lines starting with --- or +++
         diff.sub!(/^--- .*/,    '--- ' + rep.raw_path)
         diff.sub!(/^\+\+\+ .*/, '+++ ' + rep.raw_path)
 
@@ -152,24 +176,6 @@ module Nanoc3::CLI::Commands
       File.open('output.diff', 'w') { |io| io.write(full_diff) }
     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
@@ -211,51 +217,6 @@ module Nanoc3::CLI::Commands
       end
     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 = if rep.created?
-        :create
-      elsif rep.modified?
-        :update
-      elsif !rep.compiled?
-        nil
-      else
-        :identical
-      end
-
-      # Log
-      unless action.nil?
-        duration = @rep_times[rep.raw_path]
-        Nanoc3::CLI::Logger.instance.file(:high, 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_site.rb

@@ -57,6 +57,20 @@ data_sources:
     # The path where layouts should be mounted. The layouts root behaves the
     # same as the items root, but applies to layouts rather than items.
     layouts_root: #{Nanoc3::Site::DEFAULT_DATA_SOURCE_CONFIG[:layouts_root]}
+
+# Configuration for the “watch” command, which watches a site for changes and
+# recompiles if necessary.
+watcher:
+  # A list of directories to watch for changes. When editing this, make sure
+  # that the “output/” and “tmp/” directories are _not_ included in this list,
+  # because recompiling the site will cause these directories to change, which
+  # will cause the site to be recompiled, which will cause these directories
+  # to change, which will cause the site to be recompiled again, and so on.
+  dirs_to_watch: [ 'content', 'layouts', 'lib' ]
+
+  # A list of single files to watch for changes. As mentioned above, don’t put
+  # any files from the “output/” or “tmp/” directories in here.
+  files_to_watch: [ 'config.yaml', 'Rules' ]
 EOS
 
     DEFAULT_RULES = <<EOS
@@ -156,20 +170,18 @@ a:hover {
   line-height: 20px;
 }
 
-#main ul, #main ol {
+#main ul {
   margin: 20px;
 }
 
 #main li {
+  list-style-type: square;
+
   font-size: 15px;
   
   line-height: 20px;
 }
 
-#main ul li {
-  list-style-type: square;
-}
-
 #sidebar {
   position: absolute;
 

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

@@ -43,8 +43,7 @@ module Nanoc3::CLI::Commands
       layouts = @base.site.layouts
 
       # Get dependency tracker
-      # FIXME clean this up
-      dependency_tracker = @base.site.compiler.send(:dependency_tracker)
+      dependency_tracker = @base.site.compiler.dependency_tracker
       dependency_tracker.load_graph
 
       # Print item dependencies
@@ -66,7 +65,13 @@ module Nanoc3::CLI::Commands
       items.sort_by { |i| i.identifier }.each do |item|
         item.reps.sort_by { |r| r.name.to_s }.each do |rep|
           puts "item #{item.identifier}, rep #{rep.name}:"
-          puts "  #{rep.raw_path || '(not written)'}"
+          if rep.raw_paths.empty?
+            puts "  (not written)"
+          end
+          length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
+          rep.raw_paths.each do |snapshot_name, raw_path|
+            puts "  [ %-#{length}s ] %s" % [ snapshot_name, raw_path ]
+          end
         end
         puts
       end
@@ -91,7 +96,9 @@ module Nanoc3::CLI::Commands
       puts '=== Layouts'
       puts
       layouts.each do |layout|
-        puts "layout #{layout.identifier}"
+        puts "layout #{layout.identifier}:"
+        puts "  is #{layout.outdated? ? '' : 'not '}outdated"
+        puts
       end
     end
 

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

@@ -72,7 +72,6 @@ module Nanoc3::CLI::Commands
         use Rack::CommonLogger
         use Rack::ShowExceptions
         use Rack::Lint
-        use Rack::Head
         use Adsf::Rack::IndexFileFinder, :root => site.config[:output_dir]
         run Rack::File.new(site.config[:output_dir])
       end.to_app

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

@@ -0,0 +1,148 @@
+# encoding: utf-8
+
+module Nanoc3::CLI::Commands
+
+  class Watch < Cri::Command
+
+    def name
+      'watch'
+    end
+
+    def aliases
+      [ ]
+    end
+
+    def short_desc
+      'start the watcher'
+    end
+
+    def long_desc
+      'Start the watcher. When a change is detected, the site will be ' \
+      'recompiled.'
+    end
+
+    def usage
+      "nanoc3 watch"
+    end
+
+    def option_definitions
+      []
+    end
+
+    def run(options, arguments)
+      require 'fssm'
+
+      @notifier = Notifier.new
+
+      # Define rebuilder
+      rebuilder = lambda do |base, relative|
+        # Determine filename
+        if base.nil? || relative.nil?
+          filename = nil
+        else
+          filename = ::Pathname.new(File.join([ base, relative ])).relative_path_from(::Pathname.new(Dir.getwd)).to_s
+        end
+
+        # Notify
+        if filename
+          print "Change detected to #{filename}; recompiling… ".make_compatible_with_env
+        else
+          print "Watcher started; compiling the entire site… ".make_compatible_with_env
+        end
+
+        # Recompile
+        start = Time.now
+        site = Nanoc3::Site.new('.')
+        site.load_data
+        begin
+          site.compiler.run
+
+          # TODO include icon (--image misc/success-icon.png)
+          @notifier.notify('Compilation complete')
+
+          puts "done in #{((Time.now - start)*10000).round.to_f / 10}ms"
+        rescue Exception => e
+          # TODO include icon (--image misc/error-icon.png)
+          @notifier.notify('Compilation failed')
+
+          puts
+          @base.print_error(e)
+          puts
+        end
+      end
+
+      # Rebuild once
+      rebuilder.call(nil, nil)
+
+      # Get directories to watch
+      watcher_config = @base.site.config[:watcher] || {}
+      dirs_to_watch  = watcher_config[:dirs_to_watch]  || %w( content layouts lib )
+      files_to_watch = watcher_config[:files_to_watch] || %w( config.yaml Rules )
+
+      # Watch
+      puts "Watching for changes…".make_compatible_with_env
+      watcher = lambda do
+        update(&rebuilder)
+        delete(&rebuilder)
+        create(&rebuilder)
+      end
+      monitor = FSSM::Monitor.new
+      dirs_to_watch.each  { |dir|      monitor.path(dir, '**/*', &watcher) }
+      files_to_watch.each { |filename| monitor.file(filename, &watcher)    }
+      monitor.run
+    end
+
+    # Allows sending user notifications in a cross-platform way.
+    class Notifier
+
+      # A list of commandline tool names that can be used to send notifications
+      TOOLS = %w( growlnotify notify_send )
+
+      # Error that is raised when no notifier can be found.
+      class NoNotifierFound < ::StandardError
+
+        def initialize
+          super("Could not find a notifier that works on this system. I tried to find #{CrossPlatformNotifier::TOOLS.join(', ')} but found nothing.")
+        end
+
+      end
+
+      # Send a notification.
+      #
+      # @param [String] message The message to include in the notification
+      #
+      # @option params [Boolean] :raise (true) true if this method should
+      #   raise an exception if no notifier can be found, false otherwise
+      def notify(message, params={})
+        params[:raise] = true if !params.has_key?(:raise)
+
+        if tool.nil?
+          if params[:raise]
+            raise NoNotifierFound
+          else
+            return
+          end
+        end
+
+        send(tool, message, params)
+      end
+
+    private
+
+      def tool
+        @tool ||= TOOLS.find { |t| !`which #{t}`.empty? }
+      end
+
+      def growlnotify(message, params={})
+        system('growlnotify', '-m', message)
+      end
+
+      def notify_send(message, params={})
+        system('notify_send', messsage)
+      end
+
+    end
+
+  end
+
+end

data/lib/nanoc3/cli/commands.rb

@@ -13,3 +13,4 @@ require 'nanoc3/cli/commands/help'
 require 'nanoc3/cli/commands/info'
 require 'nanoc3/cli/commands/update'
 require 'nanoc3/cli/commands/view'
+require 'nanoc3/cli/commands/watch'