nanoc 3.2.4 → 3.3.0

data/test/base/test_plugin.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+class Nanoc::PluginTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  class SampleFilter < Nanoc::Filter
+    identifier :_plugin_test_sample_filter
+  end
+
+  def test_named
+    # Find existant filter
+    filter = Nanoc::Filter.named(:erb)
+    assert(!filter.nil?)
+
+    # Find non-existant filter
+    filter = Nanoc::Filter.named(:lksdaffhdlkashlgkskahf)
+    assert(filter.nil?)
+  end
+
+  def test_register
+    SampleFilter.send(:identifier, :_plugin_test_sample_filter)
+
+    registry = Nanoc::PluginRegistry.instance
+    filter = registry.find(Nanoc::Filter, :_plugin_test_sample_filter)
+
+    refute_nil filter
+  end
+
+end

data/test/base/test_rule.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+class Nanoc::RuleTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_initialize
+    # TODO implement
+  end
+
+  def test_applicable_to
+    # TODO implement
+  end
+
+  def test_apply_to
+    # TODO implement
+  end
+
+end

data/test/base/test_rule_context.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+class Nanoc::RuleContextTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_objects
+    # Mock everything
+    config = mock
+    items = mock
+    layouts = mock
+    site = mock
+    site.stubs(:config).returns(config)
+    site.stubs(:items).returns(items)
+    site.stubs(:layouts).returns(layouts)
+    item = mock
+    item.stubs(:site).returns(site)
+    rep = mock
+    rep.stubs(:item).returns(item)
+    compiler = Nanoc::Compiler.new(site)
+
+    # Create context
+    @rule_context = Nanoc::RuleContext.new(:rep => rep, :compiler => compiler)
+
+    # Check
+    assert_equal rep,     @rule_context.rep
+    assert_equal item,    @rule_context.item
+    assert_equal site,    @rule_context.site
+    assert_equal config,  @rule_context.config
+    assert_equal layouts, @rule_context.layouts
+    assert_equal items,   @rule_context.items
+  end
+
+  def test_actions
+    # Mock everything
+    config = mock
+    items = mock
+    layouts = mock
+    site = mock
+    site.stubs(:config).returns(config)
+    site.stubs(:items).returns(items)
+    site.stubs(:layouts).returns(layouts)
+    item = mock
+    item.stubs(:site).returns(site)
+
+    # Mock rep
+    rep = mock
+    rep.stubs(:item).returns(item)
+    rep.expects(:filter).with(:foo, { :bar => 'baz' })
+    rep.expects(:layout).with('foo')
+    rep.expects(:snapshot).with('awesome')
+
+    # Mock compiler
+    compiler = Nanoc::Compiler.new(site)
+
+    # Create context
+    @rule_context = Nanoc::RuleContext.new(:rep => rep, :compiler => compiler)
+
+    # Check
+    rep.filter   :foo, :bar => 'baz'
+    rep.layout   'foo'
+    rep.snapshot 'awesome'
+  end
+
+end

data/test/base/test_site.rb

