RubyGems - nanoc - Versions diffs - 3.4.3 → 3.5.0b1 - Mend

nanoc 3.4.3 → 3.5.0b1

Files changed (85) hide show

data/CONTRIBUTING.md +25 -0
data/Gemfile +3 -1
data/Gemfile.lock +22 -13
data/NEWS.md +27 -0
data/README.md +3 -1
data/lib/nanoc.rb +2 -2
data/lib/nanoc/base/compilation/compiler_dsl.rb +19 -0
data/lib/nanoc/base/core_ext/array.rb +18 -8
data/lib/nanoc/base/core_ext/hash.rb +18 -8
data/lib/nanoc/base/core_ext/pathname.rb +2 -8
data/lib/nanoc/base/plugin_registry.rb +57 -19
data/lib/nanoc/base/result_data/item_rep.rb +3 -15
data/lib/nanoc/base/source_data/item.rb +1 -1
data/lib/nanoc/base/source_data/layout.rb +1 -1
data/lib/nanoc/base/source_data/site.rb +15 -19
data/lib/nanoc/cli.rb +28 -23
data/lib/nanoc/cli/command_runner.rb +4 -0
data/lib/nanoc/cli/commands/autocompile.rb +15 -6
data/lib/nanoc/cli/commands/check.rb +47 -0
data/lib/nanoc/cli/commands/compile.rb +271 -195
data/lib/nanoc/cli/commands/create-site.rb +5 -5
data/lib/nanoc/cli/commands/deploy.rb +16 -4
data/lib/nanoc/cli/commands/prune.rb +3 -3
data/lib/nanoc/cli/commands/show-data.rb +73 -58
data/lib/nanoc/cli/commands/show-rules.rb +1 -1
data/lib/nanoc/cli/commands/validate-css.rb +2 -3
data/lib/nanoc/cli/commands/validate-html.rb +2 -3
data/lib/nanoc/cli/commands/validate-links.rb +5 -11
data/lib/nanoc/cli/commands/view.rb +1 -1
data/lib/nanoc/cli/commands/watch.rb +38 -20
data/lib/nanoc/cli/error_handler.rb +122 -122
data/lib/nanoc/data_sources.rb +2 -0
data/lib/nanoc/data_sources/filesystem_unified.rb +1 -1
data/lib/nanoc/data_sources/filesystem_verbose.rb +1 -1
data/lib/nanoc/data_sources/static.rb +60 -0
data/lib/nanoc/extra.rb +2 -0
data/lib/nanoc/extra/checking.rb +16 -0
data/lib/nanoc/extra/checking/check.rb +33 -0
data/lib/nanoc/extra/checking/checks.rb +19 -0
data/lib/nanoc/extra/checking/checks/css.rb +23 -0
data/lib/nanoc/extra/checking/checks/external_links.rb +149 -0
data/lib/nanoc/extra/checking/checks/html.rb +24 -0
data/lib/nanoc/extra/checking/checks/internal_links.rb +57 -0
data/lib/nanoc/extra/checking/checks/stale.rb +23 -0
data/lib/nanoc/extra/checking/dsl.rb +31 -0
data/lib/nanoc/extra/checking/issue.rb +19 -0
data/lib/nanoc/extra/checking/runner.rb +130 -0
data/lib/nanoc/extra/link_collector.rb +57 -0
data/lib/nanoc/extra/pruner.rb +1 -1
data/lib/nanoc/extra/validators/links.rb +5 -262
data/lib/nanoc/extra/validators/w3c.rb +8 -76
data/lib/nanoc/filters/colorize_syntax.rb +1 -1
data/lib/nanoc/filters/handlebars.rb +2 -2
data/lib/nanoc/filters/less.rb +1 -1
data/lib/nanoc/filters/redcarpet.rb +1 -1
data/lib/nanoc/filters/rubypants.rb +1 -1
data/lib/nanoc/filters/slim.rb +1 -1
data/lib/nanoc/helpers/blogging.rb +163 -104
data/lib/nanoc/helpers/xml_sitemap.rb +9 -3
data/tasks/doc.rake +2 -1
data/test/base/core_ext/array_spec.rb +4 -4
data/test/base/core_ext/hash_spec.rb +7 -7
data/test/base/core_ext/pathname_spec.rb +12 -2
data/test/base/test_compiler_dsl.rb +24 -0
data/test/base/test_item_rep.rb +58 -26
data/test/cli/commands/test_watch.rb +0 -8
data/test/data_sources/test_static.rb +66 -0
data/test/extra/checking/checks/test_css.rb +40 -0
data/test/extra/checking/checks/test_external_links.rb +76 -0
data/test/extra/checking/checks/test_html.rb +40 -0
data/test/extra/checking/checks/test_internal_links.rb +46 -0
data/test/extra/checking/checks/test_stale.rb +49 -0
data/test/extra/checking/test_check.rb +16 -0
data/test/extra/checking/test_dsl.rb +20 -0
data/test/extra/checking/test_runner.rb +15 -0
data/test/extra/test_link_collector.rb +93 -0
data/test/extra/validators/test_links.rb +0 -64
data/test/extra/validators/test_w3c.rb +20 -26
data/test/filters/test_colorize_syntax.rb +15 -0
data/test/filters/test_less.rb +14 -0
data/test/filters/test_pandoc.rb +5 -1
data/test/helpers/test_blogging.rb +52 -8
data/test/helpers/test_xml_sitemap.rb +68 -0
data/test/test_gem.rb +1 -1
metadata +31 -6

