nanoc 3.4.3 → 3.5.0b1

data/lib/nanoc/helpers/xml_sitemap.rb

@@ -35,12 +35,16 @@ module Nanoc::Helpers
     #
     # @option params [Array] :items A list of items to include in the sitemap
     #
+    # @option params [Proc] :rep_select A proc to filter reps through. If the
+    #   proc returns true, the rep will be included; otherwise, it will not.
+    #
     # @return [String] The XML sitemap
     def xml_sitemap(params={})
       require 'builder'
 
       # Extract parameters
-      items = params.fetch(:items) { @items.reject { |i| i[:is_hidden] } }
+      items       = params.fetch(:items) { @items.reject { |i| i[:is_hidden] } }
+      select_proc = params.fetch(:rep_select, nil)
 
       # Create builder
       buffer = ''
@@ -55,8 +59,10 @@ module Nanoc::Helpers
       xml.instruct!
       xml.urlset(:xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9') do
         # Add item
-        items.each do |item|
-          item.reps.reject { |r| r.raw_path.nil? }.each do |rep|
+        items.sort_by { |i| i.identifier }.each do |item|
+          reps = item.reps.reject { |r| r.raw_path.nil? }
+          reps.reject! { |r| !select_proc[r] } if select_proc
+          reps.sort_by { |r| r.name.to_s }.each do |rep|
             xml.url do
               xml.loc         @site.config[:base_url] + rep.path
               xml.lastmod     item[:mtime].to_iso8601_date unless item[:mtime].nil?

data/tasks/doc.rake

@@ -11,6 +11,7 @@ YARD::Rake::YardocTask.new(:doc) do |yard|
     '--readme',          'README.md',
     '--files',           'NEWS.md,LICENSE',
     '--output-dir',      'doc/yardoc',
-    '--template-path',   'doc/yardoc_templates'
+    '--template-path',   'doc/yardoc_templates',
+    '--load',            'doc/yardoc_handlers/identifier.rb'
   ]
 end

data/test/base/core_ext/array_spec.rb

@@ -1,21 +1,21 @@
 # encoding: utf-8
 
-describe 'Array#symbolize_keys' do
+describe 'Array#symbolize_keys_recursively' do
 
   it 'should convert keys to symbols' do
     array_old = [ :abc, 'xyz', { 'foo' => 'bar', :baz => :qux } ]
     array_new = [ :abc, 'xyz', { :foo  => 'bar', :baz => :qux } ]
-    array_old.symbolize_keys.must_equal array_new
+    array_old.symbolize_keys_recursively.must_equal array_new
   end
 
 end
 
-describe 'Array#stringify_keys' do
+describe 'Array#stringify_keys_recursively' do
 
   it 'should convert keys to strings' do
     array_old = [ :abc, 'xyz', { :foo  => 'bar', 'baz' => :qux } ]
     array_new = [ :abc, 'xyz', { 'foo' => 'bar', 'baz' => :qux } ]
-    array_old.stringify_keys.must_equal array_new
+    array_old.stringify_keys_recursively.must_equal array_new
   end
 
 end

data/test/base/core_ext/hash_spec.rb

@@ -1,39 +1,39 @@
 # encoding: utf-8
 
-describe 'Hash#symbolize_keys' do
+describe 'Hash#symbolize_keys_recursively' do
 
   it 'should convert keys to symbols' do
     hash_old = { 'foo' => 'bar' }
     hash_new = { :foo  => 'bar' }
-    hash_old.symbolize_keys.must_equal hash_new
+    hash_old.symbolize_keys_recursively.must_equal hash_new
   end
 
 end
 
-describe 'Hash#stringify_keys' do
+describe 'Hash#stringify_keys_recursively' do
 
   it 'should leave strings as strings' do
     hash_old = { 'foo' => 'bar' }
     hash_new = { 'foo' => 'bar' }
-    hash_old.stringify_keys.must_equal hash_new
+    hash_old.stringify_keys_recursively.must_equal hash_new
   end
 
   it 'should convert symbols to strings' do
     hash_old = { :foo  => 'bar' }
     hash_new = { 'foo' => 'bar' }
-    hash_old.stringify_keys.must_equal hash_new
+    hash_old.stringify_keys_recursively.must_equal hash_new
   end
 
   it 'should convert integers to strings' do
     hash_old = { 123   => 'bar' }
     hash_new = { '123' => 'bar' }
