nanoc3 3.2.0a3 → 3.2.0a4

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

@@ -2,6 +2,7 @@
 
 module Nanoc3::CLI::Commands
 
+  # @since 3.2.0
   class Watch < Cri::Command
 
     def name
@@ -92,7 +93,7 @@ module Nanoc3::CLI::Commands
 
       # Watch
       puts "Watching for changes…".make_compatible_with_env
-      watcher = lambda do
+      watcher = lambda do |*args|
         update(&rebuilder)
         delete(&rebuilder)
         create(&rebuilder)

data/lib/nanoc3/data_sources/deprecated/delicious.rb

@@ -8,8 +8,6 @@ module Nanoc3::DataSources
     def items
       @items ||= begin
         require 'json'
-        require 'time'
-        require 'enumerator'
 
         # Get data
         @http_client ||= Nanoc3::Extra::CHiCk::Client.new

data/lib/nanoc3/data_sources/deprecated/last_fm.rb

@@ -8,9 +8,7 @@ module Nanoc3::DataSources
     def items
       @items ||= begin
         require 'json'
-        require 'time'
         require 'uri'
-        require 'enumerator'
 
         # Check configuration
         if self.config[:username].nil?

data/lib/nanoc3/data_sources/deprecated/twitter.rb

@@ -8,8 +8,6 @@ module Nanoc3::DataSources
     def items
       @item ||= begin
         require 'json'
-        require 'time'
-        require 'enumerator'
 
         # Get data
         @http_client ||= Nanoc3::Extra::CHiCk::Client.new

data/lib/nanoc3/data_sources/filesystem.rb

@@ -228,14 +228,14 @@ module Nanoc3::DataSources
     def parse(content_filename, meta_filename, kind)
       # Read content and metadata from separate files
       if meta_filename
-        content = content_filename ? File.read(content_filename) : ''
-        meta    = YAML.load_file(meta_filename) || {}
+        content = content_filename ? read(content_filename) : ''
+        meta    = YAML.load(read(meta_filename)) || {}
 
         return [ meta, content ]
       end
 
       # Read data
-      data = File.read(content_filename)
+      data = read(content_filename)
 
       # Check presence of metadata section
       if data !~ /\A-{3,5}\s*$/
@@ -258,6 +258,20 @@ module Nanoc3::DataSources
       [ meta, content ]
     end
 
+    # Reads the content of the file with the given name and returns a string
+    # in UTF-8 encoding. The original encoding of the string is derived from
+    # 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
+      end
+    end
+
   end
 
 end

data/lib/nanoc3/data_sources/filesystem_unified.rb

@@ -14,10 +14,10 @@ module Nanoc3::DataSources
   # itself can start with a metadata section: it can be stored at the top of
   # the file, between `---` (three dashes) separators. For example:
   #
-  #   ---
-  #   title: "Moo!"
-  #   ---
-  #   h1. Hello!
+  #     ---
+  #     title: "Moo!"
+  #     ---
+  #     h1. Hello!
   #
   # The metadata section can be omitted. If the file does not start with
   # three or five dashes, the entire file will be considered as content.
@@ -26,7 +26,7 @@ module Nanoc3::DataSources
   # an `index.*` filename, such as `index.txt`, will have the filesystem path
   # with the `index.*` part stripped as a identifier. For example:
   #
-  #   foo/bar/index.html → /foo/bar/
+  #     foo/bar/index.html → /foo/bar/
   #
   # In other cases, the identifier is calculated by stripping the extension.
   # If the `allow_periods_in_identifiers` attribute in the configuration is
@@ -34,24 +34,24 @@ module Nanoc3::DataSources
   # extensions; if it is false or unset, all extensions will be stripped.
   # For example:
   #
-  #   (`allow_periods_in_identifiers` set to true)
-  #   foo.entry.html → /foo.entry/
-  #   
-  #   (`allow_periods_in_identifiers` set to false)
-  #   foo.html.erb → /foo/
+  #     (`allow_periods_in_identifiers` set to true)
+  #     foo.entry.html → /foo.entry/
+  #     
+  #     (`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.
   #
   # Some more examples:
   #
-  #   content/index.html          → /
-  #   content/foo.html            → /foo/
-  #   content/foo/index.html      → /foo/
-  #   content/foo/bar.html        → /foo/bar/
-  #   content/foo/bar.baz.html    → /foo/bar/ OR /foo/bar.baz/
-  #   content/foo/bar/index.html  → /foo/bar/
-  #   content/foo.bar/index.html  → /foo.bar/
+  #     content/index.html          → /
+  #     content/foo.html            → /foo/
+  #     content/foo/index.html      → /foo/
+  #     content/foo/bar.html        → /foo/bar/
+  #     content/foo/bar.baz.html    → /foo/bar/ OR /foo/bar.baz/
+  #     content/foo/bar/index.html  → /foo/bar/
+  #     content/foo.bar/index.html  → /foo.bar/
   #
   # The file extension does not determine the filters to run on items; the
   # Rules file is used to specify processing instructors for each item.

