nanoc 3.3.7 → 3.4.0

data/lib/nanoc/cli/commands/show-rules.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+usage       'show-rules [thing]'
+aliases     :explain
+summary     'describe the rules for each item'
+description <<-EOS
+Prints the rules used for all items and layouts in the current site. An argument can be given, which can be either an item identifier (e.g. /foo/), the path to the source file (e.g. content/foo.html) or the path to the output file (e.g. output/foo.html).
+EOS
+
+module Nanoc::CLI::Commands
+
+  class ShowRules < ::Nanoc::CLI::CommandRunner
+
+    def run
+      self.require_site
+
+      @c    = Nanoc::CLI::ANSIStringColorizer
+      @calc = self.site.compiler.rule_memory_calculator
+
+      # TODO explain /foo/
+      # TODO explain content/foo.html
+      # TODO explain output/foo/index.html
+
+      self.site.items.each   { |i| self.explain_item(i)   }
+      self.site.layouts.each { |l| self.explain_layout(l) }
+    end
+
+  protected
+
+    def explain_item(item)
+      puts "#{@c.c('Item ' + item.identifier, :bold, :yellow)}:"
+      puts "  (from #{item[:filename]})" if item[:filename]
+      item.reps.each do |rep|
+        puts "  Rep #{rep.name}:"
+        if @calc[rep].empty? && rep.raw_path.nil?
+          puts "    (nothing)"
+        else
+          @calc[rep].each do |mem|
+            puts '    %s %s' % [
+              @c.c(format('%-10s', mem[0].to_s), :blue),
+              mem[1..-1].map { |m| m.inspect }.join(', ')
+            ]
+          end
+          if rep.raw_path
+            puts '    %s %s' % [
+              @c.c(format('%-10s', 'write to'), :blue),
+              rep.raw_path
+            ]
+          end
+        end
+      end
+      puts
+    end
+
+    def explain_layout(layout)
+      puts "#{@c.c('Layout ' + layout.identifier, :bold, :yellow)}:"
+      puts "  (from #{layout[:filename]})" if layout[:filename]
+      puts "  %s %s" % [
+        @c.c(format('%-10s', 'filter'), :blue),
+        @calc[layout].map { |m| m.inspect }.join(', ')
+      ]
+      puts
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::ShowRules

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

@@ -22,8 +22,7 @@ module Nanoc::CLI::Commands
     def run
       # Check arguments
       if arguments.size != 0
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Make sure we are in a nanoc site directory

data/lib/nanoc/cli/commands/validate-css.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+usage       'validate-css [options]'
+aliases     :validate_css, :vcss
+summary     'validate the site’s CSS'
+description <<-EOS
+Validates the site’s CSS files.
+EOS
+
+module Nanoc::CLI::Commands
+
+  class ValidateCSS < ::Nanoc::CLI::CommandRunner
+
+    def run
+      require_site
+      validator = ::Nanoc::Extra::Validators::W3C.new(site.config[:output_dir], [ :css ])
+      validator.run
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::ValidateCSS

data/lib/nanoc/cli/commands/validate-html.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+usage       'validate-html [options]'
+aliases     :validate_html, :vhtml
+summary     'validate the site’s HTML'
+description <<-EOS
+Validates the site’s HTML files.
+EOS
+
+module Nanoc::CLI::Commands
+
+  class ValidateHTML < ::Nanoc::CLI::CommandRunner
+
+    def run
+      require_site
+      validator = ::Nanoc::Extra::Validators::W3C.new(site.config[:output_dir], [ :html ])
+      validator.run
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::ValidateHTML

data/lib/nanoc/cli/commands/validate-links.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+usage       'validate-links [options]'
+aliases     :validate_links, :vlink
+summary     'validate links in site'
+description <<-EOS
+Validates the site’s links. By default, both internal and external links will be checked.
+EOS
+
+flag   :i, :internal, 'validate internal links only'
+flag   :e, :external, 'validate external links only'
+
+module Nanoc::CLI::Commands
+
+  class ValidateLinks < ::Nanoc::CLI::CommandRunner
+
+    def run
+      require_site
+
+      dir             = site.config[:output_dir]
+      index_filenames = site.config[:index_filenames]
+
+      validator = ::Nanoc::Extra::Validators::Links.new(
+        dir,
+        index_filenames,
+        :internal => (options[:external] ? false : true),
+        :external => (options[:internal] ? false : true))
+      validator.run
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::ValidateLinks

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

