nanoc3 3.2.0a1 → 3.2.0a2

data/lib/nanoc3/filters/asciidoc.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class AsciiDoc < Nanoc3::Filter
+
+    type :text
+    identifier :asciidoc
+
+    # Runs the content through [AsciiDoc](http://www.methods.co.nz/asciidoc/).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      require 'escape'
+      require 'tempfile'
+
+      # Run filter
+      output = ''
+      errors = ''
+      success = true
+      Tempfile.open('nanoc-asciidoc-in') do |cmd_in|
+        cmd_out = Tempfile.open('nanoc-asciidoc-out')
+        cmd_err = Tempfile.open('nanoc-asciidoc-err')
+        cmd_out.close
+        cmd_err.close
+
+        # Write input
+        cmd_in.write(content)
+        cmd_in.close
+
+        # Run
+        # TODO allow customizable options
+        fns = {
+          :in  => Escape.shell_single_word(cmd_in.path),
+          :out => Escape.shell_single_word(cmd_out.path),
+          :err => Escape.shell_single_word(cmd_err.path),
+        }
+        command = "asciidoc -o #{fns[:out]} #{fns[:in]} 2>#{fns[:err]}"
+        system(command)
+        success = $?.success?
+
+        # Done
+        output = File.read(cmd_out.path)
+        errors = File.read(cmd_err.path)
+      end
+
+      # Show errors
+      puts errors
+      raise RuntimeError, errors if !success
+
+      # Done
+      output
+    end
+
+  end
+end

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -17,8 +17,11 @@ module Nanoc3::Filters
     # invoked with a `:coderay => coderay_options_hash` option, the
     # `coderay_options_hash` hash will be passed to the CodeRay colorizer.
     #
-    # Currently, only the `:coderay` and `:pygmentize` colorizers are
-    # implemented. Additional colorizer implementations are welcome!
+    # Currently, only the `:coderay` (http://coderay.rubychan.de/),
+    # `:pygmentize` (http://pygments.org/, http://pygments.org/docs/cmdline/),
+    # and `:simon_highlight`
+    # (http://www.andre-simon.de/doku/highlight/en/highlight.html) colorizers
+    # are implemented. Additional colorizer implementations are welcome!
     #
     # @example Content that will be highlighted
     #
@@ -36,7 +39,11 @@ module Nanoc3::Filters
     #
     # @param [String] content The content to filter
     #
-    # @option params [Hash] :colorizers (DEFAULT_COLORIZER) A hash containing
+    # @option params [symbol] :default_colorizer (DEFAULT_COLORIZER) The
+    #   default colorizer, i.e. the colorizer that will be used when the
+    #   colorizer is not overriden for a specific language.
+    #
+    # @option params [Hash] :colorizers ({}) A hash containing
     #   a mapping of programming languages (symbols, not strings) onto
     #   colorizers (symbols).
     #
@@ -45,7 +52,7 @@ module Nanoc3::Filters
       require 'nokogiri'
 
       # Take colorizers from parameters
-      @colorizers = Hash.new(DEFAULT_COLORIZER)
+      @colorizers = Hash.new(params[:default_colorizer] || DEFAULT_COLORIZER)
       (params[:colorizers] || {}).each_pair do |language, colorizer|
         @colorizers[language] = colorizer
       end
@@ -70,8 +77,8 @@ module Nanoc3::Filters
         language = match[2]
 
         # Highlight
-        highlighted_code = highlight(element.inner_text, language, params)
-        element.inner_html = highlighted_code
+        highlighted_code = highlight(element.inner_text.strip, language, params)
+        element.inner_html = highlighted_code.strip
       end
 
       doc.to_s
@@ -79,10 +86,10 @@ module Nanoc3::Filters
 
   private
 
-    KNOWN_COLORIZERS = [ :coderay, :dummy, :pygmentize ]
+    KNOWN_COLORIZERS = [ :coderay, :dummy, :pygmentize, :simon_highlight ]
 
     def highlight(code, language, params={})
-      colorizer = @colorizers[language]
+      colorizer = @colorizers[language.to_sym]
       if KNOWN_COLORIZERS.include?(colorizer)
         send(colorizer, code, language, params[colorizer] || {})
       else
