nanoc3 3.2.0a1 → 3.2.0a2

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

@@ -17,17 +17,15 @@ module Nanoc3::CLI::Commands
     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. ' +
+      '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. In ' +
-      'order to compile items even when they are outdated, use the --force option.'
+      'content from other items may have to be recompiled manually.'
     end
 
     def usage
-      "nanoc3 compile [options] [identifier]"
+      "nanoc3 compile [options]"
     end
 
     def option_definitions
@@ -35,12 +33,12 @@ module Nanoc3::CLI::Commands
         # --all
         {
           :long => 'all', :short => 'a', :argument => :forbidden,
-          :desc => 'alias for --force (DEPRECATED)'
+          :desc => '(ignored)'
         },
         # --force
         {
           :long => 'force', :short => 'f', :argument => :forbidden,
-          :desc => 'compile items even when they are not outdated'
+          :desc => '(ignored)'
         }
       ]
     end
@@ -49,30 +47,21 @@ module Nanoc3::CLI::Commands
       # 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
+      if options.has_key?(:all) || options.has_key?(:force)
+        $stderr.puts "Warning: the --force option (and its deprecated --all alias) are, as of nanoc 3.2, no longer supported and have no effect."
+      end
+
+      # Warn if trying to compile a single item
+      if arguments.size == 1
+        $stderr.puts '-' * 80
+        $stderr.puts 'Note: As of nanoc 3.2, it is no longer possible to compile a single item. When invoking the “compile” command, all items in the site will be compiled.'.make_compatible_with_env
+        $stderr.puts '-' * 80
       end
 
       # Give feedback
-      puts "Compiling #{item.nil? ? 'site' : 'item'}..."
+      puts "Compiling site..."
 
       # Initialize profiling stuff
       time_before = Time.now
@@ -80,14 +69,14 @@ module Nanoc3::CLI::Commands
       @filter_times  = {}
       setup_notifications
 
+      # Prepare for generating diffs
+      setup_diffs
+
       # Compile
-      @base.site.compiler.run(
-        item,
-        :force => options.has_key?(:all) || options.has_key?(:force)
-      )
+      @base.site.compile
 
       # Find reps
-      reps = @base.site.items.map  { |i| i.reps }.flatten
+      reps = @base.site.items.map { |i| i.reps }.flatten
 
       # Show skipped reps
       reps.select { |r| !r.compiled? }.each do |rep|
@@ -98,12 +87,12 @@ module Nanoc3::CLI::Commands
         end
       end
 
-      # Show diff
-      write_diff_for(reps)
+      # Stop diffing
+      teardown_diffs
 
       # Give general feedback
       puts
-      puts "#{item.nil? ? 'Site' : 'Item'} compiled in #{format('%.2f', Time.now - time_before)}s."
+      puts "Site compiled in #{format('%.2f', Time.now - time_before)}s."
 
       # Give detailed feedback
       if options.has_key?(:verbose)
@@ -115,6 +104,9 @@ module Nanoc3::CLI::Commands
 
     def setup_notifications
       # File notifications
+      Nanoc3::NotificationCenter.on(:will_write_rep) do |rep, snapshot|
+        generate_diff_for(rep, snapshot)
+      end
       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]
@@ -144,36 +136,112 @@ module Nanoc3::CLI::Commands
       end
       Nanoc3::NotificationCenter.on(:filtering_started) do |rep, 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]
+        stop_filter_progress(rep, filter_name)
       end
     end
 
-    def write_diff_for(reps)
-      # Delete diff
+    def setup_diffs
+      @diff_lock    = Mutex.new
+      @diff_threads = []
       FileUtils.rm('output.diff') if File.file?('output.diff')
+    end
+
+    def teardown_diffs
+      @diff_threads.each { |t| t.join }
+    end
 
-      # Don’t generate diffs when diffs are disabled
+    def generate_diff_for(rep, snapshot)
       return if !@base.site.config[:enable_output_diff]
+      return if !File.file?(rep.raw_path(:snapshot => snapshot))
+      return if rep.binary?
+
+      # Get old and new content
+      old_content = File.read(rep.raw_path(:snapshot => snapshot))
+      new_content = rep.compiled_content(:snapshot => snapshot, :force => true)
 
-      # Generate diff
-      full_diff = ''
-      reps.each do |rep|
-        diff = rep.diff
-        next if diff.nil?
+      # Check whether there’s a different
+      return if old_content == new_content
 