@@ -30,9 +30,9 @@ module Nanoc::CLI::Commands
 
         # Notify
         if filename
-          print "Change detected to #{filename}; recompiling… ".make_compatible_with_env
+          print "Change detected to #{filename}; recompiling… "
         else
-          print "Watcher started; compiling the entire site… ".make_compatible_with_env
+          print "Watcher started; compiling the entire site… "
         end
 
         # Recompile
@@ -71,7 +71,7 @@ module Nanoc::CLI::Commands
       files_to_watch.delete_if { |f| !File.file?(f) }
 
       # Watch
-      puts "Watching for changes…".make_compatible_with_env
+      puts "Watching for changes…"
       watcher = lambda do |*args|
         update(&rebuilder)
         delete(&rebuilder)

data/lib/nanoc/cli/error_handler.rb

@@ -61,6 +61,9 @@ module Nanoc::CLI
 
       # Run
       yield
+    rescue Nanoc::Errors::GenericTrivial => e
+      $stderr.puts "Error: #{e.message}"
+      exit(1)
     rescue Interrupt => e
       exit(1)
     rescue StandardError, ScriptError => e
@@ -85,50 +88,149 @@ module Nanoc::CLI
     #
     # @return [void]
     def print_error(error)
+      write_compact_error(error, $stderr)
+      File.open('crash.log', 'w') { |io| write_verbose_error(error, io) }
+    end
+
+    # Writes a compact representation of the error, suitable for a terminal, on
+    # the given stream (probably stderr).
+    #
+    # @param [Error] error The error that should be described
+    #
+    # @param [IO] stream The stream to write the description too
+    #
+    # @api private
+    #
+    # @return [void]
+    def write_compact_error(error, stream)
       # Header
-      $stderr.puts
-      $stderr.puts "Captain! We’ve been hit!".make_compatible_with_env
+      stream.puts
+      stream.puts "Captain! We’ve been hit!"
 
       # Exception and resolution (if any)
-      $stderr.puts
-      $stderr.puts '=== MESSAGE:'
-      $stderr.puts
-      $stderr.puts "#{error.class}: #{error.message}"
+      stream.puts
+      stream.puts format_title('Message:')
+      stream.puts
+      stream.puts "#{error.class}: #{error.message}"
       resolution = self.resolution_for(error)
-      $stderr.puts "#{resolution}" if resolution
+      stream.puts "#{resolution}" if resolution
 
       # Compilation stack
-      $stderr.puts
-      $stderr.puts '=== COMPILATION STACK:'
-      $stderr.puts
+      stream.puts
+      stream.puts format_title('Compilation stack:')
+      stream.puts
       if self.stack.empty?
-        $stderr.puts "  (empty)"
+        stream.puts "  (empty)"
       else
         self.stack.reverse.each do |obj|
           if obj.is_a?(Nanoc::ItemRep)
-            $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
+            stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
           else # layout
-            $stderr.puts "  - [layout] #{obj.identifier}"
+            stream.puts "  - [layout] #{obj.identifier}"
           end
         end
       end
 
       # Backtrace
-      $stderr.puts
-      $stderr.puts '=== BACKTRACE:'
-      $stderr.puts
-      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
-
-      # Extra information
-      $stderr.puts
-      $stderr.puts '=== VERSION INFORMATION:'
-      $stderr.puts
-      $stderr.puts Nanoc.version_information
+      stream.puts
+      stream.puts format_title('Stack trace:')
+      stream.puts
+      count = 10
+      error.backtrace[0...count].each_with_index do |item, index|
+        stream.puts "  #{index}. #{item}"
+      end
+      if error.backtrace.size > count
+        puts "  ... #{error.backtrace.size - count} more lines omitted. See full crash log for details."
+      end
 
       # Issue link
