nanoc 3.3.6 → 3.3.7

data/NEWS.md

@@ -1,5 +1,11 @@
 # nanoc news
 
+## 3.3.7 (2012-05-28)
+
+* Added filename to YAML parser errors
+* Fixed issue which caused extra dependencies to be generated
+* Made timing information take filtering helper into account
+
 ## 3.3.6 (2012-04-27)
 
 * Fixed issue with relative_link_to stripping HTML boilerplate

data/lib/nanoc.rb

@@ -3,7 +3,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '3.3.6'
+  VERSION = '3.3.7'
 
   # @return [String] A string containing information about this nanoc version
   #   and its environment (Ruby engine and version, Rubygems version if any).

data/lib/nanoc/base/compilation/compiler.rb

@@ -370,7 +370,7 @@ module Nanoc
       # Calculate rule memory if we haven’t yet done do
       rules_collection.new_rule_memory_for_rep(rep)
 
-      if !outdatedness_checker.outdated?(rep) && compiled_content_cache[rep]
+      if !rep.item.forced_outdated? && !outdatedness_checker.outdated?(rep) && compiled_content_cache[rep]
         # Reuse content
         Nanoc::NotificationCenter.post(:cached_content_used, rep)
         rep.content = compiled_content_cache[rep]

data/lib/nanoc/base/compilation/dependency_tracker.rb

@@ -37,8 +37,8 @@ module Nanoc
       super('tmp/dependencies', 4)
 
       @objects = objects
-
-      @graph = Nanoc::DirectedGraph.new([ nil ] + @objects)
+      @graph   = Nanoc::DirectedGraph.new([ nil ] + @objects)
+      @stack   = []
     end
 
     # Starts listening for dependency messages (`:visit_started` and
@@ -75,6 +75,14 @@ module Nanoc
       Nanoc::NotificationCenter.remove(:visit_ended,   self)
     end
 
+    # @return The topmost item on the stack, i.e. the one currently being
+    #   compiled
+    #
+    # @api private
+    def top
+      @stack.last
+    end
+
     # Returns the direct dependencies for the given object.
     #
     # The direct dependencies of the given object include the items and

data/lib/nanoc/base/source_data/item.rb

@@ -294,6 +294,16 @@ module Nanoc
       @identifier = *source
     end
 
+    # @api private
+    def forced_outdated=(bool)
+      @forced_outdated = bool
+    end
+
+    # @api private
+    def forced_outdated?
+      @forced_outdated || false
+    end
+
     # @deprecated Access the modification time using `item[:mtime]` instead.
     def mtime
       self[:mtime]

data/lib/nanoc/cli/command_runner.rb

@@ -56,7 +56,6 @@ module Nanoc::CLI
     #
     # @return [void]
     def require_site
-      @site = nil
       if site.nil?
         $stderr.puts 'The current working directory does not seem to be a ' +
                      'valid/complete nanoc site directory; aborting.'

data/lib/nanoc/cli/commands/deploy.rb

@@ -16,7 +16,7 @@ Available deployers: #{deployer_names.join(', ')}
 EOS
 
 option :t, :target,    'specify the location to deploy to', :argument => :required
-flag   :l, :list,      'list available locations to deploy to'
+flag   :L, :list,      'list available locations to deploy to'
 option :n, :'dry-run', 'show what would be deployed'
 
 module Nanoc::CLI::Commands

data/lib/nanoc/cli/error_handler.rb

@@ -20,7 +20,28 @@ module Nanoc::CLI
     #
     # @return [void]
     def self.handle_while(params={}, &block)
-      self.new(params).handle_while(&block)
+      if @disabled
+        yield
+      else
+        self.new(params).handle_while(&block)
+      end
+    end
+
+    # Disables error handling. This is used by the test cases to prevent error
+    # from being handled by the CLI while tests are running.
+    #
+    # @api private
+    def self.disable
+      @disabled = true
+    end
+
+    # Re-enables error handling after it was disabled. This is used by the test
+    # cases to prevent error from being handled by the CLI while tests are
+    # running.
+    #
+    # @api private
+    def self.enable
+      @disabled = false
     end
 
     # Enables error handling in the given block. This method should not be

data/lib/nanoc/data_sources/filesystem.rb

@@ -229,8 +229,12 @@ module Nanoc::DataSources
       # Read content and metadata from separate files
       if meta_filename
         content = content_filename ? read(content_filename) : ''
-        meta    = YAML.load(read(meta_filename)) || {}
-
+        meta_raw = read(meta_filename)
+        begin
+          meta = YAML.load(meta_raw) || {}
+        rescue Exception => e
+          raise "Could not parse YAML for #{meta_filename}: #{e.message}"
+        end
         return [ meta, content ]
       end
 
