nanoc 3.3.7 → 3.4.0

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    nanoc (3.4.0)
+      cri (~> 2.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    albino (1.3.3)
+      posix-spawn (>= 0.3.6)
+    blankslate (2.1.2.4)
+    bluecloth (2.2.0)
+    builder (3.0.0)
+    coderay (1.0.6)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.3.3)
+    colored (1.2)
+    commonjs (0.2.6)
+    cri (2.3.0)
+      colored (>= 1.2)
+    erubis (2.7.0)
+    excon (0.13.4)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    ffi (1.0.11)
+    fog (1.3.1)
+      builder
+      excon (~> 0.13.0)
+      formatador (~> 0.2.0)
+      mime-types
+      multi_json (~> 1.0)
+      net-scp (~> 1.0.4)
+      net-ssh (>= 2.1.3)
+      nokogiri (~> 1.5.0)
+      ruby-hmac
+    formatador (0.2.3)
+    haml (3.1.6)
+    json (1.7.3)
+    kramdown (0.13.7)
+    less (2.2.1)
+      commonjs (~> 0.2.6)
+    markaby (0.7.2)
+      builder (>= 2.0.0)
+    maruku (0.6.0)
+      syntax (>= 1.0.0)
+    metaclass (0.0.1)
+    mime-types (1.18)
+    minitest (3.0.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    mustache (0.99.4)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.5.2)
+    nokogiri (1.5.3)
+    posix-spawn (0.3.6)
+    pygments.rb (0.2.12)
+      rubypython (~> 0.5.3)
+    rack (1.4.1)
+    rainpress (1.0)
+    rake (0.9.2.2)
+    rdiscount (1.6.8)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    ruby-hmac (0.4.0)
+    rubypants (0.2.0)
+    rubypython (0.5.3)
+      blankslate (>= 2.1.2.3)
+      ffi (~> 1.0.7)
+    sass (3.1.19)
+    slim (1.2.1)
+      temple (~> 0.4.0)
+      tilt (~> 1.3.3)
+    syntax (1.0.0)
+    systemu (2.5.1)
+    temple (0.4.0)
+    tilt (1.3.3)
+    typogruby (1.0.15)
+      rubypants
+    uglifier (1.2.4)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+    w3c_validators (1.2)
+      json
+      nokogiri
+    yard (0.8.2)
+    yuicompressor (1.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  albino
+  bluecloth
+  builder
+  coderay
+  coffee-script
+  erubis
+  fog
+  haml
+  kramdown
+  less (~> 2.0)
+  markaby
+  maruku
+  mime-types
+  minitest
+  mocha
+  mustache
+  nanoc!
+  nokogiri
+  pygments.rb
+  rack
+  rainpress
+  rake
+  rdiscount
+  rdoc
+  redcarpet
+  rubypants
+  sass (~> 3.1)
+  slim
+  systemu
+  typogruby
+  uglifier
+  w3c_validators
+  yard
+  yuicompressor

data/NEWS.md

@@ -1,5 +1,20 @@
 # nanoc news
 
+## 3.4 (2012-06-09)
+
+* Improved error output and added crash log
+* Renamed `debug` and `info` commands to `show-data` and `show-plugins`, respectively 
+* Added `show-rules` command (aka `explain`)
+
+Extensions:
+
+* Added `:yield` key for Mustache filter
+* Added Handebars filter
+* Added Pandoc filter
+* Made the deployer use the `default` target if no target is specified
+* Converted HTML/CSS/link validation tasks to commands
+* Made link validator follow relative redirects
+
 ## 3.3.7 (2012-05-28)
 
 * Added filename to YAML parser errors

data/lib/nanoc.rb

@@ -3,7 +3,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '3.3.7'
+  VERSION = '3.4.0'
 
   # @return [String] A string containing information about this nanoc version
   #   and its environment (Ruby engine and version, Rubygems version if any).
@@ -11,7 +11,7 @@ module Nanoc
     gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : "without RubyGems"
     engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
     res = ''
-    res << "nanoc #{Nanoc::VERSION} © 2007-2012 Denis Defreyne.\n".make_compatible_with_env
+    res << "nanoc #{Nanoc::VERSION} © 2007-2012 Denis Defreyne.\n"
     res << "Running #{engine} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} #{gem_info}.\n"
     res
   end

data/lib/nanoc/base/compilation/compiler.rb

@@ -237,7 +237,7 @@ module Nanoc
           basic_path = rule.apply_to(rep, :compiler => self)
           next if basic_path.nil?
           if basic_path !~ %r{^/}
-            raise RuntimeError, "The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash.".make_compatible_with_env
+            raise RuntimeError, "The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash."
           end
 
           # Get raw path by prepending output directory

data/lib/nanoc/base/compilation/item_rep_proxy.rb

@@ -35,11 +35,11 @@ module Nanoc
     #
     # @see Nanoc::ItemRep#filter
     #
-    # @param [Symbol] filter_name The name of the filter to run the item
+    # @param [Symbol] name The name of the filter to run the item
     #   representations' content through
     #
-    # @param [Hash] filter_args The filter arguments that should be passed to
-    #   the filter's #run method
+    # @param [Hash] args The filter arguments that should be passed to the
+    #   filter's #run method
     #
     # @return [void]
     def filter(name, args={})

data/lib/nanoc/base/core_ext/string.rb

@@ -9,24 +9,6 @@ module Nanoc::StringExtensions
     "/#{self}/".gsub(/^\/+|\/+$/, '/')
   end
 
-  # Replaces Unicode characters with their ASCII decompositions if the
-  # environment does not support Unicode.
-  #
-  # This method is not suited for general usage. If you need similar
-  # functionality, consider using the Iconv library instead.
-  #
-  # @return [String] The decomposed string
-  def make_compatible_with_env
-    # Check whether environment supports Unicode
-    # FIXME this is ugly, and there most likely are better ways to do this
-    is_unicode_supported = %w( LC_ALL LC_CTYPE LANG ).any? { |e| ENV[e] =~ /UTF/ }
-    return self if is_unicode_supported
-
-    # Decompose if necessary
-    # FIXME this decomposition is not generally usable
-    self.gsub(/“|”/, '"').gsub(/‘|’/, '\'').gsub('…', '...').gsub('©', '(c)')
-  end
-
   # Calculates the checksum for this string. Any change to this string will
   # result in a different checksum.
   #

data/lib/nanoc/base/errors.rb

@@ -9,6 +9,11 @@ module Nanoc
     class Generic < ::StandardError
     end
 
+    # Generic trivial error. Superclass for all nanoc-specific errors that are
+    # considered "trivial", i.e. errors that do not require a full crash report.
+    class GenericTrivial < Generic
+    end
+
     # Error that is raised when a site is loaded that uses a data source with
     # an unknown identifier.
     class UnknownDataSource < Generic
@@ -16,7 +21,7 @@ module Nanoc
       # @param [String] data_source_name The data source name for which no
       #   data source could be found
       def initialize(data_source_name)
-        super("The data source specified in the site’s configuration file, “#{data_source_name}”, does not exist.".make_compatible_with_env)
+        super("The data source specified in the site’s configuration file, “#{data_source_name}”, does not exist.")
       end
 
     end
@@ -28,7 +33,7 @@ module Nanoc
       # @param [String] layout_identifier The layout identifier for which no
       #   layout could be found
       def initialize(layout_identifier)
-        super("The site does not have a layout with identifier “#{layout_identifier}”.".make_compatible_with_env)
+        super("The site does not have a layout with identifier “#{layout_identifier}”.")
       end
 
     end
@@ -40,7 +45,7 @@ module Nanoc
       # @param [Symbol] filter_name The filter name for which no filter could
       #   be found
       def initialize(filter_name)
-        super("The requested filter, “#{filter_name}”, does not exist.".make_compatible_with_env)
+        super("The requested filter, “#{filter_name}”, does not exist.")
       end
 
     end
@@ -53,7 +58,7 @@ module Nanoc
       # @param [String] layout_identifier The identifier of the layout for
       #   which the filter could not be determined
       def initialize(layout_identifier)
-        super("The filter to be used for the “#{layout_identifier}” layout could not be determined. Make sure the layout does have a filter.".make_compatible_with_env)
+        super("The filter to be used for the “#{layout_identifier}” layout could not be determined. Make sure the layout does have a filter.")
       end
 
     end
@@ -66,7 +71,7 @@ module Nanoc
       #   that mutually depend on each other
       def initialize(reps)
         list = reps.map { |r| r.inspect }.join("\n")
-        super("The site cannot be compiled because the following items mutually depend on each other:\n#{list}.".make_compatible_with_env)
+        super("The site cannot be compiled because the following items mutually depend on each other:\n#{list}.")
       end
 
     end
@@ -76,7 +81,7 @@ module Nanoc
     class NoRulesFileFound < Generic
 
       def initialize
-        super("This site does not have a rules file, which is required for nanoc sites.".make_compatible_with_env)
+        super("This site does not have a rules file, which is required for nanoc sites.")
       end
 
     end
@@ -88,7 +93,7 @@ module Nanoc
       # @param [Nanoc::Item] item The item for which no compilation rule
       #   could be found
       def initialize(item)
-        super("No compilation rules were found for the “#{item.identifier}” item.".make_compatible_with_env)
+        super("No compilation rules were found for the “#{item.identifier}” item.")
       end
 
     end
@@ -97,10 +102,10 @@ module Nanoc
     # current item can be found.
     class NoMatchingRoutingRuleFound < Generic
 
-      # @param [Nanoc::Item] item The item for which no routing rule could be
-      #   found
+      # @param [Nanoc::ItemRep] rep The item repiresentation for which no
+      #   routing rule could be found
       def initialize(rep)
-        super("No routing rules were found for the “#{rep.item.identifier}” item (rep “#{rep.name}”).".make_compatible_with_env)
+        super("No routing rules were found for the “#{rep.item.identifier}” item (rep “#{rep.name}”).")
       end
 
     end
@@ -113,11 +118,11 @@ module Nanoc
       #   compiled
       attr_reader :rep
 
-      # @param [Nanoc::ItemRep] The item representation that cannot yet be
+      # @param [Nanoc::ItemRep] rep The item representation that cannot yet be
       #   compiled
       def initialize(rep)
         @rep = rep
-        super("The current item cannot be compiled yet because of an unmet dependency on the “#{rep.item.identifier}” item (rep “#{rep.name}”).".make_compatible_with_env)
+        super("The current item cannot be compiled yet because of an unmet dependency on the “#{rep.item.identifier}” item (rep “#{rep.name}”).")
       end
 
     end
@@ -125,10 +130,10 @@ module Nanoc
     # Error that is raised when a binary item is attempted to be laid out.
     class CannotLayoutBinaryItem < Generic
 
-      # @param [Nanoc::ItemRep] The item representation that was attempted to
-      #   be laid out
+      # @param [Nanoc::ItemRep] rep The item representation that was attempted
+      #   to be laid out
       def initialize(rep)
-        super("The “{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.".make_compatible_with_env)
+        super("The “{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.")
       end
 
     end
@@ -142,7 +147,7 @@ module Nanoc
       #
       # @param [Class] filter_class The filter class that was used
       def initialize(rep, filter_class)
-        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because textual filters cannot be used on binary items.".make_compatible_with_env)
+        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because textual filters cannot be used on binary items.")
       end
 
     end
@@ -156,7 +161,7 @@ module Nanoc
       #
       # @param [Class] filter_class The filter class that was used
       def initialize(rep, filter_class)
-        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.".make_compatible_with_env)
+        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.")
       end
 
     end
@@ -192,7 +197,7 @@ module Nanoc
       # @param [Symbol] snapshot The name of the snapshot that was attempted to
       #   be made
       def initialize(rep, snapshot)
-        super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep “#{rep.inspect}”".make_compatible_with_env)
+        super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep “#{rep.inspect}”")
       end
 
     end
@@ -201,7 +206,7 @@ module Nanoc
     class DataNotYetAvailable < Generic
 
       def initialize(type, plural)
-        super("#{type} #{plural ? 'are' : 'is'} not available yet. You may be missing a Nanoc::Site#load_data call.".make_compatible_with_env)
+        super("#{type} #{plural ? 'are' : 'is'} not available yet. You may be missing a Nanoc::Site#load_data call.")
       end
 
     end

data/lib/nanoc/base/plugin_registry.rb

@@ -14,7 +14,7 @@ module Nanoc
 
       # Sets the identifiers for this plugin.
       #
-      # @param [Array<Symbol>] identifier A list of identifiers to assign to
+      # @param [Array<Symbol>] identifiers A list of identifiers to assign to
       #   this plugin.
       #
       # @return [void]

data/lib/nanoc/base/result_data/item_rep.rb

@@ -115,8 +115,7 @@ module Nanoc
       #
       # @api private
       #
-      # @param [String, nil] raw_path The raw path to write the compiled rep
-      #   to. If nil, the default raw path will be used.
+      # @param [Symbol, nil] snapshot The name of the snapshot to write.
       #
       # @return [void]
       def write(snapshot=:last)

data/lib/nanoc/base/source_data/site.rb

@@ -32,7 +32,7 @@ module Nanoc
     # that lacks some options, the default value will be taken from
     # `DEFAULT_CONFIG`.
     DEFAULT_CONFIG = {
-      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee ),
+      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms ).sort,
       :output_dir         => 'output',
       :data_sources       => [ {} ],
       :index_filenames    => [ 'index.html' ],

