merged changes from master branch

Author: denisdefreyne

.travis.yml

@@ -1 +1 @@
-script: "bundle exec rake skip=Nanoc3::Filters::LessTest"
+rvm: 1.9.3

NEWS.md

@@ -16,6 +16,13 @@ Extensions:
 * Added Albino to supported syntax colorizers [Dan Callahan]
 * Allowed syntax colorizer to colorize outside `pre` elements [Kevin Lynagh]
 
+## 3.2.3 (2011-10-31)
+
+* Made syntax colorizer only strip trailing blank lines instead of all blanks
+* Improved Ruby 1.9.x compatibility
+* Made default rakefile require rubygems if necessary
+* Made filename/content argument of `Nanoc3::Item#initialize` mandatory
+
 ## 3.2.2 (2011-09-04)
 
 * Fixed command usage printing

README.md

@@ -73,6 +73,7 @@ may be interested in the development dependencies:
 
 * Ben Armston
 * Colin Barrett
+* Bil Bas
 * Dmitry Bilunov
 * Devon Luke Buchanan
 * Stefan Bühler
@@ -102,6 +103,7 @@ may be interested in the development dependencies:
 * Eric Sunshine
 * Dennis Sutch
 * Matthias Vallentin
+* Ruben Verborgh
 * Toon Willems
 
 ## Contact

lib/nanoc/base/compilation/compiler.rb

@@ -315,8 +315,7 @@ def layouts
     #
     # @return [void]
     def compile_reps(reps)
-      outdated_reps = Set.new(reps.select { |rep| outdatedness_checker.outdated?(rep) })
-      content_dependency_graph = Nanoc::DirectedGraph.new(outdated_reps)
+      content_dependency_graph = Nanoc::DirectedGraph.new(reps)
 
       # Listen to processing start/stop
       Nanoc::NotificationCenter.on(:processing_started, self) { |obj| @stack.push(obj) }

lib/nanoc/base/directed_graph.rb

@@ -8,7 +8,7 @@ module Nanoc
   # @example Creating and using a directed graph
   #
   #   # Create a graph with three vertices
-  #   graph = DirectedGraph.new(%w( a b c d ))
+  #   graph = Nanoc::DirectedGraph.new(%w( a b c d ))
   #   
   #   # Add edges
   #   graph.add_edge('a', 'b')

lib/nanoc/base/result_data/item_rep.rb

@@ -240,7 +240,7 @@ def compiled_content(params={})
       Nanoc::NotificationCenter.post(:visit_ended,   self.item)
 
       # Require compilation
-      raise Nanoc::Errors::UnmetDependency.new(self) if !compiled? && !params[:force]
+      raise Nanoc::Errors::UnmetDependency.new(self) if !compiled?
 
       # Get name of last pre-layout snapshot
       snapshot_name = params[:snapshot]

lib/nanoc/base/source_data/item.rb

@@ -70,6 +70,10 @@ def initialize(raw_content_or_raw_filename, attributes, identifier, params=nil)
       params = { :mtime => params } if params.is_a?(Time)
       params[:binary] = false unless params.has_key?(:binary)
 
+      if raw_content_or_raw_filename.nil?
+        raise "attempted to create an item with no content/filename (identifier #{identifier})"
+      end
+
       # Get type and raw content or raw filename
       @is_binary = params[:binary]
       if @is_binary

lib/nanoc/cli/commands/compile.rb

@@ -153,7 +153,7 @@ def generate_diff_for(rep, snapshot)
 
       # Get old and new content
       old_content = File.read(rep.raw_path(:snapshot => snapshot))
-      new_content = rep.compiled_content(:snapshot => snapshot, :force => true)
+      new_content = rep.compiled_content(:snapshot => snapshot)
 
       # Check whether there’s a different
       return if old_content == new_content

lib/nanoc/cli/commands/watch.rb

@@ -92,6 +92,9 @@ class Notifier
       # A list of commandline tool names that can be used to send notifications
       TOOLS = %w( growlnotify notify-send )
 
+      # The tool to use for discovering binaries' locations
+      FIND_BINARY_COMMAND = RUBY_PLATFORM =~ /mingw|mswin/ ? "where" : "which"
+
       # Send a notification. If no notifier is found, no notification will be
       # created.
       #
@@ -104,7 +107,7 @@ def notify(message)
     private
 
       def tool
-        @tool ||= TOOLS.find { |t| !`which #{t}`.empty? }
+        @tool ||= TOOLS.find { |t| !`#{FIND_BINARY_COMMAND} #{t}`.empty? }
       end
 
       def growlnotify(message)

lib/nanoc/cli/error_handler.rb

@@ -169,10 +169,9 @@ def resolution_for(error)
       case error
       when LoadError
         # Get gem name
