nanoc3 3.2.0a3 → 3.2.0a4

data/test/base/test_site.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::SiteTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_initialize_with_dir_without_config_yaml
+    assert_raises(Errno::ENOENT) do
+      site = Nanoc3::Site.new('.')
+    end
+  end
+
+  def test_initialize_with_dir_with_config_yaml
+    File.open('config.yaml', 'w') { |io| io.write('output_dir: public_html') }
+    site = Nanoc3::Site.new('.')
+    assert_equal 'public_html', site.config[:output_dir]
+  end
+
+  def test_initialize_with_config_hash
+    site = Nanoc3::Site.new(:foo => 'bar')
+    assert_equal 'bar', site.config[:foo]
+  end
+
+  def test_initialize_with_incomplete_data_source_config
+    site = Nanoc3::Site.new(:data_sources => [ { :type => 'foo', :items_root => '/bar/' } ])
+    assert_equal('foo',   site.config[:data_sources][0][:type])
+    assert_equal('/bar/', site.config[:data_sources][0][:items_root])
+    assert_equal('/',     site.config[:data_sources][0][:layouts_root])
+    assert_equal({},      site.config[:data_sources][0][:config])
+  end
+
+  def test_load_rules_with_existing_rules_file
+    # Mock DSL
+    dsl = mock
+    dsl.expects(:compile).with('*')
+
+    # Create site
+    site = Nanoc3::Site.new({})
+    site.compiler.rules_collection.expects(:dsl).returns(dsl)
+
+    # Create rules file
+    File.open('Rules', 'w') do |io|
+      io.write <<-EOF
+compile '*' do
+  # ... do nothing ...
+end
+EOF
+    end
+
+    # Load rules
+    site.compiler.rules_collection.load
+  end
+
+  def test_load_data_sources_first
+    # Create site
+    Nanoc3::CLI::Base.new.run([ 'create_site', 'bar' ])
+
+    FileUtils.cd('bar') do
+      # Create data source code
+      File.open('lib/some_data_source.rb', 'w') do |io|
+        io.write "class FooDataSource < Nanoc3::DataSource\n"
+        io.write "  identifier :site_test_foo\n"
+        io.write "  def items ; [ Nanoc3::Item.new('content', {}, '/foo/') ] ; end\n"
+        io.write "end\n"
+      end
+
+      # Update configuration
+      File.open('config.yaml', 'w') do |io|
+        io.write "data_sources:\n"
+        io.write "  - type: site_test_foo"
+      end
+
+      # Create site
+      site = Nanoc3::Site.new('.')
+      site.load_data
+
+      # Check
+      assert_equal 1,       site.data_sources.size
+      assert_equal '/foo/', site.items[0].identifier
+    end
+  end
+
+end
+
+describe 'Nanoc3::Site#initialize' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should merge default config' do
+    site = Nanoc3::Site.new(:foo => 'bar')
+    site.config[:foo].must_equal 'bar'
+    site.config[:output_dir].must_equal 'output'
+  end
+
+  it 'should not raise under normal circumstances' do
+    Nanoc3::Site.new({})
+  end
+
+  it 'should not raise for non-existant output directory' do
+    Nanoc3::Site.new(:output_dir => 'fklsdhailfdjalghlkasdflhagjskajdf')
+  end
+
+  it 'should not raise for unknown data sources' do
+    proc do
+      Nanoc3::Site.new(:data_source => 'fklsdhailfdjalghlkasdflhagjskajdf')
+    end
+  end
+
+end
+
+describe 'Nanoc3::Site#compiler' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should not raise under normal circumstances' do
+    site = Nanoc3::Site.new({})
+    site.compiler
+  end
+
+end
+
+describe 'Nanoc3::Site#data_sources' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should not raise for known data sources' do
+    site = Nanoc3::Site.new({})
+    site.data_sources
+  end
+
+  it 'should raise for unknown data sources' do
+    proc do
+      site = Nanoc3::Site.new(
+        :data_sources => [
+          { :type => 'fklsdhailfdjalghlkasdflhagjskajdf' }
+        ]
+      )
+      site.data_sources
+    end.must_raise Nanoc3::Errors::UnknownDataSource
+  end
+
+end

data/test/cli/commands/test_compile.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::CompileTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_stub
+  end
+
+end

data/test/cli/commands/test_create_item.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::CreateItemTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_stub
+  end
+
+end

