nanoc3 3.2.0a3 → 3.2.0a4

data/lib/nanoc3/filters.rb

@@ -17,10 +17,13 @@ module Nanoc3::Filters
   autoload 'Rainpress',       'nanoc3/filters/rainpress'
   autoload 'RDiscount',       'nanoc3/filters/rdiscount'
   autoload 'RDoc',            'nanoc3/filters/rdoc'
+  autoload 'Redcarpet',       'nanoc3/filters/redcarpet'
   autoload 'RedCloth',        'nanoc3/filters/redcloth'
   autoload 'RelativizePaths', 'nanoc3/filters/relativize_paths'
   autoload 'RubyPants',       'nanoc3/filters/rubypants'
   autoload 'Sass',            'nanoc3/filters/sass'
+  autoload 'Slim',            'nanoc3/filters/slim'
+  autoload 'Typogruby',       'nanoc3/filters/typogruby'
 
   Nanoc3::Filter.register '::Nanoc3::Filters::AsciiDoc',        :asciidoc
   Nanoc3::Filter.register '::Nanoc3::Filters::BlueCloth',       :bluecloth
@@ -37,9 +40,12 @@ module Nanoc3::Filters
   Nanoc3::Filter.register '::Nanoc3::Filters::Rainpress',       :rainpress
   Nanoc3::Filter.register '::Nanoc3::Filters::RDiscount',       :rdiscount
   Nanoc3::Filter.register '::Nanoc3::Filters::RDoc',            :rdoc
+  Nanoc3::Filter.register '::Nanoc3::Filters::Redcarpet',       :redcarpet
   Nanoc3::Filter.register '::Nanoc3::Filters::RedCloth',        :redcloth
   Nanoc3::Filter.register '::Nanoc3::Filters::RelativizePaths', :relativize_paths
   Nanoc3::Filter.register '::Nanoc3::Filters::RubyPants',       :rubypants
   Nanoc3::Filter.register '::Nanoc3::Filters::Sass',            :sass
+  Nanoc3::Filter.register '::Nanoc3::Filters::Slim',            :slim
+  Nanoc3::Filter.register '::Nanoc3::Filters::Typogruby',       :typogruby
 
 end

data/lib/nanoc3/helpers/blogging.rb

@@ -8,15 +8,15 @@ module Nanoc3::Helpers
   # This helper has a few requirements. First, all blog articles should have
   # the following attributes:
   #
-  # * `kind` — Set to `"article"`
+  # * `kind` - Set to `"article"`
   #
-  # * `created_at` — The article’s publication timestamp
+  # * `created_at` - The article's publication timestamp
   #
   # Some functions in this blogging helper, such as the {#atom_feed} function,
   # require additional attributes to be set; these attributes are described in
   # the documentation for these functions.
   #
-  # All “time” item attributes, site configuration attributes or method
+  # All "time" item attributes, site configuration attributes or method
   # parameters can either be a `Time` instance or a string in any format
   # parseable by `Time.parse`.
   #
@@ -37,7 +37,6 @@ module Nanoc3::Helpers
     #
     # @return [Array] A sorted array containing all articles
     def sorted_articles
-      require 'time'
       articles.sort_by do |a|
         attribute_to_time(a[:created_at])
       end.reverse
@@ -48,53 +47,53 @@ module Nanoc3::Helpers
     #
     # The following attributes must be set on blog articles:
     #
-    # * `title` — The title of the blog post
+    # * `title` - The title of the blog post
     #
     # * `kind` and `created_at` (described above)
     #
     # The following attributes can optionally be set on blog articles to
     # change the behaviour of the Atom feed:
     #
-    # * `excerpt` — An excerpt of the article, which is usually only a few
+    # * `excerpt` - An excerpt of the article, which is usually only a few
     #   lines long.
     #
-    # * `custom_path_in_feed` — The path that will be used instead of the
+    # * `custom_path_in_feed` - The path that will be used instead of the
     #   normal path in the feed. This can be useful when including
     #   non-outputted items in a feed; such items could have their custom feed
     #   path set to the blog path instead, for example.
     #