data/lib/nanoc/cli.rb

@@ -7,13 +7,16 @@ module Nanoc::CLI
   module Commands
   end
 
-  autoload 'Logger',             'nanoc/cli/logger'
-  autoload 'CommandRunner',      'nanoc/cli/command_runner'
-  autoload 'ErrorHandler',       'nanoc/cli/error_handler'
+  autoload 'ANSIStringColorizer', 'nanoc/cli/ansi_string_colorizer'
+  autoload 'Logger',              'nanoc/cli/logger'
+  autoload 'CommandRunner',       'nanoc/cli/command_runner'
+  autoload 'CleaningStream',      'nanoc/cli/cleaning_stream'
+  autoload 'StreamCleaners',      'nanoc/cli/stream_cleaners'
+  autoload 'ErrorHandler',        'nanoc/cli/error_handler'
 
   # Deprecated; use CommandRunner instead
   # TODO [in nanoc 4.0] remove me
-  autoload 'Command',            'nanoc/cli/command_runner'
+  autoload 'Command',             'nanoc/cli/command_runner'
 
   # @return [Boolean] true if debug output is enabled, false if not
   #
@@ -60,6 +63,9 @@ protected
   #
   # @return [void]
   def self.setup
+    # Set up output streams
+    self.setup_cleaning_streams
+
     # Reinit
     @root_command = nil
 
@@ -134,4 +140,40 @@ protected
     files
   end
 
+  # Wraps `$stdout` and `$stderr` in appropriate cleaning streams.
+  #
+  # @return [void]
+  def self.setup_cleaning_streams
+    $stdout = Nanoc::CLI::CleaningStream.new($stdout)
+    $stderr = Nanoc::CLI::CleaningStream.new($stderr)
+
+    if !self.enable_utf8?
+      $stdout.add_stream_cleaner(Nanoc::CLI::StreamCleaners::UTF8)
+      $stderr.add_stream_cleaner(Nanoc::CLI::StreamCleaners::UTF8)
+    end
+
+    if !self.enable_ansi_colors?
+      $stdout.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+      $stderr.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+    end
+  end
+
+  # @return [Boolean] true if UTF-8 support is present, false if not
+  def self.enable_utf8?
+    %w( LC_ALL LC_CTYPE LANG ).any? { |e| ENV[e] =~ /UTF/ }
+  end
+
+  # @return [Boolean] true if color support is present, false if not
+  def self.enable_ansi_colors?
+    return false if !$stdout.tty?
+
+    begin
+      require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /mswin|mingw/
+    rescue LoadError
+      return false
+    end
+    
+    return true
+  end
+
 end