nanoc3 3.2.0a3 → 3.2.0a4

data/test/filters/test_redcarpet.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::RedcarpetTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_find
+    refute Nanoc3::Filter.named(:redcarpet).nil?
+  end
+
+  def test_filter
+    if_have 'redcarpet' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Redcarpet.new
+
+      # Run filter
+      result = filter.run("> Quote")
+      assert_match(/<blockquote>\s*<p>Quote<\/p>\s*<\/blockquote>/, result)
+    end
+  end
+
+  def test_with_extensions
+    if_have 'redcarpet' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Redcarpet.new
+
+      # Run filter
+      input           = "The quotation 'marks' sure make this look sarcastic!"
+      output_expected = /The quotation &lsquo;marks&rsquo; sure make this look sarcastic!/
+      output_actual   = filter.run(input, :options => [ :smart ])
+      assert_match(output_expected, output_actual)
+    end
+  end
+
+  def test_html_by_default
+    if_have 'redcarpet' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Redcarpet.new
+
+      # Run filter
+      input           = "![Alt](/path/to/img 'Title')"
+      output_expected = %r{<img src="/path/to/img" alt="Alt" title="Title">}
+      output_actual   = filter.run(input)
+      assert_match(output_expected, output_actual)
+    end
+  end
+
+  def test_xhtml_if_requested
+    if_have 'redcarpet' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Redcarpet.new
+
+      # Run filter
+      input           = "![Alt](/path/to/img 'Title')"
+      output_expected = %r{<img src="/path/to/img" alt="Alt" title="Title"/>}
+      output_actual   = filter.run(input, :options => [ :xhtml ])
+      assert_match(output_expected, output_actual)
+    end
+  end
+
+end

data/test/filters/test_redcloth.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::RedClothTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_filter
+    if_have 'redcloth' do
+      # Get filter
+      filter = ::Nanoc3::Filters::RedCloth.new
+
+      # Run filter
+      result = filter.run("h1. Foo")
+      assert_equal("<h1>Foo</h1>", result)
+    end
+  end
+
+  def test_filter_with_options
+    if_have 'redcloth' do
+      # Get filter
+      filter = ::Nanoc3::Filters::RedCloth.new
+
+      # Run filter without options
+      result = filter.run("I am a member of SPECTRE.")
+      assert_equal("<p>I am a member of <span class=\"caps\">SPECTRE</span>.</p>", result)
+
+      # Run filter with options
+      result = filter.run("I am a member of SPECTRE.", :no_span_caps => true)
+      assert_equal("<p>I am a member of SPECTRE.</p>", result)
+    end
+  end
+
+end

data/test/filters/test_relativize_paths.rb

@@ -0,0 +1,231 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::RelativizePathsTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_filter_html_with_double_quotes
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[<a href="/foo">foo</a>]
+    expected_content = %[<a href="../..">foo</a>]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :html)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_html_with_single_quotes
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[<a href='/foo'>foo</a>]
+    expected_content = %[<a href='../..'>foo</a>]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :html)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_html_without_quotes
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[<a href=/foo>foo</a>]
+    expected_content = %[<a href=../..>foo</a>]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :html)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_html_multiple
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[<a href="/foo">foo</a> <a href="/bar">bar</a>]
+    expected_content = %[<a href="../..">foo</a> <a href="../../../bar">bar</a>]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :html)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_html_outside_tag
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[stuff href="/foo" more stuff]
+    expected_content = %[stuff href="/foo" more stuff]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :html)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_html_root
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/woof/meow/')
+    end
+
+    # Set content
+    raw_content      = %[<a href="/">foo</a>]
+    expected_content = %[<a href="../../">foo</a>]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :html)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_implicit
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Test
+    assert_raises(RuntimeError) do
+      filter.run("moo")
+    end
+  end
+
+  def test_filter_css_with_double_quotes
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[background: url("/foo/bar/background.png");]
+    expected_content = %[background: url("../background.png");]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :css)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_css_with_single_quotes
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[background: url('/foo/bar/background.png');]
+    expected_content = %[background: url('../background.png');]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :css)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_css_without_quotes
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[background: url(/foo/bar/background.png);]
+    expected_content = %[background: url(../background.png);]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :css)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_css_multiple
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/foo/bar/baz/')
+    end
+
+    # Set content
+    raw_content      = %[background: url(/foo/bar/a.png) url(/foo/bar/b.png);]
+    expected_content = %[background: url(../a.png) url(../b.png);]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :css)
+    assert_equal(expected_content, actual_content)
+  end
+
+  def test_filter_css_root
+    # It is probably a bit weird to have “url(/)” in CSS, but I’ve made a
+    # test case for this situation anyway. Can’t hurt…
+
+    # Create filter with mock item
+    filter = Nanoc3::Filters::RelativizePaths.new
+
+    # Mock item
+    filter.instance_eval do
+      @item_rep = MiniTest::Mock.new
+      @item_rep.expect(:path, '/woof/meow/')
+    end
+
+    # Set content
+    raw_content      = %[background: url(/);]
+    expected_content = %[background: url(../../);]
+
+    # Test
+    actual_content = filter.run(raw_content, :type => :css)
+    assert_equal(expected_content, actual_content)
+  end
+
+end

