nanoc3 3.1.7 → 3.1.8

data/test/base/test_layout.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::LayoutTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_initialize
+    # Make sure attributes are cleaned
+    layout = Nanoc3::Layout.new("content", { 'foo' => 'bar' }, '/foo/')
+    assert_equal({ :foo => 'bar' }, layout.attributes)
+
+    # Make sure identifier is cleaned
+    layout = Nanoc3::Layout.new("content", { 'foo' => 'bar' }, 'foo')
+    assert_equal('/foo/', layout.identifier)
+  end
+
+  def test_frozen_identifier
+    layout = Nanoc3::Layout.new("foo", {}, '/foo')
+
+    error = assert_raises(RuntimeError) do
+      layout.identifier.chop!
+    end
+    assert_equal "can't modify frozen string", error.message
+  end
+
+  def test_lookup_with_known_attribute
+    # Create layout
+    layout = Nanoc3::Layout.new("content", { 'foo' => 'bar' }, '/foo/')
+
+    # Check attributes
+    assert_equal('bar', layout[:foo])
+  end
+
+  def test_lookup_with_unknown_attribute
+    # Create layout
+    layout = Nanoc3::Layout.new("content", { 'foo' => 'bar' }, '/foo/')
+
+    # Check attributes
+    assert_equal(nil, layout[:filter])
+  end
+
+end

data/test/base/test_notification_center.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::NotificationCenterTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_post
+    # Set up notification
+    Nanoc3::NotificationCenter.on :ping_received, :test do
+      @ping_received = true
+    end
+
+    # Post
+    @ping_received = false
+    Nanoc3::NotificationCenter.post :ping_received
+    assert(@ping_received)
+  end
+
+  def test_remove
+    # Set up notification
+    Nanoc3::NotificationCenter.on :ping_received, :test do
+      @ping_received = true
+    end
+
+    # Remove observer
+    Nanoc3::NotificationCenter.remove :ping_received, :test
+
+    # Post
+    @ping_received = false
+    Nanoc3::NotificationCenter.post :ping_received
+    assert(!@ping_received)
+  end
+
+end

data/test/base/test_plugin.rb

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

data/test/base/test_rule.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::RuleTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::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,63 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::RuleContextTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::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)
+
+    # Create context
+    @rule_context = Nanoc3::RuleContext.new(rep)
+
+    # 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')
+
+    # Create context
+    @rule_context = Nanoc3::RuleContext.new(rep)
+
+    # Check
+    rep.filter   :foo, :bar => 'baz'
+    rep.layout   'foo'
+    rep.snapshot 'awesome'
+  end
+
+end

data/test/base/test_site.rb

