nanoc3 3.2.0a4 → 3.2.0b1

data/NEWS.md

@@ -10,18 +10,36 @@ Base:
 * Added --color option to force color on
 * Cleaned up internals, deprecating several parts and/or marking them as
   private in the progress
+* Allowed custom commands in commands/
 
 Extensions:
 
 * Added AsciiDoc filter
 * Added Redcarpet filter [Peter Aronoff]
-* Added Typogruby filter
 * Added Slim filter [Zaiste de Grengolada]
-* Added :items parameter for the XML site map [Justin Hileman]
+* Added Typogruby filter
+* Added UglifyJS filter [Justin Hileman]
+* Added `:items` parameter for the XML site map [Justin Hileman]
 * Added support for params to ERB
+* Added `:default_colorizer` parameter to the `:colorize_syntax` filter
 * Allowed for passing arbitrary options to pygmentize [Matthias Vallentin]
 * Exposed RedCloth parameters in the filter [Vincent Driessen]
 
+## 3.1.9 (2011-06-30)
+
+* Really fixed dependency generation between Sass partials this time
+* Updated Less filter to 2.0
+* Made colorize_syntax filter throw an error if pygmentize is not available
+
+## 3.1.8 (2011-06-25)
+
+* Made link validator accept https: URLs
+* Fixed erronous handling of layouts with names ending in index
+* Fixed dependency generation between Sass partials
+* Fixed errors related to thread requires
+* Fixed crash while handling load errors
+* Improved encoding handling while reading files
+
 ## 3.1.7 (2011-05-03)
 
 * Restored compatibility with Sass 3.1

data/README.md

@@ -28,12 +28,14 @@ directories:
 * `cli` contains the commandline interface
 * `data_sources` contains the standard data sources ({Nanoc3::DataSource}
   subclasses), such as the filesystem data source
-* `helpers` contains helpers, which provide functionality some sites
-  may find useful, such as the blogging and tagging helpers
 * `extra` contains stuff that is not needed by nanoc itself, but which may
   be used by helpers, data sources, filters or VCSes.
 * `filters` contains the standard filters ({Nanoc3::Filter} subclasses)
-  such as ERB, Markdown, Haml, ...
+  such as ERB, Markdown, Haml, …
+* `helpers` contains helpers, which provide functionality some sites
+  may find useful, such as the blogging and tagging helpers
+* `tasks` contains rake tasks that perform a variety of functions such as
+  validating HTML and CSS, uploading compiled files, …
 
 The namespaces (modules) are organised like this:
 
@@ -90,10 +92,12 @@ may be interested in the development dependencies:
 * Christian Plessl
 * Šime Ramov
 * Xavier Shay
+* Arnau Siches
 * “Soryu”
 * Eric Sunshine
 * Dennis Sutch
 * Matthias Vallentin
+* Toon Willems
 
 ## Contact
 

data/bin/nanoc3

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-puts "Starting..."
-
 # Add lib to load path
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 
@@ -11,4 +9,4 @@ require 'nanoc3'
 require 'nanoc3/cli'
 
 # Run base
-Nanoc3::CLI::Base.shared_base.run(ARGV)
+Nanoc3::CLI.run(ARGV)

data/lib/nanoc3.rb

@@ -3,22 +3,10 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.2.0a4'
+  VERSION = '3.2.0b1'
 
 end
 
-# Switch #require for a faster variant
-require 'set'
-$_nanoc_requires ||= Set.new
-module Kernel
-  alias_method :nanoc_original_require, :require
-  def require(r)
-    return if $_nanoc_requires.include?(r)
-    nanoc_original_require(r)
-    $_nanoc_requires << r
-  end
-end
-
 # Load general requirements
 require 'digest'
 require 'enumerator'

data/lib/nanoc3/base/compilation/filter.rb

@@ -139,6 +139,27 @@ module Nanoc3
       end
     end
 
+    # Creates a dependency from the item that is currently being filtered onto
+    # the given collection of items. In other words, require the given items
+    # to be compiled first before this items is processed.
+    #
+    # @param [Array<Nanoc3::Item>] items The items that are depended on.
+    #
+    # @return [void]
+    def depend_on(items)
+      # Notify
+      items.each do |item|
+        Nanoc3::NotificationCenter.post(:visit_started, item)
+        Nanoc3::NotificationCenter.post(:visit_ended,   item)
+      end
+
+      # Raise unmet dependency error if necessary
+      items.each do |item|
+        rep = item.reps.find { |r| !r.compiled? }
+        raise Nanoc3::Errors::UnmetDependency.new(rep) if rep
+      end
+    end
+
   end
 
 end

data/lib/nanoc3/base/compilation/item_rep_recorder_proxy.rb

@@ -20,8 +20,6 @@ module Nanoc3
 
     def_delegators :@item_rep, :item, :name, :binary, :binary?, :compiled_content, :has_snapshot?, :raw_path, :path, :assigns, :assigns=
 
