nanoc3 3.1.8 → 3.1.9

data/NEWS.md

@@ -1,6 +1,12 @@
 # nanoc news
 
-## 3.1.8 (2001-06-25)
+## 3.1.9 (2011-06-30)
+
+* Really fixed dependency generation between Sass partials this time
+* Updated Less filter to 2.0
+* Made colorize_syntax filter throw an error if pygmentize is not available
+
+## 3.1.8 (2011-06-25)
 
 * Made link validator accept https: URLs
 * Fixed erronous handling of layouts with names ending in index

data/README.md

@@ -83,6 +83,7 @@ may be interested in the development dependencies:
 * Christian Plessl
 * Šime Ramov
 * Xavier Shay
+* Arnau Siches
 * “Soryu”
 * Eric Sunshine
 * Dennis Sutch

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.1.8'
+  VERSION = '3.1.9'
 
 end
 

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'open3'
+
 module Nanoc3::Filters
   class ColorizeSyntax < Nanoc3::Filter
 
@@ -36,6 +38,9 @@ module Nanoc3::Filters
     #
     # @param [String] content The content to filter
     #
+    # @option params [Symbol] :syntax (:html) The syntax to use, which can be
+    #   `:html`, `:xml` or `:xhtml`, the latter two being the same.
+    #
     # @option params [Hash] :colorizers (DEFAULT_COLORIZER) A hash containing
     #   a mapping of programming languages (symbols, not strings) onto
     #   colorizers (symbols).
@@ -90,6 +95,8 @@ module Nanoc3::Filters
     end
 
     def pygmentize(code, language, params={})
+      check_availability('pygmentize --V')
+
       IO.popen("pygmentize -l #{language} -f html", "r+") do |io|
         io.write(code)
         io.close_write
@@ -100,5 +107,10 @@ module Nanoc3::Filters
       end
     end
 
+    def check_availability(cmd)
+      # Will raise on error
+      Open3.popen3('highlight --version') { |stdin, stdout, stderr| }
+    end
+
   end
 end

data/lib/nanoc3/filters/less.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'less'
+
 module Nanoc3::Filters
   class Less < Nanoc3::Filter
 
@@ -10,15 +12,56 @@ module Nanoc3::Filters
     #
     # @return [String] The filtered content
     def run(content, params={})
