nanoc3 3.1.7 → 3.1.8

data/test/data_sources/test_filesystem_verbose.rb

@@ -0,0 +1,359 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::DataSources::FilesystemVerboseTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def new_data_source(params=nil)
+    # Mock site
+    site = Nanoc3::Site.new({})
+
+    # Create data source
+    data_source = Nanoc3::DataSources::FilesystemVerbose.new(site, nil, nil, params)
+
+    # Done
+    data_source
+  end
+
+  def test_items
+    # Create data source
+    data_source = new_data_source
+
+    # Create foo item
+    FileUtils.mkdir_p('content/foo')
+    File.open('content/foo/foo.yaml', 'w') do |io|
+      io.write("---\n")
+      io.write("title: Foo\n")
+    end
+    File.open('content/foo/foo.html', 'w') do |io|
+      io.write('Lorem ipsum dolor sit amet...')
+    end
+
+    # Create bar item
+    FileUtils.mkdir_p('content/bar')
+    File.open('content/bar/bar.yaml', 'w') do |io|
+      io.write("---\n")
+      io.write("title: Bar\n")
+    end
+    File.open('content/bar/bar.xml', 'w') do |io|
+      io.write("Lorem ipsum dolor sit amet...")
+    end
+
+    # Load items
+    items = data_source.items
+
+    # Check items
+    assert_equal(2, items.size)
+    assert(items.any? { |a|
+      a[:title]            == 'Foo' &&
+      a[:extension]        == 'html' &&
+      a[:content_filename] == 'content/foo/foo.html' &&
+      a[:meta_filename]    == 'content/foo/foo.yaml'
+    })
+    assert(items.any? { |a|
+      a[:title]            == 'Bar' &&
+      a[:extension]        == 'xml' &&
+      a[:content_filename] == 'content/bar/bar.xml' &&
+      a[:meta_filename]    == 'content/bar/bar.yaml'
+    })
+  end
+
+  def test_items_with_period_in_name
+    data_source = new_data_source(:allow_periods_in_identifiers => true)
+
+    # Create foo.css
+    FileUtils.mkdir_p('content/foo')
+    File.open('content/foo/foo.yaml', 'w') do |io|
+      io.write(YAML.dump({ 'title' => 'Foo' }))
+    end
+    File.open('content/foo/foo.css', 'w') do |io|
+      io.write('body.foo {}')
+    end
+    
+    # Create foo.bar.css
+    FileUtils.mkdir_p('content/foo.bar')
+    File.open('content/foo.bar/foo.bar.yaml', 'w') do |io|
+      io.write(YAML.dump({ 'title' => 'Foo Bar' }))
+    end
+    File.open('content/foo.bar/foo.bar.css', 'w') do |io|
+      io.write('body.foobar {}')
+    end
+    
+    # Load
+    items = data_source.items
+    
+    # Check
+    assert_equal 2, items.size
+    assert_equal '/foo/',                        items[0].identifier
+    assert_equal 'Foo',                          items[0][:title]
+    assert_equal 'content/foo/foo.css',          items[0][:content_filename]
+    assert_equal 'content/foo/foo.yaml',         items[0][:meta_filename]
+    assert_equal '/foo.bar/',                    items[1].identifier
+    assert_equal 'Foo Bar',                      items[1][:title]
+    assert_equal 'content/foo.bar/foo.bar.css',  items[1][:content_filename]
+    assert_equal 'content/foo.bar/foo.bar.yaml', items[1][:meta_filename]
+  end
+
+  def test_items_with_optional_meta_file
+    # Create data source
+    data_source = new_data_source
+
+    # Create foo item
+    FileUtils.mkdir_p('content/foo')
+    File.open('content/foo/foo.html', 'w') do |io|
+      io.write('Lorem ipsum dolor sit amet...')
+    end
+
+    # Create bar item
+    FileUtils.mkdir_p('content/bar')
+    File.open('content/bar/bar.yaml', 'w') do |io|
+      io.write("---\n")
+      io.write("title: Bar\n")
+    end
+
+    # Load items
+    items = data_source.items
+
+    # Check items
+    assert_equal(2, items.size)
+    assert(items.any? { |a|
+      a[:title]            == nil &&
+      a[:extension]        == 'html' &&
+      a[:content_filename] == 'content/foo/foo.html' &&
+      a[:meta_filename]    == nil
+    })
+    assert(items.any? { |a|
+      a[:title]            == 'Bar' &&
+      a[:extension]        == nil &&
+      a[:content_filename] == nil &&
+      a[:meta_filename]    == 'content/bar/bar.yaml'
+    })
+  end
+
+  def test_layouts
+    # Create data source
+    data_source = new_data_source
+
+    # Create layout
+    FileUtils.mkdir_p('layouts/foo')
+    File.open('layouts/foo/foo.yaml', 'w') do |io|
+      io.write("---\n")
+      io.write("filter: erb\n")
+    end
+    File.open('layouts/foo/foo.rhtml', 'w') do |io|
+      io.write('Lorem ipsum dolor sit amet...')
+    end
+
+    # Load layouts
+    layouts = data_source.layouts
+
+    # Check layouts
+    assert_equal(1,                       layouts.size)
+    assert_equal('erb',                   layouts[0][:filter])
+    assert_equal('rhtml',                 layouts[0][:extension])
+    assert_equal('layouts/foo/foo.rhtml', layouts[0][:content_filename])
+    assert_equal('layouts/foo/foo.yaml',  layouts[0][:meta_filename])
+  end
+
+  def test_layouts_with_period_in_name_disallowing_periods_in_identifiers
+    data_source = new_data_source
+
+    # Create foo.html
+    FileUtils.mkdir_p('layouts/foo')
+    File.open('layouts/foo/foo.yaml', 'w') do |io|
+      io.write(YAML.dump({ 'dog' => 'woof' }))
+    end
+    File.open('layouts/foo/foo.html', 'w') do |io|
+      io.write('body.foo {}')
+    end
+    
+    # Create bar.html.erb
+    FileUtils.mkdir_p('layouts/bar')
+    File.open('layouts/bar/bar.yaml', 'w') do |io|
+      io.write(YAML.dump({ 'cat' => 'meow' }))
+    end
+    File.open('layouts/bar/bar.html.erb', 'w') do |io|
+      io.write('body.foobar {}')
+    end
+    
+    # Load
+    layouts = data_source.layouts.sort_by { |i| i.identifier }
+    
+    # Check
+    assert_equal 2, layouts.size
+    assert_equal '/bar/', layouts[0].identifier
+    assert_equal 'meow',  layouts[0][:cat]
+    assert_equal '/foo/', layouts[1].identifier
+    assert_equal 'woof',  layouts[1][:dog]
+  end
+
+  def test_layouts_with_period_in_name_allowing_periods_in_identifiers
+    data_source = new_data_source(:allow_periods_in_identifiers => true)
+
+    # Create foo.html
+    FileUtils.mkdir_p('layouts/foo')
+    File.open('layouts/foo/foo.yaml', 'w') do |io|
+      io.write(YAML.dump({ 'dog' => 'woof' }))
+    end
+    File.open('layouts/foo/foo.html', 'w') do |io|
+      io.write('body.foo {}')
+    end
+    
+    # Create bar.html.erb
+    FileUtils.mkdir_p('layouts/bar.xyz')
+    File.open('layouts/bar.xyz/bar.xyz.yaml', 'w') do |io|
+      io.write(YAML.dump({ 'cat' => 'meow' }))
+    end
+    File.open('layouts/bar.xyz/bar.xyz.html', 'w') do |io|
+      io.write('body.foobar {}')
+    end
+    
+    # Load
+    layouts = data_source.layouts.sort_by { |i| i.identifier }
+    
+    # Check
+    assert_equal 2, layouts.size
+    assert_equal '/bar.xyz/', layouts[0].identifier
+    assert_equal 'meow',      layouts[0][:cat]
+    assert_equal '/foo/',     layouts[1].identifier
+    assert_equal 'woof',      layouts[1][:dog]
+  end
+
+  def test_create_item_at_root
+    # Create item
+    data_source = new_data_source
+    data_source.create_item('content here', { :foo => 'bar' }, '/')
+
+    # Check file existance
+    assert File.directory?('content')
+    assert File.file?('content/content.html')
+    assert File.file?('content/content.yaml')
+
+    # Check file content
+    assert_equal 'content here', File.read('content/content.html')
+    assert_match 'foo: bar',     File.read('content/content.yaml')
+  end
+
+  def test_create_item_not_at_root
+    # Create item
+    data_source = new_data_source
+    data_source.create_item('content here', { :foo => 'bar' }, '/moo/')
+
+    # Check file existance
+    assert File.directory?('content/moo')
+    assert File.file?('content/moo/moo.html')
+    assert File.file?('content/moo/moo.yaml')
+
+    # Check file content
+    assert_equal 'content here', File.read('content/moo/moo.html')
+    assert_match 'foo: bar',     File.read('content/moo/moo.yaml')
+  end
+
+  def test_create_layout
+    # Create layout
+    data_source = new_data_source
+    data_source.create_layout('content here', { :foo => 'bar' }, '/moo/')
+
+    # Check file existance
+    assert File.directory?('layouts/moo')
+    assert File.file?('layouts/moo/moo.html')
+    assert File.file?('layouts/moo/moo.yaml')
+
+    # Check file content
+    assert_equal 'content here', File.read('layouts/moo/moo.html')
+    assert_match 'foo: bar',     File.read('layouts/moo/moo.yaml')
+  end
+
+  def test_load_binary_objects
+    # Create data source
+    data_source = new_data_source
+
+    # Create sample files
+    FileUtils.mkdir_p('foo')
+    File.open('foo/stuff.dat', 'w') { |io| io.write("random binary data") }
+
+    # Load
+    items = data_source.send(:load_objects, 'foo', 'item', Nanoc3::Item)
+
+    # Check
+    assert_equal 1, items.size
+    assert items[0].binary?
+    assert_equal 'foo/stuff.dat', items[0].raw_filename
+    assert_nil items[0].raw_content
+  end
+
+  def test_filename_for_with_single
+    data_source = new_data_source
+
+    FileUtils.mkdir_p('foo/bar')
+    File.open('foo/bar.ext', 'w') { |io| io.write('o hai') }
+    assert_equal 'foo/bar.ext', data_source.send(:filename_for, 'foo/bar', 'ext')
+  end
+
+  def test_filename_for_with_double
+    data_source = new_data_source
+
+    FileUtils.mkdir_p('foo/bar')
+    File.open('foo/bar/bar.ext', 'w') { |io| io.write('o hai') }
+    assert_equal 'foo/bar/bar.ext', data_source.send(:filename_for, 'foo/bar', 'ext')
+  end
+
+  def test_filename_for_with_index
+    data_source = new_data_source
+
+    FileUtils.mkdir_p('foo/bar')
+    File.open('foo/bar/index.ext', 'w') { |io| io.write('o hai') }
+    assert_equal 'foo/bar/index.ext', data_source.send(:filename_for, 'foo/bar', 'ext')
+  end
+
+  def test_filename_for_with_nil
+    data_source = new_data_source
+
+    assert_equal nil, data_source.send(:filename_for, 'foo/bar', nil)
+  end
+
+  def test_filename_for_with_single_and_empty_ext
+    data_source = new_data_source
+
+    FileUtils.mkdir_p('foo')
+    File.open('foo/bar', 'w') { |io| io.write('o hai') }
+    assert_equal 'foo/bar', data_source.send(:filename_for, 'foo/bar', '')
+  end
+
+  def test_filename_for_with_double_and_empty_ext
+    data_source = new_data_source
+
+    FileUtils.mkdir_p('foo/bar')
+    File.open('foo/bar/bar', 'w') { |io| io.write('o hai') }
+    assert_equal 'foo/bar/bar', data_source.send(:filename_for, 'foo/bar', '')
+  end
+
+  def test_filename_for_with_index_and_empty_ext
+    data_source = new_data_source
+
+    FileUtils.mkdir_p('foo/bar')
+    File.open('foo/bar/index', 'w') { |io| io.write('o hai') }
+    assert_equal 'foo/bar/index', data_source.send(:filename_for, 'foo/bar', '')
+  end
+
+  def test_compile_huge_site
+    if_implemented do
+      # Create data source
+      data_source = new_data_source
+
+      # Create a lot of items
+      count = Process.getrlimit(Process::RLIMIT_NOFILE)[0] + 5
+      count.times do |i|
+        FileUtils.mkdir_p("content/#{i}")
+        File.open("content/#{i}/#{i}.html", 'w') { |io| io << "This is item #{i}." }
+        File.open("content/#{i}/#{i}.yaml", 'w') { |io| io << "title: Item #{i}"   }
+      end
+
+      # Read all items
+      data_source.items
+    end
+  end
+
+end