-    # @return The list of recorded actions (“rule memory”)
-    #
     # @example The compilation rule and the corresponding rule memory
     #
     #     # rule
@@ -38,7 +36,7 @@ module Nanoc3
     #       [ :layout, 'meh' ]
     #     ]
     #
-    # @return [Array] The rule memory
+    # @return [Array] The list of recorded actions (“rule memory”)
     attr_reader :rule_memory
 
     # @param [Nanoc3::ItemRep] item_rep The item representation that this

data/lib/nanoc3/base/compilation/outdatedness_checker.rb

@@ -203,7 +203,7 @@ module Nanoc3
       @checksum_store
     end
 
-    # TODO document
+    # @return [Nanoc3::RulesCollection] The rules collection
     def rules_collection
       site.compiler.rules_collection
     end

data/lib/nanoc3/base/compilation/rule_memory_calculator.rb

@@ -13,8 +13,6 @@ module Nanoc3
     # @option params [Nanoc3::RulesCollection] rules_collection The rules
     #   collection
     def initialize(params={})
-      super('tmp/rule_memory', 1)
-
       @rules_collection = params[:rules_collection] or
         raise ArgumentError, "Required :rules_collection option is missing"
     end

data/lib/nanoc3/base/compilation/rules_collection.rb

@@ -34,7 +34,14 @@ module Nanoc3
       @layout_filter_mapping   = OrderedHash.new
     end
 
-    # TODO document
+    # Add the given rule to the list of item compilation rules.
+    #
+    # @param [Nanoc3::Rule] rule The item compilation rule to add
+    #
+    # @param [:before, :after] position The place where the rule should be
+    #   added (either at the beginning or the end of the list of rules)
+    #
+    # @return [void]
     def add_item_compilation_rule(rule, position=:after)
       case position
       when :before
@@ -46,7 +53,14 @@ module Nanoc3
       end
     end
 
-    # TODO document
+    # Add the given rule to the list of item routing rules.
+    #
+    # @param [Nanoc3::Rule] rule The item routing rule to add
+    #
+    # @param [:before, :after] position The place where the rule should be
+    #   added (either at the beginning or the end of the list of rules)
+    #
+    # @return [void]
     def add_item_routing_rule(rule, position=:after)
       case position
       when :before
@@ -58,12 +72,17 @@ module Nanoc3
       end
     end
 
-    # TODO document
+    # @param [Nanoc3::Item] item The item for which the compilation rules
+    #   should be retrieved
+    #
+    # @return [Array] The list of item compilation rules for the given item
     def item_compilation_rules_for(item)
       @item_compilation_rules.select { |r| r.applicable_to?(item) }
     end
 
     # Loads this site’s rules.
+    #
+    # @return [void]
     def load
       # Find rules file
       rules_filenames = [ 'Rules', 'rules', 'Rules.rb', 'rules.rb' ]
@@ -78,6 +97,8 @@ module Nanoc3
     end
 
     # Unloads this site’s rules.
+    #
+    # @return [void]
     def unload
       @item_compilation_rules  = []
       @item_routing_rules      = []
@@ -114,6 +135,8 @@ module Nanoc3
     # returned. The result is a hash containing the corresponding rule for
     # each snapshot.
     #
+    # @param [Nanoc3::ItemRep] rep The item rep for which to fetch the rules
+    #
     # @return [Hash<Symbol, Nanoc3::Rule>] The routing rules for the given rep
     def routing_rules_for(rep)
       rules = {}
@@ -146,17 +169,15 @@ module Nanoc3
     end
     memoize :dsl
 
-    # TODO document
+    # Returns an object that can be used for uniquely identifying objects.
+    #
+    # @return [Object] An unique reference to this object
     def reference
       :rules
     end
 
-    # TODO document
-    def data
-      @data
-    end
-
-    # TODO document
+    # @return [String] The checksum for this object. If its contents change,
+    #   the checksum will change as well.
     def checksum
       @data.checksum
     end
@@ -184,18 +205,21 @@ module Nanoc3
     end
     memoize :new_rule_memory_for_layout
 
-    # TODO document
+    # @param [Nanoc3::Item] obj The object for which to check the rule memory
+    #
+    # @return [Boolean] true if the rule memory for the given object has
+    # changed since the last compilation, false otherwise
     def rule_memory_differs_for(obj)
       !rule_memory_store[obj].eql?(rule_memory_calculator[obj])
     end
     memoize :rule_memory_differs_for
 
-    # TODO document
+    # @return [Nanoc3::RuleMemoryStore] The rule memory store
     def rule_memory_store
       @compiler.rule_memory_store
     end
 
-    # TODO document
+    # @return [Nanoc3::RuleMemoryCalculator] The rule memory calculator
     def rule_memory_calculator
       @compiler.rule_memory_calculator
     end

data/lib/nanoc3/base/directed_graph.rb

@@ -31,16 +31,16 @@ module Nanoc3
   #     # => %w( b c )
   class DirectedGraph
 