data/test/cli/commands/test_create_layout.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::CreateLayoutTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_can_compile_new_layout
+    Nanoc3::CLI::Base.new.run([ 'create_site', 'foo' ])
+
+    FileUtils.cd('foo') do
+      # Create new layout
+      Nanoc3::CLI::Base.new.run([ 'create_layout', 'moo' ])
+
+      # Makes rules use new layout
+      rules_raw = File.read('Rules')
+      File.open('Rules', 'w') do |io|
+        io.write rules_raw.sub("layout 'default'", "layout 'moo'")
+      end
+
+      site = Nanoc3::Site.new('.')
+      site.load_data
+      site.compile
+    end
+  end
+
+end

data/test/cli/commands/test_create_site.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::CreateSiteTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_create_site_with_existing_name
+    Nanoc3::CLI::Base.new.run([ 'create_site', 'foo' ])
+    assert_raises(SystemExit) { Nanoc3::CLI::Base.new.run([ 'create_site', 'foo' ]) }
+  end
+
+  def test_can_compile_new_site
+    Nanoc3::CLI::Base.new.run([ 'create_site', 'foo' ])
+
+    FileUtils.cd('foo') do
+      site = Nanoc3::Site.new('.')
+      site.load_data
+      site.compile
+    end
+  end
+
+end

data/test/cli/commands/test_help.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::HelpTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_stub
+  end
+
+end

data/test/cli/commands/test_info.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::InfoTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_stub
+  end
+
+end

data/test/cli/commands/test_update.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::Commands::UpdateTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_stub
+  end
+
+end

data/test/cli/test_logger.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CLI::LoggerTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_stub
+  end
+
+end

data/test/data_sources/test_filesystem.rb