-      require 'less'
+      # Find imports (hacky)
+      imports = []
+      imports.concat(content.scan(/^@import\s+(["'])([^\1]+?)\1;/))
+      imports.concat(content.scan(/^@import\s+url\((["']?)([^)]+?)\1\);/))
+      imported_filenames = imports.map do |i|
+        i[1].match(/\.(less|css)$/) ? i[1] : i[1] + '.less'
+      end
+
+      # Convert to items
+      imported_items = imported_filenames.map do |filename|
+        # Find directory for this item
+        current_dir_pathname = Pathname.new(@item[:content_filename]).dirname.realpath
+
+        # Find absolute pathname for imported item
+        imported_pathname    = Pathname.new(filename)
+        if imported_pathname.relative?
+          imported_pathname = current_dir_pathname + imported_pathname
+        end
+        next if !imported_pathname.exist?
+        imported_filename = imported_pathname.realpath
+
+        # Find matching item
+        @items.find do |i|
+          next if i[:content_filename].nil?
+          Pathname.new(i[:content_filename]).realpath == imported_filename
+        end
+      end.compact
+
+      # Create dependencies
+      depend_on(imported_items)
 
       # Add filename to load path
-      $LESS_LOAD_PATH << File.dirname(@item[:content_filename])
+      paths = [ File.dirname(@item[:content_filename]) ]
+      parser = ::Less::Parser.new(:paths => paths)
+      parser.parse(content).to_css
+    end
+
+    # @todo Remove me in nanoc 3.2.x
+    def depend_on(items)
+      # Notify
+      items.each do |item|
+        Nanoc3::NotificationCenter.post(:visit_started, item)
+        Nanoc3::NotificationCenter.post(:visit_ended,   item)
+      end
 
-      ::Less::Engine.new(content).to_css
-    ensure
-      # Restore load path
-      $LESS_LOAD_PATH.delete_at(-1)
+      # Raise unmet dependency error if necessary
+      items.each do |item|
+        rep = item.reps.find { |r| !r.compiled? }
+        raise Nanoc3::Errors::UnmetDependency.new(rep) if rep
+      end
     end
 
   end

data/lib/nanoc3/filters/sass.rb

@@ -1,8 +1,38 @@
 # encoding: utf-8
 
+require 'sass'
+require 'set'
+
 module Nanoc3::Filters
   class Sass < Nanoc3::Filter
 
+    class << self
+      # The current filter. This is definitely going to bite me if I ever get
+      # to multithreading nanoc.
+      attr_accessor :current
+    end
+
+    # Essentially the {Sass::Importers::Filesystem} but registering each
+    # import file path.
+    class SassFilesystemImporter < ::Sass::Importers::Filesystem
+
+      private
+
+      def _find(dir, name, options)
+        full_filename, syntax = find_real_file(dir, name)
+        return unless full_filename && File.readable?(full_filename)
+
+        filter = Nanoc3::Filters::Sass.current
+        item = filter.imported_filename_to_item(full_filename)
+        filter.depend_on([ item ]) unless item.nil?
+
+        options[:syntax] = syntax
+        options[:filename] = full_filename
+        options[:importer] = self
+        ::Sass::Engine.new(File.read(full_filename), options)
+      end
+    end
+
     # Runs the content through [Sass](http://sass-lang.com/).
     # Parameters passed to this filter will be passed on to Sass.
     #
@@ -10,77 +40,41 @@ module Nanoc3::Filters
     #
     # @return [String] The filtered content
     def run(content, params={})
-      require 'sass'
-
-      # Add imported_filename read accessor to ImportNode
-      # … but… but… nex3 said I could monkey patch it! :(
-      methods = ::Sass::Tree::ImportNode.instance_methods
-      if !methods.include?(:import_filename) && !methods.include?('import_filename')
-        ::Sass::Tree::ImportNode.send(:attr_reader, :imported_filename)
-      end
-
-      # Get options
+      # Build options
       options = params.dup
-      sass_filename = options[:filename] || (@item && @item[:content_filename])
+      sass_filename = options[:filename] ||
+        (@item && @item[:content_filename])
       options[:filename] ||= sass_filename
+      options[:filesystem_importer] ||=
+        Nanoc3::Filters::Sass::SassFilesystemImporter
 
-      # Build engine
+      # Render
       engine = ::Sass::Engine.new(content, options)
+      self.class.current = self
+      engine.render
+    end
 
-      # Get import nodes
-      require 'set'
-      imported_nodes = []
-      unprocessed_nodes = Set.new([ engine.to_tree ])
-      until unprocessed_nodes.empty?
-        # Get an unprocessed node
-        node = unprocessed_nodes.each { |n| break n }
-        unprocessed_nodes.delete(node)
-
-        # Add to list of import nodes if necessary
-        imported_nodes << node if node.is_a?(::Sass::Tree::ImportNode)
-
-        # Mark children of this node for processing
-        node.children.each { |c| unprocessed_nodes << c }
+    def imported_filename_to_item(filename)
+      path = Pathname.new(filename).realpath
+      @items.find do |i|
+        next if i[:content_filename].nil?
+        Pathname.new(i[:content_filename]).realpath == path
       end
+    end
 
-      # Get import paths
-      import_paths = (options[:load_paths] || []).dup
-      import_paths.unshift(File.dirname(sass_filename)) if sass_filename
-      imported_filenames = imported_nodes.map { |node| node.imported_filename }
-
-      # Convert to items
-      imported_items = imported_filenames.map do |filename|
-        # Find directory for this item
-        current_dir_pathname = Pathname.new(@item[:content_filename]).dirname.realpath
-
-        # Find absolute pathname for imported item
-        imported_pathname    = Pathname.new(filename)
-        if imported_pathname.relative?
-          imported_pathname = current_dir_pathname + imported_pathname
-        end
-        next if !imported_pathname.exist?
-        imported_filename = imported_pathname.realpath
-
-        # Find matching item
-        @items.find do |i|
-          next if i[:content_filename].nil?
-          Pathname.new(i[:content_filename]).realpath == imported_filename
-        end
-      end.compact
-
-      # Require compilation of each item
-      imported_items.each do |i|
-        # Notify
-        Nanoc3::NotificationCenter.post(:visit_started, i)
-        Nanoc3::NotificationCenter.post(:visit_ended,   i)
-
-        # Raise unmet dependency error if item is not yet compiled
-        any_uncompiled_rep = i.reps.find { |r| !r.compiled? }
-        raise Nanoc3::Errors::UnmetDependency.new(any_uncompiled_rep) if any_uncompiled_rep
+    # @todo Remove me in nanoc 3.2.x
+    def depend_on(items)
+      # Notify
+      items.each do |item|
+        Nanoc3::NotificationCenter.post(:visit_started, item)
+        Nanoc3::NotificationCenter.post(:visit_ended,   item)
       end
 
-      # Done
-      engine.render
+      # Raise unmet dependency error if necessary
+      items.each do |item|
+        rep = item.reps.find { |r| !r.compiled? }
+        raise Nanoc3::Errors::UnmetDependency.new(rep) if rep
+      end
     end
 
   end

data/test/filters/test_colorize_syntax.rb

@@ -53,4 +53,32 @@ class Nanoc3::Filters::ColorizeSyntaxTest < MiniTest::Unit::TestCase
     assert_match(expected_output, actual_output)
   end
 
+  def test_colorize_syntax_with_missing_executables
+    if_have 'nokogiri' do
+      begin
+        original_path = ENV['PATH']
+        ENV['PATH'] = './blooblooblah'
+
+        # Create filter
+        filter = ::Nanoc3::Filters::ColorizeSyntax.new
+
+        # Get input and expected output
+        input = '<pre><code class="language-ruby">puts "foo"</code></pre>'
+
+        # Run filter
+        begin
+          input = '<pre><code class="language-ruby">puts "foo"</code></pre>'
+          actual_output = filter.run(
+            input,
+            :colorizers => { :ruby => :pygmentize })
+          flunk "expected colorizer to raise if no executable is available"
+        rescue => e
+          assert_match /No such file or directory/, e.message
+        end
+      ensure
+        ENV['PATH'] = original_path
+      end
+    end
+  end
+
 end

data/test/filters/test_less.rb

@@ -45,10 +45,11 @@ class Nanoc3::Filters::LessTest < MiniTest::Unit::TestCase
       File.open('content/foo/bar/imported_file.less', 'w') { |io| io.write('p { color: red; }') }
 
       # Create item
+      File.open('content/foo/bar.txt', 'w') { |io| io.write('meh') }
       @item = Nanoc3::Item.new("blah", { :content_filename => 'content/foo/bar.txt' }, '/foo/bar/')
 
       # Create filter
-      filter = ::Nanoc3::Filters::Less.new(:item => @item)
+      filter = ::Nanoc3::Filters::Less.new(:item => @item, :items => [ @item ])
 
       # Run filter
       result = filter.run('@import "bar/imported_file.less";')
@@ -56,4 +57,62 @@ class Nanoc3::Filters::LessTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_recompile_includes
+    if_have 'less' do
+      Nanoc3::CLI::Base.new.run([ 'create_site', 'bar' ])
+      FileUtils.cd('bar') do
+        # Create two less files
+        Dir['content/*'].each { |i| FileUtils.rm(i) }
+        File.open('content/a.less', 'w') do |io|
+          io.write('@import "b.less";')
+        end
+        File.open('content/b.less', 'w') do |io|
+          io.write("p { color: red; }")
+        end
+
+        # Update rules
+        File.open('Rules', 'w') do |io|
+          io.write "compile '*' do\n"
+          io.write "  filter :less\n"
+          io.write "end\n"
+          io.write "\n"
+          io.write "route '/a/' do\n"
+          io.write "  item.identifier.chop + '.css'\n"
+          io.write "end\n"
+          io.write "\n"
+          io.write "route '/b/' do\n"
+          io.write "  nil\n"
+          io.write "end\n"
+        end
+
+        # Compile
+        site = Nanoc3::Site.new('.')
+        site.load_data
+        site.compiler.run
+
+        # Check
+        assert Dir['output/*'].size == 1
+        assert File.file?('output/a.css')
+        refute File.file?('output/b.css')
+        assert_match /^p\s*\{\s*color:\s*red;?\s*\}/, File.read('output/a.css')
+
+        # Update included file
+        File.open('content/b.less', 'w') do |io|
+          io.write("p { color: blue; }")
+        end
+
+        # Recompile
+        site = Nanoc3::Site.new('.')
+        site.load_data
+        site.compiler.run
+
+        # Recheck
+        assert Dir['output/*'].size == 1
+        assert File.file?('output/a.css')
+        refute File.file?('output/b.css')
+        assert_match /^p\s*\{\s*color:\s*blue;?\s*\}/, File.read('output/a.css')
+      end
+    end
+  end
+
 end

data/test/filters/test_sass.rb

@@ -159,10 +159,75 @@ class Nanoc3::Filters::SassTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_recompile_includes_with_underscore_without_extension
+    if_have 'sass' do
+      # Create site
+      Nanoc3::CLI::Base.new.run([ 'create_site', 'bar' ])
+      FileUtils.cd('bar') do
+        # Create two Sass files
+        Dir['content/*'].each { |i| FileUtils.rm(i) }
+        File.open('content/a.sass', 'w') do |io|
+          io.write('@import b')
+        end
+        File.open('content/_b.sass', 'w') do |io|
+          io.write("p\n  color: red")
+        end
+
+        # Update rules
+        File.open('Rules', 'w') do |io|
+          io.write "compile '*' do\n"
+          io.write "  filter :sass\n"
+          io.write "end\n"
+          io.write "\n"
+          io.write "route '/a/' do\n"
+          io.write "  item.identifier.chop + '.css'\n"
+          io.write "end\n"
+          io.write "\n"
+          io.write "route '/_b/' do\n"
+          io.write "  nil\n"
+          io.write "end\n"
+        end
+
+        # Compile
+        site = Nanoc3::Site.new('.')
+        site.load_data
+        site.compiler.run
+
+        # Check
+        assert Dir['output/*'].size == 1
+        assert File.file?('output/a.css')
+        refute File.file?('output/b.css')
+        assert_match /^p\s*{\s*color:\s*red;?\s*}/, File.read('output/a.css')
+
+        # Update included file
+        File.open('content/_b.sass', 'w') do |io|
+          io.write("p\n  color: blue")
+        end
+
+        # Recompile
+        site = Nanoc3::Site.new('.')
+        site.load_data
+        site.compiler.run
+
+        # Recheck
+        assert Dir['output/*'].size == 1
+        assert File.file?('output/a.css')
+        refute File.file?('output/b.css')
+        assert_match /^p\s*{\s*color:\s*blue;?\s*}/, File.read('output/a.css')
+      end
+    end
+  end
+
 private
 
   def create_filter(params={})
-    items = [ Nanoc3::Item.new('blah', { :content_filename => 'xyzzy.sass' }, '/blah/') ]
+    FileUtils.mkdir_p('content')
+    File.open('content/xyzzy.sass', 'w') { |io| io.write('p\n  color: green')}
+
+    items = [ Nanoc3::Item.new(
+      'blah',
+      { :content_filename => 'content/xyzzy.sass' },
+      '/blah/') ]
     params = { :item => items[0], :items => items }.merge(params)
     ::Nanoc3::Filters::Sass.new(params)
   end

metadata

@@ -2,7 +2,7 @@
 name: nanoc3
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.1.8
+  version: 3.1.9
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-25 00:00:00 Z
+date: 2011-06-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cri
@@ -122,7 +122,6 @@ files:
 - lib/nanoc3/filters/relativize_paths.rb
 - lib/nanoc3/filters/rubypants.rb
 - lib/nanoc3/filters/sass.rb
-- lib/nanoc3/filters/sass.rb.orig
 - lib/nanoc3/filters.rb
 - lib/nanoc3/helpers/blogging.rb
 - lib/nanoc3/helpers/breadcrumbs.rb
@@ -200,7 +199,6 @@ files:
 - test/filters/test_relativize_paths.rb
 - test/filters/test_rubypants.rb
 - test/filters/test_sass.rb
-- test/filters/test_sass.rb.orig
 - test/gem_loader.rb
 - test/helper.rb
 - test/helpers/test_blogging.rb

data/lib/nanoc3/filters/sass.rb.orig

@@ -1,75 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Filters
-  class Sass < Nanoc3::Filter
-
-    # Runs the content through [Sass](http://sass-lang.com/).
-    # Parameters passed to this filter will be passed on to Sass.
-    #
-    # @param [String] content The content to filter
-    #
-    # @return [String] The filtered content
-    def run(content, params={})
-      require 'sass'
-
-      # Add imported_filename read accessor to ImportNode
-      # … but… but… nex3 said I could monkey patch it! :(
-      methods = ::Sass::Tree::ImportNode.instance_methods
-      if !methods.include?(:import_filename) && !methods.include?('import_filename')
-        ::Sass::Tree::ImportNode.send(:attr_reader, :imported_filename)
-      end
-
-      # Get options
-      options = params.dup
-      sass_filename = options[:filename] || (@item && @item[:content_filename])
-      options[:filename] ||= sass_filename
-
-      # Build engine
-      engine = ::Sass::Engine.new(content, options)
-
-      # Get import nodes
-      require 'set'
-      imported_nodes = []
-      unprocessed_nodes = Set.new([ engine.to_tree ])
-      until unprocessed_nodes.empty?
-        # Get an unprocessed node
-        node = unprocessed_nodes.each { |n| break n }
-        unprocessed_nodes.delete(node)
-
-        # Add to list of import nodes if necessary
-        imported_nodes << node if node.is_a?(::Sass::Tree::ImportNode)
-
-        # Mark children of this node for processing
-        node.children.each { |c| unprocessed_nodes << c }
-      end
-
-      # Get import paths
-      import_paths = (options[:load_paths] || []).dup
-      import_paths.unshift(File.dirname(sass_filename)) if sass_filename
-      imported_filenames = imported_nodes.map { |node| node.imported_filename }
-
-      # Convert to items
-      imported_items = imported_filenames.map do |filename|
-        pathname = Pathname.new(filename)
-        next unless pathname.file?
-        normalized_filename = pathname.realpath
-        @items.find { |i| i[:content_filename] && Pathname.new(i[:content_filename]).realpath == normalized_filename }
-      end.compact
-
-      # Require compilation of each item
-      imported_items.each do |item|
-        # Notify
-        Nanoc3::NotificationCenter.post(:visit_started, item)
-        Nanoc3::NotificationCenter.post(:visit_ended,   item)
-
-        # Raise unmet dependency error if item is not yet compiled
-        any_uncompiled_rep = item.reps.find { |r| !r.compiled? }
-        raise Nanoc3::Errors::UnmetDependency.new(any_uncompiled_rep) if any_uncompiled_rep
-      end
-
-      # Done
-      engine.render
-    end
-
-  end
-end

data/test/filters/test_sass.rb.orig

@@ -1,103 +0,0 @@
-# encoding: utf-8
-
-require 'test/helper'
-
-class Nanoc3::Filters::SassTest < MiniTest::Unit::TestCase
-
-  include Nanoc3::TestHelpers
-
-  def test_filter
-    if_have 'sass' do
-      # Get filter
-      filter = ::Nanoc3::Filters::Sass.new({ :foo => 'bar' })
-
-      # Run filter
-      result = filter.run(".foo #bar\n  color: #f00")
-      assert_match(/.foo\s+#bar\s*\{\s*color:\s+(red|#f00);?\s*\}/, result)
-    end
-  end
-
-  def test_filter_with_params
-    if_have 'sass' do
-      # Create filter
-      filter = ::Nanoc3::Filters::Sass.new({ :foo => 'bar' })
-
-      # Check with compact
-      result = filter.run(".foo #bar\n  color: #f00", :style => 'compact')
-      assert_match(/^\.foo #bar[\s\n]*\{[\s\n]*color:\s*(red|#f00);?[\s\n]*\}/m, result)
-
-      # Check with compressed
-      result = filter.run(".foo #bar\n  color: #f00", :style => 'compressed')
-      assert_match(/^\.foo #bar[\s\n]*\{[\s\n]*color:\s*(red|#f00);?[\s\n]*\}/m, result)
-    end
-  end
-
-  def test_filter_error
-    if_have 'sass' do
-      # Create filter
-      filter = ::Nanoc3::Filters::Sass.new({ :foo => 'bar' })
-
-      # Run filter
-      raised = false
-      begin
-        filter.run('$*#&!@($')
-      rescue Sass::SyntaxError => e
-        assert_match ':1', e.backtrace[0]
-        raised = true
-      end
-      assert raised
-    end
-  end
-
-  def test_filter_can_import_external_files
-    if_have 'sass' do
-      # Create filter
-      filter = ::Nanoc3::Filters::Sass.new(:items => [])
-
-      # Create sample file
-      File.open('moo.sass', 'w') { |io| io.write "body\n  color: red" }
-
-      # Run filter
-      filter.run('@import moo')
-    end
-  end
-
-  def test_filter_can_import_relative_files
-    if_have 'sass' do
-      # Create filter
-      filter = ::Nanoc3::Filters::Sass.new(:items => [])
-
-      # Create sample file
-      File.open('moo.sass', 'w') { |io| io.write %Q{@import subdir/relative} }
-      FileUtils.mkdir_p("subdir")
-      File.open('subdir/relative.sass', 'w') { |io| io.write "body\n  color: red" }
-
-      # Run filter
-      filter.run('@import moo')
-    end
-  end
-
-  def test_filter_will_skip_items_without_filename
-    if_have 'sass' do
-      # Create filter
-      filter = ::Nanoc3::Filters::Sass.new(:items => [ Nanoc3::Item.new('blah', {}, '/blah/') ])
-
-      # Create sample file
-      File.open('moo.sass', 'w') { |io| io.write "body\n  color: red" }
-
-      # Run filter
-      filter.run('@import moo')
-    end
-  end
-  
-  def test_css_imports_work
-    if_have 'sass' do
-      # Create filter
-      filter = ::Nanoc3::Filters::Sass.new(:items => [ Nanoc3::Item.new('blah', {}, '/blah/') ])
-
-      # Run filter
-      filter.run('@import moo.css')
-    end
-  end
-
-end