nanoc3 3.1.7 → 3.1.8

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2010 Denis Defreyne and contributors
+Copyright (c) 2007-2011 Denis Defreyne and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -1,5 +1,14 @@
 # nanoc news
 
+## 3.1.8 (2001-06-25)
+
+* Made link validator accept https: URLs
+* Fixed erronous handling of layouts with names ending in index
+* Fixed dependency generation between Sass partials
+* Fixed errors related to thread requires
+* Fixed crash while handling load errors
+* Improved encoding handling while reading files
+
 ## 3.1.7 (2011-05-03)
 
 * Restored compatibility with Sass 3.1

data/doc/yardoc_templates/default/layout/html/footer.erb

@@ -0,0 +1,10 @@
+<%= superb %>
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-15639968-1");
+pageTracker._trackPageview();
+} catch(err) {}</script>

data/lib/nanoc3/base/item.rb

@@ -96,7 +96,7 @@ module Nanoc3
 
       # Get rest of params
       @attributes   = attributes.symbolize_keys
-      @identifier   = identifier.cleaned_identifier
+      @identifier   = identifier.cleaned_identifier.freeze
 
       @parent       = nil
       @children     = []

data/lib/nanoc3/base/item_rep.rb

@@ -459,6 +459,7 @@ module Nanoc3
       if @old_content.nil? || self.raw_path.nil? || !@item.site.config[:enable_output_diff]
         @diff = nil
       else
+        require 'thread'
         @diff_thread = Thread.new do
           @diff = diff_strings(@old_content, @content[:last])
           sleep 2

data/lib/nanoc3/base/layout.rb

@@ -48,7 +48,7 @@ module Nanoc3
 
       @raw_content  = raw_content
       @attributes   = attributes.symbolize_keys
-      @identifier   = identifier.cleaned_identifier
+      @identifier   = identifier.cleaned_identifier.freeze
     end
 
     # Requests the attribute with the given key.

data/lib/nanoc3/cli/base.rb

@@ -164,7 +164,9 @@ module Nanoc3::CLI
       case error
       when LoadError
         # Get gem name
-        lib_name = error.message.match(/no such file to load -- ([^\s]+)/)[1]
+        matches = error.message.match(/no such file to load -- ([^\s]+)/)
+        return nil if matches.empty?
+        lib_name = matches[1]
         gem_name = gem_names[$1]
 
         # Build message
@@ -238,7 +240,7 @@ module Nanoc3::CLI
         gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : "without RubyGems"
         engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
 
-        puts "nanoc #{Nanoc3::VERSION} (c) 2007-2010 Denis Defreyne."
+        puts "nanoc #{Nanoc3::VERSION} (c) 2007-2011 Denis Defreyne."
         puts "Running #{engine} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} #{gem_info}"
         exit 0
       when :verbose

data/lib/nanoc3/cli/commands/view.rb

@@ -72,6 +72,7 @@ module Nanoc3::CLI::Commands
         use Rack::CommonLogger
         use Rack::ShowExceptions
         use Rack::Lint
+        use Rack::Head
         use Adsf::Rack::IndexFileFinder, :root => site.config[:output_dir]
         run Rack::File.new(site.config[:output_dir])
       end.to_app

data/lib/nanoc3/data_sources/filesystem.rb

@@ -264,13 +264,32 @@ module Nanoc3::DataSources
     # the default external encoding, but this can be overridden by the
     # “encoding” configuration attribute in the data source configuration.
     def read(filename)
-      data = File.read(filename)
-      if data.respond_to?(:encode)
-        data.force_encoding(@config[:encoding]) if @config && @config[:encoding]
-        data.encode('UTF-8')
-      else
-        data
+      # Read
+      begin
+        data = File.read(filename)
+      rescue => e
+        raise RuntimeError.new("Could not read #{filename}: #{e.inspect}")
       end
+
+      # Fix
+      if data.respond_to?(:encode!)
+        if @config && @config[:encoding]
+          original_encoding = Encoding.find(@config[:encoding])
+          data.force_encoding(@config[:encoding])
+        else
+          original_encoding = data.encoding
+        end
+
+        data.encode!('UTF-8') rescue raise_encoding_error(filename, original_encoding)
+        raise_encoding_error(filename, original_encoding) if !data.valid_encoding?
+      end
+
+      data
+    end
+
+    # Raises an invalid encoding error for the given filename and encoding.
+    def raise_encoding_error(filename, encoding)
+      raise RuntimeError.new("Could not read #{filename} because the file is not valid #{encoding}.")
     end
 
   end