-    # * `custom_url_in_feed` — The url that will be used instead of the
-    #   normal url in the feed (generated from the site’s base url + the item
-    #   rep’s path). This can be useful when building a link-blog where the
+    # * `custom_url_in_feed` - The url that will be used instead of the
+    #   normal url in the feed (generated from the site's base url + the item
+    #   rep's path). This can be useful when building a link-blog where the
     #   URL of article is a remote location.
     #
-    # * `updated_at` — The time when the article was last modified. If this
+    # * `updated_at` - The time when the article was last modified. If this
     #   attribute is not present, the `created_at` attribute will be used as
     #   the time when the article was last modified.
     #
     # The site configuration will need to have the following attributes:
     #
-    # * `base_url` — The URL to the site, without trailing slash. For
-    #   example, if the site is at “http://example.com/”, the `base_url`
-    #   would be “http://example.com”.
+    # * `base_url` - The URL to the site, without trailing slash. For
+    #   example, if the site is at "http://example.com/", the `base_url`
+    #   would be "http://example.com".
     #
     # The feed item will need to know about the feed title, the feed author
     # name, and the URI corresponding to the author. These can be specified
     # using parameters, as attributes in the feed item, or in the site
     # configuration.   
     #
-    # * `title` — The title of the feed, which is usually also the title of
+    # * `title` - The title of the feed, which is usually also the title of
     #   the blog.
     #
-    # * `author_name` — The name of the item’s author.
+    # * `author_name` - The name of the item's author.
     #
-    # * `author_uri` — The URI for the item’s author, such as the author’s
+    # * `author_uri` - The URI for the item's author, such as the author's
     #   web site URL.
     #
     # The feed item can have the following optional attributes:
     #
-    # * `feed_url` — The custom URL of the feed. This can be useful when the
-    #   private feed URL shouldn’t be exposed; for example, when using
+    # * `feed_url` - The custom URL of the feed. This can be useful when the
+    #   private feed URL shouldn't be exposed; for example, when using
     #   FeedBurner this would be set to the public FeedBurner URL.
     #
     # To construct a feed, create a new item and make sure that it is
@@ -133,19 +132,18 @@ module Nanoc3::Helpers
     #   A proc that returns the excerpt of the given article, passed as a
     #   parameter. This function should return nil if there is no excerpt.
     #
-    # @option params [String] :title The feed’s title, if it is not given in
+    # @option params [String] :title The feed's title, if it is not given in
     #   the item attributes.
     #
-    # @option params [String] :author_name The name of the feed’s author, if
+    # @option params [String] :author_name The name of the feed's author, if
     #   it is not given in the item attributes.
     #
-    # @option params [String] :author_uri The URI of the feed’s author, if it
+    # @option params [String] :author_uri The URI of the feed's author, if it
     #   is not given in the item attributes.
     #
     # @return [String] The generated feed content
     def atom_feed(params={})
       require 'builder'
-      require 'time'
 
       # Extract parameters
       limit             = params[:limit] || 5
@@ -289,15 +287,13 @@ module Nanoc3::Helpers
     # Returns an URI containing an unique ID for the given item. This will be
     # used in the Atom feed to uniquely identify articles. These IDs are
     # created using a procedure suggested by Mark Pilgrim and described in his
-    # [“How to make a good ID in Atom” blog post]
+    # ["How to make a good ID in Atom" blog post]
     # (http://diveintomark.org/archives/2004/05/28/howto-atom-id).
     #
     # @param [Nanoc3::Item] item The item for which to create an atom tag
     #
     # @return [String] The atom tag for the given item
     def atom_tag_for(item)
-      require 'time'
-
       hostname, base_dir = %r{^.+?://([^/]+)(.*)$}.match(@site.config[:base_url])[1..2]
 
       formatted_date = attribute_to_time(item[:created_at]).to_iso8601_date

data/lib/nanoc3/helpers/rendering.rb

@@ -81,7 +81,7 @@ module Nanoc3::Helpers
       }.merge(other_assigns)
 
       # Get filter name