@@ -104,9 +111,40 @@ module Nanoc3::Filters
       IO.popen("pygmentize -l #{language} -f html", "r+") do |io|
         io.write(code)
         io.close_write
-        return io.read
+        highlighted_code = io.read
+
+        doc = Nokogiri::HTML.fragment(highlighted_code)
+        return doc.xpath('./div[@class="highlight"]/pre').inner_html
       end
     end
 
+    SIMON_HIGHLIGHT_OPT_MAP = {
+        :wrap => '-W',
+        :include_style => '-I',
+        :line_numbers  => '-l',
+    }
+
+    def simon_highlight(code, language, params={})
+      opts = []
+
+      params.each do |key, value|
+        if SIMON_HIGHLIGHT_OPT_MAP[key]
+          opts << SIMON_HIGHLIGHT_OPT_MAP[key]
+        else
+          # TODO allow passing other options
+          case key
+          when :style
+            opts << "--style #{params[:style]}"
+          end
+        end
+      end
+
+      commandline = "highlight --syntax #{language} --fragment #{opts.join(" ")} /dev/stdin" 
+      IO.popen(commandline, "r+") do |io|
+        io.write(code)
+        io.close_write
+        return io.read
+      end
+    end
   end
 end

data/lib/nanoc3/filters/less.rb

@@ -12,7 +12,13 @@ module Nanoc3::Filters
     def run(content, params={})
       require 'less'
 
+      # Add filename to load path
+      $LESS_LOAD_PATH << File.dirname(@item[:content_filename])
+
       ::Less::Engine.new(content).to_css
+    ensure
+      # Restore load path
+      $LESS_LOAD_PATH.delete_at(-1)
     end
 
   end

data/lib/nanoc3/filters/sass.rb

@@ -20,7 +20,9 @@ module Nanoc3::Filters
       end
 
       # Get options
-      options = params.merge(:filename => filename)
+      options = params.dup
+      sass_filename = options[:filename] || (@item && @item[:content_filename])
+      options[:filename] ||= sass_filename
 
       # Build engine
       engine = ::Sass::Engine.new(content, options)
@@ -43,8 +45,7 @@ module Nanoc3::Filters
 
       # Get import paths
       import_paths = (options[:load_paths] || []).dup
-      import_paths.unshift(File.dirname(options[:filename])) if options[:filename]
-
+      import_paths.unshift(File.dirname(sass_filename)) if sass_filename
       # Get imported filenames
       imported_filenames = imported_nodes.map do |node|
         ::Sass::Files.find_file_to_import(node.imported_filename, import_paths)
@@ -52,8 +53,10 @@ module Nanoc3::Filters
 
       # Convert to items
       imported_items = imported_filenames.map do |filename|