@@ -0,0 +1,190 @@
+# encoding: utf-8
+
+class Nanoc::SiteTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_initialize_with_dir_without_config_yaml
+    assert_raises(Errno::ENOENT) do
+      site = Nanoc::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 = Nanoc::Site.new('.')
+    assert_equal 'public_html', site.config[:output_dir]
+  end
+
+  def test_initialize_with_config_hash
+    site = Nanoc::Site.new(:foo => 'bar')
+    assert_equal 'bar', site.config[:foo]
+  end
+
+  def test_initialize_with_incomplete_data_source_config
+    site = Nanoc::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 = Nanoc::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
+    Nanoc::CLI.run %w( 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 < Nanoc::DataSource\n"
+        io.write "  identifier :site_test_foo\n"
+        io.write "  def items ; [ Nanoc::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 = Nanoc::Site.new('.')
+      site.load_data
+
+      # Check
+      assert_equal 1,       site.data_sources.size
+      assert_equal '/foo/', site.items[0].identifier
+    end
+  end
+
+  def test_setup_child_parent_links
+    Nanoc::CLI.run %w( create_site bar)
+    FileUtils.cd('bar') do
+      Nanoc::CLI.run %w( create_item /parent/ )
+      Nanoc::CLI.run %w( create_item /parent/foo/ )
+      Nanoc::CLI.run %w( create_item /parent/bar/ )
+      Nanoc::CLI.run %w( create_item /parent/bar/qux/ )
+
+      site = Nanoc::Site.new('.')
+
+      root   = site.items.find { |i| i.identifier == '/' }
+      style  = site.items.find { |i| i.identifier == '/stylesheet/' }
+      parent = site.items.find { |i| i.identifier == '/parent/' }
+      foo    = site.items.find { |i| i.identifier == '/parent/foo/' }
+      bar    = site.items.find { |i| i.identifier == '/parent/bar/' }
+      qux    = site.items.find { |i| i.identifier == '/parent/bar/qux/' }
+
+      assert_equal Set.new([ parent, style ]), Set.new(root.children)
+      assert_equal Set.new([ foo, bar ]),      Set.new(parent.children)
+      assert_equal Set.new([ qux ]),           Set.new(bar.children)
+
+      assert_equal nil,    root.parent
+      assert_equal root,   parent.parent
+      assert_equal parent, foo.parent
+      assert_equal parent, bar.parent
+      assert_equal bar,    qux.parent
+    end
+  end
+
+end
+
+describe 'Nanoc::Site#initialize' do
+
+  include Nanoc::TestHelpers
+
+  it 'should merge default config' do
+    site = Nanoc::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
+    Nanoc::Site.new({})
+  end
+
+  it 'should not raise for non-existant output directory' do
+    Nanoc::Site.new(:output_dir => 'fklsdhailfdjalghlkasdflhagjskajdf')
+  end
+
+  it 'should not raise for unknown data sources' do
+    proc do
+      Nanoc::Site.new(:data_source => 'fklsdhailfdjalghlkasdflhagjskajdf')
+    end
+  end
+
+end
+
+describe 'Nanoc::Site#compiler' do
+
+  include Nanoc::TestHelpers
+
+  it 'should not raise under normal circumstances' do
+    site = Nanoc::Site.new({})
+    site.compiler
+  end
+
+end
+
+describe 'Nanoc::Site#data_sources' do
+
+  include Nanoc::TestHelpers
+
+  it 'should not raise for known data sources' do
+    site = Nanoc::Site.new({})
+    site.data_sources
+  end
+
+  it 'should raise for unknown data sources' do
+    proc do
+      site = Nanoc::Site.new(
+        :data_sources => [
+          { :type => 'fklsdhailfdjalghlkasdflhagjskajdf' }
+        ]
+      )
+      site.data_sources
+    end.must_raise Nanoc::Errors::UnknownDataSource
+  end
+
+  it 'should also use the toplevel config for data sources' do
+    with_site do
+      File.open('config.yaml', 'w') do |io|
+        io.write "data_sources:\n"
+        io.write "  -\n"
+        io.write "    type: filesystem_unified\n"
+        io.write "    aaa: one\n"
+        io.write "    config:\n"
+        io.write "      bbb: two\n"
+      end
+
+      site = Nanoc::Site.new('.')
+      data_sources = site.data_sources
+
+      assert data_sources.first.config[:aaa] = 'one'
+      assert data_sources.first.config[:bbb] = 'two'
+    end
+  end
+
+end

data/test/cli/commands/test_compile.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+class Nanoc::CLI::Commands::CompileTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_profiling_information
+    with_site do |site|
+      Nanoc::CLI.run %w( create_item foo )
+      Nanoc::CLI.run %w( create_item bar )
+      Nanoc::CLI.run %w( create_item baz )
+
+      File.open('Rules', 'w') do |io|
+        io.write "compile '*' do\n"
+        io.write "  filter :erb\n"
+        io.write "end\n"
+        io.write "\n"
+        io.write "route '*' do\n"
+        io.write "  if item.binary?\n"
+        io.write "    item.identifier.chop + '.' + item[:extension]\n"
+        io.write "  else\n"
+        io.write "    item.identifier + 'index.html'\n"
+        io.write "  end\n"
+        io.write "end\n"
+        io.write "\n"
+        io.write "layout '*', :erb\n"
+      end
+
+      Nanoc::CLI.run %w( compile --verbose )
+    end
+  end
+
+end

data/test/cli/commands/test_create_item.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+class Nanoc::CLI::Commands::CreateItemTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_run
+    with_site do |site|
+      Nanoc::CLI.run %w( create_item /blah/ )
+      assert File.file?('content/blah.html')
+    end
+  end
+
+end

data/test/cli/commands/test_create_layout.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+class Nanoc::CLI::Commands::CreateLayoutTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_can_compile_new_layout
+    require 'nanoc/cli'
+
+    Nanoc::CLI.run %w( create_site foo )
+
+    FileUtils.cd('foo') do
+      # Create new layout
+      Nanoc::CLI.run %w( 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 = Nanoc::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
+
+class Nanoc::CLI::Commands::CreateSiteTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_create_site_with_existing_name
+    Nanoc::CLI.run %w( create_site foo )
+    assert_raises(SystemExit) do
+      Nanoc::CLI.run %w( create_site foo )
+    end
+  end
+
+  def test_can_compile_new_site
+    Nanoc::CLI.run %w( create_site foo )
+
+    FileUtils.cd('foo') do
+      site = Nanoc::Site.new('.')
+      site.load_data
+      site.compile
+    end
+  end
+
+end

data/test/cli/commands/test_deploy.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+class Nanoc::CLI::Commands::DeployTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_deploy
+    if_have 'systemu' do
+      with_site do |site|
+        File.open('config.yaml', 'w') do |io|
+          io.write "deploy:\n"
+          io.write "  public:\n"
+          io.write "    kind: rsync\n"
+          io.write "    dst: mydestination"
+        end
+
+        FileUtils.mkdir_p('output')
+        File.open('output/blah.html', 'w') { |io| io.write 'moo' }
+
+        Nanoc::CLI.run %w( deploy -t public )
+
+        assert File.directory?('mydestination')
+        assert File.file?('mydestination/blah.html')
+      end
+    end
+  end
+
+  def test_deploy_with_dry_run
+    if_have 'systemu' do
+      with_site do |site|
+        File.open('config.yaml', 'w') do |io|
+          io.write "deploy:\n"
+          io.write "  public:\n"
+          io.write "    kind: rsync\n"
+          io.write "    dst: mydestination"
+        end
+
+        FileUtils.mkdir_p('output')
+        File.open('output/blah.html', 'w') { |io| io.write 'moo' }
+
+        Nanoc::CLI.run %w( deploy -t public -n )
+
+        refute File.directory?('mydestination')
+        refute File.file?('mydestination/blah.html')
+      end
+    end
+  end
+
+  def test_deploy_with_list
+    if_have 'systemu' do
+      with_site do |site|
+        File.open('config.yaml', 'w') do |io|
+          io.write "deploy:\n"
+          io.write "  public:\n"
+          io.write "    kind: rsync\n"
+          io.write "    dst: mydestination"
+        end
+
+        FileUtils.mkdir_p('output')
+        File.open('output/blah.html', 'w') { |io| io.write 'moo' }
+
+        ios = capturing_stdio do
+          Nanoc::CLI.run %w( deploy -l )
+        end
+
+        assert ios[:stdout].include?('Available deployment configurations:')
+
+        refute File.directory?('mydestination')
+        refute File.file?('mydestination/blah.html')
+      end
+    end
+  end
+
+end