-        # Fix header
-        # FIXME this may break for other lines starting with --- or +++
+      require 'thread'
+      @diff_threads << Thread.new do
+        # Generate diff
+        diff = diff_strings(old_content, new_content)
         diff.sub!(/^--- .*/,    '--- ' + rep.raw_path)
         diff.sub!(/^\+\+\+ .*/, '+++ ' + rep.raw_path)
 
-        # Add
-        full_diff << diff
+        # Write diff
+        @diff_lock.synchronize do
+          File.open('output.diff', 'a') { |io| io.write(diff) }
+        end
+      end
+    end
+
+    # TODO move this elsewhere
+    def diff_strings(a, b)
+      require 'tempfile'
+      require 'open3'
+
+      # Create files
+      Tempfile.open('old') do |old_file|
+        Tempfile.open('new') do |new_file|
+          # Write files
+          old_file.write(a)
+          old_file.flush
+          new_file.write(b)
+          new_file.flush
+
+          # Diff
+          cmd = [ 'diff', '-u', old_file.path, new_file.path ]
+          Open3.popen3(*cmd) do |stdin, stdout, stderr|
+            result = stdout.read
+            return (result == '' ? nil : result)
+          end
+        end
       end
+    rescue Errno::ENOENT
+      warn 'Failed to run `diff`, so no diff with the previously compiled ' \
+           'content will be available.'
+      nil
+    end
+
+    def start_filter_progress(rep, filter_name)
+      # Only show progress on terminals
+      return if !$stdout.tty?
+
+      @progress_thread = Thread.new do
+        delay = 1.0
+        step  = 0
+
+        text = "Running #{filter_name} filter… ".make_compatible_with_env
+
+        while !Thread.current[:stopped]
+          sleep 0.1
+
+          # Wait for a while before showing text
+          delay -= 0.1
+          next if delay > 0.05
+
+          # Print progress
+          $stdout.print text + %w( | / - \\ )[step] + "\r"
+          step = (step + 1) % 4
+        end
+
+        # Clear text
+        if delay < 0.05
+          $stdout.print ' ' * (text.length + 1 + 1) + "\r"
+        end
+      end
+    end
+
+    def stop_filter_progress(rep, filter_name)
+      # Only show progress on terminals
+      return if !$stdout.tty?
 
-      # Write
-      File.open('output.diff', 'w') { |io| io.write(full_diff) }
+      @progress_thread[:stopped] = true
     end
 
     def print_profiling_feedback(reps)

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

@@ -46,7 +46,6 @@ module Nanoc3::CLI::Commands
 
       # 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])

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

@@ -46,7 +46,6 @@ module Nanoc3::CLI::Commands
 
       # 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])

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

@@ -71,6 +71,10 @@ watcher:
   # 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' ]
+
+  # When to send notifications (using Growl or notify-send).
+  notify_on_compilation_success: true
+  notify_on_compilation_failure: true
 EOS
 
     DEFAULT_RULES = <<EOS
@@ -100,7 +104,13 @@ route '/stylesheet/' do
 end
 
 route '*' do
-  item.identifier + 'index.html'
+  if item.binary?
+    # /foo/ -> /foo.ext
+    item.identifier.chop + '.' + item[:extension]
+  else
+    # /foo/ -> /foo/index.html
+    item.identifier + 'index.html'
+  end
 end
 
 layout '*', :erb

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

@@ -33,7 +33,6 @@ module Nanoc3::CLI::Commands
       # Make sure we are in a nanoc site directory
       print "Loading site data... "
       @base.require_site
-      @base.site.load_data
       puts "done"
       puts
 
@@ -43,8 +42,9 @@ module Nanoc3::CLI::Commands
       layouts = @base.site.layouts
 
       # Get dependency tracker
-      dependency_tracker = @base.site.compiler.dependency_tracker
-      dependency_tracker.load_graph
+      compiler = @base.site.compiler
+      compiler.load
+      dependency_tracker = compiler.dependency_tracker
 
       # Print item dependencies
       puts '=== Item dependencies ======================================================='
@@ -82,9 +82,9 @@ 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}:"
-          outdatedness_reason = rep.outdatedness_reason
+          outdatedness_reason = compiler.outdatedness_reason_for(rep)
           if outdatedness_reason
-            puts "  is outdated: #{outdatedness_reason[:type]} (#{outdatedness_reason[:description]})"
+            puts "  is outdated: #{outdatedness_reason.message}"
           else
             puts "  is not outdated"
           end
