nanoc 3.4.3 → 3.5.0b1

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+Contributing
+============
+
+Reporting bugs
+--------------
+
+If you find a bug in nanoc, you should report it! But before you do, make sure you have the latest version of nanoc (and dependencies) installed, and see if you can still reproduce the bug there. If you can, report it!
+
+When reporting a bug, please make sure you include as many details as you can about the bug. Some information that you should include:
+
+* The nanoc version (`nanoc --version`)
+* The `crash.log` file, if relevant
+
+Submitting Patches
+------------------
+
+If you want to submit a pull request, please review the following few guidelines:
+
+* If your pull request is a **bug fix**, submit it on the latest release branch. At the moment of writing, this is `release-3.4.x`. This ensures that the bug fix comes in the next patch release.
+
+* If your pull request is a new **feature** or extends an existing feature,  submit it on the `master` branch.
+
+In both cases, make sure that your changes have **test cases** that cover the bug fix or the new/changed functionality.
+
+Also note that **backwards compatibility** must be retained. This means that you cannot simply modify a feature to work in a different way. What you can do, is add an option to make it work in a different way, but do double-check with me (@ddfreyne) first.

data/Gemfile

@@ -9,15 +9,17 @@ gem 'coderay'
 gem 'coffee-script'
 gem 'erubis'
 gem 'fog'
-gem 'fssm'
 gem 'haml'
+gem 'handlebars'
 gem 'kramdown'
 gem 'less', '~> 2.0'
+gem 'listen'
 gem 'markaby'
 gem 'maruku'
 gem 'mime-types'
 gem 'mustache'
 gem 'nokogiri', '~> 1.5.5'
+gem 'pandoc-ruby'
 gem 'pygments.rb'
 gem 'rack'
 gem 'rake'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (3.4.2)
+    nanoc (3.5.0)
       cri (~> 2.2)
 
 GEM
@@ -25,7 +25,7 @@ GEM
     excon (0.16.10)
     execjs (1.4.0)
       multi_json (~> 1.0)
-    fog (1.7.0)
+    fog (1.8.0)
       builder
       excon (~> 0.14)
       formatador (~> 0.2.0)
@@ -36,47 +36,54 @@ GEM
       nokogiri (~> 1.5.0)
       ruby-hmac
     formatador (0.2.4)
-    fssm (0.2.9)
     haml (3.1.7)
+    handlebars (0.3.1)
+      commonjs (~> 0.2.3)
+      therubyracer (~> 0.10.0)
     json (1.7.5)
-    kramdown (0.14.0)
+    kramdown (0.14.1)
     less (2.2.2)
       commonjs (~> 0.2.6)
+    libv8 (3.3.10.4)
+    listen (0.6.0)
     markaby (0.7.2)
       builder (>= 2.0.0)
     maruku (0.6.1)
       syntax (>= 1.0.0)
     metaclass (0.0.1)
     mime-types (1.19)
-    minitest (4.3.1)
-    mocha (0.13.0)
+    minitest (4.3.3)
+    mocha (0.13.1)
       metaclass (~> 0.0.1)
-    multi_json (1.3.7)
+    multi_json (1.5.0)
     mustache (0.99.4)
     net-scp (1.0.4)
       net-ssh (>= 1.99.1)
     net-ssh (2.6.2)
-    nokogiri (1.5.5)
+    nokogiri (1.5.6)
+    pandoc-ruby (0.6.0)
     posix-spawn (0.3.6)
-    pygments.rb (0.3.2)
+    pygments.rb (0.3.3)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
     rack (1.4.1)
     rainpress (1.0)
-    rake (10.0.2)
+    rake (10.0.3)
     rdiscount (1.6.8)
     rdoc (3.12)
       json (~> 1.4)
     redcarpet (2.2.2)
     ruby-hmac (0.4.0)
     rubypants (0.2.0)
-    sass (3.2.3)
-    slim (1.3.4)
+    sass (3.2.4)
+    slim (1.3.5)
       temple (~> 0.5.5)
       tilt (~> 1.3.3)
     syntax (1.0.0)
     systemu (2.5.2)
     temple (0.5.5)
+    therubyracer (0.10.2)
+      libv8 (~> 3.3.10)
     tilt (1.3.3)
     typogruby (1.0.15)
       rubypants