-        normalized_filename = Pathname.new(filename).realpath
-        @items.find { |i| i[:filename] && Pathname.new(i[:filename]).realpath == normalized_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

data/lib/nanoc3/filters.rb

@@ -2,6 +2,7 @@
 
 module Nanoc3::Filters
 
+  autoload 'AsciiDoc',        'nanoc3/filters/asciidoc'
   autoload 'BlueCloth',       'nanoc3/filters/bluecloth'
   autoload 'CodeRay',         'nanoc3/filters/coderay'
   autoload 'ColorizeSyntax',  'nanoc3/filters/colorize_syntax'
@@ -21,6 +22,7 @@ module Nanoc3::Filters
   autoload 'RubyPants',       'nanoc3/filters/rubypants'
   autoload 'Sass',            'nanoc3/filters/sass'
 
+  Nanoc3::Filter.register '::Nanoc3::Filters::AsciiDoc',        :asciidoc
   Nanoc3::Filter.register '::Nanoc3::Filters::BlueCloth',       :bluecloth
   Nanoc3::Filter.register '::Nanoc3::Filters::CodeRay',         :coderay
   Nanoc3::Filter.register '::Nanoc3::Filters::ColorizeSyntax',  :colorize_syntax

data/lib/nanoc3/helpers/blogging.rb

@@ -233,6 +233,14 @@ module Nanoc3::Helpers
             update_time = a[:updated_at] || a[:created_at]
             xml.published((create_time.is_a?(String) ? Time.parse(create_time) : create_time).to_iso8601_time)
             xml.updated(  (update_time.is_a?(String) ? Time.parse(update_time) : update_time).to_iso8601_time)
+        
+            # Add specific author information
+            if a[:author_name] || a[:author_uri]
+              xml.author do
+                xml.name  a[:author_name] || author_name
+                xml.uri   a[:author_uri]  || author_uri
+              end
+            end
 
             # Add link
             xml.link(:rel => 'alternate', :href => url)

data/lib/nanoc3/helpers/html_escape.rb

@@ -5,17 +5,47 @@ module Nanoc3::Helpers
   # Contains functionality for HTML-escaping strings.
   module HTMLEscape
 
-    # Returns the HTML-escaped representation of the given string. Only `&`,
-    # `<`, `>` and `"` are escaped.
+    require 'nanoc3/helpers/capturing'
+    include Nanoc3::Helpers::Capturing
+
+    # Returns the HTML-escaped representation of the given string or the given
+    # block. Only `&`, `<`, `>` and `"` are escaped. When given a block, the
+    # contents of the block will be escaped and appended to the output buffer,
+    # `_erbout`.
+    #
+    # @example Escaping a string
+    #
+    #     h('<br>')
+    #     # => '&lt;br&gt;'
+    #
+    # @example Escaping with a block
+    #
+    #     <% h do %>
+    #       <h1>Hello <em>world</em>!</h1>
+    #     <% end %>
+    #     # The buffer will now contain “&lt;h1&gt;Hello &lt;em&gt;world&lt;/em&gt;!&lt;/h1&gt;”
     #
     # @param [String] string The string to escape
     #
     # @return [String] The escaped string
-    def html_escape(string)
-      string.gsub('&', '&amp;').
-             gsub('<', '&lt;').
-             gsub('>', '&gt;').
-             gsub('"', '&quot;')
+    def html_escape(string=nil, &block)
+      if block_given?
+        # Capture and escape block
+        data = capture(&block)
+        escaped_data = html_escape(data)
+
+        # Append filtered data to buffer
+        buffer = eval('_erbout', block.binding)
+        buffer << escaped_data
+      elsif string
+        string.gsub('&', '&amp;').
+               gsub('<', '&lt;').
+               gsub('>', '&gt;').
+               gsub('"', '&quot;')
+      else
+        raise RuntimeError, "The #html_escape or #h function needs either a " \
+          "string or a block to HTML-escape, but neither a string nor a block was given"
+      end
     end
 
     alias h html_escape

data/lib/nanoc3/helpers/link_to.rb

@@ -47,7 +47,12 @@ module Nanoc3::Helpers
     #   # => '<a title="My super cool blog" href="/blog/">Blog</a>'
     def link_to(text, target, attributes={})
       # Find path
-      path = target.is_a?(String) ? target : target.path
+      if target.is_a?(String)
+        path = target
+      else
+        path = target.path
+        raise RuntimeError, "Cannot create a link to #{target.inspect} because this target is not outputted (its routing rule returns nil)" if path.nil?
+      end
 
       # Join attributes
       attributes = attributes.inject('') do |memo, (key, value)|
@@ -112,14 +117,20 @@ module Nanoc3::Helpers
       require 'pathname'
 
       # Find path
-      path = target.is_a?(String) ? target : target.path
+      if target.is_a?(String)
+        path = target
+      else
+        path = target.path
+        raise RuntimeError, "Cannot get the relative path to #{target.inspect} because this target is not outputted (its routing rule returns nil)" if path.nil?
+      end
 
       # Get source and destination paths
       dst_path   = Pathname.new(path)
+      raise RuntimeError, "Cannot get the relative path to #{path} because the current item representation, #{@item_rep.inspect}, is not outputted (its routing rule returns nil)" if @item_rep.path.nil?
       src_path   = Pathname.new(@item_rep.path)
 
-      # Calculate elative path (method depends on whether destination is a
-      # directory or not).
+      # Calculate the relative path (method depends on whether destination is
+      # a directory or not).
       if src_path.to_s[-1,1] != '/'
         relative_path = dst_path.relative_path_from(src_path.dirname).to_s
       else

data/lib/nanoc3/helpers/rendering.rb

@@ -68,10 +68,11 @@ module Nanoc3::Helpers
       # Create filter
       filter = filter_class.new(assigns)
 
+      # Notify start
+      Nanoc3::NotificationCenter.post(:processing_started, layout)
+
       # Layout
-      @site.compiler.stack.push(layout)
       result = filter.run(layout.raw_content, filter_args)
-      @site.compiler.stack.pop
 
       # Append to erbout if we have a block
       if block_given?
@@ -81,6 +82,9 @@ module Nanoc3::Helpers
 
       # Done
       result
+    ensure
+      # Notify end
+      Nanoc3::NotificationCenter.post(:processing_ended, layout)
     end
 
   end

data/lib/nanoc3/tasks/clean.rb

@@ -9,10 +9,6 @@ module Nanoc3::Tasks
     end
 
     def run
-      # Load site data
-      @site.load_data
-
-      # Delete all compiled item reps
       filenames.each do |filename|
         FileUtils.rm_f filename unless filename.nil?
       end

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.2.0a1'
+  VERSION = '3.2.0a2'
 
 end
 

data/nanoc3.gemspec

@@ -0,0 +1,42 @@
+# 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.homepage    = 'http://nanoc.stoneship.org/'
+  s.summary     = 'a web publishing system written in Ruby for building small to medium-sized websites.'
+  s.description = 'nanoc is a simple but very flexible static site generator written in Ruby. It operates on local files, and therefore does not run on the server. nanoc “compiles” the local source files into HTML (usually), by evaluating eRuby, Markdown, etc.'
+
+  s.author = 'Denis Defreyne'
+  s.email  = 'denis.defreyne@stoneship.org'
+
+  s.files              = Dir['[A-Z]*'] + Dir['lib/**/*'] + Dir['doc/yardoc_templates/**/*'] + [ 'nanoc3.gemspec' ]
+  s.default_executable = 'nanoc3'
+  s.executables        = [ 'nanoc3' ]
+  s.require_paths      = [ 'lib' ]
+
+  s.has_rdoc         = 'yard'
+  s.rdoc_options     = [ '--main', 'README.md' ]
+  s.extra_rdoc_files = [ 'ChangeLog', 'LICENSE', 'README.md', 'NEWS.md' ]
+
+  s.add_runtime_dependency('cri', '>= 1.0.0')
+
+  s.post_install_message = %q{------------------------------------------------------------------------------
+Thanks for installing nanoc 3.2! Here are some resources to help you get
+started:
+
+* The web site at <http://nanoc.stoneship.org/>
+* The tutorial at <http://nanoc.stoneship.org/docs/3-getting-started/>
+* The manual at <http://nanoc.stoneship.org/docs/4-basic-concepts/>
+
+If you have questions, issues or simply want to share ideas, join the
+discussion at <http://groups.google.com/group/nanoc> or stop by in the IRC
+channel on irc.freenode.net, channel #nanoc. See you there!
+
+Enjoy!
+------------------------------------------------------------------------------
+}
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
+  hash: -142061300
   prerelease: true
   segments: 
   - 3
   - 2
-  - 0a1
-  version: 3.2.0a1
+  - 0a2
+  version: 3.2.0a2
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-16 00:00:00 +02:00
+date: 2010-07-09 00:00:00 +02:00
 default_executable: nanoc3
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
@@ -31,7 +34,7 @@ dependencies:
         version: 1.0.0
   type: :runtime
   version_requirements: *id001
-description: 
+description: "nanoc is a simple but very flexible static site generator written in Ruby. It operates on local files, and therefore does not run on the server. nanoc \xE2\x80\x9Ccompiles\xE2\x80\x9D the local source files into HTML (usually), by evaluating eRuby, Markdown, etc."
 email: denis.defreyne@stoneship.org
 executables: 
 - nanoc3
@@ -48,30 +51,35 @@ files:
 - NEWS.md
 - Rakefile
 - README.md
-- lib/nanoc3/base/checksummer.rb
-- lib/nanoc3/base/code_snippet.rb
-- lib/nanoc3/base/compiled_content_cache.rb
-- lib/nanoc3/base/compiler.rb
-- lib/nanoc3/base/compiler_dsl.rb
+- lib/nanoc3/base/compilation/checksum_store.rb
+- lib/nanoc3/base/compilation/checksummer.rb
+- lib/nanoc3/base/compilation/compiled_content_cache.rb
+- lib/nanoc3/base/compilation/compiler.rb
+- lib/nanoc3/base/compilation/compiler_dsl.rb
+- lib/nanoc3/base/compilation/dependency_tracker.rb
+- lib/nanoc3/base/compilation/filter.rb
+- lib/nanoc3/base/compilation/item_rep_proxy.rb
+- lib/nanoc3/base/compilation/outdatedness_checker.rb
+- lib/nanoc3/base/compilation/outdatedness_reasons.rb
+- lib/nanoc3/base/compilation/rule.rb
+- lib/nanoc3/base/compilation/rule_context.rb
 - lib/nanoc3/base/context.rb
 - lib/nanoc3/base/core_ext/array.rb
 - lib/nanoc3/base/core_ext/hash.rb
 - lib/nanoc3/base/core_ext/string.rb
 - lib/nanoc3/base/core_ext.rb
-- lib/nanoc3/base/data_source.rb
-- lib/nanoc3/base/dependency_tracker.rb
 - lib/nanoc3/base/directed_graph.rb
 - lib/nanoc3/base/errors.rb
-- lib/nanoc3/base/filter.rb
-- lib/nanoc3/base/item.rb
-- lib/nanoc3/base/item_rep.rb
-- lib/nanoc3/base/layout.rb
 - lib/nanoc3/base/notification_center.rb
 - lib/nanoc3/base/ordered_hash.rb
 - lib/nanoc3/base/plugin_registry.rb
-- lib/nanoc3/base/rule.rb
-- lib/nanoc3/base/rule_context.rb
-- lib/nanoc3/base/site.rb
+- lib/nanoc3/base/result_data/item_rep.rb
+- lib/nanoc3/base/source_data/code_snippet.rb
+- lib/nanoc3/base/source_data/data_source.rb
+- lib/nanoc3/base/source_data/item.rb
+- lib/nanoc3/base/source_data/layout.rb
+- lib/nanoc3/base/source_data/site.rb
+- lib/nanoc3/base/store.rb
 - lib/nanoc3/base.rb
 - lib/nanoc3/cli/base.rb
 - lib/nanoc3/cli/commands/autocompile.rb
@@ -114,6 +122,7 @@ files:
 - lib/nanoc3/extra/vcses/subversion.rb
 - lib/nanoc3/extra/vcses.rb
 - lib/nanoc3/extra.rb
+- lib/nanoc3/filters/asciidoc.rb
 - lib/nanoc3/filters/bluecloth.rb
 - lib/nanoc3/filters/coderay.rb
 - lib/nanoc3/filters/colorize_syntax.rb
@@ -150,6 +159,9 @@ files:
 - lib/nanoc3/tasks/validate.rake
 - lib/nanoc3/tasks.rb
 - lib/nanoc3.rb
+- doc/yardoc_templates/default/layout/html/footer.erb
+- nanoc3.gemspec
+- bin/nanoc3
 has_rdoc: yard
 homepage: http://nanoc.stoneship.org/
 licenses: []
@@ -176,16 +188,20 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
+      hash: 25
       segments: 
       - 1
       - 3
@@ -194,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: a web publishing system written in Ruby for building small to medium-sized websites.

data/lib/nanoc3/base/checksummer.rb

@@ -1,40 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3
-
-  # Responsible for creating checksums of files. Such checksums are used to
-  # determine whether files have changed between compilations.
-  class Checksummer
-
-    # Returns a checksum for the specified file. Multiple invocations of this
-    # method with the same filename argument will yield the same result.
-    #
-    # The returned checksum has the property that for two given files with
-    # different content, the returned checksum will be different with a very
-    # high probability. In practice, this boils down to using a secure
-    # cryptographic hash function, such as SHA-1.
-    #
-    # The format of the resulting checksum should not be relied upon. In
-    # future versions of nanoc, this function may use a different method for
-    # generating checksums.
-    #
-    # @param [String] filename The name of the file for which the checksum
-    #   should be calculated
-    #
-    # @return [String] The checksum for the given files
-    def self.checksum_for(filename)
-      require 'digest'
-
-      digest = Digest::SHA1.new
-      File.open(filename, 'r') do |io|
-        until io.eof
-          data = io.readpartial(2**10)
-          digest.update(data)
-        end
-      end
-      digest.hexdigest
-    end
-
-  end
-
-end