@@ -97,7 +97,12 @@ module Nanoc3::CLI::Commands
       puts
       layouts.each do |layout|
         puts "layout #{layout.identifier}:"
-        puts "  is #{layout.outdated? ? '' : 'not '}outdated"
+        outdatedness_reason = compiler.outdatedness_reason_for(layout)
+        if outdatedness_reason
+          puts "  is outdated: #{outdatedness_reason.message}"
+        else
+          puts "  is not outdated"
+        end
         puts
       end
     end

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

@@ -39,8 +39,7 @@ module Nanoc3::CLI::Commands
 
       # Get list of plugins (before and after)
       plugins_before = Nanoc3::Plugin.all
-      @base.site
-      @base.site.load_data if @base.site
+      @base.site.code_snippets if @base.site
       plugins_after  = Nanoc3::Plugin.all
 
       # Divide list of plugins into builtin and custom

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

@@ -55,7 +55,6 @@ module Nanoc3::CLI::Commands
 
       # 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])

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

@@ -32,6 +32,11 @@ module Nanoc3::CLI::Commands
     def run(options, arguments)
       require 'fssm'
 
+      Signal.trap("INT") do
+        puts
+        exit
+      end
+
       @notifier = Notifier.new
 
       # Define rebuilder
@@ -53,17 +58,27 @@ module Nanoc3::CLI::Commands
         # Recompile
         start = Time.now
         site = Nanoc3::Site.new('.')
-        site.load_data
         begin
-          site.compiler.run
+          site.compile
 
           # TODO include icon (--image misc/success-icon.png)
-          @notifier.notify('Compilation complete')
+          notify_on_compilation_success = site.config.has_key?(:notify_on_compilation_success) ?
+            site.config[:notify_on_compilation_success] :
+            true
+          if notify_on_compilation_success
+            @notifier.notify('Compilation complete')
+          end
 
-          puts "done in #{((Time.now - start)*10000).round.to_f / 10}ms"
+          time_spent = ((Time.now - start)*1000.0).round
+          puts "done in #{format '%is %ims', *(time_spent.divmod(1000))}"
         rescue Exception => e
           # TODO include icon (--image misc/error-icon.png)
-          @notifier.notify('Compilation failed')
+          notify_on_compilation_failure = site.config.has_key?(:notify_on_compilation_failure) ?
+            site.config[:notify_on_compilation_failure] :
+            true
+          if notify_on_compilation_failure
+            @notifier.notify('Compilation failed')
+          end
 
           puts
           @base.print_error(e)
@@ -96,35 +111,15 @@ module Nanoc3::CLI::Commands
     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
+      TOOLS = %w( growlnotify notify-send )
 
-      end
-
-      # Send a notification.
+      # Send a notification. If no notifier is found, no notification will be
+      # created.
       #
       # @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)
+      def notify(message)
+        return if tool.nil?
+        send(tool.tr('-', '_'), message, params)
       end
 
     private
@@ -138,7 +133,7 @@ module Nanoc3::CLI::Commands
       end
 
       def notify_send(message, params={})
-        system('notify_send', messsage)
+        system('notify-send', message)
       end
 
     end

data/lib/nanoc3/cli/logger.rb

@@ -28,13 +28,13 @@ module Nanoc3::CLI
 
     def initialize
       @level = :high
-      @color = true
+      @color = $stdout.tty?
 
       # Try enabling color support on Windows
       begin
         require 'Win32/Console/ANSI' if RUBY_PLATFORM =~/mswin|mingw/
       rescue LoadError
-        warn 'The win32console gem is not available. Install it to enable color support on Windows.'
+        @color = false
       end
     end
 

data/lib/nanoc3/data_sources/filesystem.rb

@@ -123,15 +123,10 @@ module Nanoc3::DataSources
           raise RuntimeError, "meta_mtime and content_mtime are both nil"
         end
 
-        # Get checksum
-        meta_checksum    = meta_filename    ? Nanoc3::Checksummer.checksum_for(meta_filename)    : nil
-        content_checksum = content_filename ? Nanoc3::Checksummer.checksum_for(content_filename) : nil
-        checksum = [ meta_checksum, content_checksum ].compact.join('-')
-
         # Create layout object
         klass.new(
           content_or_filename, attributes, identifier,
-          :binary => is_binary, :mtime => mtime, :checksum => checksum
+          :binary => is_binary, :mtime => mtime
         )
       end
     end

data/lib/nanoc3/extra/auto_compiler.rb

