nanoc 3.2.4 → 3.3.0

data/test/base/test_layout.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+class Nanoc::LayoutTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_initialize
+    # Make sure attributes are cleaned
+    layout = Nanoc::Layout.new("content", { 'foo' => 'bar' }, '/foo/')
+    assert_equal({ :foo => 'bar' }, layout.attributes)
+
+    # Make sure identifier is cleaned
+    layout = Nanoc::Layout.new("content", { 'foo' => 'bar' }, 'foo')
+    assert_equal('/foo/', layout.identifier)
+  end
+
+  def test_frozen_identifier
+    layout = Nanoc::Layout.new("foo", {}, '/foo')
+
+    raised = false
+    begin
+      layout.identifier.chop!
+    rescue => error
+      raised = true
+      assert_match /^can't modify frozen [Ss]tring$/, error.message
+    end
+    assert raised, 'Should have raised when trying to modify a frozen string'
+  end
+
+  def test_lookup_with_known_attribute
+    # Create layout
+    layout = Nanoc::Layout.new("content", { 'foo' => 'bar' }, '/foo/')
+
+    # Check attributes
+    assert_equal('bar', layout[:foo])
+  end
+
+  def test_lookup_with_unknown_attribute
+    # Create layout
+    layout = Nanoc::Layout.new("content", { 'foo' => 'bar' }, '/foo/')
+
+    # Check attributes
+    assert_equal(nil, layout[:filter])
+  end
+
+  def test_dump_and_load
+    layout = Nanoc::Layout.new(
+      "foobar",
+      { :a => { :b => 123 }},
+      '/foo/')
+
+    layout = Marshal.load(Marshal.dump(layout))
+
+    assert_equal '/foo/', layout.identifier
+    assert_equal 'foobar', layout.raw_content
+    assert_equal({ :a => { :b => 123 }}, layout.attributes)
+  end
+
+end

data/test/base/test_memoization.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+class Nanoc::MemoizationTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  class Sample1
+
+    extend Nanoc::Memoization
+
+    def initialize(value)
+      @value = value
+    end
+
+    def run(n)
+      @value*10 + n
+    end
+    memoize :run
+
+  end
+
+  class Sample2
+
+    extend Nanoc::Memoization
+
+    def initialize(value)
+      @value = value
+    end
+
+    def run(n)
+      @value*100 + n
+    end
+    memoize :run
+
+  end
+
+  class EqualSample
+
+    extend Nanoc::Memoization
+
+    def initialize(value)
+      @value = value
+    end
+
+    def hash
+      4
+    end
+
+    def eql?(other)
+      true
+    end
+
+    def ==(other)
+      true
+    end
+
+    def run(n)
+      @value*10 + n
+    end
+    memoize :run
+
+  end
+
+  def test
+    sample1a = Sample1.new(10)
+    sample1b = Sample1.new(15)
+    sample2a = Sample2.new(20)
+    sample2b = Sample2.new(25)
+
+    3.times do
+      assert_equal (10*10+5),  sample1a.run(5)
+      assert_equal (10*15+7),  sample1b.run(7)
+      assert_equal (100*20+5), sample2a.run(5)
+      assert_equal (100*25+7), sample2b.run(7)
+    end
+  end
+
+  def test_equal
+    sample1 = EqualSample.new(2)
+    sample2 = EqualSample.new(3)
+
+    3.times do
+      assert_equal (2*10+5), sample1.run(5)
+      assert_equal (2*10+3), sample1.run(3)
+      assert_equal (3*10+5), sample2.run(5)
+      assert_equal (3*10+3), sample2.run(3)
+    end
+  end
+
+end

data/test/base/test_notification_center.rb

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

data/test/base/test_outdatedness_checker.rb