-      filter_name, filter_args = @site.compiler.filter_for_layout(layout)
+      filter_name, filter_args = @site.compiler.rules_collection.filter_for_layout(layout)
       raise Nanoc3::Errors::CannotDetermineFilter.new(layout.identifier) if filter_name.nil?
 
       # Get filter class

data/lib/nanoc3/helpers/xml_sitemap.rb

@@ -29,10 +29,19 @@ module Nanoc3::Helpers
     #   if the site is at "http://example.com/", the `base_url` would be
     #   "http://example.com".
     #
+    # @example Excluding binary items from the sitemap
+    #
+    #   <%= xml_sitemap :items => @items.reject{ |i| i[:is_hidden] || i[:binary] } %>
+    #
+    # @option params [Array] :items A list of items to include in the sitemap
+    #
     # @return [String] The XML sitemap
-    def xml_sitemap
+    def xml_sitemap(params={})
       require 'builder'
 
+      # Extract parameters
+      items = params[:items] || @items.reject { |i| i[:is_hidden] }
+
       # Create builder
       buffer = ''
       xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
@@ -46,7 +55,7 @@ module Nanoc3::Helpers
       xml.instruct!
       xml.urlset(:xmlns => 'http://www.google.com/schemas/sitemap/0.84') do
         # Add item
-        @items.reject { |i| i[:is_hidden] }.each do |item|
+        items.each do |item|
           item.reps.reject { |r| r.raw_path.nil? }.each do |rep|
             xml.url do
               xml.loc         @site.config[:base_url] + rep.path

data/lib/nanoc3.rb

@@ -3,13 +3,34 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.2.0a3'
+  VERSION = '3.2.0a4'
 
 end
 
-# Load requirements
-require 'yaml'
+# 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'
 require 'fileutils'
+require 'forwardable'
+require 'pathname'
+require 'pstore'
+require 'set'
+require 'tempfile'
+require 'thread'
+require 'time'
+require 'yaml'
 
 # Load nanoc
 require 'nanoc3/base'

data/nanoc3.gemspec

@@ -13,12 +13,13 @@ Gem::Specification.new do |s|
   s.author = 'Denis Defreyne'
   s.email  = 'denis.defreyne@stoneship.org'
 
-  s.files              = Dir['[A-Z]*'] + Dir['lib/**/*'] + Dir['doc/yardoc_templates/**/*'] + [ 'nanoc3.gemspec' ]
-  s.default_executable = 'nanoc3'
+  s.files              = Dir['[A-Z]*'] +
+                         Dir['doc/yardoc_templates/**/*'] +
+                         Dir['{bin,lib,tasks,test}/**/*'] +
+                         [ 'nanoc3.gemspec', '.gemtest' ]
   s.executables        = [ 'nanoc3' ]
   s.require_paths      = [ 'lib' ]
 
-  s.has_rdoc         = 'yard'
   s.rdoc_options     = [ '--main', 'README.md' ]
   s.extra_rdoc_files = [ 'ChangeLog', 'LICENSE', 'README.md', 'NEWS.md' ]
 

data/tasks/clean.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'rake/clean'
+
+CLEAN.include([
+  'coverage',
+  'doc',
+  'tmp'
+])
+
+CLOBBER.include([ 'pkg' ])

data/tasks/doc.rake

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |yard|
+  yard.files   = Dir['lib/**/*.rb']
+  yard.options = [
+    '--markup',        'markdown',
+    '--readme',        'README.md',
+    '--files',         'NEWS.md,LICENSE',
+    '--output-dir',    'doc/yardoc',
+    '--template-path', 'doc/yardoc_templates'
+  ]
+end

