nanoc3 3.2.0a1 → 3.2.0a2

data/ChangeLog

@@ -1,3 +1,3 @@
 For a list of all changes, please see the changelog on the project repository
-instead (http://projects.stoneship.org/hg/nanoc/shortlog). For release notes,
-please see the NEWS file.
+instead (http://projects.stoneship.org/hg/nanoc). For release notes, please
+see the NEWS file.

data/NEWS.md

@@ -1,5 +1,19 @@
 # nanoc news
 
+## 3.2 (???)
+
+* Sped up nanoc quite a bit
+* Added AsciiDoc filter
+* Added progress indicator for long-running filters
+
+## 3.1.3 (2010-04-25)
+
+* Removed annoying win32console warning [Eric Sunshine]
+* Removed color codes when not writing to a terminal, or when writing to
+  Windows’ console when win32console is not installed [Eric Sunshine]
+* Added .xhtml and .xml to list of text extensions
+* Improved support for relative Sass @imports [Chris Eppstein]
+
 ## 3.1.2 (2010-04-07)
 
 * Fixed bug which could cause incorrect output when compilation of an item is

data/README.md

@@ -10,13 +10,8 @@ Note: This documentation looks best with Yardoc, not RDoc.
 ## Resources
 
 The [nanoc web site](http://nanoc.stoneship.org) contains a few useful
-resources to help you get started with nanoc:
-
-* The [tutorial](http://nanoc.stoneship.org/tutorial)
-* The [manual](http://nanoc.stoneship.org/manual)
-* The [migration guide](http://nanoc.stoneship.org/migrating)
-
-If you need assistance, the following places will help you out:
+resources to help you get started with nanoc. If you need further assistance,
+the following places will help you out:
 
 * The [discussion group](http://groups.google.com/group/nanoc)
 * The [IRC channel](irc://chat.freenode.net/#nanoc)
@@ -27,6 +22,9 @@ The source code is located in `lib/nanoc3` and is structured in a few
 directories:
 
 * `base` contains the bare essentials necessary for nanoc to function
+  * `source_data` contains raw, uncompiled content that will be compiled
+  * `result_data` contains the compiled content
+  * `compilation` contains the compilation functionality
 * `cli` contains the commandline interface
 * `data_sources` contains the standard data sources ({Nanoc3::DataSource}
   subclasses), such as the filesystem data source
@@ -52,32 +50,42 @@ you want to explore nanoc from a technical perspective.
 
 ## Dependencies
 
-nanoc itself can be used without installing any dependencies. Some
-components, however, do have dependencies:
+nanoc has few dependencies. It is possible to use nanoc programmatically
+without any dependencies at all, but if you want to use nanoc in a proper way,
+you’ll likely need some dependencies:
 
+* The **commandline frontend** depends on `cli`.
 * The **autocompiler** depends on `mime-types` and `rack`.
+* Filters and helpers likely have dependencies on their own too.
+
+If you’re developing for nanoc, such as writing custom filters or helpers, you
+may be interested in the development dependencies:
+
 * For **documentation generation** you’ll need `yard`.
 * For **packaging** you’ll need `rubygems` (1.3 or newer).
-* For **testing** you’ll need `mocha`.
+* For **testing** you’ll need `mocha` and `minitest`.
 
 ## Contributors
 
 (In alphabetical order)
 
+* Ben Armston
 * Colin Barrett
 * Dmitry Bilunov
+* Devon Luke Buchanan
 * Brian Candler
 * Chris Eppstein
+* Felix Hanley
 * Starr Horne
+* Ale Muñoz
 * Nicky Peeters
 * Christian Plessl
 * Šime Ramov
+* Xavier Shay
 * “Soryu”
 * Eric Sunshine
 * Dennis Sutch
 
-Special thanks to Ale Muñoz.
-
 ## Contact
 
 You can reach me at <denis.defreyne@stoneship.org>.

data/doc/yardoc_templates/default/layout/html/footer.erb

@@ -0,0 +1,10 @@
+<%= superb %>
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-15639968-1");
+pageTracker._trackPageview();
+} catch(err) {}</script>

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

@@ -0,0 +1,130 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # Stores checksums for objects in order to be able to detect whether a file
+  # has changed since the last site compilation.
+  #
+  # Old checksums are checksums that were in effect during the previous site
+  # compilation. New checksums are checksums that are in effect right now. If
+  # an old checksum differs from a new checksum, the corresponding object was
+  # modified and will need to be recompiled (along with the objects that
+  # depend on that object).
+  #
+  # @api private
+  class ChecksumStore < ::Nanoc3::Store
+
+    # @option params [Nanoc3::Site] site The site where this checksum store
+    #   belongs to
+    def initialize(params={})
+      super('tmp/checksums', 1)
+
+      @site = params[:site] if params.has_key?(:site)
+
+      @new_checksums = {}
+      @old_checksums = {}
+    end
+
+    # Returns the old checksum for the given object. The object must respond
+    # to `#reference` (for example, {Nanoc3::Item#reference},
+    # {Nanoc3::Layout#reference}, {Nanoc3::CodeSnippet#reference}, …).
+    #
+    # @param [#reference] obj The object for which to fetch the old checksum
+    #
+    # @return [String] The old checksum for the given object
+    def old_checksum_for(obj)
+      @old_checksums[obj.reference]
+    end
+
+    # Returns the new checksum for the given object. The object must respond
+    # to `#reference` (for example, {Nanoc3::Item#reference},
+    # {Nanoc3::Layout#reference}, {Nanoc3::CodeSnippet#reference}, …).
+    #
+    # @param [#reference] obj The object for which to calculate the new
+    #   checksum
+    #
+    # @return [String] The new checksum for the given object
+    def new_checksum_for(obj)
+      @new_checksums[obj.reference] ||= begin
+        checksum_parts = []
+
+        # Calculate content checksum
+        checksum_parts << if obj.respond_to?(:binary?) && obj.binary?
+          Nanoc3::Checksummer.checksum_for_file(obj.raw_filename)
+        elsif obj.respond_to?(:raw_content)
+          Nanoc3::Checksummer.checksum_for_string(obj.raw_content)
+        elsif obj.respond_to?(:data)
+          Nanoc3::Checksummer.checksum_for_string(obj.data)
+        else
+          raise RuntimeError, "Couldn’t figure out how to calculate the " \
+            "content checksum for #{obj.inspect} (tried #raw_filename, " \
+            "#raw_content and #data but none of these worked)"
+        end
+
+        # Calculate attributes checksum
+        if obj.respond_to?(:attributes)
+          attributes = obj.attributes.dup
+          attributes.delete(:file)
+          checksum_parts << Nanoc3::Checksummer.checksum_for_hash(attributes)
+        end
+
+        # Done
+        checksum_parts.join('-')
+      end
+    end
+
+    # Calculates the checksums for all objects in the site. This method should
+    # be used to make the checksum store remember the new checksums for all
+    # given objects; it is probably necessary to call this method before
+    # calling {#store}, to make sure that all new checksums are calculated. It
+    # is not necessary to call this method in order to use
+    # {#new_checksum_for}.
+    #
+    # @return [void]
+    def calculate_all_checksums
+      @site.objects.each { |obj| new_checksum_for(obj) }
+    end
+
+    # @param [#reference] obj
+    #
+    # @return [Boolean] false if either the new or the old checksum for the
+    #   given object is not available, true if both checksums are available
+    def checksums_available?(obj)
+      !!old_checksum_for(obj) && !!new_checksum_for(obj)
+    end
+
+    # @param [#reference] obj
+    #
+    # @return [Boolean] false if the old and new checksums for the given
+    #   object differ, true if they are identical
+    def checksums_identical?(obj)
+      old_checksum_for(obj) == new_checksum_for(obj)
+    end
+
+    # @param [#reference] obj
+    #
+    # @return [Boolean] true if the old and new checksums for the given object
+    #   are available and identical, false otherwise
+    def object_modified?(obj)
+      !checksums_available?(obj) || !checksums_identical?(obj)
+    end
+
+    # @see Nanoc3::Store#store
+    def store
+      calculate_all_checksums
+      super
+    end
+
+  protected
+
+    def data
+      @new_checksums
+    end
+
+    def data=(new_data)
+      @old_checksums = new_data
+    end
+
+  end
+
+end

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

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # Responsible for creating checksums of files. Such checksums are used to
+  # determine whether files have changed between compilations.
+  #
+  # Identical content will always result in the same checksum. Multiple
+  # invocations of the checksum creation methods with the same content or
+  # filename will yield the same result.
+  #
+  # The returned checksum has the property that for two given files with
+  # different content, the returned checksum will be different with a very
+  # high probability. In practice, this boils down to using a secure
+  # cryptographic hash function, such as SHA-1.
+  #
+  # The format of the resulting checksum should not be relied upon. In future
+  # versions of nanoc, this function may use a different method for generating
+  # checksums.
+  #
+  # @api private
+  class Checksummer
+
+    # Returns a checksum for the specified file.
+    #
+    # @param [String] filename The name of the file for which the checksum
+    #   should be calculated
+    #
+    # @return [String] The checksum for the given file
+    def self.checksum_for_file(filename)
+      require 'digest'
+
+      digest = Digest::SHA1.new
+      File.open(filename, 'r') do |io|
+        until io.eof
+          data = io.readpartial(2**10)
+          digest.update(data)
+        end
+      end
+      digest.hexdigest
+    end
+
+    # Returns a checksum for the specified string. 
+    #
+    # @param [String] string The string for which the checksum should be
+    #   calculated
+    #
+    # @return [String] The checksum for the given string
+    def self.checksum_for_string(string)
+      require 'digest'
+
+      digest = Digest::SHA1.new
+      digest.update(string)
+      digest.hexdigest
+    end
+
+    # Returns a checksum for the specified hash. 
+    #
+    # @param [Hash] hash The hash for which the checksum should be calculated.
+    #
+    # @return [String] The checksum for the given hash
+    def self.checksum_for_hash(hash)
+      self.checksum_for_string(YAML.dump(hash))
+    end
+
+  end
+
+end

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

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Nanoc3
+
+  # Represents a cache than can be used to store already compiled content,
+  # to prevent it from being needlessly recompiled.
+  #
+  # @api private
+  class CompiledContentCache < ::Nanoc3::Store
+
+    def initialize
+      super('tmp/compiled_content', 1)
+
+      @cache = {}
+    end
+
+    # Returns the cached compiled content for the given item
+    # representation. This cached compiled content is a hash where the keys
+    # are the snapshot names and the values the compiled content at the
+    # given snapshot.
+    #
+    # @param [Nanoc3::ItemRep] rep The item rep to fetch the content for
+    #
+    # @return [Hash<Symbol,String>] A hash containing the cached compiled
+    #   content for the given item representation
+    def [](rep)
+      item_cache = @cache[rep.item.identifier] || {}
+      item_cache[rep.name]
+    end
+
+    # Sets the compiled content for the given representation.
+    #
+    # @param [Nanoc3::ItemRep] rep The item representation for which to set
+    #   the compiled content
+    #
+    # @param [Hash<Symbol,String>] content A hash containing the compiled
+    #   content of the given representation
+    #
+    # @return [void]
+    def []=(rep, content)
+      @cache[rep.item.identifier] ||= {}
+      @cache[rep.item.identifier][rep.name] = content
+    end
+
+  protected
+
+    def data
+      @cache
+    end
+
+    def data=(new_data)
+      @cache = new_data
+    end
+
+  end
+
+end