-        matches = error.message.match(/no such file to load -- ([^\s]+)/)
-        return nil if matches.size == 0
-        lib_name = matches[1]
-        gem_name = GEM_NAMES[$1]
+        matches = error.message.match(/(no such file to load|cannot load such file) -- ([^\s]+)/)
+        return nil if matches.nil?
+        gem_name = GEM_NAMES[matches[2]]
 
         # Build message
         if gem_name

lib/nanoc/data_sources/filesystem.rb

@@ -283,6 +283,9 @@ def read(filename)
         raise_encoding_error(filename, original_encoding) if !data.valid_encoding?
       end
 
+      # Remove UTF-8 BOM (ugly)
+      data.gsub!("\xEF\xBB\xBF", '')
+
       data
     end
 

lib/nanoc/filters/colorize_syntax.rb

@@ -119,8 +119,9 @@ def run(content, params={})
         next if language.nil?
 
         # Highlight
-        highlighted_code = highlight(element.inner_text.strip, language, params)
-        element.inner_html = highlighted_code.strip
+        raw = strip(element.inner_text)
+        highlighted_code = highlight(raw, language, params)
+        element.inner_html = strip(highlighted_code)
 
         # Add class
         unless has_class
@@ -139,6 +140,11 @@ def run(content, params={})
 
     KNOWN_COLORIZERS = [ :albino, :coderay, :dummy, :pygmentize, :simon_highlight ]
 
+    # Removes the first blank lines and any whitespace at the end.
+    def strip(s)
+      s.lines.drop_while { |line| line.strip.empty? }.join.rstrip
+    end
+
     def highlight(code, language, params={})
       colorizer = @colorizers[language.to_sym]
       if KNOWN_COLORIZERS.include?(colorizer)

lib/nanoc/helpers/rendering.rb

@@ -7,24 +7,33 @@ module Rendering
 
     include Nanoc::Helpers::Capturing
 
-    # Returns a string containing the rendered given layout. The given layout
-    # will first be run through the matching layout rule.
+    # Renders the given layout. The given layout will be run through the first
+    # matching layout rule.
     #
-    # The assigns (`@item`, `@config`, …) will not be available in the
-    # partial, but it is possible to pass custom assigns to the method. These
-    # assigns will be made available as instance variables inside the partial.
+    # When this method is invoked _without_ a block, the return value will be
+    # the rendered layout (a string)  and `_erbout` will not be modified.
     #
-    # The method can also take a block. In this case, the content of the block
-    # will be captured (using the {Nanoc::Helpers::Capturing} helper) and
-    # this content will be made available with `yield`. In other words, a
-    # `yield` inside the partial will output the content of the block passed
-    # to the method.
+    # When this method is invoked _with_ a block, an empty string will be
+    # returned and the rendered content will be appended to `_erbout`. In this
+    # case, the content of the block will be captured (using the
+    # {Nanoc::Helpers::Capturing} helper) and this content will be made
+    # available with `yield`. In other words, a `yield` inside the partial
+    # will output the content of the block passed to the method.
+    #
+    # (For the curious: the reason why {#render} with a block has this
+    # behaviour of returning an empty string and modifying `_erbout` is
+    # because ERB does not support combining the `<%= ... %>` form with a
+    # method call that takes a block.)
+    #
+    # The assigns (`@item`, `@config`, …) will be available in the partial. It
+    # is also possible to pass custom assigns to the method; these assigns
+    # will be made available as instance variables inside the partial.
     #
     # @param [String] identifier The identifier of the layout that should be
     #   rendered
     #
-    # @param [Hash] other_assigns A hash containing assigns that will be made
-    #   available as instance variables in the partial
+    # @param [Hash] other_assigns A hash containing extra assigns that will be
+    #   made available as instance variables in the partial
     #
     # @example Rendering a head and a foot partial around some text
     #
@@ -52,10 +61,22 @@ module Rendering
     #     I'm boxy! Luvz!
     #   <% end %>
     #
+    #   # Result
+    #   <div class="box">
+    #     I'm boxy! Luvz!
+    #   </div>
+    #
     # @raise [Nanoc::Errors::UnknownLayout] if the given layout does not
     #   exist
     #
-    # @return [String] The rendered partial
+    # @raise [Nanoc::Errors::CannotDetermineFilter] if there is no layout
+    #   rule for the given layout
+    #
+    # @raise [Nanoc::Errors::UnknownFilter] if the layout rule for the given
+    #   layout specifies an unknown filter
+    #
+    # @return [String, nil] The rendered partial, or nil if this method was
+    #   invoked with a block
     def render(identifier, other_assigns={}, &block)
       # Find layout
       layout = @site.layouts.find { |l| l.identifier == identifier.cleaned_identifier }

test/base/test_compiler.rb

@@ -298,4 +298,19 @@ def compiler.route_reps
     end
   end
 
+  def test_compile_should_recompile_all_reps
+    Nanoc3::CLI.run %w( create_site bar )
+
+    FileUtils.cd('bar') do
+      Nanoc3::CLI.run %w( compile )
+
+      site = Nanoc3::Site.new('.')
+      site.compile
+
+      # At this point, even the already compiled items in the previous pass
+      # should have their compiled content assigned, so this should work:
+      site.items[0].reps[0].compiled_content
+    end
+  end
+
 end