data/lib/nanoc3/data_sources/filesystem_unified.rb

@@ -40,8 +40,8 @@ module Nanoc3::DataSources
   #     (`allow_periods_in_identifiers` set to false)
   #     foo.html.erb → /foo/
   #
-  # Note that it is possible for two different, separate files to have the
-  # same identifier. It is recommended to avoid such situations.
+  # Note that each item must have an unique identifier. nanoc will display an
+  # error if two items with the same identifier are found.
   #
   # Some more examples:
   #
@@ -103,10 +103,10 @@ module Nanoc3::DataSources
     # Returns the identifier derived from the given filename, first stripping
     # the given directory name off the filename.
     def identifier_for_filename(filename)
-      if filename =~ /index\.[^\/]+$/
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /index\.[^\/\.]+$/ : /index\.[^\/]+$/)
+      if filename =~ /(^|\/)index\.[^\/]+$/
+        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\/?index\.[^\/\.]+$/ : /\/?index\.[^\/]+$/)
       else
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/      : /\.[^\/]+$/)
+        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/         : /\.[^\/]+$/)
       end
       filename.sub(regex, '').cleaned_identifier
     end

data/lib/nanoc3/extra/validators/links.rb

@@ -166,7 +166,7 @@ module Nanoc3::Extra::Validators
       end
 
       # Skip non-HTTP URLs
-      return true if uri.scheme != 'http'
+      return true if uri.scheme !~ /^https?$/
 
       # Get status
       status = fetch_http_status_for(uri)

data/lib/nanoc3/filters/rdiscount.rb

@@ -4,7 +4,8 @@ module Nanoc3::Filters
   class RDiscount < Nanoc3::Filter
 
     # Runs the content through [RDiscount](http://github.com/rtomayko/rdiscount).
-    # This method takes no options.
+    #
+    # @option params [Array] symbol ([]) A list of RDiscount extensions
     #
     # @param [String] content The content to filter
     #

data/lib/nanoc3/filters/sass.rb

@@ -50,20 +50,32 @@ module Nanoc3::Filters
 
       # 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 }
+        # 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 |item|
+      imported_items.each do |i|
         # Notify
-        Nanoc3::NotificationCenter.post(:visit_started, item)
-        Nanoc3::NotificationCenter.post(:visit_ended,   item)
+        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 = item.reps.find { |r| !r.compiled? }
+        any_uncompiled_rep = i.reps.find { |r| !r.compiled? }
         raise Nanoc3::Errors::UnmetDependency.new(any_uncompiled_rep) if any_uncompiled_rep
       end
 

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

@@ -0,0 +1,75 @@
+# 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/lib/nanoc3.rb

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

data/nanoc3.gemspec

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../lib/', __FILE__))
+require 'nanoc3'
+
+Gem::Specification.new do |s|
+  s.name     = 'nanoc3'
+  s.version  = Nanoc3::VERSION
+  s.summary  = 'a web publishing system written in Ruby for building small to medium-sized websites.'
+  s.homepage = 'http://nanoc.stoneship.org/'
+
+  s.authors = 'Denis Defreyne'
+  s.email   = 'denis.defreyne@stoneship.org'
+
+  s.files              = Dir['[A-Z]*'] +
+                         Dir['doc/yardoc_templates/**/*'] +
+                         Dir['{bin,lib,tasks,test}/**/*'] +
+                         [ 'nanoc3.gemspec', '.gemtest' ]
+  s.executables        = [ 'nanoc3' ]
+  s.require_paths      = [ 'lib' ]
+
+  s.rdoc_options     = [ '--main', 'README.md' ]
+  s.extra_rdoc_files = [ 'ChangeLog', 'LICENSE', 'README.md', 'NEWS.md' ]
+
+  s.add_runtime_dependency('cri', '~> 1.0')
+
+  s.post_install_message = %q{------------------------------------------------------------------------------
+Thanks for installing nanoc 3.1! Here are some resources to help you get
+started:
+
+* The tutorial at <http://nanoc.stoneship.org/tutorial/>
+* The manual at <http://nanoc.stoneship.org/manual/>
+* The discussion group at <http://groups.google.com/group/nanoc>
+
+Because nanoc 3.1 has quite a few new features, be sure to check out the nanoc
+blog at <http://nanoc.stoneship.org/blog/> for details about this release.
+
+Enjoy!
+------------------------------------------------------------------------------
+}
+end