data/lib/nanoc3/extra/auto_compiler.rb

@@ -66,7 +66,7 @@ module Nanoc3::Extra
     rescue StandardError, ScriptError => e
       # Add compilation stack to env
       env['nanoc.stack'] = []
-      site.compiler.stack.reverse.each do |obj|
+      stack.reverse.each do |obj|
         if obj.is_a?(Nanoc3::ItemRep) # item rep
           env['nanoc.stack'] << "[item] #{obj.item.identifier} (rep #{obj.name})"
         else # layout
@@ -93,6 +93,10 @@ module Nanoc3::Extra
       @file_server ||= ::Rack::File.new(site.config[:output_dir])
     end
 
+    def stack
+      site.compiler.stack
+    end
+
   end
 
 end

data/lib/nanoc3/extra/core_ext/time.rb

@@ -9,7 +9,7 @@ module Nanoc3::Extra::TimeExtensions
 
   # @return [String] The time in an ISO-8601 time format.
   def to_iso8601_time
-    self.gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
+    self.getutc.strftime("%Y-%m-%dT%H:%M:%SZ")
   end
 
 end

data/lib/nanoc3/extra/file_proxy.rb

@@ -13,8 +13,12 @@ module Nanoc3::Extra
       @path = path
     end
 
+    def freeze
+      super
+    end
+
     def respond_to?(meth)
-      File.instance_methods.any? { |m| m == meth.to_s || m == meth.to_sym }
+      file_instance_methods.include?(meth.to_sym)
     end
 
     def method_missing(sym, *args, &block)
@@ -26,6 +30,12 @@ module Nanoc3::Extra
       File.open(@path, 'r') { |io| io.__send__(sym, *args, &block) }
     end
 
+  private
+
+    def file_instance_methods
+      @@file_instance_methods ||= Set.new(File.instance_methods.map { |m| m.to_sym })
+    end
+
   end
 
 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/asciidoc.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
 
 module Nanoc3::Filters
-  class AsciiDoc < Nanoc3::Filter
 
-    type :text
-    identifier :asciidoc
+  # @since 3.2.0
+  class AsciiDoc < Nanoc3::Filter
 
     # Runs the content through [AsciiDoc](http://www.methods.co.nz/asciidoc/).
     # This method takes no options.
@@ -55,4 +54,5 @@ module Nanoc3::Filters
     end
 
   end
+
 end

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -9,8 +9,15 @@ module Nanoc3::Filters
 
     # Syntax-highlights code blocks in the given content. Code blocks should
     # be enclosed in `pre` elements that contain a `code` element. The code
-    # element should have a class starting with `language-` and followed by
-    # the programming language, as specified by HTML5.
+    # element should have an indication of the language the code is in. There
+    # are two possible ways of adding such an indication:
+    #
+    # 1. A HTML class starting with `language-` and followed by the
+    # code language, as specified by HTML5. For example, `<code class="language-ruby">`.
+    #
+    # 2. A comment on the very first line of the code block in the format
+    # `#!language` where `language` is the language the code is in. For
+    # example, `#!ruby`.
     #
     # Options for individual colorizers will be taken from the {#run}
     # options’ value for the given colorizer. For example, if the filter is
@@ -23,7 +30,7 @@ module Nanoc3::Filters
     # (http://www.andre-simon.de/doku/highlight/en/highlight.html) colorizers
     # are implemented. Additional colorizer implementations are welcome!
     #
-    # @example Content that will be highlighted
+    # @example Using a class to indicate type of code be highlighted
     #
     #     <pre><code class="language-ruby">
     #     def foo
@@ -31,6 +38,15 @@ module Nanoc3::Filters
     #     end
     #     </code></pre>
     #
+    # @example Using a comment to indicate type of code be highlighted
+    #
+    #     <pre><code>
+    #     #!ruby
+    #     def foo
+    #       "asdf"
+    #     end
+    #     </code></pre>
+    #
     # @example Invoking the filter with custom parameters
     #
     #     filter :colorize_syntax,
@@ -62,7 +78,7 @@ module Nanoc3::Filters
       case syntax
       when :html
         klass = Nokogiri::HTML
-      when :xml
+      when :xml, :xhtml
         klass = Nokogiri::XML
       else
         raise RuntimeError, "unknown syntax: #{syntax.inspect} (expected :html or :xml)"
@@ -70,18 +86,40 @@ module Nanoc3::Filters
 
       # Colorize
       doc = klass.fragment(content)
-      doc.css('pre > code[class*="language-"]').each do |element|
+      doc.css('pre > code').each do |element|
         # Get language