@@ -251,7 +255,11 @@ module Nanoc::DataSources
       end
 
       # Parse
-      meta    = YAML.load(pieces[2]) || {}
+      begin
+        meta = YAML.load(pieces[2]) || {}
+      rescue Exception => e
+        raise "Could not parse YAML for #{content_filename}: #{e.message}"
+      end
       content = pieces[4..-1].join.strip
 
       # Done

data/lib/nanoc/filters/relativize_paths.rb

@@ -55,7 +55,7 @@ module Nanoc::Filters
           # this cleans the XHTML namespace to process fragments and full
           # documents in the same way. At least, Nokogiri adds this namespace
           # if detects the `html` element.
-          content.sub!(%r{(<html[^>]+)xmlns="http://www.w3.org/1999/xhtml"}, '\1')
+          content = content.sub(%r{(<html[^>]+)xmlns="http://www.w3.org/1999/xhtml"}, '\1')
         end
 
         nokogiri_process(content, selectors, namespaces, klass, params[:type])

data/lib/nanoc/helpers/capturing.rb

@@ -62,6 +62,12 @@ module Nanoc::Helpers
         @captures_store ||= CapturesStore.new
       end
 
+      # @api private
+      def captures_store_compiled_items
+        require 'set'
+        @captures_store_compiled_items ||= Set.new
+      end
+
     end
 
     # @overload content_for(name, &block)
@@ -112,6 +118,27 @@ module Nanoc::Helpers
         item = args[0]
         name = args[1]
 
+        # Create dependency
+        current_item = @site.compiler.dependency_tracker.top
+        if item != current_item
+          Nanoc::NotificationCenter.post(:visit_started, item)
+          Nanoc::NotificationCenter.post(:visit_ended,   item)
+
+          # This is an extremely ugly hack to get the compiler to recompile the
+          # item from which we use content. For this, we need to manually edit
+          # the content attribute to reset it. :(
+          # FIXME clean this up
+          if !@site.captures_store_compiled_items.include? item
+            @site.captures_store_compiled_items << item 
+            item.forced_outdated = true
+            item.reps.each do |r|
+              raw_content = item.raw_content
+              r.content = { :raw => raw_content, :last => raw_content }
+              @site.compiler.send(:compile_rep, r)
+            end
+          end
+        end
+
         # Get content
         @site.captures_store[item, name.to_sym]
       end

data/lib/nanoc/helpers/filtering.rb

@@ -38,7 +38,9 @@ module Nanoc::Helpers
       filter = klass.new(@item_rep.assigns)
 
       # Filter captured data
+      Nanoc::NotificationCenter.post(:filtering_started, @item_rep, filter_name)
       filtered_data = filter.run(data, arguments)
+      Nanoc::NotificationCenter.post(:filtering_ended, @item_rep, filter_name)
 
       # Append filtered data to buffer
       buffer = eval('_erbout', block.binding)

data/tasks/test.rake

@@ -18,7 +18,7 @@ test = namespace :test do
     test_files = Dir['test/**/*_spec.rb'] + Dir['test/**/test_*.rb']
     test_files.each { |f| require f }
 
-    MiniTest::Unit.new.run($VERBOSE ? %w( --verbose ) : %w())
+    exit MiniTest::Unit.new.run($VERBOSE ? %w( --verbose ) : %w())
   end
 
   # test:...
@@ -36,7 +36,7 @@ test = namespace :test do
       test_files = Dir["test/#{dir}/**/*_spec.rb"] + Dir["test/#{dir}/**/test_*.rb"]
       test_files.each { |f| require f }
 
-      MiniTest::Unit.new.run($VERBOSE ? %w( --verbose ) : %w())
+      exit MiniTest::Unit.new.run($VERBOSE ? %w( --verbose ) : %w())
     end
   end
 

data/test/cli/commands/test_deploy.rb

@@ -60,7 +60,7 @@ class Nanoc::CLI::Commands::DeployTest < MiniTest::Unit::TestCase
         File.open('output/blah.html', 'w') { |io| io.write 'moo' }
 
         ios = capturing_stdio do
-          Nanoc::CLI.run %w( deploy -l )
+          Nanoc::CLI.run %w( deploy -L )
         end
 
         assert ios[:stdout].include?('Available deployment configurations:')

data/test/cli/test_cli.rb

@@ -87,6 +87,11 @@ EOS
 
       # Run command
       position_before = $stderr.tell