-    # The list of vertices in this graph.
+    # The set of vertices in this graph.
     #
-    # @return [Array]
+    # @return [Set]
     attr_reader :vertices
 
     # @group Creating a graph
 
     # Creates a new directed graph with the given vertices.
     def initialize(vertices)
-      @vertices = vertices
+      @vertices = Set.new(vertices)
 
       @from_graph = {}
       @to_graph   = {}

data/lib/nanoc3/base/memoization.rb

@@ -49,21 +49,18 @@ module Nanoc3
 
       # Redefine
       define_method(method_name) do |*args|
-        # Get method-specific cache
-        key = [ self, method_name ]
-        if !CACHE.has_key?(key)
-          CACHE[key] = {}
-        end
-        method_cache = CACHE[key]
+        # Get cache
+        @cache ||= {}
+        @cache[method_name] ||= {}
 
         # Recalculate if necessary
-        if !method_cache.has_key?(args)
+        if !@cache[method_name].has_key?(args)
           result = send(original_method_name, *args)
-          method_cache[args] = result
+          @cache[method_name][args] = result
         end
 
         # Done
-        method_cache[args]
+        @cache[method_name][args]
       end
     end
 

data/lib/nanoc3/base/source_data/code_snippet.rb

@@ -47,7 +47,8 @@ module Nanoc3
       "<#{self.class}:0x#{self.object_id.to_s(16)} filename=#{self.filename}>"
     end
 
-    # TODO document
+    # @return [String] The checksum for this object. If its contents change,
+    #   the checksum will change as well.
     def checksum
       @data.checksum
     end

data/lib/nanoc3/base/source_data/configuration.rb

@@ -2,15 +2,19 @@
 
 module Nanoc3
 
-  # TODO document
+  # Represents the site configuration.
   class Configuration < ::Hash
 
-    # TODO document
+    # Creates a new configuration with the given hash.
+    #
+    # @param [Hash] hash The actual configuration hash
     def initialize(hash)
       self.replace(hash)
     end
 
-    # TODO document
+    # Returns an object that can be used for uniquely identifying objects.
+    #
+    # @return [Object] An unique reference to this object
     def reference
       :config
     end

data/lib/nanoc3/base/source_data/item.rb

@@ -166,16 +166,19 @@ module Nanoc3
       # Get captured content (hax)
       # TODO [in nanoc 4.0] remove me
       if key.to_s =~ /^content_for_(.*)$/
+        @@_content_for_warning_issued ||= false
+        @@_Nanoc3_Helpers_Capturing_included ||= false
+
         # Warn
-        unless @_content_for_warning_issued
+        unless @@_content_for_warning_issued
           warn 'WARNING: Accessing captured content should happen using the #content_for method defined in the Capturing helper instead of using item[:content_for_something]. The latter way of accessing captured content will be removed in nanoc 4.0.'
-          @_content_for_warning_issued = true
+          @@_content_for_warning_issued = true
         end
 
         # Include capturing helper if necessary
-        unless @_Nanoc3_Helpers_Capturing_included
+        unless @@_Nanoc3_Helpers_Capturing_included
           self.class.send(:include, ::Nanoc3::Helpers::Capturing)
-          @_Nanoc3_Helpers_Capturing_included = true
+          @@_Nanoc3_Helpers_Capturing_included = true
         end
 
         # Get content
@@ -233,18 +236,57 @@ module Nanoc3
       "<#{self.class}:0x#{self.object_id.to_s(16)} identifier=#{self.identifier} binary?=#{self.binary?}>"
     end
 
-    # TODO document
+    # @return [String] The checksum for this object. If its contents change,
+    #   the checksum will change as well.
     def checksum
-      if binary?
-        Pathname.new(raw_filename).checksum
+      content_checksum = if binary?
+        if File.exist?(raw_filename)
+          Pathname.new(raw_filename).checksum
+        else
+          ''.checksum
+        end
       else
-        attributes = @attributes.dup
-        attributes.delete(:file)
-        @raw_content.checksum + ',' + attributes.checksum
+        @raw_content.checksum
       end
+
+      attributes = @attributes.dup
+      attributes.delete(:file)
+      attributes_checksum = attributes.checksum
+
+      content_checksum + ',' + attributes_checksum
     end
     memoize :checksum
 
+    def hash
+      self.class.hash ^ self.identifier.hash
+    end
+
+    def eql?(other)
+      self.class == other.class && self.identifier == other.identifier
+    end
+
+    def ==(other)
+      self.eql?(other)
+    end
+
+    def marshal_dump
+      [
+        @is_binary,
+        @raw_filename,
+        @raw_content,
+        @attributes,
+        @identifier
+      ]
+    end
+
+    def marshal_load(source)
+      @is_binary,
+      @raw_filename,
+      @raw_content,
+      @attributes,
+      @identifier = *source
+    end
+
     # @deprecated Access the modification time using `item[:mtime]` instead.
     def mtime
       self[:mtime]