data/tasks/test.rake

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'minitest/unit'
+
+test = namespace :test do
+
+  # test:all
+  desc 'Run all tests'
+  task :all do
+    ENV['QUIET'] ||= 'true'
+
+    $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+    MiniTest::Unit.autorun
+
+    test_files = Dir['test/**/*_spec.rb'] + Dir['test/**/test_*.rb']
+    test_files.each { |f| require f }
+  end
+
+  # test:...
+  %w( base cli data_sources extra filters helpers tasks ).each do |dir|
+    desc "Run all #{dir} tests"
+    task dir.to_sym do |task|
+      ENV['QUIET'] ||= 'true'
+
+      $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+      MiniTest::Unit.autorun
+
+      test_files = Dir["test/#{dir}/**/*_spec.rb"] + Dir["test/#{dir}/**/test_*.rb"]
+      test_files.each { |f| require f }
+    end
+  end
+
+end
+
+desc 'Alias for test:all'
+task :test => [ :'test:all' ]

data/test/base/core_ext/array_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'Array#symbolize_keys' do
+
+  it 'should convert keys to symbols' do
+    array_old = [ :abc, 'xyz', { 'foo' => 'bar', :baz => :qux } ]
+    array_new = [ :abc, 'xyz', { :foo  => 'bar', :baz => :qux } ]
+    array_old.symbolize_keys.must_equal array_new
+  end
+
+end
+
+describe 'Array#stringify_keys' do
+
+  it 'should convert keys to strings' do
+    array_old = [ :abc, 'xyz', { :foo  => 'bar', 'baz' => :qux } ]
+    array_new = [ :abc, 'xyz', { 'foo' => 'bar', 'baz' => :qux } ]
+    array_old.stringify_keys.must_equal array_new
+  end
+
+end
+
+describe 'Array#freeze_recursively' do
+
+  it 'should prevent first-level elements from being modified' do
+    array = [ :a, [ :b, :c ], :d ]
+    array.freeze_recursively
+
+    raised = false
+    begin
+      array[0] = 123
+    rescue => e
+      raised = true
+      assert_match /^can't modify frozen /, e.message
+    end
+    assert raised
+  end
+
+  it 'should prevent second-level elements from being modified' do
+    array = [ :a, [ :b, :c ], :d ]
+    array.freeze_recursively
+
+    raised = false
+    begin
+      array[1][0] = 123
+    rescue => e
+      raised = true
+      assert_match /^can't modify frozen /, e.message
+    end
+    assert raised
+  end
+
+end

data/test/base/core_ext/hash_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'Hash#symbolize_keys' do
+
+  it 'should convert keys to symbols' do
+    hash_old = { 'foo' => 'bar' }
+    hash_new = { :foo  => 'bar' }
+    hash_old.symbolize_keys.must_equal hash_new
+  end
+
+end
+
+describe 'Hash#stringify_keys' do
+
+  it 'should leave strings as strings' do
+    hash_old = { 'foo' => 'bar' }
+    hash_new = { 'foo' => 'bar' }
+    hash_old.stringify_keys.must_equal hash_new
+  end
+
+  it 'should convert symbols to strings' do
+    hash_old = { :foo  => 'bar' }
+    hash_new = { 'foo' => 'bar' }
+    hash_old.stringify_keys.must_equal hash_new
+  end
+
+  it 'should convert integers to strings' do
+    hash_old = { 123   => 'bar' }
+    hash_new = { '123' => 'bar' }
+    hash_old.stringify_keys.must_equal hash_new
+  end
+
+  it 'should convert nil to an empty string' do
+    hash_old = { nil => 'bar' }
+    hash_new = { ''  => 'bar' }
+    hash_old.stringify_keys.must_equal hash_new
+  end
+
+end
+
+describe 'Hash#freeze_recursively' do
+
+  it 'should prevent first-level elements from being modified' do
+    hash = { :a => { :b => :c } }
+    hash.freeze_recursively
+
+    raised = false
+    begin
+      hash[:a] = 123
+    rescue => e
+      raised = true
+      assert_match /^can't modify frozen /, e.message
+    end
+    assert raised
+  end
+
+  it 'should prevent second-level elements from being modified' do
+    hash = { :a => { :b => :c } }
+    hash.freeze_recursively
+
+    raised = false
+    begin
+      hash[:a][:b] = 123
+    rescue => e
+      raised = true
+      assert_match /^can't modify frozen /, e.message
+    end
+    assert raised
+  end
+
+end
+
+describe 'Hash#checksum' do
+
+  it 'should work' do
+    expectation = 'fec9ae7163e8b8d57a15d51821d2c68d4a6bb169'
+    { :foo => 123 }.checksum.must_equal expectation
+  end
+
+end