-        match = element['class'].match(/(^| )language-([^ ]+)/)
-        next if match.nil?
-        language = match[2]
+        has_class = false
+        language = nil
+        if element['class']
+          # Get language from class
+          match = element['class'].match(/(^| )language-([^ ]+)/)
+          language = match[2] if match
+          has_class = true if language
+        else
+          # Get language from comment line
+          match = element.inner_text.match(/^#!([^\n]+)$/)
+          language = match[1] if match
+          element.content = element.content.sub(/^#!([^\n]+)$\n/, '') if language
+        end
+
+        # Give up if there is no hope left
+        next if language.nil?
 
         # Highlight
         highlighted_code = highlight(element.inner_text.strip, language, params)
         element.inner_html = highlighted_code.strip
+
+        # Add class
+        unless has_class
+          klass = element['class'] || ''
+          klass << ' ' unless [' ', nil].include?(klass[-1,1])
+          klass << "language-#{language}"
+          element['class'] = klass
+        end
       end
 
-      doc.to_s
+      method = "to_#{syntax}".to_sym
+      doc.send(method, :encoding => 'UTF-8')
     end
 
   private
@@ -97,12 +135,31 @@ module Nanoc3::Filters
       end
     end
 
+    # Runs the code through [CodeRay](http://coderay.rubychan.de/).
+    #
+    # @api private
+    #
+    # @param [String] code The code to colorize
+    #
+    # @param [String] language The language the code is written in
+    #
+    # @param [Hash] params Parameters to pass on to CodeRay
+    #
+    # @return [String] The colorized output
     def coderay(code, language, params={})
       require 'coderay'
 
       ::CodeRay.scan(code, language).html(params)
     end
 
+    # Returns the input itself, not performing any code highlighting.
+    #
+    # @param [String] code The code to colorize
+    #
+    # @param [String] language The language the code is written in (unused)
+    #
+    # @return [String] The colorized output, which is identical to the input
+    #   in this case
     def dummy(code, language, params={})
       code
     end
@@ -120,17 +177,24 @@ module Nanoc3::Filters
     #
     # @return [String] The colorized output
     def pygmentize(code, language, params={})
-      enc = ""
-      enc = "-O encoding=" + params[:encoding] if params[:encoding]
+      require 'stringio'
+      require 'systemu'
 
-      IO.popen("pygmentize -l #{language} -f html #{enc}", "r+") do |io|
-        io.write(code)
-        io.close_write
-        highlighted_code = io.read
+      # Build command
+      cmd = [ 'pygmentize', '-l', language, '-f', 'html' ]
+      cmd << '-O' << params.map { |k,v| "#{k}=#{v}" }.join(',') unless params.empty?
 
-        doc = Nokogiri::HTML.fragment(highlighted_code)
-        return doc.xpath('./div[@class="highlight"]/pre').inner_html
-      end
+      # Run command
+      stdout = StringIO.new
+      systemu cmd, 'stdin' => code, 'stdout' => stdout
+
+      # Get result
+      stdout.rewind
+      highlighted_code = stdout.read
+
+      # Clean result
+      doc = Nokogiri::HTML.fragment(highlighted_code)
+      doc.xpath('./div[@class="highlight"]/pre').inner_html
     end
 
     SIMON_HIGHLIGHT_OPT_MAP = {
@@ -139,27 +203,42 @@ module Nanoc3::Filters
         :line_numbers  => '-l',
     }
 
+    # Runs the content through [Highlight](http://www.andre-simon.de/doku/highlight/en/highlight.html).
+    #
+    # @api private
+    #
+    # @param [String] code The code to colorize
+    #
+    # @param [String] language The language the code is written in
+    #
+    # @option params [String] :style The style to use
+    #
+    # @since 3.2.0
     def simon_highlight(code, language, params={})
-      opts = []
+      require 'stringio'
+      require 'systemu'
 
+      # Build command
+      cmd = [ 'highlight', '--syntax', language, '--fragment' ]
       params.each do |key, value|
         if SIMON_HIGHLIGHT_OPT_MAP[key]
-          opts << SIMON_HIGHLIGHT_OPT_MAP[key]
+          cmd << SIMON_HIGHLIGHT_OPT_MAP[key]
         else
           # TODO allow passing other options
           case key
           when :style
-            opts << "--style #{params[:style]}"
+            cmd << '--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
+      # Run command
+      stdout = StringIO.new
+      systemu cmd, 'stdin' => code, 'stdout' => stdout
+
+      # Get result
+      stdout.rewind
+      stdout.read
     end
   end
 end

data/lib/nanoc3/filters/erb.rb

@@ -1,13 +1,17 @@
-# encoding: utf-8
+# encoding: utf-8                                                                                                           
 
 module Nanoc3::Filters
   class ERB < Nanoc3::Filter
 
     # Runs the content through [ERB](http://ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html).
-    # This method takes no options.
     #
     # @param [String] content The content to filter
     #
+    # @option params [Integer] safe_level (nil) The safe level (`$SAFE`) to
+    #   use while running this filter
+    #
+    # @option params [String] trim_mode (nil) The trim mode to use
+    #
     # @return [String] The filtered content
     def run(content, params={})
       require 'erb'
@@ -15,11 +19,17 @@ module Nanoc3::Filters
       # Create context
       context = ::Nanoc3::Context.new(assigns)
 
+      # Get binding
+      proc = assigns[:content] ? lambda { assigns[:content] } : nil 
+      assigns_binding = context.get_binding(&proc)
+
       # Get result
-      erb = ::ERB.new(content)
+      safe_level = params[:safe_level]
+      trim_mode = params[:trim_mode]
+      erb = ::ERB.new(content, safe_level, trim_mode)
       erb.filename = filename
-      erb.result(context.get_binding { assigns[:content] })
-    end
+      erb.result(assigns_binding)
+    end 
 
-  end
+  end 
 end

data/lib/nanoc3/filters/erubis.rb

@@ -15,8 +15,12 @@ module Nanoc3::Filters
       # Create context
       context = ::Nanoc3::Context.new(assigns)
 
+      # Get binding
+      proc = assigns[:content] ? lambda { assigns[:content] } : nil
+      assigns_binding = context.get_binding(&proc)
+
       # Get result
-      ::Erubis::Eruby.new(content, :filename => filename).result(context.get_binding { assigns[:content] })
+      ::Erubis::Eruby.new(content, :filename => filename).result(assigns_binding)
     end
 
   end

data/lib/nanoc3/filters/haml.rb

@@ -19,7 +19,8 @@ module Nanoc3::Filters
       context = ::Nanoc3::Context.new(assigns)
 
       # Get result
-      ::Haml::Engine.new(content, options).render(context, assigns) { assigns[:content] }
+      proc = assigns[:content] ? lambda { assigns[:content] } : nil
+      ::Haml::Engine.new(content, options).render(context, assigns, &proc)
     end
 
   end

data/lib/nanoc3/filters/less.rb

@@ -13,12 +13,9 @@ module Nanoc3::Filters
       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)
+      paths = [ File.dirname(@item[:content_filename]) ]
+      parser = ::Less::Parser.new(:paths => paths)
+      parser.parse(content).to_css
     end
 
   end

data/lib/nanoc3/filters/mustache.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 
 module Nanoc3::Filters
+
+  # @since 3.2.0
   class Mustache < Nanoc3::Filter
 
     # Runs the content through
@@ -18,4 +20,5 @@ module Nanoc3::Filters
     end
 
   end
+
 end

data/lib/nanoc3/filters/redcarpet.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+
+  # @since 3.2.0
+  class Redcarpet < Nanoc3::Filter
+
+    # Runs the content through [Redcarpet](https://github.com/tanoku/redcarpet/).
+    # This method optionally takes processing options to pass on to Redcarpet.
+    #
+    # @param [String] content The content to filter
+    #
+    # @option params [Array] :options ([]) A list of options to pass on to
+    #   Redcarpet
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      require 'redcarpet'
+
+      options = params[:options] || []
+
+      ::Redcarpet.new(content, *options).to_html
+    end
+
+  end
+
+end

data/lib/nanoc3/filters/sass.rb

@@ -28,7 +28,6 @@ module Nanoc3::Filters
       engine = ::Sass::Engine.new(content, options)
 
       # Get import nodes
-      require 'set'
       imported_nodes = []
       unprocessed_nodes = Set.new([ engine.to_tree ])
       until unprocessed_nodes.empty?
@@ -46,10 +45,7 @@ module Nanoc3::Filters
       # Get import paths
       import_paths = (options[:load_paths] || []).dup
       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)
-      end
+      imported_filenames = imported_nodes.map { |node| node.imported_filename }
 
       # Convert to items
       imported_items = imported_filenames.map do |filename|

data/lib/nanoc3/filters/slim.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+
+  # @since 3.2.0
+  class Slim < Nanoc3::Filter
+
+    # Runs the content through [Slim](http://slim-lang.com/)
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      require 'slim'
+
+      # Create context
+      context = ::Nanoc3::Context.new(assigns)
+
+      ::Slim::Template.new { content }.render(context) { assigns[:content] }
+    end
+
+  end
+
+end

data/lib/nanoc3/filters/typogruby.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+
+  # @since 3.2.0
+  class Typogruby < Nanoc3::Filter
+
+    # Runs the content through [Typogruby](http://avdgaag.github.com/typogruby/).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      require 'typogruby'
+
+      # Get result
+      ::Typogruby.improve(content)
+    end
+
+  end
+
+end