+      Nanoc::CLI::ErrorHandler.disable
+      assert_raises RuntimeError do
+        Nanoc::CLI.run %w( _test )
+      end
+      Nanoc::CLI::ErrorHandler.enable
       assert_raises SystemExit do
         Nanoc::CLI.run %w( _test )
       end

data/test/data_sources/test_filesystem_verbose.rb

@@ -80,7 +80,7 @@ class Nanoc::DataSources::FilesystemVerboseTest < MiniTest::Unit::TestCase
     end
     
     # Load
-    items = data_source.items
+    items = data_source.items.sort_by { |i| i[:title] }
     
     # Check
     assert_equal 2, items.size

data/test/extra/validators/test_links.rb

@@ -53,9 +53,9 @@ class Nanoc::Extra::Validators::LinksTest < MiniTest::Unit::TestCase
     validator = Nanoc::Extra::Validators::Links.new('output', [ 'index.html' ])
 
     # Test
-    assert_equal 200, validator.send(:fetch_http_status_for, URI.parse('http://www.apple.com/'))
-    assert_equal 200, validator.send(:fetch_http_status_for, URI.parse('https://www.apple.com/'))
-    assert_equal 404, validator.send(:fetch_http_status_for, URI.parse('http://www.apple.com/sdfghgfdsdfgh'))
+    assert_equal 200, validator.send(:fetch_http_status_for, URI.parse('http://httpstat.us/200'))
+    assert_equal 200, validator.send(:fetch_http_status_for, URI.parse('https://httpstat.us/200'))
+    assert_equal 404, validator.send(:fetch_http_status_for, URI.parse('http://httpstat.us/404'))
   end
 
 end

data/test/filters/test_relativize_paths.rb

@@ -654,7 +654,7 @@ XML
 XML
 
       # Test
-      actual_content = filter.run(raw_content, :type => :xhtml)
+      actual_content = filter.run(raw_content.freeze, :type => :xhtml)
       assert_equal(expected_content, actual_content)
     end
   end

data/test/helper.rb

@@ -120,9 +120,15 @@ EOS
     # Enter tmp
     FileUtils.mkdir_p('tmp')
     FileUtils.cd('tmp')
+
+    # Let us get to the raw errors
+    Nanoc::CLI::ErrorHandler.disable
   end
 
   def teardown
+    # Restore normal error handling
+    Nanoc::CLI::ErrorHandler.enable
+
     # Exit tmp
     FileUtils.cd('..')
     FileUtils.rm_rf('tmp')

data/test/helpers/test_capturing.rb

@@ -9,6 +9,11 @@ class Nanoc::Helpers::CapturingTest < MiniTest::Unit::TestCase
   def test_content_for
     require 'erb'
 
+    File.open('Rules', 'w') do |io|
+      io.write "compile '*' do ; filter :erb ; end\n"
+      io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+    end
+
     # Build content to be evaluated
     content = "head <% content_for :sidebar do %>\n" +
               "  <%= 1+2 %>\n" +
@@ -49,6 +54,11 @@ class Nanoc::Helpers::CapturingTest < MiniTest::Unit::TestCase
   def test_content_for_recursively
     require 'erb'
 
+    File.open('Rules', 'w') do |io|
+      io.write "compile '*' do ; filter :erb ; end\n"
+      io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+    end
+
     content = <<EOS
 head
 <% content_for :box do %>
@@ -74,6 +84,11 @@ EOS
   def test_different_sites
     require 'erb'
 
+    File.open('Rules', 'w') do |io|
+      io.write "compile '*' do ; filter :erb ; end\n"
+      io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+    end
+
     @site = Nanoc3::Site.new({})
     @item = Nanoc::Item.new('content', {}, '/')
     content = "<% content_for :a do %>Content One<% end %>"
@@ -91,4 +106,123 @@ EOS
     assert_equal 'Content Two', content_for(@item, :b)
   end
 