-    hash_old.stringify_keys.must_equal hash_new
+    hash_old.stringify_keys_recursively.must_equal hash_new
   end
 
   it 'should convert nil to an empty string' do
     hash_old = { nil => 'bar' }
     hash_new = { ''  => 'bar' }
-    hash_old.stringify_keys.must_equal hash_new
+    hash_old.stringify_keys_recursively.must_equal hash_new
   end
 
 end

data/test/base/core_ext/pathname_spec.rb

@@ -4,10 +4,15 @@ describe 'Pathname#checksum' do
 
   it 'should work on empty files' do
     begin
+      # Create file
       FileUtils.mkdir_p('tmp')
       File.open('tmp/myfile', 'w') { |io| io.write('') }
+      now = Time.now
+      File.utime(now, now, 'tmp/myfile')
+
+      # Create checksum
       pathname = Pathname.new('tmp/myfile')
-      pathname.checksum.must_equal 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
+      pathname.checksum.must_equal '0-' + now.to_s
     ensure
       FileUtils.rm_rf('tmp')
     end
@@ -15,10 +20,15 @@ describe 'Pathname#checksum' do
 
   it 'should work on all files' do
     begin
+      # Create file
       FileUtils.mkdir_p('tmp')
       File.open('tmp/myfile', 'w') { |io| io.write('abc') }
+      now = Time.now
+      File.utime(now, now, 'tmp/myfile')
+
+      # Create checksum
       pathname = Pathname.new('tmp/myfile')
-      pathname.checksum.must_equal 'a9993e364706816aba3e25717850c26c9cd0d89d'
+      pathname.checksum.must_equal '3-' + now.to_s
     ensure
       FileUtils.rm_rf('tmp')
     end

data/test/base/test_compiler_dsl.rb

@@ -16,6 +16,30 @@ class Nanoc::CompilerDSLTest < MiniTest::Unit::TestCase
     # TODO implement
   end
 
+  def test_include_rules
+    # Create site
+    Nanoc::CLI.run %w( create_site with_bonus_rules )
+    FileUtils.cd('with_bonus_rules') do
+      # Create rep
+      item = Nanoc::Item.new('foo', { :extension => 'bar' }, '/foo/')
+      rep  = Nanoc::ItemRep.new(item, :default)
+
+      # Create a bonus rules file
+      File.open('more_rules.rb', 'w') { |io| io.write "passthrough '/foo/'" }
+
+      # Create other necessary stuff
+      site = Nanoc::Site.new('.')
+      site.items << item
+      dsl = site.compiler.rules_collection.dsl
+
+      # Include rules
+      dsl.include_rules 'more_rules'
+
+      # Check that the rule made it into the collection
+      refute_nil site.compiler.rules_collection.routing_rule_for(rep)
+    end
+  end
+
   def test_passthrough
     with_site do
       # Create rules

data/test/base/test_item_rep.rb

@@ -221,32 +221,6 @@ class Nanoc::ItemRepTest < MiniTest::Unit::TestCase
     assert_equal a_long_time_ago.to_s, File.mtime(item_rep.raw_path).to_s
   end
 