@@ -102,10 +109,11 @@ DEPENDENCIES
   coffee-script
   erubis
   fog
-  fssm
   haml
+  handlebars
   kramdown
   less (~> 2.0)
+  listen
   markaby
   maruku
   mime-types
@@ -114,6 +122,7 @@ DEPENDENCIES
   mustache
   nanoc!
   nokogiri (~> 1.5.5)
+  pandoc-ruby
   pygments.rb
   rack
   rainpress

data/NEWS.md

@@ -1,5 +1,32 @@
 # nanoc news
 
+## 3.5 (???)
+
+Major changes:
+
+* Added checks
+
+Minor changes:
+
+* Added `#include_rules` for modularising Rules files [Justin Hileman]
+* Replaced FSSM with Listen [Takashi Uchibe]
+* Made USR1 print stack trace
+* Added ability to configure autocompiler host/port in config.yaml [Stuart Montgomery]
+* Added static data source
+* Added `:rep_select` parameter to XML sitemap to allow filtering reps
+
+Exensions:
+
+* Added support for parameters in Less filter [Ruben Verborgh]
+* Added support for icon and logo in Atom feed [Ruben Verborgh]
+
+## 3.4.4 (???)
+
+Fixes:
+
+* Made syntax colorizer only use the first non-empty line when extracting the
+  language comment
+
 ## 3.4.3 (2012-12-09)
 
 Improvements:

data/README.md

@@ -18,7 +18,7 @@ the following places will help you out:
 
 ## Versioning
 