@@ -0,0 +1,394 @@
+# encoding: utf-8
+
+class Nanoc::OutdatednessCheckerTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_not_outdated
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      File.open('lib/stuff.rb', 'w') { |io| io.write('$foo = 123') }
+
+      site.compile
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items[0].reps[0]
+      assert_nil outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_item_checksum_nil
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      File.open('lib/stuff.rb', 'w') { |io| io.write('$foo = 123') }
+
+      site.compile
+    end
+
+    # Delete checksums
+    with_site(:name => 'foo') do |site|
+      FileUtils.rm('tmp/checksums')
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::NotEnoughData,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_compiled_file_doesnt_exist
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      File.open('lib/stuff.rb', 'w') { |io| io.write('$foo = 123') }
+
+      site.compile
+    end
+
+    # Delete old item
+    FileUtils.cd('foo') do
+      FileUtils.rm_rf('output/index.html')
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::NotWritten,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_item_checksum_is_different
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      File.open('content/new.html', 'w') { |io| io.write('o hello too') }
+      File.open('lib/stuff.rb', 'w') { |io| io.write('$foo = 123') }
+
+      site.compile
+    end
+
+    # Create new item
+    FileUtils.cd('foo') do
+      File.open('content/new.html', 'w') { |io| io.write('o hello DIFFERENT!!!') }
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/new/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::SourceModified,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_dependent_layout_outdated
+    # Compile once
+    with_site(:name => 'foo', :compilation_rule_content => 'layout "/default/"', :has_layout => true) do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      File.open('layouts/default.html', 'w') { |io| io.write('!!! <%= yield %> !!!') }
+
+      site.compile
+    end
+
+    # Change layout
+    FileUtils.cd('foo') do
+      File.open('layouts/default.html', 'w') { |io| io.write('!!! <%= yield %> !!! different') }
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      # FIXME ugly fugly hack
+      site.compiler.load
+
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::DependenciesOutdated,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_dependent_item_outdated
+    # Compile once
+    with_site(:name => 'foo', :compilation_rule_content => 'filter :erb') do |site|
+      File.open('content/a.html', 'w') do |io|
+        io.write('<%= @items.find { |i| i.identifier == "/b/" }.compiled_content %>')
+      end
+      File.open('content/b.html', 'w') do |io|
+        io.write('stuff')
+      end
+
+      site.compile
+    end
+
+    # Change item
+    FileUtils.cd('foo') do
+      File.open('content/b.html', 'w') do |io|
+        io.write('stuff different!!!')
+      end
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      # FIXME ugly fugly hack
+      site.compiler.load
+
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/a/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::DependenciesOutdated,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_dependent_item_outdated_chained
+    # Compile once
+    with_site(:name => 'foo', :compilation_rule_content => 'filter :erb') do |site|
+      File.open('content/a.html', 'w') do |io|
+        io.write('<%= @items.find { |i| i.identifier == "/b/" }.compiled_content %> aaa')
+      end
+      File.open('content/b.html', 'w') do |io|
+        io.write('<%= @items.find { |i| i.identifier == "/c/" }.compiled_content %> bbb')
+      end
+      File.open('content/c.html', 'w') do |io|
+        io.write('stuff')
+      end
+
+      site.compile
+    end
+
+    # Change item
+    FileUtils.cd('foo') do
+      File.open('content/c.html', 'w') do |io|
+        io.write('stuff different!!!')
+      end
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      # FIXME ugly fugly hack
+      site.compiler.load
+
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/a/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::DependenciesOutdated,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_dependent_item_removed
+    # Compile once
+    with_site(:name => 'foo', :compilation_rule_content => 'filter :erb') do |site|
+      File.open('content/a.html', 'w') do |io|
+        io.write('<% @items.select { |i| i.identifier != @item.identifier }.each do |i| %>')
+        io.write('  <%= i.compiled_content %>')
+        io.write('<% end %>')
+      end
+      File.open('content/b.html', 'w') do |io|
+        io.write('stuff')
+      end
+
+      site.compile
+    end
+
+    # Delete item
+    FileUtils.cd('foo') do
+      FileUtils.rm_rf('content/b.html')
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      # FIXME ugly fugly hack
+      site.compiler.load
+
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/a/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::DependenciesOutdated,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_dependent_item_added
+    # Compile once
+    with_site(:name => 'foo', :compilation_rule_content => 'filter :erb') do |site|
+      File.open('content/a.html', 'w') do |io|
+        io.write('<% @items.select { |i| i.identifier != @item.identifier }.each do |i| %>')
+        io.write('  <%= i.compiled_content %>')
+        io.write('<% end %>')
+      end
+      File.open('content/b.html', 'w') do |io|
+        io.write('stuff')
+      end
+
+      site.compile
+    end
+
+    # Add item
+    FileUtils.cd('foo') do
+      File.open('content/z.html', 'w') do |io|
+        io.write('moar stuff')
+      end
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      # FIXME ugly fugly hack
+      site.compiler.load
+
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/a/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::DependenciesOutdated,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  # TODO make sure outdatedness of non-outdated items is correct
+
+  def test_outdated_if_code_snippets_outdated
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+
+      site.compile
+    end
+
+    # Change code
+    FileUtils.cd('foo') do
+      File.open('lib/moo.rb', 'w') { |io| io.write('def moo ; puts "moo" ; end') }
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::CodeSnippetsModified,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_config_outdated
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+
+      site.compile
+    end
+
+    # Change code
+    FileUtils.cd('foo') do
+      File.open('config.yaml', 'w') { |io| io.write('awesome: true') }
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::ConfigurationModified,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_not_outdated_if_irrelevant_rule_modified
+    # Compile once
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+
+      site.compile
+    end
+
+    # Change code
+    FileUtils.cd('foo') do
+      File.open('Rules', 'a') { |io| io.write('layout "/moo/", :haml') }
+    end
+
+    # Check
+    with_site(:name => 'foo') do |site|
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_nil outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_outdated_if_relevant_rule_modified
+    # Create site
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      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("  '/index.html'\n")
+        io.write("end\n")
+      end
+    end
+
+    # Compile once
+    FileUtils.cd('foo') do
+      site = Nanoc::Site.new('.')
+      site.compile
+    end
+
+    # Modify rules
+    FileUtils.cd('foo') do
+      File.open('Rules', 'w') do |io|
+        io.write("compile '/' do\n")
+        io.write("end\n")
+        io.write("\n")
+        io.write("route '/' do\n")
+        io.write("  '/index.html'\n")
+        io.write("end\n")
+      end
+    end
+
+    # Check
+    FileUtils.cd('foo') do
+      site = Nanoc::Site.new('.')
+      outdatedness_checker = site.compiler.send :outdatedness_checker
+      rep = site.items.find { |i| i.identifier == '/' }.reps[0]
+      assert_equal ::Nanoc::OutdatednessReasons::RulesModified,
+        outdatedness_checker.outdatedness_reason_for(rep)
+    end
+  end
+
+  def test_items_in_rules_should_not_cause_outdatedness
+    # Create site
+    with_site(:name => 'foo') do |site|
+      File.open('content/index.html', 'w') { |io| io.write('o hello') }
+      File.open('Rules', 'w') do |io|
+        io.write("compile '/' do\n")
+        io.write("  filter :erb, :stuff => @items\n")
+        io.write("end\n")
+        io.write("\n")
+        io.write("route '/' do\n")
+        io.write("  '/index.html'\n")
+        io.write("end\n")
+      end
+    end
+
+    # Compile
+    FileUtils.cd('foo') do
+      site = Nanoc::Site.new('.')
+      site.compile
+    end
+
+    # Assert not outdated
+    FileUtils.cd('foo') do
+      site = Nanoc::Site.new('.')
+      outdatedness_checker = site.compiler.outdatedness_checker
+      site.items.each do |item|
+        refute outdatedness_checker.outdated?(item), "item should not be outdated"
+      end
+    end
+  end
+
+end