data/test/extra/checking/checks/test_html.rb ADDED

@@ -0,0 +1,40 @@
+# encoding: utf-8
+class Nanoc::Extra::Checking::Checks::HTMLTest < 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('<!DOCTYPE html><html><head><title>Hello</title></head><body><h1>Hi!</h1></body>') }
+      File.open('output/style.css', 'w') { |io| io.write('h1 { coxlor: rxed; }') }
+      # Run check
+      check = Nanoc::Extra::Checking::Checks::HTML.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('<h2>Hi!</h1>') }
+      File.open('output/style.css', 'w') { |io| io.write('h1 { coxlor: rxed; }') }
+      # Run check
+      check = Nanoc::Extra::Checking::Checks::HTML.new(site)
+      check.run
+      # Check
+      refute check.issues.empty?
+    end
+  end
+end

data/test/extra/checking/checks/test_internal_links.rb ADDED

@@ -0,0 +1,46 @@
+# encoding: utf-8
+class Nanoc::Extra::Checking::Checks::InternalLinksTest < MiniTest::Unit::TestCase
+  include Nanoc::TestHelpers
+  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="/broken">broken</a>') }
+      File.open('output/bar.html', 'w') { |io| io.write('<a href="/foo.txt">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::InternalLinks.new(site)
+      # Test
+      assert check.send(:valid?, 'foo',         'output/origin')
+      assert check.send(:valid?, 'origin',      'output/origin')
+      assert check.send(:valid?, 'stuff/blah',  'output/origin')
+      assert check.send(:valid?, '/foo',        'output/origin')
+      assert check.send(:valid?, '/origin',     'output/origin')
+      assert check.send(:valid?, '/stuff/blah', 'output/origin')
+    end
+  end
+end

data/test/extra/checking/checks/test_stale.rb ADDED

@@ -0,0 +1,49 @@
+# encoding: utf-8
+class Nanoc::Extra::Checking::Checks::StaleTest < MiniTest::Unit::TestCase
+  include Nanoc::TestHelpers
+  def check_class
+    Nanoc::Extra::Checking::Checks::Stale
+  end
+  def calc_issues
+    site = Nanoc::Site.new('.')
+    check = check_class.new(site)
+    check.run
+    check.issues
+  end
+  def test_run_ok
+    with_site do |site|
+      assert Dir['content/*'].empty?
+      assert Dir['output/*'].empty?
+      # Empty
+      FileUtils.mkdir_p('output')
+      assert self.calc_issues.empty?
+      # One OK file
+      File.open('content/index.html', 'w') { |io| io.write('stuff') }
+      File.open('output/index.html', 'w') { |io| io.write('stuff') }
+      assert self.calc_issues.empty?
+    end
+  end
+  def test_run_error
+    with_site do |site|
+      assert Dir['content/*'].empty?
+      assert Dir['output/*'].empty?
+      File.open('content/index.html', 'w') { |io| io.write('stuff') }
+      File.open('output/WRONG.html', 'w') { |io| io.write('stuff') }
+      assert_equal 1, self.calc_issues.count
+      issue = self.calc_issues.to_a[0]
+      assert_equal "file without matching item", issue.description
+      assert_equal "output/WRONG.html", issue.subject
+    end
+  end
+end

data/test/extra/checking/test_check.rb ADDED

@@ -0,0 +1,16 @@
+# encoding: utf-8
+class Nanoc::Extra::Checking::CheckTest < MiniTest::Unit::TestCase
+  include Nanoc::TestHelpers
+  def test_output_filenames
+    with_site do |site|
+      check = Nanoc::Extra::Checking::Check.new(site)
+      assert check.output_filenames.empty?
+      File.open('output/foo.html', 'w') { |io| io.write 'hello' }
+      assert_equal [ 'output/foo.html' ], check.output_filenames
+    end
+  end
+end

data/test/extra/checking/test_dsl.rb ADDED

@@ -0,0 +1,20 @@
+# encoding: utf-8
+class Nanoc::Extra::Checking::DSLTest < MiniTest::Unit::TestCase
+  include Nanoc::TestHelpers
+  def test_from_file
+    with_site do |site|
+      File.open('Checks', 'w') { |io| io.write("check :foo do\n\nend\ndeploy_check :bar\n") }
+      dsl = Nanoc::Extra::Checking::DSL.from_file('Checks')
+      # One new check
+      refute Nanoc::Extra::Checking::Check.named(:foo).nil?
+      # One check marked for deployment
+      assert_equal [ :bar ], dsl.deploy_checks
+    end
+  end
+end

data/test/extra/checking/test_runner.rb ADDED

@@ -0,0 +1,15 @@
+# encoding: utf-8
+class Nanoc::Extra::Checking::RunnerTest < MiniTest::Unit::TestCase
+  include Nanoc::TestHelpers
+  def test_run
+    with_site do |site|
+      File.open('output/blah', 'w') { |io| io.write('I am stale! Haha!') }
+      runner = Nanoc::Extra::Checking::Runner.new(site)
+      runner.run_specific(%w( stale ))
+    end
+  end
+end

data/test/extra/test_link_collector.rb ADDED

@@ -0,0 +1,93 @@
+# encoding: utf-8
+class Nanoc::Extra::LinkCollectorTest < MiniTest::Unit::TestCase
+  include Nanoc::TestHelpers
+  def test_all
+    # Create dummy data
+    File.open('file-a.html', 'w') do |io|
+      io << %[<a href="http://example.com/">A 1</a>\n]
+      io << %[<a href="https://example.com/">A 2</a>\n]
+      io << %[<a href="stuff/"A 3></a>\n]
+      io << %[<a name="href-less-anchor">A 4</a>]
+      io << %[<a href="https://example.com/with-fragment#moo">A 5</a>\n]
+    end
+    File.open('file-b.html', 'w') do |io|
+      io << %[<a href="mailto:bob@example.com">B 1</a>\n]
+      io << %[<a href="../stuff">B 2</a>\n]
+      io << %[<a href="/stuff">B 3</a>\n]
+    end
+    # Create validator
+    collector = Nanoc::Extra::LinkCollector.new(%w( file-a.html file-b.html ))
+    # Test
+    hrefs_with_filenames = collector.filenames_per_href
+    hrefs = hrefs_with_filenames.keys
+    assert_includes hrefs, 'http://example.com/'
+    assert_includes hrefs, 'https://example.com/'
+    assert_includes hrefs, 'stuff/'
+    refute_includes hrefs, nil
+    assert_includes hrefs, 'mailto:bob@example.com'
+    assert_includes hrefs, '../stuff'
+    assert_includes hrefs, '/stuff'
+    refute_includes hrefs, 'https://example.com/with-fragment#moo'
+    assert_includes hrefs, 'https://example.com/with-fragment'
+  end
+  def test_external
+    # Create dummy data
+    File.open('file-a.html', 'w') do |io|
+      io << %[<a href="http://example.com/">A 1</a>\n]
+      io << %[<a href="https://example.com/">A 2</a>\n]
+      io << %[<a href="stuff/"A 3></a>\n]
+    end
+    File.open('file-b.html', 'w') do |io|
+      io << %[<a href="mailto:bob@example.com">B 1</a>\n]
+      io << %[<a href="../stuff">B 2</a>\n]
+      io << %[<a href="/stuff">B 3</a>\n]
+    end
+    # Create validator
+    collector = Nanoc::Extra::LinkCollector.new(%w( file-a.html file-b.html ), :external)
+    # Test
+    hrefs_with_filenames = collector.filenames_per_href
+    hrefs = hrefs_with_filenames.keys
+    assert_includes hrefs, 'http://example.com/'
+    assert_includes hrefs, 'https://example.com/'
+    refute_includes hrefs, 'stuff/'
+    assert_includes hrefs, 'mailto:bob@example.com'
+    refute_includes hrefs, '../stuff'
+    refute_includes hrefs, '/stuff'
+  end
+  def test_internal
+    # Create dummy data
+    File.open('file-a.html', 'w') do |io|
+      io << %[<a href="http://example.com/">A 1</a>\n]
+      io << %[<a href="https://example.com/">A 2</a>\n]
+      io << %[<a href="stuff/"A 3></a>\n]
+    end
+    File.open('file-b.html', 'w') do |io|
+      io << %[<a href="mailto:bob@example.com">B 1</a>\n]
+      io << %[<a href="../stuff">B 2</a>\n]
+      io << %[<a href="/stuff">B 3</a>\n]
+    end
+    # Create validator
+    collector = Nanoc::Extra::LinkCollector.new(%w( file-a.html file-b.html ), :internal)
+    # Test
+    hrefs_with_filenames = collector.filenames_per_href
+    hrefs = hrefs_with_filenames.keys
+    refute_includes hrefs, 'http://example.com/'
+    refute_includes hrefs, 'https://example.com/'
+    assert_includes hrefs, 'stuff/'
+    refute_includes hrefs, 'mailto:bob@example.com'
+    assert_includes hrefs, '../stuff'
+    assert_includes hrefs, '/stuff'
+  end
+end

data/test/extra/validators/test_links.rb CHANGED

@@ -4,68 +4,4 @@ class Nanoc::Extra::Validators::LinksTest < MiniTest::Unit::TestCase
   include Nanoc::TestHelpers
-  def test_is_external_href?
-    # Create validator
-    validator = Nanoc::Extra::Validators::Links.new(nil, nil)
-    # Test
-    assert  validator.send(:is_external_href?, 'http://example.com/')
-    assert  validator.send(:is_external_href?, 'https://example.com/')
-    assert  validator.send(:is_external_href?, 'mailto:bob@example.com')
-    assert !validator.send(:is_external_href?, '../stuff')
-    assert !validator.send(:is_external_href?, '/stuff')
-  end
-  def test_is_valid_internal_href?
-    # 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 validator
-    validator = Nanoc::Extra::Validators::Links.new('output', [ 'index.html' ])
-    # Test
-    assert validator.send(:is_valid_internal_href?, 'foo',         'output/origin')
-    assert validator.send(:is_valid_internal_href?, 'origin',      'output/origin')
-    assert validator.send(:is_valid_internal_href?, 'stuff/blah',  'output/origin')
-    assert validator.send(:is_valid_internal_href?, '/foo',        'output/origin')
-    assert validator.send(:is_valid_internal_href?, '/origin',     'output/origin')
-    assert validator.send(:is_valid_internal_href?, '/stuff/blah', 'output/origin')
-  end
-  def test_is_valid_external_href?
-    # Create validator
-    validator = Nanoc::Extra::Validators::Links.new('output', [ 'index.html' ])
-    validator.stubs(:fetch_http_status_for).returns(200)
-    # Test
-    assert validator.send(:is_valid_external_href?, 'http://example.com/')
-    assert validator.send(:is_valid_external_href?, 'https://example.com/')
-    assert validator.send(:is_valid_external_href?, 'foo://example.com/')
-    refute validator.send(:is_valid_external_href?, 'http://example.com/">')
-  end
-  def test_fetch_http_status_for
-    @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
-    Thread.pass until @server
-    validator = Nanoc::Extra::Validators::Links.new('output', [ 'index.html' ])
-    assert_equal 200, validator.send(:fetch_http_status_for, URI.parse('http://127.0.0.1:9204/200'))
-    assert_equal 404, validator.send(:fetch_http_status_for, URI.parse('http://127.0.0.1:9204/404'))
-    @server.stop
-    @thread.kill
-  end
 end

data/test/extra/validators/test_w3c.rb CHANGED

@@ -6,41 +6,35 @@ class Nanoc::Extra::Validators::W3CTest < MiniTest::Unit::TestCase
   def test_simple
     if_have 'w3c_validators' do
-      # Create some sample files
-      %w{ foo bar baz }.each do |filename|
-        %w{ xxx yyy }.each do |extension|
-          File.open("#{filename}.#{extension}", 'w') { |io| io.write("hello") }
+      with_site do |site|
+        # Create some sample files
+        %w{ foo bar baz }.each do |filename|
+          %w{ xxx yyy }.each do |extension|
+            File.open("output/#{filename}.#{extension}", 'w') { |io| io.write("hello") }
+          end
         end
-      end
-      # Create validator
-      w3c = Nanoc::Extra::Validators::W3C.new('.', [ :xxx ])
-      # Configure expectations
-      validator_result = mock
-      validator_result.expects(:errors).times(3)
-      validator = mock
-      validator.expects(:validate_file).times(3).returns(validator_result)
-      w3c.expects(:types_to_extensions).with([ :xxx ]).returns([ 'xxx' ])
-      w3c.expects(:validator_for).with('xxx').times(3).returns(validator)
-      w3c.expects(:validation_started).times(3)
-      w3c.expects(:validation_ended).times(3)
-      # Run
-      w3c.run
+        # Create validator
+        w3c = Nanoc::Extra::Validators::W3C.new('.', [ :html ])
+        # Run
+        w3c.run
+      end
     end
   end
   def test_with_unknown_types
     if_have 'w3c_validators' do
-      # Create validator
-      w3c = Nanoc::Extra::Validators::W3C.new('.', [ :foo ])
+      with_site do |site|
+        # Create validator
+        w3c = Nanoc::Extra::Validators::W3C.new('.', [ :foo ])
-      # Test
-      exception = assert_raises RuntimeError do
-        w3c.run
+        # Test
+        exception = assert_raises Nanoc::Errors::GenericTrivial do
+          w3c.run
+        end
+        assert_equal 'unknown type(s) specified: foo', exception.message
       end
-      assert_equal 'unknown type: foo', exception.message
     end
   end

data/test/filters/test_colorize_syntax.rb CHANGED

@@ -88,6 +88,21 @@ EOS
     end
   end
+  def test_coderay_with_comment_in_middle
+    if_have 'coderay', 'nokogiri' do
+      # Create filter
+      filter = ::Nanoc::Filters::ColorizeSyntax.new
+      # Get input and expected output
+      input = %[<pre title="moo"><code>def moo ; end\n#!ruby\n# comment</code></pre>]
+      expected_output = "<pre title=\"moo\"><code>def moo ; end\n#!ruby\n# comment</code></pre>"
+      # Run filter
+      actual_output = filter.run(input)
+      assert_equal(expected_output, actual_output)
+    end
+  end
   def test_coderay_with_comment_and_class
     if_have 'coderay', 'nokogiri' do
       # Create filter

data/test/filters/test_less.rb CHANGED

@@ -110,4 +110,18 @@ class Nanoc::Filters::LessTest < MiniTest::Unit::TestCase
     end
   end
+  def test_compression
+    if_have 'less' do
+      # Create item
+      @item = Nanoc::Item.new("blah", { :content_filename => 'content/foo/bar.txt' }, '/foo/bar/')
+      # Create filter
+      filter = ::Nanoc::Filters::Less.new(:item => @item, :items => [ @item ])
+      # Run filter with compress option
+      result = filter.run('.foo { bar: a; } .bar { foo: b; }', :compress => true)
+      assert_match(/^\.foo{bar:a;}\n\.bar{foo:b;}/, result)
+    end
+  end
 end