data/test/extra/core_ext/test_enumerable.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::ExtraCoreExtEnumerableTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  class MyCollection
+
+    include Enumerable
+
+    def initialize(array)
+      @array = array
+    end
+
+    def each(&block)
+      @array.each { |i| block.call(i) }
+    end
+
+  end
+
+  def test_group_by
+    input = MyCollection.new([ 'foo', 'bar', 'baz' ])
+
+    output_expected = { ?f => [ 'foo' ], ?b => [ 'bar', 'baz' ] }
+    output_actual   = input.group_by { |i| i[0] }
+
+    assert_equal output_expected, output_actual
+  end
+
+end

data/test/extra/core_ext/test_time.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::ExtraCoreExtTimeTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_to_iso8601_date
+    assert_equal('2008-05-19', Time.utc(2008, 5, 19, 14, 20, 0, 0).to_iso8601_date)
+  end
+
+  def test_to_iso8601_time
+    assert_equal('2008-05-19T14:20:00Z', Time.utc(2008, 5, 19, 14, 20, 0, 0).to_iso8601_time)
+  end
+
+end

data/test/extra/deployers/test_rsync.rb

@@ -0,0 +1,234 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::Extra::Deployers::RsyncTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_new_without_site
+    # Try creating site
+    error = assert_raises(RuntimeError) do
+      Nanoc3::Extra::Deployers::Rsync.new
+    end
+
+    # Check error message
+    assert_equal 'No site configuration found', error.message
+  end
+
+  def test_run_without_general_deploy_config
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "foo: bar\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Try running
+    error = assert_raises(RuntimeError) do
+      rsync.run
+    end
+
+    # Check error message
+    assert_equal 'No deploy configuration found', error.message
+  end
+
+  def test_run_without_special_deploy_config
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  blahblah:\n"
+      io.write "    stuff: more stuff\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Try running
+    error = assert_raises(RuntimeError) do
+      rsync.run
+    end
+
+    # Check error message
+    assert_equal 'No deploy configuration found for default', error.message
+  end
+
+  def test_run_without_special_deploy_config_with_custom_deploy_config
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  blahblah:\n"
+      io.write "    stuff: more stuff\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Try running
+    error = assert_raises(RuntimeError) do
+      rsync.run(:config_name => 'potrzebie')
+    end
+
+    # Check error message
+    assert_equal 'No deploy configuration found for potrzebie', error.message
+  end
+
+  def test_run_without_dst
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  default:\n"
+      io.write "    foo: bar\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Try running
+    error = assert_raises(RuntimeError) do
+      rsync.run
+    end
+
+    # Check error message
+    assert_equal 'No dst found in deployment configuration', error.message
+  end
+
+  def test_run_with_erroneous_dst
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  default:\n"
+      io.write "    dst: asdf/\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Try running
+    error = assert_raises(RuntimeError) do
+      rsync.run
+    end
+
+    # Check error message
+    assert_equal 'dst requires no trailing slash', error.message
+  end
+
+  def test_run_with_custom_deploy_config_string
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  foobar:\n"
+      io.write "    dst: asdf\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Mock run_shell_cmd
+    def rsync.run_shell_cmd(args)
+      @shell_cms_args = args
+    end
+
+    # Run
+    rsync.run(:config_name => 'foobar')
+
+    # Check args
+    default_options = Nanoc3::Extra::Deployers::Rsync::DEFAULT_OPTIONS
+    assert_equal(
+      [ 'rsync', default_options, File.expand_path('output') + '/', 'asdf' ].flatten,
+      rsync.instance_eval { @shell_cms_args }
+    )
+  end
+
+  def test_run_with_custom_deploy_config_symbol
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  foobar:\n"
+      io.write "    dst: asdf\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Mock run_shell_cmd
+    def rsync.run_shell_cmd(args)
+      @shell_cms_args = args
+    end
+
+    # Run
+    rsync.run(:config_name => :foobar)
+
+    # Check args
+    default_options = Nanoc3::Extra::Deployers::Rsync::DEFAULT_OPTIONS
+    assert_equal(
+      [ 'rsync', default_options, File.expand_path('output') + '/', 'asdf' ].flatten,
+      rsync.instance_eval { @shell_cms_args }
+    )
+  end
+
+  def test_run_everything_okay
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  default:\n"
+      io.write "    dst: asdf\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Mock run_shell_cmd
+    def rsync.run_shell_cmd(args)
+      @shell_cms_args = args
+    end
+
+    # Run
+    rsync.run
+
+    # Check args
+    default_options = Nanoc3::Extra::Deployers::Rsync::DEFAULT_OPTIONS
+    assert_equal(
+      [ 'rsync', default_options, File.expand_path('output') + '/', 'asdf' ].flatten,
+      rsync.instance_eval { @shell_cms_args }
+    )
+  end
+
+  def test_run_everything_okay_dry
+    # Create config
+    File.open('config.yaml', 'w') do |io|
+      io.write "---\n"
+      io.write "deploy:\n"
+      io.write "  default:\n"
+      io.write "    dst: asdf\n"
+    end
+
+    # Create site
+    rsync = Nanoc3::Extra::Deployers::Rsync.new
+
+    # Mock run_shell_cmd
+    def rsync.run_shell_cmd(args)
+      @shell_cms_args = args
+    end
+
+    # Run
+    rsync.run(:dry_run => true)
+
+    # Check args
+    default_options = Nanoc3::Extra::Deployers::Rsync::DEFAULT_OPTIONS
+    assert_equal(
+      [ 'echo', 'rsync', default_options, File.expand_path('output') + '/', 'asdf' ].flatten,
+      rsync.instance_eval { @shell_cms_args }
+    )
+  end
+
+end