@@ -43,8 +43,8 @@ module Nanoc3::Extra
             r.raw_path == site.config[:output_dir] + path
         end
 
-        # Recompile rep
-        site.compiler.run(rep.item) if rep
+        # Recompile
+        site.compile if rep
 
         # Get paths by appending index filenames
         if path =~ /\/$/
@@ -82,7 +82,6 @@ module Nanoc3::Extra
 
     def build_site
       @site = Nanoc3::Site.new(@site_path)
-      @site.load_data
     end
 
     def mime_type_of(path, fallback)

data/lib/nanoc3/extra/deployers/rsync.rb

@@ -106,6 +106,7 @@ module Nanoc3::Extra::Deployers
     # Runs the given shell command. This is a simple wrapper around Kernel#system.
     def run_shell_cmd(args)
       system(*args)
+      raise "command exited with a nonzero status code #{$?.exitstatus} (command: #{args.join(' ')})" if !$?.success?
     end
 
   end

data/lib/nanoc3/extra/validators/links.rb

@@ -48,6 +48,36 @@ module Nanoc3::Extra::Validators
 
   private
 
+    # Enumerates all key-value pairs of a given hash in a thread-safe way.
+    #
+    # This class is a helper class, which means that it is not used directly
+    # by nanoc. Future versions of nanoc may no longer contain this class. Do
+    # not depend on this class to be available.
+    class ThreadsafeHashEnumerator
+
+      # Creates a new enumerator for the given hash.
+      #
+      # @param [Hash] hash The hash for which the enumerator should return
+      #   key-value pairs
+      def initialize(hash)
+        @hash             = hash
+        @unprocessed_keys = @hash.keys.dup
+        @mutex            = Mutex.new
+      end
+
+      # Returns the next key-value pair in the hash.
+      #
+      # @return [Array] An array containing the key and the corresponding
+      #   value of teh next key-value pair
+      def next_pair
+        @mutex.synchronize do
+          key = @unprocessed_keys.shift
+          return (key ? [ key, @hash[key] ] : nil)
+        end
+      end
+
+    end
+
     def all_broken_hrefs
       broken_hrefs = {}
 
@@ -127,17 +157,23 @@ module Nanoc3::Extra::Validators
       require 'uri'
 
       # Parse
-      uri = URI.parse(href)
+      uri = nil
+      begin
+        uri = URI.parse(href)
+      rescue URI::InvalidURIError
+        @delegate && @delegate.send(:external_href_validated, href, false)
+        return false
+      end
 
       # Skip non-HTTP URLs
       return true if uri.scheme != 'http'
 
       # Get status
       status = fetch_http_status_for(uri)
-      is_valid = (status && status >= 200 && status <= 299)
+      is_valid = !!(status && status >= 200 && status <= 299)
 
       # Notify
-      @delegate.send(:external_href_validated, href, is_valid)
+      @delegate && @delegate.send(:external_href_validated, href, is_valid)
 
       # Done
       is_valid
@@ -153,30 +189,10 @@ module Nanoc3::Extra::Validators
       end
     end
 
-    # This class is a helper class, which means that it is not used directly
-    # by nanoc. Future versions of nanoc may no longer contain this class. Do
-    # not depend on this class to be available.
-    class EachPairEnumerator
-
-      def initialize(hash)
-        @hash             = hash
-        @unprocessed_keys = @hash.keys.dup
-        @mutex            = Mutex.new
-      end
-
-      def next_pair
-        @mutex.synchronize do
-          key = @unprocessed_keys.shift
-          return (key ? [ key, @hash[key] ] : nil)
-        end
-      end
-
-    end
-
     def validate_external_hrefs(hrefs, broken_hrefs)
       @mutex = Mutex.new
 
-      enum = EachPairEnumerator.new(hrefs)
+      enum = ThreadsafeHashEnumerator.new(hrefs)
 
       threads = []
       10.times do
@@ -202,7 +218,10 @@ module Nanoc3::Extra::Validators
     def fetch_http_status_for(url, params={})
       5.times do |i|
         begin
-          res = request_url_once(url)
+          res = nil
+          Timeout::timeout(10) do
+            res = request_url_once(url)
+          end
 
           if res.code =~ /^3..$/
             url = URI.parse(res['location'])
@@ -211,7 +230,7 @@ module Nanoc3::Extra::Validators
             return res.code.to_i
           end
         rescue
-          nil
+          return nil
         end
       end
     end