-      $stderr.puts
-      $stderr.puts "If you believe this is a bug in nanoc, please do report it at"
-      $stderr.puts "<https://github.com/ddfreyne/nanoc/issues/new>--thanks!"
+      stream.puts
+      stream.puts "If you believe this is a bug in nanoc, please do report it at"
+      stream.puts "-> https://github.com/ddfreyne/nanoc/issues/new <-"
+      stream.puts
+      stream.puts "A detailed crash log has been written to ./crash.log."
+    end
+
+    # Writes a verbose representation of the error on the given stream.
+    #
+    # @param [Error] error The error that should be described
+    #
+    # @param [IO] stream The stream to write the description too
+    #
+    # @api private
+    #
+    # @return [void]
+    def write_verbose_error(error, stream)
+      # Date and time
+      stream.puts "Crashlog created at #{Time.now}"
+      stream.puts
+
+      # Exception and resolution (if any)
+      stream.puts '=== MESSAGE:'
+      stream.puts
+      stream.puts "#{error.class}: #{error.message}"
+      resolution = self.resolution_for(error)
+      stream.puts "#{resolution}" if resolution
+      stream.puts
+
+      # Compilation stack
+      stream.puts '=== COMPILATION STACK:'
+      stream.puts
+      if self.stack.empty?
+        stream.puts "  (empty)"
+      else
+        self.stack.reverse.each do |obj|
+          if obj.is_a?(Nanoc::ItemRep)
+            stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
+          else # layout
+            stream.puts "  - [layout] #{obj.identifier}"
+          end
+        end
+      end
+      stream.puts
+
+      # Backtrace
+      stream.puts '=== BACKTRACE:'
+      stream.puts
+      stream.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
+      stream.puts
+
+      # Version information
+      stream.puts '=== VERSION INFORMATION:'
+      stream.puts
+      stream.puts Nanoc.version_information
+      stream.puts
+
+      # Installed gems
+      stream.puts '=== INSTALLED GEMS:'
+      stream.puts
+      self.gems_and_versions.each do |g|
+        stream.puts "  #{g.first} #{g.last.join(', ')}"
+      end
+      stream.puts
+
+      # Environment
+      stream.puts '=== ENVIRONMENT:'
+      stream.puts
+      ENV.sort.each do |e|
+        stream.puts "#{e.first} => #{e.last.inspect}"
+      end
+      stream.puts
+
+      # Gemfile
+      if File.exist?('Gemfile.lock')
+        stream.puts '=== GEMFILE.LOCK:'
+        stream.puts
+        stream.puts File.read('Gemfile.lock')
+        stream.puts
+      end
+
+      # Load paths
+      stream.puts '=== $LOAD_PATH:'
+      stream.puts
+      $LOAD_PATH.each_with_index do |i, index|
+        stream.puts "  #{index}. #{i}"
+      end
     end
 
   protected
@@ -155,6 +257,15 @@ module Nanoc::CLI
       (compiler && compiler.stack) || []
     end
 
+    def gems_and_versions
+      gems = {}
+      Gem::Specification.find_all.sort_by { |s| [ s.name, s.version ] }.each do |spec|
+        gems[spec.name] ||= []
+        gems[spec.name] << spec.version.to_s
+      end
+      gems
+    end
+
     # 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 = {
@@ -168,6 +279,7 @@ module Nanoc::CLI
       'fog'            => 'fog',
       'fssm'           => 'fssm',
       'haml'           => 'haml',
+      'handlebars'     => 'hbs',
       'json'           => 'json',
       'kramdown'       => 'kramdown',
       'less'           => 'less',
@@ -216,6 +328,10 @@ module Nanoc::CLI
       end
     end
 
+    def format_title(s)
+      "\e[1m\e[31m" + s + "\e[0m"
+    end
+
   end
 
 end

data/lib/nanoc/cli/logger.rb

@@ -27,27 +27,10 @@ module Nanoc::CLI
     # @return [Symbol] The log level
     attr_accessor :level
 
-    # @return [Boolean] True if color should be used, false otherwise
-    attr_writer :color
-
     def initialize
       @level = :high
     end
 
-    # @return [Boolean] true if colors are enabled, false otherwise
-    def color?
-      if @color.nil?
-        @color = true
-        begin
-          require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /mswin|mingw/
-        rescue LoadError
-          @color = false
-        end
-      end
-
-      @color
-    end
-
     # Logs a file-related action.
     #
     # @param [:high, :low] level The importance of this action
@@ -57,15 +40,15 @@ module Nanoc::CLI
     # @param [String] name The name of the file the action was performed on
     #
     # @return [void]
-    def file(level, action, identifier, duration=nil)
+    def file(level, action, name, duration=nil)
       log(
         level,
         '%s%12s%s  %s%s' % [
-          color? ? ACTION_COLORS[action.to_sym] : '',
+          ACTION_COLORS[action.to_sym],
           action,
-          color? ? "\e[0m" : '',
+          "\e[0m",
           duration.nil? ? '' : "[%2.2fs]  " % [ duration ],
-          identifier
+          name
         ]
       )
     end