-  def test_write_should_not_touch_identical_binary_files
-    # Create temporary source file
-    File.open('blahblah', 'w') { |io| io.write("Blah blah…") }
-    full_file_path = File.expand_path('blahblah')
-
-    # Mock item
-    item = Nanoc::Item.new(
-      full_file_path, {}, '/',
-      :binary => true
-    )
-
-    # Create rep
-    item_rep = Nanoc::ItemRep.new(item, :foo)
-    item_rep.raw_path = 'foo/bar/baz/quux'
-
-    # Write once
-    item_rep.write
-    a_long_time_ago = Time.now-1_000_000
-    File.utime(a_long_time_ago, a_long_time_ago, item_rep.raw_path)
-
-    # Write again
-    assert_equal a_long_time_ago.to_s, File.mtime(item_rep.raw_path).to_s
-    item_rep.write
-    assert_equal a_long_time_ago.to_s, File.mtime(item_rep.raw_path).to_s
-  end
-
   def test_write
     # Mock item
     item = Nanoc::Item.new(
@@ -536,6 +510,64 @@ class Nanoc::ItemRepTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_write_should_calculate_is_modified_correctly_for_binary_items_new
+    # Mock item
+    FileUtils.mkdir_p('content')
+    File.open('content/meow.dat', 'w') { |io| io.write('asdf') }
+    item = Nanoc::Item.new(
+      "content/meow.dat", {}, '/',
+      :binary => true
+    )
+
+    # Create rep
+    item_rep = Nanoc::ItemRep.new(item, :foo)
+    FileUtils.mkdir_p('tmp')
+    File.open('tmp/woof.dat', 'w') { |io| io.write('fdsa') }
+    item_rep.instance_eval { @temporary_filenames[:last] = 'tmp/woof.dat' }
+    item_rep.raw_path = 'output/woof.dat'
+
+    # Write
+    notified = false
+    Nanoc::NotificationCenter.on(:rep_written, self) do |rep, raw_path, is_created, is_modified|
+      notified = true
+      assert is_created
+      assert is_modified
+    end
+    item_rep.write
+    assert notified
+    Nanoc::NotificationCenter.remove(:rep_written, self)
+  end
+
+  def test_write_should_calculate_is_modified_correctly_for_binary_items_existing
+    # Mock item
+    FileUtils.mkdir_p('content')
+    File.open('content/meow.dat', 'w') { |io| io.write('asdf') }
+    item = Nanoc::Item.new(
+      "content/meow.dat", {}, '/',
+      :binary => true
+    )
+
+    # Create rep
+    item_rep = Nanoc::ItemRep.new(item, :foo)
+    FileUtils.mkdir_p('tmp')
+    File.open('tmp/woof.dat', 'w') { |io| io.write('fdsa') }
+    FileUtils.mkdir_p('output')
+    File.open('output/woof.dat', 'w') { |io| io.write('fdsa but different') }
+    item_rep.instance_eval { @temporary_filenames[:last] = 'tmp/woof.dat' }
+    item_rep.raw_path = 'output/woof.dat'
+
+    # Write
+    notified = false
+    Nanoc::NotificationCenter.on(:rep_written, self) do |rep, raw_path, is_created, is_modified|
+      notified = true
+      refute is_created
+      assert is_modified
+    end
+    item_rep.write
+    assert notified
+    Nanoc::NotificationCenter.remove(:rep_written, self)
+  end
+
 private
 
   def create_binary_item

data/test/cli/commands/test_watch.rb

@@ -4,14 +4,6 @@ class Nanoc::CLI::Commands::WatchTest < MiniTest::Unit::TestCase
 
   include Nanoc::TestHelpers
 
-  def setup
-    super
-    @@warned ||= begin
-      STDERR.puts "\n(fssm deprecation warning can be ignored; master branch uses guard/listen)"
-      true
-    end
-  end
-
   def test_run
     with_site do |s|
       watch_thread = Thread.new do

data/test/data_sources/test_static.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+class Nanoc::DataSources::StaticTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def new_data_source(params=nil)
+    # Mock site
+    site = Nanoc::Site.new({})
+
+    # Create data source
+    data_source = Nanoc::DataSources::Static.new(site, nil, nil, params)
+
+    # Done
+    data_source
+  end
+
+  def test_items
+    # Create data source
+    data_source = new_data_source(:prefix => 'foo')
+
+    # Create sample files
+    FileUtils.mkdir_p('foo')
+    FileUtils.mkdir_p('foo/a/b')
+    File.open('foo/bar.png',   'w') { |io| io.write("random binary data") }
+    File.open('foo/b.c.css',   'w') { |io| io.write("more binary data") }
+    File.open('foo/a/b/c.gif', 'w') { |io| io.write("yet more binary data") }
+
+    # Get expected and actual output
+    expected_out = [
+      Nanoc::Item.new(
+        'foo/bar.png',
+        { :extension => 'png', :filename => 'foo/bar.png' },
+        '/bar.png/',
+        :binary => true,
+        :mtime => File.mtime('foo/bar.png'),
+        :checksum => Pathname.new('foo/bar.png').checksum
+      ),
+      Nanoc::Item.new(
+        'foo/b.c.css',
+        { :extension => 'css', :filename => 'foo/b.c.css' },
+        '/b.c.css/',
+        :binary => true,
+        :mtime => File.mtime('foo/b.c.css'),
+        :checksum => Pathname.new('foo/b.c.css').checksum
+      ),
+      Nanoc::Item.new(
+        'foo/a/b/c.gif',
+        { :extension => 'gif', :filename => 'foo/a/b/c.gif' },
+        '/a/b/c.gif/',
+        :binary => true,
+        :mtime => File.mtime('foo/a/b/c.gif'),
+        :checksum => Pathname.new('foo/a/b/c.gif').checksum
+      )
+    ].sort_by { |i| i.identifier }
+
+    actual_out = data_source.send(:items).sort_by { |i| i.identifier }
+
+    (0..expected_out.size-1).each do |i|
+      assert_equal expected_out[i].raw_content, actual_out[i].raw_content, 'content must match'
+      assert_equal expected_out[i].identifier, actual_out[i].identifier, 'identifier must match'
+      assert_equal expected_out[i].mtime, actual_out[i].mtime, 'mtime must match'
+      assert_equal expected_out[i].raw_filename, actual_out[i].raw_filename, 'file paths must match'
+    end
+  end
+end

data/test/extra/checking/checks/test_css.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+class Nanoc::Extra::Checking::Checks::CSSTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def test_run_ok
+    with_site do |site|
+      # Create files
+      FileUtils.mkdir_p('output')
+      File.open('output/blah.html', 'w') { |io| io.write('<h1>Hi!</h1>') }
+      File.open('output/style.css', 'w') { |io| io.write('h1 { color: red; }') }
+
+      # Run check
+      check = Nanoc::Extra::Checking::Checks::CSS.new(site)
+      check.run
+
+      # Check
+      assert check.issues.empty?
+    end
+  end
+
+  def test_run_error
+    with_site do |site|
+      # Create files
+      FileUtils.mkdir_p('output')
+      File.open('output/blah.html', 'w') { |io| io.write('<h1>Hi!</h1>') }
+      File.open('output/style.css', 'w') { |io| io.write('h1 { coxlor: rxed; }') }
+
+      # Run check
+      check = Nanoc::Extra::Checking::Checks::CSS.new(site)
+      check.run
+
+      # Check
+      refute check.issues.empty?
+    end
+  end
+
+end
+

data/test/extra/checking/checks/test_external_links.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+class Nanoc::Extra::Checking::Checks::ExternalLinksTest < MiniTest::Unit::TestCase
+
+  include Nanoc::TestHelpers
+
+  def setup
+    super
+    require 'timeout'
+  end
+
+  def test_run
+    with_site do |site|
+      # Create files
+      FileUtils.mkdir_p('output')
+      FileUtils.mkdir_p('output/stuff')
+      File.open('output/foo.txt',  'w') { |io| io.write('<a href="http://example.com/404">broken</a>') }
+      File.open('output/bar.html', 'w') { |io| io.write('<a href="http://example.com/">not broken</a>') }
+
+      # Create check
+      check = Nanoc::Extra::Checking::Checks::InternalLinks.new(site)
+      check.run
+
+      # Test
+      assert check.issues.empty?
+    end
+  end
+
+  def test_valid?
+    with_site do |site|
+      # Create files
+      FileUtils.mkdir_p('output')
+      FileUtils.mkdir_p('output/stuff')
+      File.open('output/origin',     'w') { |io| io.write('hi') }
+      File.open('output/foo',        'w') { |io| io.write('hi') }
+      File.open('output/stuff/blah', 'w') { |io| io.write('hi') }
+
+      # Create check
+      check = Nanoc::Extra::Checking::Checks::ExternalLinks.new(site)
+
+      # Test
+      self.run_server_while do
+        assert ok?(check, 'http://127.0.0.1:9204/200')
+        assert ok?(check, 'foo://example.com/')
+        refute ok?(check, 'http://127.0.0.1:9204">')
+      end
+    end
+  end
+
+  def ok?(check, url)
+    Timeout.timeout(3) do
+      check.validate(url).nil?
+    end
+  end
+
+  def run_server_while
+    @app = lambda { |env| [ env['REQUEST_PATH'][1..-1].to_i, {}, [ '... Useless body ...' ] ] }
+    @server = nil
+
+    @thread = Thread.new do
+      Rack::Handler::WEBrick.run(@app, :Host => @host='127.0.0.1', :Port => @port=9204) do |server|
+        @server = server
+      end
+    end
+
+    Timeout::timeout(5) do
+      Thread.pass until @server
+    end
+
+    yield
+
+    @server.stop
+    @thread.kill
+  end
+
+end