data/test/base/core_ext/pathname_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'Pathname#checksum' do
+
+  it 'should work on empty files' do
+    begin
+      FileUtils.mkdir_p('tmp')
+      File.open('tmp/myfile', 'w') { |io| io.write('') }
+      pathname = Pathname.new('tmp/myfile')
+      pathname.checksum.must_equal 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
+    ensure
+      FileUtils.rm_rf('tmp')
+    end
+  end
+
+  it 'should work on all files' do
+    begin
+      FileUtils.mkdir_p('tmp')
+      File.open('tmp/myfile', 'w') { |io| io.write('abc') }
+      pathname = Pathname.new('tmp/myfile')
+      pathname.checksum.must_equal 'a9993e364706816aba3e25717850c26c9cd0d89d'
+    ensure
+      FileUtils.rm_rf('tmp')
+    end
+  end
+
+end

data/test/base/core_ext/string_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'String#cleaned_identifier' do
+
+  it 'should not convert already clean paths' do
+    '/foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should prepend slash if necessary' do
+    'foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should append slash if necessary' do
+    '/foo/bar'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should remove double slashes at start' do
+    '//foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should remove double slashes at end' do
+    '/foo/bar//'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+end
+
+describe 'String#checksum' do
+
+  it 'should work on empty strings' do
+    ''.checksum.must_equal 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
+  end
+
+  it 'should work on all strings' do
+    'abc'.checksum.must_equal 'a9993e364706816aba3e25717850c26c9cd0d89d'
+  end
+
+end

data/test/base/test_checksum_store.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::ChecksumStoreTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_get_with_existing_object
+    require 'pstore'
+
+    # Create store
+    FileUtils.mkdir_p('tmp')
+    pstore = PStore.new('tmp/checksums')
+    pstore.transaction do
+      pstore[:data] = { [ :item, '/moo/' ] => 'zomg' }
+      pstore[:version] = 1
+    end
+
+    # Check
+    store = Nanoc3::ChecksumStore.new
+    store.load
+    obj = Nanoc3::Item.new('Moo?', {}, '/moo/')
+    assert_equal 'zomg', store[obj]
+  end
+
+  def test_get_with_nonexistant_object
+    store = Nanoc3::ChecksumStore.new
+    store.load
+
+    # Check
+    obj = Nanoc3::Item.new('Moo?', {}, '/animals/cow/')
+    new_checksum = 'Moo?'.checksum + '-' + {}.checksum
+    assert_equal nil, store[obj]
+  end
+
+end

data/test/base/test_code_snippet.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CodeSnippetTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_load
+    # Initialize
+    $complete_insane_parrot = 'meow'
+
+    # Create code and load it
+    code_snippet = Nanoc3::CodeSnippet.new("$complete_insane_parrot = 'woof'", 'parrot.rb')
+    code_snippet.load
+
+    # Ensure code is loaded
+    assert_equal('woof', $complete_insane_parrot)
+  end
+
+  def test_load_with_toplevel_binding
+    # Initialize
+    @foo = 'meow'
+
+    # Create code and load it
+    code_snippet = Nanoc3::CodeSnippet.new("@foo = 'woof'", 'dog.rb')
+    code_snippet.load
+
+    # Ensure binding is correct
+    assert_equal('meow', @foo)
+  end
+
+end