-nanoc uses [Semantic Versioning](semver.org).
+nanoc uses [Semantic Versioning](http://semver.org/).
 
 ## Source Code Documentation
 
@@ -102,6 +102,7 @@ may be interested in the development dependencies:
 * Go Maeda
 * Nikhil Marathe
 * Daniel Mendler
+* Stuart Montgomery
 * Ale Muñoz
 * John Nishinaga
 * Gregory Pakosz
@@ -114,6 +115,7 @@ may be interested in the development dependencies:
 * “Soryu”
 * Eric Sunshine
 * Dennis Sutch
+* Takashi Uchibe
 * Matthias Vallentin
 * Ruben Verborgh
 * Scott Vokes

data/lib/nanoc.rb

@@ -3,7 +3,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '3.4.3'
+  VERSION = '3.5.0b1'
 
   # @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"
+    res << "nanoc #{Nanoc::VERSION} © 2007-2013 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_dsl.rb

@@ -190,6 +190,25 @@ module Nanoc
       @rules_collection.add_item_routing_rule(routing_rule)
     end
 
+    # Includes an additional rules file in the current rules collection.
+    #
+    # @param [String] name The name of the rules file — an ".rb" extension is
+    #   implied if not explicitly given
+    #
+    # @return [void]
+    #
+    # @example Including two additional rules files, 'rules/assets.rb' and
+    #   'rules/content.rb'
+    #
+    #     include_rules 'rules/assets'
+    #     include_rules 'rules/content'
+    def include_rules(name)
+      filename = [ "#{name}", "#{name}.rb", "./#{name}", "./#{name}.rb" ].find { |f| File.file?(f) }
+      raise Nanoc::Errors::NoRulesFileFound.new if filename.nil?
+
+      self.instance_eval(File.read(filename), filename)
+    end
+
   private
 
     # Converts the given identifier, which can contain the '*' or '+'

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

@@ -3,27 +3,37 @@
 module Nanoc::ArrayExtensions
 
   # Returns a new array where all items' keys are recursively converted to
-  # symbols by calling {Nanoc::ArrayExtensions#symbolize_keys} or
-  # {Nanoc::HashExtensions#symbolize_keys}.
+  # symbols by calling {Nanoc::ArrayExtensions#symbolize_keys_recursively} or
+  # {Nanoc::HashExtensions#symbolize_keys_recursively}.
   #
   # @return [Array] The converted array
-  def symbolize_keys
+  def symbolize_keys_recursively
     inject([]) do |array, element|
-      array + [ element.respond_to?(:symbolize_keys) ? element.symbolize_keys : element ]
+      array + [ element.respond_to?(:symbolize_keys_recursively) ? element.symbolize_keys_recursively : element ]
     end
   end
 
+  # @deprecated Renamed to {#symbolize_keys_recursively}
+  def symbolize_keys
+    symbolize_keys_recursively
+  end
+
   # Returns a new array where all items' keys are recursively converted to
-  # strings by calling {Nanoc::ArrayExtensions#stringify_keys} or
-  # {Nanoc::HashExtensions#stringify_keys}.
+  # strings by calling {Nanoc::ArrayExtensions#stringify_keys_recursively} or
+  # {Nanoc::HashExtensions#stringify_keys_recursively}.
   #
   # @return [Array] The converted array
-  def stringify_keys
+  def stringify_keys_recursively
     inject([]) do |array, element|
-      array + [ element.respond_to?(:stringify_keys) ? element.stringify_keys : element ]
+      array + [ element.respond_to?(:stringify_keys_recursively) ? element.stringify_keys_recursively : element ]
     end
   end
 
+  # @deprecated Renamed to {#stringify_keys_recursively}
+  def stringify_keys
+    stringify_keys_recursively
+  end
+
   # Freezes the contents of the array, as well as all array elements. The
   # array elements will be frozen using {#freeze_recursively} if they respond
   # to that message, or #freeze if they do not.

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

@@ -3,27 +3,37 @@
 module Nanoc::HashExtensions
 
   # Returns a new hash where all keys are recursively converted to symbols by
-  # calling {Nanoc::ArrayExtensions#symbolize_keys} or
-  # {Nanoc::HashExtensions#symbolize_keys}.
+  # calling {Nanoc::ArrayExtensions#symbolize_keys_recursively} or
+  # {Nanoc::HashExtensions#symbolize_keys_recursively}.
   #
   # @return [Hash] The converted hash
-  def symbolize_keys
+  def symbolize_keys_recursively
     inject({}) do |hash, (key, value)|
-      hash.merge(key.to_sym => value.respond_to?(:symbolize_keys) ? value.symbolize_keys : value)
+      hash.merge(key.to_sym => value.respond_to?(:symbolize_keys_recursively) ? value.symbolize_keys_recursively : value)
     end
   end
 
+  # @deprecated Renamed to {#symbolize_keys_recursively}
+  def symbolize_keys
+    symbolize_keys_recursively
+  end
+
   # Returns a new hash where all keys are recursively converted to strings by
-  # calling {Nanoc::ArrayExtensions#stringify_keys} or
-  # {Nanoc::HashExtensions#stringify_keys}.
+  # calling {Nanoc::ArrayExtensions#stringify_keys_recursively} or
+  # {Nanoc::HashExtensions#stringify_keys_recursively}.
   #
   # @return [Hash] The converted hash
-  def stringify_keys
+  def stringify_keys_recursively
     inject({}) do |hash, (key, value)|
-      hash.merge(key.to_s => value.respond_to?(:stringify_keys) ? value.stringify_keys : value)
+      hash.merge(key.to_s => value.respond_to?(:stringify_keys_recursively) ? value.stringify_keys_recursively : value)
     end
   end
 
+  # @deprecated Renamed to {#stringify_keys_recursively}
+  def stringify_keys
+    stringify_keys_recursively
+  end
+
   # Freezes the contents of the hash, as well as all hash values. The hash
   # values will be frozen using {#freeze_recursively} if they respond to
   # that message, or #freeze if they do not.

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

@@ -9,14 +9,8 @@ module Nanoc::PathnameExtensions
   #
   # @api private
   def checksum
-    digest = Digest::SHA1.new
-    File.open(self.to_s, 'r') do |io|
-      until io.eof
-        data = io.read(2**10)
-        digest.update(data)
-      end
-    end
-    digest.hexdigest
+    stat = File.stat(self.to_s)
+    stat.size.to_s + '-' + stat.mtime.to_s
   end
 
 end

data/lib/nanoc/base/plugin_registry.rb

@@ -14,23 +14,43 @@ module Nanoc
     # classes should extend this module.
     module PluginMethods
 
-      # Sets the identifiers for this plugin.
+      # @overload identifiers(*identifiers)
       #
-      # @param [Array<Symbol>] identifiers A list of identifiers to assign to
-      #   this plugin.
+      #   Sets the identifiers for this plugin.
       #
-      # @return [void]
+      #   @param [Array<Symbol>] identifiers A list of identifiers to assign to
+      #     this plugin.
+      #
+      #   @return [void]
+      #
+      # @overload identifiers
+      #
+      #   @return [Array<Symbol>] The identifiers for this plugin
       def identifiers(*identifiers)
-        register(self, *identifiers)
+        if identifiers.empty?
+          Nanoc::PluginRegistry.instance.identifiers_of(self.superclass, self)
+        else
+          register(self, *identifiers)
+        end
       end
 
-      # Sets the identifier for this plugin.
+      # @overload identifier(identifier)
       #
-      # @param [Symbol] identifier An identifier to assign to this plugin.
+      #   Sets the identifier for this plugin.
       #
-      # @return [void]
-      def identifier(identifier)
-        register(self, identifier)
+      #   @param [Symbol] identifier An identifier to assign to this plugin.
+      #
+      #   @return [void]
+      #
+      # @overload identifier
+      #
+      #   @return [Symbol] The first identifier for this plugin
+      def identifier(identifier=nil)
+        if identifier
+          self.identifiers(identifier)
+        else
+          Nanoc::PluginRegistry.instance.identifiers_of(self.superclass, self).first
+        end
       end
 
       # Registers the given class as a plugin with the given identifier.
@@ -81,7 +101,8 @@ module Nanoc
     # is recommended to use the shared instance (obtained from
     # {Nanoc::PluginRegistry.instance}).
     def initialize
-      @map = {}
+      @identifiers_to_classes = {}
+      @classes_to_identifiers = {}
     end
 
     # Registers the given class as a plugin.
@@ -99,13 +120,26 @@ module Nanoc
     #
     # @return [void]
     def register(superclass, class_or_name, *identifiers)
-      @map[superclass] ||= {}
+      @identifiers_to_classes[superclass] ||= {}
+      @classes_to_identifiers[superclass] ||= {}
 
       identifiers.each do |identifier|
-        @map[superclass][identifier.to_sym] = class_or_name
+        @identifiers_to_classes[superclass][identifier.to_sym] = class_or_name
+        (@classes_to_identifiers[superclass][name_for_class(class_or_name)] ||= []) << identifier.to_sym
       end
     end
 
+    # @param [Class] superclass The superclass of the plugin. For example:
+    #   {Nanoc::Filter}, {Nanoc::Extra::VCS}.
+    #
+    # @param [Class, String] class_or_name The class to get the identifiers for.
+    #   This can also be a string containing the name of the class.
+    #
+    # @return [Array<Symbol>] An array of identifiers for the given class
+    def identifiers_of(superclass, klass)
+      (@classes_to_identifiers[superclass] || {})[name_for_class(klass)] || []
+    end
+
     # Finds the plugin that is a subclass of the given class and has the given
     # name.
     #
@@ -115,8 +149,8 @@ module Nanoc
     #
     # @return [Class, nil] The plugin with the given name
     def find(klass, name)
-      @map[klass] ||= {}
-      resolve(@map[klass][name.to_sym], klass)
+      @identifiers_to_classes[klass] ||= {}
+      resolve(@identifiers_to_classes[klass][name.to_sym], klass)
     end
 
     # Returns all plugins of the given class.
@@ -125,9 +159,9 @@ module Nanoc
     #
     # @return [Enumerable<Class>] A collection of class plugins
     def find_all(klass)
-      @map[klass] ||= {}
+      @identifiers_to_classes[klass] ||= {}
       res = {}
-      @map[klass].each_pair { |k,v| res[k] = resolve(v, k) }
+      @identifiers_to_classes[klass].each_pair { |k,v| res[k] = resolve(v, k) }
       res
     end
 
@@ -139,7 +173,7 @@ module Nanoc
     # @return [Array<Hash>] A list of all plugins in the format described
     def all
       plugins = []
-      @map.each_pair do |superclass, submap|
+      @identifiers_to_classes.each_pair do |superclass, submap|
         submap.each_pair do |identifier, klass|
           # Find existing plugin
           existing_plugin = plugins.find do |p|
@@ -181,7 +215,11 @@ module Nanoc
       end
     end
     memoize :resolve
-  
+
+    def name_for_class(klass)
+      klass.to_s.sub(/^(::)?/, '::')
+    end
+
   end
 
   # @deprecated Use {Nanoc::PluginRegistry.instance} instead