data/test/filters/test_rubypants.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::RubyPantsTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_filter
+    if_have 'rubypants' do
+      # Get filter
+      filter = ::Nanoc3::Filters::RubyPants.new
+
+      # Run filter
+      result = filter.run("Wait---what?")
+      assert_equal("Wait&#8212;what?", result)
+    end
+  end
+
+end

data/test/filters/test_sass.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::SassTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_filter
+    if_have 'sass' do
+      # Get filter
+      filter = ::Nanoc3::Filters::Sass.new({ :foo => 'bar' })
+
+      # Run filter
+      result = filter.run(".foo #bar\n  color: #f00")
+      assert_match(/.foo\s+#bar\s*\{\s*color:\s+(red|#f00);?\s*\}/, result)
+    end
+  end
+
+  def test_filter_with_params
+    if_have 'sass' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Sass.new({ :foo => 'bar' })
+
+      # Check with compact
+      result = filter.run(".foo #bar\n  color: #f00", :style => 'compact')
+      assert_match(/^\.foo #bar[\s\n]*\{[\s\n]*color:\s*(red|#f00);?[\s\n]*\}/m, result)
+
+      # Check with compressed
+      result = filter.run(".foo #bar\n  color: #f00", :style => 'compressed')
+      assert_match(/^\.foo #bar[\s\n]*\{[\s\n]*color:\s*(red|#f00);?[\s\n]*\}/m, result)
+    end
+  end
+
+  def test_filter_error
+    if_have 'sass' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Sass.new({ :foo => 'bar' })
+
+      # Run filter
+      raised = false
+      begin
+        filter.run('$*#&!@($')
+      rescue Sass::SyntaxError => e
+        assert_match ':1', e.backtrace[0]
+        raised = true
+      end
+      assert raised
+    end
+  end
+
+  def test_filter_can_import_external_files
+    if_have 'sass' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Sass.new(:items => [])
+
+      # Create sample file
+      File.open('moo.sass', 'w') { |io| io.write "body\n  color: red" }
+
+      # Run filter
+      filter.run('@import moo')
+    end
+  end
+
+  def test_filter_can_import_relative_files
+    if_have 'sass' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Sass.new(:items => [])
+
+      # Create sample file
+      File.open('moo.sass', 'w') { |io| io.write %Q{@import subdir/relative} }
+      FileUtils.mkdir_p("subdir")
+      File.open('subdir/relative.sass', 'w') { |io| io.write "body\n  color: red" }
+
+      # Run filter
+      filter.run('@import moo')
+    end
+  end
+
+  def test_filter_will_skip_items_without_filename
+    if_have 'sass' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Sass.new(:items => [ Nanoc3::Item.new('blah', {}, '/blah/') ])
+
+      # Create sample file
+      File.open('moo.sass', 'w') { |io| io.write "body\n  color: red" }
+
+      # Run filter
+      filter.run('@import moo')
+    end
+  end
+  
+  def test_css_imports_work
+    if_have 'sass' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Sass.new(:items => [ Nanoc3::Item.new('blah', {}, '/blah/') ])
+
+      # Run filter
+      filter.run('@import moo.css')
+    end
+  end
+
+end

data/test/filters/test_slim.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::SlimTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_filter
+    if_have 'slim' do
+      # Create filter
+      filter = ::Nanoc3::Filters::Slim.new({ :rabbit => 'The rabbit is on the branch.' })
+
+      # Run filter (no assigns)
+      result = filter.run('html')
+      assert_match(/<html>.*<\/html>/, result)
+
+      # Run filter (assigns without @)
+      result = filter.run('p = rabbit')
+      assert_equal("<p>The rabbit is on the branch.</p>", result)
+
+      # Run filter (assigns with @)
+      result = filter.run('p = @rabbit')
+      assert_equal("<p>The rabbit is on the branch.</p>", result)
+    end
+  end
+
+  def test_filter_with_yield
+    if_have 'slim' do
+      filter = ::Nanoc3::Filters::Slim.new({ :content => 'The rabbit is on the branch.' })
+
+      result = filter.run('p = yield')
+      assert_equal("<p>The rabbit is on the branch.</p>", result)
+    end
+  end
+
+end

data/test/filters/test_typogruby.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Filters::TypogrubyTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_filter
+    if_have 'typogruby' do
+      # Get filter
+      filter = ::Nanoc3::Filters::Typogruby.new
+
+      # Run filter
+      a = '"Typogruby makes HTML look smarter &amp; better, don\'t you think?"'
+      b = '<span class="dquo">&#8220;</span>Typogruby makes <span class="caps">HTML</span> look smarter <span class="amp">&amp;</span> better, don&#8217;t you&nbsp;think?&#8221;'
+      result = filter.run(a)
+      assert_equal(b, result)
+    end
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,161 @@
+# encoding: utf-8
+
+# Load unit testing stuff
+begin
+  require 'minitest/unit'
+  require 'minitest/spec'
+  require 'minitest/mock'
+  require 'mocha'
+rescue => e
+  $stderr.puts "To run the nanoc unit tests, you need minitest and mocha."
+  raise e
+end
+
+# Load nanoc
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'nanoc3'
+require 'nanoc3/cli'
+require 'nanoc3/tasks'
+
+# Load miscellaneous requirements
+require 'stringio'
+
+module Nanoc3::TestHelpers
+
+  def if_have(*libs)
+    libs.each do |lib|
+      begin
+        require lib
+      rescue LoadError
+        skip "requiring #{lib} failed"
+        return
+      end
+    end
+
+    yield
+  end
+
+  def if_implemented
+    begin
+      yield
+    rescue NotImplementedError, NameError
+      skip $!
+      return
+    end
+  end
+
+  def with_site(params={})
+    # Build site name
+    site_name = params[:name]
+    if site_name.nil?
+      @site_num ||= 0
+      site_name = "site-#{@site_num}"
+      @site_num += 1
+    end
+
+    # Build rules
+    rules_content = <<EOS
+compile '*' do
+  {{compilation_rule_content}}
+end
+
+route '*' do
+  if item.binary?
+    item.identifier.chop + '.' + item[:extension]
+  else
+    item.identifier + 'index.html'
+  end
+end
+
+layout '*', :erb
+EOS
+    rules_content.gsub!('{{compilation_rule_content}}', params[:compilation_rule_content] || '')
+
+    # Create site
+    unless File.directory?(site_name)
+      FileUtils.mkdir_p(site_name)
+      FileUtils.cd(site_name) do
+        FileUtils.mkdir_p('content')
+        FileUtils.mkdir_p('layouts')
+        FileUtils.mkdir_p('lib')
+        FileUtils.mkdir_p('output')
+
+        if params[:has_layout]
+          File.open('layouts/default.html', 'w') do |io|
+            io.write('... <%= @yield %> ...')
+          end
+        end
+
+        File.open('config.yaml', 'w') { |io| io.write('stuff: 12345') }
+        File.open('Rules', 'w') { |io| io.write(rules_content) }
+      end
+    end
+
+    # Yield site
+    FileUtils.cd(site_name) do
+      yield Nanoc3::Site.new('.')
+    end
+  end
+
+  def setup
+    # Clean up
+    GC.start
+
+    # Go quiet
+    unless ENV['QUIET'] == 'false'
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+    end
+
+    # Enter tmp
+    FileUtils.mkdir_p('tmp')
+    FileUtils.cd('tmp')
+  end
+
+  def teardown
+    # Exit tmp
+    FileUtils.cd('..')
+    FileUtils.rm_rf('tmp')
+
+    # Go unquiet
+    unless ENV['QUIET'] == 'false'
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+  end
+
+  # Adapted from http://github.com/lsegal/yard-examples/tree/master/doctest
+  def assert_examples_correct(object)
+    P(object).tags(:example).each do |example|
+      begin
+        # Get input and output
+        parts = example.text.split(/# ?=>/).map { |s| s.strip }
+        code             = parts[0].strip
+        expected_out_raw = parts[1].strip
+
+        # Evaluate
+        expected_out     = eval(parts[1])
+        actual_out       = instance_eval("#{code}")
+      rescue Exception => e
+        e.message << " (code: #{code}; expected output: #{expected_out_raw})"
+        raise e
+      end
+
+      assert_equal expected_out, actual_out,
+        "Incorrect example: #{code}"
+    end
+  end
+
+  def assert_contains_exactly(expected, actual)
+    assert_equal expected.size, actual.size,
+      'Expected %s to be of same size as %s' % [actual.inspect, expected.inspect]
+    remaining = actual.dup.to_a
+    expected.each do |e|
+      index = remaining.index(e)
+      remaining.delete_at(index) if index
+    end
+    assert remaining.empty?,
+      'Expected %s to contain all the elements of %s' % [actual.inspect, expected.inspect]
+  end
+
+end