test/base/test_directed_graph.rb

@@ -280,4 +280,9 @@ def test_roots_after_removing_edge
     assert_equal Set.new([ 1, 2, 3 ]), graph.roots
   end
 
+  def test_example
+    YARD.parse('../lib/nanoc/base/directed_graph.rb')
+    assert_examples_correct 'Nanoc::DirectedGraph'
+  end
+
 end

test/base/test_item.rb

@@ -25,7 +25,7 @@ def test_frozen_identifier
       item.identifier.chop!
     rescue => error
       raised = true
-      assert_equal "can't modify frozen string", error.message
+      assert_match /^can't modify frozen [Ss]tring$/, error.message
     end
     assert raised, 'Should have raised when trying to modify a frozen string'
   end

test/base/test_layout.rb

@@ -22,7 +22,7 @@ def test_frozen_identifier
       layout.identifier.chop!
     rescue => error
       raised = true
-      assert_equal "can't modify frozen string", error.message
+      assert_match /^can't modify frozen [Ss]tring$/, error.message
     end
     assert raised, 'Should have raised when trying to modify a frozen string'
   end

test/data_sources/test_filesystem.rb

@@ -365,6 +365,22 @@ def test_parse_embedded_empty_meta
     assert_equal('blah blah', result[1])
   end
 
+  def test_parse_utf8_bom
+    File.open('test.html', 'w') do |io|
+      io.write [ 0xEF, 0xBB, 0xBF ].map { |i| i.chr }.join
+      io.write "-----\n"
+      io.write "utf8bomawareness: high\n"
+      io.write "-----\n"
+      io.write "content goes here\n"
+    end
+
+    data_source = Nanoc::DataSources::FilesystemCombined.new(nil, nil, nil, nil)
+
+    result = data_source.instance_eval { parse('test.html', nil, 'foobar') }
+    assert_equal({ 'utf8bomawareness' => 'high' }, result[0])
+    assert_equal('content goes here', result[1])
+  end
+
   def test_parse_embedded_no_meta
     content = "blah\n" \
       "blah blah blah\n" \

test/data_sources/test_filesystem_unified.rb

@@ -27,8 +27,8 @@ def test_create_object_not_at_root
     assert File.file?('foobar/asdf.html')
 
     # Check file content
-    expected = "--- \nfoo: bar\n---\n\ncontent here"
-    assert_equal expected, File.read('foobar/asdf.html')
+    expected = /^--- ?\nfoo: bar\n---\n\ncontent here$/
+    assert_match expected, File.read('foobar/asdf.html')
   end
 
   def test_create_object_at_root
@@ -43,8 +43,8 @@ def test_create_object_at_root
     assert File.file?('foobar/index.html')
 
     # Check file content
-    expected = "--- \nfoo: bar\n---\n\ncontent here"
-    assert_equal expected, File.read('foobar/index.html')
+    expected = /^--- ?\nfoo: bar\n---\n\ncontent here$/
+    assert_match expected, File.read('foobar/index.html')
   end
 
   def test_load_objects

test/filters/test_colorize_syntax.rb

@@ -287,7 +287,7 @@ def test_not_outside_pre
   def test_outside_pre
     if_have 'coderay', 'nokogiri' do
       # Create filter
-      filter = ::Nanoc3::Filters::ColorizeSyntax.new
+      filter = ::Nanoc::Filters::ColorizeSyntax.new
 
       # Get input and expected output
       input           = '<code class="language-ruby"># comment</code>'
@@ -299,4 +299,34 @@ def test_outside_pre
     end
   end
 
+  def test_strip
+    if_have 'coderay', 'nokogiri' do
+      # Create filter
+      filter = ::Nanoc::Filters::ColorizeSyntax.new
+
+      # Simple test
+      assert_equal "  bar", filter.send(:strip, "\n  bar")
+
+      # Get input and expected output
+      input = <<EOS
+before
+<pre><code class="language-ruby">
+  def foo
+  end
+</code></pre>
+after
+EOS
+      expected_output = <<EOS
+before
+<pre><code class="language-ruby">  <span class=\"keyword\">def</span> <span class=\"function\">foo</span>
+  <span class=\"keyword\">end</span></code></pre>
+after
+EOS
+
+      # Run filter
+      actual_output = filter.run(input)
+      assert_equal(expected_output, actual_output)
+    end
+  end
+
 end

test/filters/test_rdoc.rb

@@ -11,7 +11,7 @@ def test_filter
 
       # Run filter
       result = filter.run("= Foo")
-      assert_match(%r{<h1>Foo</h1>\Z}, result)
+      assert_match(%r{<h1( id="label-Foo")?>Foo</h1>\Z}, result)
     end
   end