+  def test_dependencies
+    with_site do |site|
+      # Prepare
+      File.open('lib/helpers.rb', 'w') do |io|
+        io.write 'include Nanoc::Helpers::Capturing'
+      end
+      File.open('content/includer.erb', 'w') do |io|
+        io.write '[<%= content_for(@items.find { |i| i.identifier == \'/includee/\' }, :blah) %>]'
+      end
+      File.open('Rules', 'w') do |io|
+        io.write "compile '*' do ; filter :erb ; end\n"
+        io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+      end
+
+      # Compile once
+      File.open('content/includee.erb', 'w') do |io|
+        io.write '{<% content_for :blah do %>Old content<% end %>}'
+      end
+      Nanoc::CLI.run(%w(compile))
+      assert_equal '[Old content]', File.read('output/includer/index.html')
+
+      # Compile again
+      File.open('content/includee.erb', 'w') do |io|
+        io.write '{<% content_for :blah do %>New content<% end %>}'
+      end
+      Nanoc::CLI.run(%w(compile))
+      assert_equal '[New content]', File.read('output/includer/index.html')
+    end
+  end
+
+  def test_dependency_without_item_variable
+    with_site do |site|
+      # Prepare
+      File.open('lib/helpers.rb', 'w') do |io|
+        io.write "include Nanoc::Helpers::Capturing\n"
+        io.write "include Nanoc::Helpers::Rendering\n"
+      end
+      File.open('content/includer.erb', 'w') do |io|
+        io.write '{<%= render \'partial\', :item => nil %>}'
+      end
+      File.open('layouts/partial.erb', 'w') do |io|
+        io.write '[<%= @item.inspect %>-<%= content_for(@items.find { |i| i.identifier == \'/includee/\' }, :blah) %>]'
+      end
+      File.open('Rules', 'w') do |io|
+        io.write "compile '*' do ; filter :erb ; end\n"
+        io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+        io.write "layout '*', :erb\n"
+      end
+
+      # Compile once
+      File.open('content/includee.erb', 'w') do |io|
+        io.write '{<% content_for :blah do %>Old content<% end %>}'
+      end
+      Nanoc::CLI.run(%w(compile))
+      assert_equal '{[nil-Old content]}', File.read('output/includer/index.html')
+
+      # Compile again
+      File.open('content/includee.erb', 'w') do |io|
+        io.write '{<% content_for :blah do %>New content<% end %>}'
+      end
+      Nanoc::CLI.run(%w(compile))
+      assert_equal '{[nil-New content]}', File.read('output/includer/index.html')
+    end
+  end
+
+  def test_self
+    with_site do |site|
+      File.open('lib/helpers.rb', 'w') do |io|
+        io.write 'include Nanoc::Helpers::Capturing'
+      end
+
+      File.open('content/self.erb', 'w') do |io|
+        io.write "<% content_for :foo do %>Foo!<% end %>"
+        io.write "<%= content_for(@item, :foo) %>"
+      end
+
+      File.open('Rules', 'w') do |io|
+        io.write "compile '*' do ; filter :erb ; end\n"
+        io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+      end
+
+      Nanoc::CLI.run(%w(compile))
+      assert_equal 'Foo!', File.read('output/self/index.html')
+    end
+  end
+
+  def test_recompile_dependency
+    with_site do |site|
+      # Prepare
+      File.open('lib/helpers.rb', 'w') do |io|
+        io.write 'include Nanoc::Helpers::Capturing'
+      end
+      File.open('content/includee.erb', 'w') do |io|
+        io.write '{<% content_for :blah do %>Content<% end %>}'
+      end
+      File.open('Rules', 'w') do |io|
+        io.write "compile '*' do ; filter :erb ; end\n"
+        io.write "route '*' do ; item.identifier + 'index.html' ; end\n"
+      end
+
+      # Compile once
+      File.open('content/includer.erb', 'w') do |io|
+        io.write 'Old-<%= content_for(@items.find { |i| i.identifier == \'/includee/\' }, :blah) %>'
+      end
+      Nanoc::CLI.run(%w(compile))
+      assert_equal 'Old-Content', File.read('output/includer/index.html')
+
+      # Compile again
+      $LOUD = true
+      File.open('content/includer.erb', 'w') do |io|
+        io.write 'New-<%= content_for(@items.find { |i| i.identifier == \'/includee/\' }, :blah) %>'
+      end
+      Nanoc::CLI.run(%w(compile))
+      assert_equal 'New-Content', File.read('output/includer/index.html')
+    end
+  ensure
+    $LOUD = false 
+  end
+
 end

data/test/helpers/test_filtering.rb

@@ -103,4 +103,24 @@ class Nanoc::Helpers::FilteringTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_notifications
+    notifications = Set.new
+    Nanoc::NotificationCenter.on(:filtering_started) { notifications << :filtering_started }
+    Nanoc::NotificationCenter.on(:filtering_ended)   { notifications << :filtering_ended   }
+
+    # Build content to be evaluated
+    content = "<% filter :erb do %>\n" +
+              "   ... stuff ...\n" +
+              "<% end %>\n"
+
+    # Mock item and rep
+    @item_rep = mock
+    @item_rep.expects(:assigns).returns({})
+
+    ::ERB.new(content).result(binding)
+
+    assert notifications.include?(:filtering_started)
+    assert notifications.include?(:filtering_ended)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 3.3.6
+  version: 3.3.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2012-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -399,7 +399,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: a web publishing system written in Ruby for building small to medium-sized