@@ -0,0 +1,366 @@
+# 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.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.send :load_rules
+  end
+
+  def test_load_rules_with_broken_rules_file
+    # Mock DSL
+    dsl = mock
+    dsl.expects(:some_function_that_doesn_really_exist)
+    dsl.expects(:weird_param_number_one)
+    dsl.expects(:mysterious_param_number_two)
+
+    # Create site
+    site = Nanoc3::Site.new({})
+    site.expects(:dsl).returns(dsl)
+
+    # Create rules file
+    File.open('Rules', 'w') do |io|
+      io.write <<-EOF
+some_function_that_doesn_really_exist(
+weird_param_number_one,
+mysterious_param_number_two
+)
+EOF
+    end
+
+    # Load rules
+    site.send :load_rules
+  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
+
+  def test_disallow_routes_not_starting_with_slash
+    # Create site
+    Nanoc3::CLI::Base.new.run([ 'create_site', 'bar' ])
+
+    FileUtils.cd('bar') do
+      # Create routes
+      File.open('Rules', 'w') do |io|
+        io.write "compile '*' do\n"
+        io.write "  layout 'default'\n"
+        io.write "end\n"
+        io.write "\n"
+        io.write "route '*' do\n"
+        io.write "  'index.html'\n"
+        io.write "end\n"
+        io.write "\n"
+        io.write "layout '*', :erb\n"
+      end
+
+      # Create site
+      site = Nanoc3::Site.new('.')
+      error = assert_raises(RuntimeError) do
+        site.load_data
+      end
+      assert_match /^The path returned for the.*does not start with a slash. Please ensure that all routing rules return a path that starts with a slash./, error.message
+    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#load_data' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should load the data source' do
+    site = Nanoc3::Site.new({})
+
+    # Mock data sources
+    data_sources = [ mock, mock, mock ]
+    data_sources.each { |ds| ds.expects(:use)   }
+    data_sources.each { |ds| ds.expects(:unuse) }
+    site.stubs(:data_sources).returns(data_sources)
+
+    # Mock load_* methods
+    site.stubs(:load_code_snippets).with(false)
+    site.stubs(:load_rules)
+    site.stubs(:load_items)
+    site.stubs(:load_layouts)
+    site.expects(:link_everything_to_site)
+    site.expects(:setup_child_parent_links).times(2)
+    site.expects(:build_reps)
+    site.expects(:route_reps)
+
+    # Load data
+    site.load_data
+  end
+
+  it 'should call the preprocessor' do
+    site = Nanoc3::Site.new({})
+    site.instance_eval do
+      @items_loaded   = true
+      @layouts_loaded = true
+    end
+
+    # Mock data sources
+    data_sources = [ mock, mock, mock ]
+    data_sources.each { |ds| ds.expects(:use)   }
+    data_sources.each { |ds| ds.expects(:unuse) }
+    site.stubs(:data_sources).returns(data_sources)
+
+    # Mock load_* methods
+    site.expects(:load_code_snippets).with(false)
+    site.expects(:load_rules)
+    site.expects(:load_items)
+    site.expects(:load_layouts)
+    site.expects(:link_everything_to_site)
+    site.expects(:setup_child_parent_links).times(2)
+    site.expects(:build_reps)
+    site.expects(:route_reps)
+
+    # Mock preprocessor
+    preprocessor = lambda { |*x| }
+    site.expects(:preprocessor).times(2).returns(preprocessor)
+
+    # Load data
+    site.load_data
+  end
+
+  it 'should call load_* methods' do
+    site = Nanoc3::Site.new({})
+
+    # Mock data sources
+    data_sources = [ mock, mock, mock ]
+    data_sources.each { |ds| ds.expects(:use)   }
+    data_sources.each { |ds| ds.expects(:unuse) }
+    site.stubs(:data_sources).returns(data_sources)
+
+    # Mock load_* methods
+    site.expects(:load_code_snippets).with(false)
+    site.expects(:load_rules)
+    site.expects(:load_items)
+    site.expects(:load_layouts)
+    site.expects(:link_everything_to_site)
+    site.expects(:setup_child_parent_links).times(2)
+    site.expects(:build_reps)
+    site.expects(:route_reps)
+
+    # Load data
+    site.load_data
+  end
+
+  it 'should not load data twice if not forced' do
+    site = Nanoc3::Site.new({})
+
+    # Mock data sources
+    data_sources = [ mock, mock, mock ]
+    data_sources.each { |ds| ds.expects(:use)   }
+    data_sources.each { |ds| ds.expects(:unuse) }
+    site.stubs(:data_sources).returns(data_sources)
+
+    # Mock load_* methods
+    site.expects(:load_code_snippets).with(false).once
+    site.expects(:load_rules)
+    site.expects(:load_items).once
+    site.expects(:load_layouts).once
+    site.expects(:link_everything_to_site)
+    site.expects(:setup_child_parent_links).times(2)
+    site.expects(:build_reps).once
+    site.expects(:route_reps).once
+
+    # Load data twice
+    site.load_data
+    site.load_data
+  end
+
+  it 'should load data twice if forced' do
+    site = Nanoc3::Site.new({})
+
+    # Mock data sources
+    data_sources = [ mock, mock, mock ]
+    data_sources.each { |ds| ds.expects(:use).times(2)   }
+    data_sources.each { |ds| ds.expects(:unuse).times(2) }
+    site.stubs(:data_sources).returns(data_sources)
+
+    # Mock load_* methods
+    site.expects(:load_code_snippets).with(true).times(2)
+    site.expects(:load_rules).times(2)
+    site.expects(:load_items).times(2)
+    site.expects(:load_layouts).times(2)
+    site.expects(:link_everything_to_site).times(2)
+    site.expects(:setup_child_parent_links).times(2*2)
+    site.expects(:build_reps).times(2)
+    site.expects(:route_reps).times(2)
+
+    # Load data twice
+    site.load_data(true)
+    site.load_data(true)
+  end
+
+end
+
+describe 'Nanoc3::Site#code_snippets' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should raise when data is not loaded yet' do
+    site = Nanoc3::Site.new({})
+    proc do
+      site.code_snippets
+    end.must_raise Nanoc3::Errors::DataNotYetAvailable
+  end
+
+end
+
+describe 'Nanoc3::Site#items' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should raise when data is not loaded yet' do
+    site = Nanoc3::Site.new({})
+    proc do
+      site.items
+    end.must_raise Nanoc3::Errors::DataNotYetAvailable
+  end
+
+end
+
+describe 'Nanoc3::Site#layouts' do
+
+  include Nanoc3::TestHelpers
+
+  it 'should raise when data is not loaded yet' do
+    site = Nanoc3::Site.new({})
+    proc do
+      site.layouts
+    end.must_raise Nanoc3::Errors::DataNotYetAvailable
+  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.compiler.run
+    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.compiler.run
+    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