data/tasks/clean.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'rake/clean'
+
+CLEAN.include([
+  'coverage',
+  'doc',
+  'tmp'
+])
+
+CLOBBER.include([ 'pkg' ])

data/tasks/doc.rake

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |yard|
+  yard.files   = Dir['lib/**/*.rb']
+  yard.options = [
+    '--markup',        'markdown',
+    '--readme',        'README.md',
+    '--files',         'NEWS.md,LICENSE',
+    '--output-dir',    'doc/yardoc',
+    '--template-path', 'doc/yardoc_templates'
+  ]
+end

data/tasks/gem.rake

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'rubygems/package_task'
+
+namespace :pkg do
+
+  spec = eval(File.read('nanoc3.gemspec'))
+  Gem::PackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+
+end

data/tasks/test.rake

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'minitest/unit'
+
+test = namespace :test do
+
+  # test:all
+  desc 'Run all tests'
+  task :all do
+    ENV['QUIET'] ||= 'true'
+
+    $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+    MiniTest::Unit.autorun
+
+    test_files = Dir['test/**/*_spec.rb'] + Dir['test/**/test_*.rb']
+    test_files.each { |f| require f }
+  end
+
+  # test:...
+  %w( base cli data_sources extra filters helpers tasks ).each do |dir|
+    desc "Run all #{dir} tests"
+    task dir.to_sym do |task|
+      ENV['QUIET'] ||= 'true'
+
+      $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+      MiniTest::Unit.autorun
+
+      test_files = Dir["test/#{dir}/**/*_spec.rb"] + Dir["test/#{dir}/**/test_*.rb"]
+      test_files.each { |f| require f }
+    end
+  end
+
+end
+
+desc 'Alias for test:all'
+task :test => [ :'test:all' ]

data/test/base/core_ext/array_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'Array#symbolize_keys' 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
+  end
+
+end
+
+describe 'Array#stringify_keys' 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
+  end
+
+end

data/test/base/core_ext/hash_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'Hash#symbolize_keys' do
+
+  it 'should convert keys to symbols' do
+    hash_old = { 'foo' => 'bar' }
+    hash_new = { :foo  => 'bar' }
+    hash_old.symbolize_keys.must_equal hash_new
+  end
+
+end
+
+describe 'Hash#stringify_keys' do
+
+  it 'should leave strings as strings' do
+    hash_old = { 'foo' => 'bar' }
+    hash_new = { 'foo' => 'bar' }
+    hash_old.stringify_keys.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
+  end
+
+  it 'should convert integers to strings' do
+    hash_old = { 123   => 'bar' }
+    hash_new = { '123' => 'bar' }
+    hash_old.stringify_keys.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
+  end
+
+end

data/test/base/core_ext/string_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+describe 'String#cleaned_identifier' do
+
+  it 'should not convert already clean paths' do
+    '/foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should prepend slash if necessary' do
+    'foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should append slash if necessary' do
+    '/foo/bar'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should remove double slashes at start' do
+    '//foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+  it 'should remove double slashes at end' do
+    '/foo/bar//'.cleaned_identifier.must_equal '/foo/bar/'
+  end
+
+end

data/test/base/test_code_snippet.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'test/helper'
+
+class Nanoc3::CodeSnippetTest < MiniTest::Unit::TestCase
+
+  include Nanoc3::TestHelpers
+
+  def test_load
+    # Initialize
+    $complete_insane_parrot = 'meow'
+
+    # Create code and load it
+    code_snippet = Nanoc3::CodeSnippet.new("$complete_insane_parrot = 'woof'", 'parrot.rb')
+    code_snippet.load
+
+    # Ensure code is loaded
+    assert_equal('woof', $complete_insane_parrot)
+  end
+
+  def test_load_with_toplevel_binding
+    # Initialize
+    @foo = 'meow'
+
+    # Create code and load it
+    code_snippet = Nanoc3::CodeSnippet.new("@foo = 'woof'", 'dog.rb')
+    code_snippet.load
+
+    # Ensure binding is correct
+    assert_equal('meow', @foo)
+  end
+
+end