@@ -0,0 +1,420 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::DataSources::FilesystemTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  class SampleFilesystemDataSource < Nanoc3::DataSource
+    include Nanoc3::DataSources::Filesystem
+  end
+
+  def test_setup
+    # Create data source
+    data_source = SampleFilesystemDataSource.new(nil, nil, nil, nil)
+
+    # Remove files to make sure they are recreated
+    FileUtils.rm_rf('content')
+    FileUtils.rm_rf('layouts/default')
+    FileUtils.rm_rf('lib/default.rb')
+
+    # Mock VCS
+    vcs = mock
+    vcs.expects(:add).times(3) # One time for each directory
+    data_source.vcs = vcs
+
+    # Recreate files
+    data_source.setup
+
+    # Ensure essential files have been recreated
+    assert(File.directory?('content/'))
+    assert(File.directory?('layouts/'))
+    assert(File.directory?('lib/'))
+
+    # Ensure no non-essential files have been recreated
+    assert(!File.file?('content/index.html'))
+    assert(!File.file?('layouts/default.html'))
+    assert(!File.file?('lib/default.rb'))
+  end
+
+  def test_items
+    # Create data source
+    data_source = SampleFilesystemDataSource.new(nil, nil, nil, nil)
+
+    # Check
+    data_source.expects(:load_objects).with('content', 'item', Nanoc3::Item)
+    data_source.items
+  end
+
+  def test_layouts
+    # Create data source
+    data_source = SampleFilesystemDataSource.new(nil, nil, nil, nil)
+
+    # Check
+    data_source.expects(:load_objects).with('layouts', 'layout', Nanoc3::Layout)
+    data_source.layouts
+  end
+
+  def test_create_item
+    # Create data source
+    data_source = SampleFilesystemDataSource.new(nil, nil, nil, nil)
+
+    # Check
+    data_source.expects(:create_object).with('content', 'the content', 'the attributes', 'the identifier', {})
+    data_source.create_item('the content', 'the attributes', 'the identifier')
+  end
+
+  def test_create_layout
+    # Create data source
+    data_source = SampleFilesystemDataSource.new(nil, nil, nil, nil)
+
+    # Check
+    data_source.expects(:create_object).with('layouts', 'the content', 'the attributes', 'the identifier', {})
+    data_source.create_layout('the content', 'the attributes', 'the identifier')
+  end
+
+  def test_all_split_files_in_allowing_periods_in_identifiers
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, { :allow_periods_in_identifiers => true })
+
+    # Write sample files
+    FileUtils.mkdir_p('foo')
+    %w( foo.html foo.yaml bar.entry.html foo/qux.yaml ).each do |filename|
+      File.open(filename, 'w') { |io| io.write('test') }
+    end
+
+    # Write stray files
+    %w( foo.html~ foo.yaml.orig bar.entry.html.bak ).each do |filename|
+      File.open(filename, 'w') { |io| io.write('test') }
+    end
+
+    # Get all files
+    output_expected = {
+      './foo'       => [ 'yaml', 'html' ],
+      './bar.entry' => [ nil,    'html' ],
+      './foo/qux'   => [ 'yaml', nil    ]
+    }
+    output_actual = data_source.send :all_split_files_in, '.'
+
+    # Check
+    assert_equal output_expected, output_actual
+  end
+
+  def test_all_split_files_in_disallowing_periods_in_identifiers
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, nil)
+
+    # Write sample files
+    FileUtils.mkdir_p('foo')
+    %w( foo.html foo.yaml bar.html.erb foo/qux.yaml ).each do |filename|
+      File.open(filename, 'w') { |io| io.write('test') }
+    end
+
+    # Write stray files
+    %w( foo.html~ foo.yaml.orig bar.entry.html.bak ).each do |filename|
+      File.open(filename, 'w') { |io| io.write('test') }
+    end
+
+    # Get all files
+    output_expected = {
+      './foo'       => [ 'yaml', 'html'     ],
+      './bar'       => [ nil,    'html.erb' ],
+      './foo/qux'   => [ 'yaml', nil        ]
+    }
+    output_actual = data_source.send :all_split_files_in, '.'
+
+    # Check
+    assert_equal output_expected, output_actual
+  end
+
+  def test_all_split_files_in_with_multiple_dirs
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, nil)
+
+    # Write sample files
+    %w( aaa/foo.html bbb/foo.html ccc/foo.html ).each do |filename|
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.open(filename, 'w') { |io| io.write('test') }
+    end
+
+    # Check
+    expected = {
+      './aaa/foo' => [ nil, 'html' ],
+      './bbb/foo' => [ nil, 'html' ],
+      './ccc/foo' => [ nil, 'html' ]
+    }
+    assert_equal expected, data_source.send(:all_split_files_in, '.')
+  end
+
+  def test_all_split_files_in_with_multiple_content_files
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, nil)
+
+    # Write sample files
+    %w( foo.html foo.xhtml foo.txt foo.yaml bar.html qux.yaml ).each do |filename|
+      File.open(filename, 'w') { |io| io.write('test') }
+    end
+
+    # Check
+    assert_raises RuntimeError do
+      data_source.send(:all_split_files_in, '.')
+    end
+  end
+
+  def test_basename_of_allowing_periods_in_identifiers
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, { :allow_periods_in_identifiers => true })
+
+    # Get input and expected output
+    expected = {
+      '/'                 => '/',
+      '/foo'              => '/foo',
+      '/foo.html'         => '/foo',
+      '/foo.xyz.html'     => '/foo.xyz',
+      '/foo/'             => '/foo/',
+      '/foo.xyz/'         => '/foo.xyz/',
+      '/foo/bar'          => '/foo/bar',
+      '/foo/bar.html'     => '/foo/bar',
+      '/foo/bar.xyz.html' => '/foo/bar.xyz',
+      '/foo/bar/'         => '/foo/bar/',
+      '/foo/bar.xyz/'     => '/foo/bar.xyz/',
+      '/foo.xyz/bar.xyz/' => '/foo.xyz/bar.xyz/'
+    }
+
+    # Check
+    expected.each_pair do |input, expected_output|
+      actual_output = data_source.send(:basename_of, input)
+      assert_equal(
+        expected_output, actual_output,
+        "basename_of(#{input.inspect}) should equal #{expected_output.inspect}, not #{actual_output.inspect}"
+      )
+    end
+  end
+
+  def test_basename_of_disallowing_periods_in_identifiers
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, nil)
+
+    # Get input and expected output
+    expected = {
+      '/'                 => '/',
+      '/foo'              => '/foo',
+      '/foo.html'         => '/foo',
+      '/foo.xyz.html'     => '/foo',
+      '/foo/'             => '/foo/',
+      '/foo.xyz/'         => '/foo.xyz/',
+      '/foo/bar'          => '/foo/bar',
+      '/foo/bar.html'     => '/foo/bar',
+      '/foo/bar.xyz.html' => '/foo/bar',
+      '/foo/bar/'         => '/foo/bar/',
+      '/foo/bar.xyz/'     => '/foo/bar.xyz/',
+      '/foo.xyz/bar.xyz/' => '/foo.xyz/bar.xyz/'
+    }
+
+    # Check
+    expected.each_pair do |input, expected_output|
+      actual_output = data_source.send(:basename_of, input)
+      assert_equal(
+        expected_output, actual_output,
+        "basename_of(#{input.inspect}) should equal #{expected_output.inspect}, not #{actual_output.inspect}"
+      )
+    end
+  end
+
+  def test_ext_of_allowing_periods_in_identifiers
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, { :allow_periods_in_identifiers => true })
+
+    # Get input and expected output
+    expected = {
+      '/'                 => '',
+      '/foo'              => '',
+      '/foo.html'         => '.html',
+      '/foo.xyz.html'     => '.html',
+      '/foo/'             => '',
+      '/foo.xyz/'         => '',
+      '/foo/bar'          => '',
+      '/foo/bar.html'     => '.html',
+      '/foo/bar.xyz.html' => '.html',
+      '/foo/bar/'         => '',
+      '/foo/bar.xyz/'     => '',
+      '/foo.xyz/bar.xyz/' => ''
+    }
+
+    # Check
+    expected.each_pair do |input, expected_output|
+      actual_output = data_source.send(:ext_of, input)
+      assert_equal(
+        expected_output, actual_output,
+        "basename_of(#{input.inspect}) should equal #{expected_output.inspect}, not #{actual_output.inspect}"
+      )
+    end
+  end
+
+  def test_ext_of_disallowing_periods_in_identifiers
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCompact.new(nil, nil, nil, nil)
+
+    # Get input and expected output
+    expected = {
+      '/'                 => '',
+      '/foo'              => '',
+      '/foo.html'         => '.html',
+      '/foo.xyz.html'     => '.xyz.html',
+      '/foo/'             => '',
+      '/foo.xyz/'         => '',
+      '/foo/bar'          => '',
+      '/foo/bar.html'     => '.html',
+      '/foo/bar.xyz.html' => '.xyz.html',
+      '/foo/bar/'         => '',
+      '/foo/bar.xyz/'     => '',
+      '/foo.xyz/bar.xyz/' => ''
+    }
+
+    # Check
+    expected.each_pair do |input, expected_output|
+      actual_output = data_source.send(:ext_of, input)
+      assert_equal(
+        expected_output, actual_output,
+        "basename_of(#{input.inspect}) should equal #{expected_output.inspect}, not #{actual_output.inspect}"
+      )
+    end
+  end
+
+  def test_parse_embedded_invalid_2
+    # Create a file
+    File.open('test.html', 'w') do |io|
+      io.write "-----\n"
+      io.write "blah blah\n"
+    end
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    assert_raises(RuntimeError) do
+      data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    end
+  end
+
+  def test_parse_embedded_separators_but_not_metadata
+    # Create a file
+    File.open('test.html', 'w') do |io|
+      io.write "blah blah\n"
+      io.write "-----\n"
+      io.write "blah blah\n"
+    end
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal(File.read('test.html'), result[1])
+    assert_equal({},                     result[0])
+  end
+
+  def test_parse_embedded_full_meta
+    # Create a file
+    File.open('test.html', 'w') do |io|
+      io.write "-----\n"
+      io.write "foo: bar\n"
+      io.write "-----\n"
+      io.write "blah blah\n"
+    end
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal({ 'foo' => 'bar' }, result[0])
+    assert_equal('blah blah', result[1])
+  end
+
+  def test_parse_embedded_with_extra_spaces
+    # Create a file
+    File.open('test.html', 'w') do |io|
+      io.write "-----             \n"
+      io.write "foo: bar\n"
+      io.write "-----\t\t\t\t\t\n"
+      io.write "blah blah\n"
+    end
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal({ 'foo' => 'bar' }, result[0])
+    assert_equal('blah blah', result[1])
+  end
+
+  def test_parse_embedded_empty_meta
+    # Create a file
+    File.open('test.html', 'w') do |io|
+      io.write "-----\n"
+      io.write "-----\n"
+      io.write "blah blah\n"
+    end
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal({}, result[0])
+    assert_equal('blah blah', result[1])
+  end
+
+  def test_parse_embedded_no_meta
+    content = "blah\n" \
+      "blah blah blah\n" \
+      "blah blah\n"
+
+    # Create a file
+    File.open('test.html', 'w') { |io| io.write(content) }
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal({}, result[0])
+    assert_equal(content, result[1])
+  end
+
+  def test_parse_embedded_diff
+    content = \
+      "--- a/foo\n" \
+      "+++ b/foo\n" \
+      "blah blah\n"
+
+    # Create a file
+    File.open('test.html', 'w') { |io| io.write(content) }
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal({}, result[0])
+    assert_equal(content, result[1])
+  end
+
+  def test_parse_external
+    # Create a file
+    File.open('test.html', 'w') { |io| io.write("blah blah") }
+    File.open('test.yaml', 'w') { |io| io.write("foo: bar") }
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    # Parse it
+    result = data_source.instance_eval { parse('test.html', 'test.yaml', 'foobar') }
+    assert_equal({ "foo" => "bar"}, result[0])
+    assert_equal("blah blah",       result[1])
+  end
+
+end