nanoc3 3.2.0a3 → 3.2.0a4

data/test/base/test_dependency_tracker.rb

@@ -0,0 +1,264 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::DependencyTrackerTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_initialize
+    # Mock items
+    items = [ mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Verify no dependencies yet
+    assert_empty tracker.objects_causing_outdatedness_of(items[0])
+    assert_empty tracker.objects_causing_outdatedness_of(items[1])
+  end
+
+  def test_record_dependency
+    # Mock items
+    items = [ mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+
+    # Verify dependencies
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+  end
+
+  def test_record_dependency_no_self
+    # Mock items
+    items = [ mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[0])
+    tracker.record_dependency(items[0], items[1])
+
+    # Verify dependencies
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+  end
+
+  def test_record_dependency_no_doubles
+    # Mock items
+    items = [ mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[0], items[1])
+
+    # Verify dependencies
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+  end
+
+  def test_objects_causing_outdatedness_of
+    # Mock items
+    items = [ mock, mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[1], items[2])
+
+    # Verify dependencies
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+  end
+
+  def test_objects_outdated_due_to
+    # Mock items
+    items = [ mock, mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[1], items[2])
+
+    # Verify dependencies
+    assert_contains_exactly [ items[0] ], tracker.objects_outdated_due_to(items[1])
+  end
+
+  def test_start_and_stop
+    # Mock items
+    items = [ mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Start, do something and stop
+    tracker.start
+    Nanoc3::NotificationCenter.post(:visit_started, items[0])
+    Nanoc3::NotificationCenter.post(:visit_started, items[1])
+    Nanoc3::NotificationCenter.post(:visit_ended,   items[1])
+    Nanoc3::NotificationCenter.post(:visit_ended,   items[0])
+    tracker.stop
+
+    # Verify dependencies
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+    assert_empty tracker.objects_causing_outdatedness_of(items[1])
+  end
+
+  def test_store_graph_and_load_graph_simple
+    # Mock items
+    items = [ mock('0'), mock('1'), mock('2'), mock('3') ]
+    items.each { |i| i.stubs(:type).returns(:item) }
+    items[0].stubs(:reference).returns([ :item, '/aaa/' ])
+    items[1].stubs(:reference).returns([ :item, '/bbb/' ])
+    items[2].stubs(:reference).returns([ :item, '/ccc/' ])
+    items[3].stubs(:reference).returns([ :item, '/ddd/' ])
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[1], items[2])
+    tracker.record_dependency(items[1], items[3])
+
+    # Store
+    tracker.store_graph
+    assert File.file?(tracker.filename)
+
+    # Re-create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Load
+    tracker.load_graph
+
+    # Check loaded graph
+    assert_contains_exactly [ items[1] ],           tracker.objects_causing_outdatedness_of(items[0])
+    assert_contains_exactly [ items[2], items[3] ], tracker.objects_causing_outdatedness_of(items[1])
+    assert_empty tracker.objects_causing_outdatedness_of(items[2])
+    assert_empty tracker.objects_causing_outdatedness_of(items[3])
+  end
+
+  def test_store_graph_and_load_graph_with_removed_items
+    # Mock items
+    items = [ mock('0'), mock('1'), mock('2'), mock('3') ]
+    items.each { |i| i.stubs(:type).returns(:item) }
+    items[0].stubs(:reference).returns([ :item, '/aaa/' ])
+    items[1].stubs(:reference).returns([ :item, '/bbb/' ])
+    items[2].stubs(:reference).returns([ :item, '/ccc/' ])
+    items[3].stubs(:reference).returns([ :item, '/ddd/' ])
+
+    # Create new and old lists
+    old_items = [ items[0], items[1], items[2], items[3] ]
+    new_items = [ items[0], items[1], items[2]           ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(old_items)
+
+    # Record some dependencies
+    tracker.record_dependency(old_items[0], old_items[1])
+    tracker.record_dependency(old_items[1], old_items[2])
+    tracker.record_dependency(old_items[1], old_items[3])
+
+    # Store
+    tracker.store_graph
+    assert File.file?(tracker.filename)
+
+    # Re-create
+    tracker = Nanoc3::DependencyTracker.new(new_items)
+
+    # Load
+    tracker.load_graph
+
+    # Check loaded graph
+    assert_contains_exactly [ items[1] ],       tracker.objects_causing_outdatedness_of(items[0])
+    assert_contains_exactly [ items[2], nil ],  tracker.objects_causing_outdatedness_of(items[1])
+    assert_empty tracker.objects_causing_outdatedness_of(items[2])
+  end
+
+  def test_store_graph_with_nils_in_dst
+    # Mock items
+    items = [ mock('0'), mock('1'), mock('2') ]
+    items.each { |i| i.stubs(:type).returns(:item) }
+    items[0].stubs(:reference).returns([ :item, '/aaa/' ])
+    items[1].stubs(:reference).returns([ :item, '/bbb/' ])
+    items[2].stubs(:reference).returns([ :item, '/ccc/' ])
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[1], nil)
+
+    # Store
+    tracker.store_graph
+    assert File.file?(tracker.filename)
+
+    # Re-create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Load
+    tracker.load_graph
+
+    # Check loaded graph
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+    assert_contains_exactly [ nil ],      tracker.objects_causing_outdatedness_of(items[1])
+  end
+
+  def test_store_graph_with_nils_in_src
+    # Mock items
+    items = [ mock('0'), mock('1'), mock('2') ]
+    items.each { |i| i.stubs(:type).returns(:item) }
+    items[0].stubs(:reference).returns([ :item, '/aaa/' ])
+    items[1].stubs(:reference).returns([ :item, '/bbb/' ])
+    items[2].stubs(:reference).returns([ :item, '/ccc/' ])
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(nil,      items[2])
+
+    # Store
+    tracker.store_graph
+    assert File.file?(tracker.filename)
+
+    # Re-create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Load
+    tracker.load_graph
+
+    # Check loaded graph
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+    assert_empty tracker.objects_causing_outdatedness_of(items[1])
+  end
+
+  def test_forget_dependencies_for
+    # Mock items
+    items = [ mock, mock, mock ]
+
+    # Create
+    tracker = Nanoc3::DependencyTracker.new(items)
+
+    # Record some dependencies
+    tracker.record_dependency(items[0], items[1])
+    tracker.record_dependency(items[1], items[2])
+    assert_contains_exactly [ items[1] ], tracker.objects_causing_outdatedness_of(items[0])
+
+    # Forget dependencies
+    tracker.forget_dependencies_for(items[0])
+    assert_empty tracker.objects_causing_outdatedness_of(items[0])
+  end
+
+end

data/test/base/test_directed_graph.rb

@@ -0,0 +1,285 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::DirectedGraphTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_direct_predecessors
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+
+    assert_equal [],    graph.direct_predecessors_of(1)
+    assert_equal [ 1 ], graph.direct_predecessors_of(2)
+    assert_equal [ 2 ], graph.direct_predecessors_of(3)
+  end
+
+  def test_predecessors
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+
+    assert_equal [],       graph.predecessors_of(1).sort
+    assert_equal [ 1 ],    graph.predecessors_of(2).sort
+    assert_equal [ 1, 2 ], graph.predecessors_of(3).sort
+  end
+
+  def test_direct_successors
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+
+    assert_equal [ 2 ], graph.direct_successors_of(1)
+    assert_equal [ 3 ], graph.direct_successors_of(2)
+    assert_equal [],    graph.direct_successors_of(3)
+  end
+
+  def test_successors
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+
+    assert_equal [ 2, 3 ], graph.successors_of(1).sort
+    assert_equal [ 3 ],    graph.successors_of(2).sort
+    assert_equal [],       graph.successors_of(3).sort
+  end
+
+  def test_edges
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+
+    assert_equal [ [ 0, 1 ], [ 1, 2 ] ], graph.edges.sort
+  end
+
+  def test_edges_with_new_vertices
+    graph = Nanoc3::DirectedGraph.new([ 1 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(3, 2)
+
+    assert_equal [ [ 0, 1 ], [ 2, 1 ] ], graph.edges.sort
+  end
+
+  def test_add_edge
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    
+    assert_equal [], graph.successors_of(1)
+    assert_equal [], graph.predecessors_of(2)
+
+    graph.add_edge(1, 2)
+
+    assert_equal [ 2 ], graph.successors_of(1)
+    assert_equal [ 1 ], graph.predecessors_of(2)
+  end
+
+  def test_add_edge_with_new_vertices
+    graph = Nanoc3::DirectedGraph.new([ 1 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(3, 2)
+
+    assert graph.vertices.include?(2)
+    assert graph.vertices.include?(3)
+  end
+
+  def test_remove_edge
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1,2)
+
+    assert_equal [ 2 ], graph.successors_of(1)
+    assert_equal [ 1 ], graph.predecessors_of(2)
+
+    graph.remove_edge(1, 2)
+
+    assert_equal [], graph.successors_of(1)
+    assert_equal [], graph.predecessors_of(2)
+  end
+
+  def test_delete_edges_from
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 1)
+    graph.add_edge(2, 3)
+    graph.add_edge(3, 2)
+    graph.add_edge(1, 3)
+    graph.add_edge(3, 1)
+
+    assert_equal [ 2, 3 ], graph.direct_predecessors_of(1).sort
+    assert_equal [ 2, 3 ], graph.direct_successors_of(1).sort
+    assert_equal [ 1, 3 ], graph.direct_predecessors_of(2).sort
+    assert_equal [ 1, 3 ], graph.direct_successors_of(2).sort
+    assert_equal [ 1, 2 ], graph.direct_predecessors_of(3).sort
+    assert_equal [ 1, 2 ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([]), graph.roots
+
+    graph.delete_edges_from(1)
+
+    assert_equal [ 2, 3 ], graph.direct_predecessors_of(1).sort
+    assert_equal [      ], graph.direct_successors_of(1).sort
+    assert_equal [ 3    ], graph.direct_predecessors_of(2).sort
+    assert_equal [ 1, 3 ], graph.direct_successors_of(2).sort
+    assert_equal [ 2    ], graph.direct_predecessors_of(3).sort
+    assert_equal [ 1, 2 ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([]), graph.roots
+
+    graph.delete_edges_from(2)
+
+    assert_equal [ 3    ], graph.direct_predecessors_of(1).sort
+    assert_equal [      ], graph.direct_successors_of(1).sort
+    assert_equal [ 3    ], graph.direct_predecessors_of(2).sort
+    assert_equal [      ], graph.direct_successors_of(2).sort
+    assert_equal [      ], graph.direct_predecessors_of(3).sort
+    assert_equal [ 1, 2 ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([ 3 ]), graph.roots
+  end
+
+  def test_delete_edges_to
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 1)
+    graph.add_edge(2, 3)
+    graph.add_edge(3, 2)
+    graph.add_edge(1, 3)
+    graph.add_edge(3, 1)
+
+    assert_equal [ 2, 3 ], graph.direct_predecessors_of(1).sort
+    assert_equal [ 2, 3 ], graph.direct_successors_of(1).sort
+    assert_equal [ 1, 3 ], graph.direct_predecessors_of(2).sort
+    assert_equal [ 1, 3 ], graph.direct_successors_of(2).sort
+    assert_equal [ 1, 2 ], graph.direct_predecessors_of(3).sort
+    assert_equal [ 1, 2 ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([]), graph.roots
+
+    graph.delete_edges_to(1)
+
+    assert_equal [      ], graph.direct_predecessors_of(1).sort
+    assert_equal [ 2, 3 ], graph.direct_successors_of(1).sort
+    assert_equal [ 1, 3 ], graph.direct_predecessors_of(2).sort
+    assert_equal [ 3    ], graph.direct_successors_of(2).sort
+    assert_equal [ 1, 2 ], graph.direct_predecessors_of(3).sort
+    assert_equal [ 2    ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([ 1 ]), graph.roots
+
+    graph.delete_edges_to(2)
+
+    assert_equal [      ], graph.direct_predecessors_of(1).sort
+    assert_equal [ 3    ], graph.direct_successors_of(1).sort
+    assert_equal [      ], graph.direct_predecessors_of(2).sort
+    assert_equal [ 3    ], graph.direct_successors_of(2).sort
+    assert_equal [ 1, 2 ], graph.direct_predecessors_of(3).sort
+    assert_equal [      ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([ 1, 2 ]), graph.roots
+  end
+
+  def test_delete_vertex
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 1)
+    graph.add_edge(2, 3)
+    graph.add_edge(3, 2)
+    graph.add_edge(1, 3)
+    graph.add_edge(3, 1)
+
+    graph.delete_vertex(2)
+
+    assert_equal [ 3 ], graph.direct_predecessors_of(1).sort
+    assert_equal [ 3 ], graph.direct_successors_of(1).sort
+    assert_equal [ 1 ], graph.direct_predecessors_of(3).sort
+    assert_equal [ 1 ], graph.direct_successors_of(3).sort
+    assert_equal Set.new([]), graph.roots
+  end
+
+  def test_delete_vertex_resulting_roots
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    assert_equal Set.new([ 1, 2, 3 ]), graph.roots
+
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+    assert_equal Set.new([ 1 ]), graph.roots
+
+    graph.delete_vertex(2)
+    assert_equal Set.new([ 1, 3 ]), graph.roots
+  end
+
+  def test_should_return_empty_array_for_nonexistant_vertices
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+
+    assert_equal [], graph.direct_predecessors_of(4)
+    assert_equal [], graph.predecessors_of(4)
+    assert_equal [], graph.direct_successors_of(4)
+    assert_equal [], graph.successors_of(4)
+  end
+
+  def test_roots_after_init
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+
+    assert_equal Set.new([ 1, 2, 3 ]), graph.roots
+  end
+
+  def test_roots_after_adding_edge
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    assert_equal Set.new([ 1, 3 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 3)
+    assert_equal Set.new([ 1, 2 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(2, 1)
+    assert_equal Set.new([ 2, 3 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+    assert_equal Set.new([ 1 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+    graph.add_edge(3, 1)
+    assert_equal Set.new([]), graph.roots
+  end
+
+  def test_roots_after_removing_edge
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.remove_edge(1, 2)
+    assert_equal Set.new([ 1, 2, 3 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 3)
+    assert_equal Set.new([ 1, 2 ]), graph.roots
+    graph.remove_edge(1, 2) # no such edge
+    assert_equal Set.new([ 1, 2 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(2, 1)
+    graph.remove_edge(2, 1)
+    assert_equal Set.new([ 1, 2, 3 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+    graph.remove_edge(1, 2)
+    assert_equal Set.new([ 1, 2 ]), graph.roots
+    graph.remove_edge(2, 3)
+    assert_equal Set.new([ 1, 2, 3 ]), graph.roots
+
+    graph = Nanoc3::DirectedGraph.new([ 1, 2, 3 ])
+    graph.add_edge(1, 2)
+    graph.add_edge(2, 3)
+    graph.add_edge(3, 1)
+    graph.remove_edge(1, 2)
+    assert_equal Set.new([ 2 ]), graph.roots
+    graph.remove_edge(2, 3)
+    assert_equal Set.new([ 2, 3 ]), graph.roots
+    graph.remove_edge(3, 1)
+    assert_equal Set.new([ 1, 2, 3 ]), graph.roots
+  end
+
+end

data/test/base/test_filter.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::FilterTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_initialize
+    # Create filter
+    filter = Nanoc3::Filter.new
+
+    # Test assigns
+    assert_equal({}, filter.instance_eval { @assigns })
+  end
+
+  def test_assigns
+    # Create filter
+    filter = Nanoc3::Filter.new({ :foo => 'bar' })
+
+    # Check assigns
+    assert_equal('bar', filter.assigns[:foo])
+  end
+
+  def test_assigns_with_instance_variables
+    # Create filter
+    filter = Nanoc3::Filter.new({ :foo => 'bar' })
+
+    # Check assigns
+    assert_equal('bar', filter.instance_eval { @foo })
+  end
+
+  def test_assigns_with_instance_methods
+    # Create filter
+    filter = Nanoc3::Filter.new({ :foo => 'bar' })
+
+    # Check assigns
+    assert_equal('bar', filter.instance_eval { foo })
+  end
+
+  def test_run
+    # Create filter
+    filter = Nanoc3::Filter.new
+
+    # Make sure an error is raised
+    assert_raises(NotImplementedError) do
+      filter.run(nil)
+    end
+  end
+
+  def test_filename_item
+    # Mock items
+    item = mock
+    item.expects(:identifier).returns('/foo/bar/baz/')
+    item_rep = mock
+    item_rep.expects(:name).returns(:quux)
+
+    # Create filter
+    filter = Nanoc3::Filter.new({ :item => item, :item_rep => item_rep })
+
+    # Check filename
+    assert_equal('item /foo/bar/baz/ (rep quux)', filter.filename)
+  end
+
+  def test_filename_layout
+    # Mock items
+    layout = mock
+    layout.expects(:identifier).returns('/wohba/')
+
+    # Create filter
+    filter = Nanoc3::Filter.new({ :item => mock, :item_rep => mock, :layout => layout })
+
+    # Check filename
+    assert_equal('layout /wohba/', filter.filename)
+  end
+
+  def test_filename_unknown
+    # Create filter
+    filter = Nanoc3::Filter.new({})
+
+    # Check filename
+    assert_equal('?', filter.filename)
+  end
+
+end