nanoc 3.2.4 → 3.3.0

data/lib/nanoc/extra/vcses/bazaar.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Nanoc::Extra::VCSes
+
+  # @see Nanoc::Extra::VCS
+  class Bazaar < Nanoc::Extra::VCS
+
+    # @see Nanoc::Extra::VCS#add
+    def add(filename)
+      system('bzr', 'add', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#remove
+    def remove(filename)
+      system('bzr', 'rm', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#move
+    def move(src, dst)
+      system('bzr', 'mv', src, dst)
+    end
+
+  end
+
+end

data/lib/nanoc/extra/vcses/dummy.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Nanoc::Extra::VCSes
+
+  # @see Nanoc::Extra::VCS
+  class Dummy < Nanoc::Extra::VCS
+
+    # @see Nanoc::Extra::VCS#add
+    def add(filename)
+    end
+
+    # @see Nanoc::Extra::VCS#remove
+    def remove(filename)
+      FileUtils.rm_rf(filename)
+    end
+
+    # @see Nanoc::Extra::VCS#move
+    def move(src, dst)
+      FileUtils.move(src, dst)
+    end
+
+  end
+
+end

data/lib/nanoc/extra/vcses/git.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Nanoc::Extra::VCSes
+
+  # @see Nanoc::Extra::VCS
+  class Git < Nanoc::Extra::VCS
+
+    # @see Nanoc::Extra::VCS#add
+    def add(filename)
+      system('git', 'add', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#remove
+    def remove(filename)
+      system('git', 'rm', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#move
+    def move(src, dst)
+      system('git', 'mv', src, dst)
+    end
+
+  end
+
+end

data/lib/nanoc/extra/vcses/mercurial.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Nanoc::Extra::VCSes
+
+  # @see Nanoc::Extra::VCS
+  class Mercurial < Nanoc::Extra::VCS
+
+    # @see Nanoc::Extra::VCS#add
+    def add(filename)
+      system('hg', 'add', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#remove
+    def remove(filename)
+      system('hg', 'rm', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#move
+    def move(src, dst)
+      system('hg', 'mv', src, dst)
+    end
+
+  end
+
+end

data/lib/nanoc/extra/vcses/subversion.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Nanoc::Extra::VCSes
+
+  # @see Nanoc::Extra::VCS
+  class Subversion < Nanoc::Extra::VCS
+
+    # @see Nanoc::Extra::VCS#add
+    def add(filename)
+      system('svn', 'add', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#remove
+    def remove(filename)
+      system('svn', 'rm', filename)
+    end
+
+    # @see Nanoc::Extra::VCS#move
+    def move(src, dst)
+      system('svn', 'mv', src, dst)
+    end
+
+  end
+
+end

data/lib/nanoc/filters.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Nanoc::Filters
+
+  autoload 'AsciiDoc',        'nanoc/filters/asciidoc'
+  autoload 'BlueCloth',       'nanoc/filters/bluecloth'
+  autoload 'CodeRay',         'nanoc/filters/coderay'
+  autoload 'ColorizeSyntax',  'nanoc/filters/colorize_syntax'
+  autoload 'CoffeeScript',    'nanoc/filters/coffeescript'
+  autoload 'ERB',             'nanoc/filters/erb'
+  autoload 'Erubis',          'nanoc/filters/erubis'
+  autoload 'Haml',            'nanoc/filters/haml'
+  autoload 'Kramdown',        'nanoc/filters/kramdown'
+  autoload 'Less',            'nanoc/filters/less'
+  autoload 'Markaby',         'nanoc/filters/markaby'
+  autoload 'Maruku',          'nanoc/filters/maruku'
+  autoload 'Mustache',        'nanoc/filters/mustache'
+  autoload 'Rainpress',       'nanoc/filters/rainpress'
+  autoload 'RDiscount',       'nanoc/filters/rdiscount'
+  autoload 'RDoc',            'nanoc/filters/rdoc'
+  autoload 'Redcarpet',       'nanoc/filters/redcarpet'
+  autoload 'RedCloth',        'nanoc/filters/redcloth'
+  autoload 'RelativizePaths', 'nanoc/filters/relativize_paths'
+  autoload 'RubyPants',       'nanoc/filters/rubypants'
+  autoload 'Sass',            'nanoc/filters/sass'
+  autoload 'Slim',            'nanoc/filters/slim'
+  autoload 'Typogruby',       'nanoc/filters/typogruby'
+  autoload 'UglifyJS',        'nanoc/filters/uglify_js'
+  autoload 'XSL',             'nanoc/filters/xsl'
+  autoload 'YUICompressor',   'nanoc/filters/yui_compressor'
+
+  Nanoc::Filter.register '::Nanoc::Filters::AsciiDoc',        :asciidoc
+  Nanoc::Filter.register '::Nanoc::Filters::BlueCloth',       :bluecloth
+  Nanoc::Filter.register '::Nanoc::Filters::CodeRay',         :coderay
+  Nanoc::Filter.register '::Nanoc::Filters::ColorizeSyntax',  :colorize_syntax
+  Nanoc::Filter.register '::Nanoc::Filters::CoffeeScript',    :coffeescript
+  Nanoc::Filter.register '::Nanoc::Filters::ERB',             :erb
+  Nanoc::Filter.register '::Nanoc::Filters::Erubis',          :erubis
+  Nanoc::Filter.register '::Nanoc::Filters::Haml',            :haml
+  Nanoc::Filter.register '::Nanoc::Filters::Kramdown',        :kramdown
+  Nanoc::Filter.register '::Nanoc::Filters::Less',            :less
+  Nanoc::Filter.register '::Nanoc::Filters::Markaby',         :markaby
+  Nanoc::Filter.register '::Nanoc::Filters::Maruku',          :maruku
+  Nanoc::Filter.register '::Nanoc::Filters::Mustache',        :mustache
+  Nanoc::Filter.register '::Nanoc::Filters::Rainpress',       :rainpress
+  Nanoc::Filter.register '::Nanoc::Filters::RDiscount',       :rdiscount
+  Nanoc::Filter.register '::Nanoc::Filters::RDoc',            :rdoc
+  Nanoc::Filter.register '::Nanoc::Filters::Redcarpet',       :redcarpet
+  Nanoc::Filter.register '::Nanoc::Filters::RedCloth',        :redcloth
+  Nanoc::Filter.register '::Nanoc::Filters::RelativizePaths', :relativize_paths
+  Nanoc::Filter.register '::Nanoc::Filters::RubyPants',       :rubypants
+  Nanoc::Filter.register '::Nanoc::Filters::Sass',            :sass
+  Nanoc::Filter.register '::Nanoc::Filters::Slim',            :slim
+  Nanoc::Filter.register '::Nanoc::Filters::Typogruby',       :typogruby
+  Nanoc::Filter.register '::Nanoc::Filters::UglifyJS',        :uglify_js
+  Nanoc::Filter.register '::Nanoc::Filters::XSL',             :xsl
+  Nanoc::Filter.register '::Nanoc::Filters::YUICompressor',   :yui_compressor
+
+end

data/lib/nanoc/filters/asciidoc.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'systemu'
+
+module Nanoc::Filters
+
+  # @since 3.2.0
+  class AsciiDoc < Nanoc::Filter
+
+    # 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={})
+      # Run command
+      stdout = ''
+      stderr = ''
+      status = systemu(
+        [ 'asciidoc', '-o', '-', '-' ],
+        'stdin'  => content,
+        'stdout' => stdout,
+        'stderr' => stderr)
+
+      # Show errors
+      unless status.success?
+        $stderr.puts stderr
+        raise RuntimeError, "AsciiDoc filter failed with status #{status}"
+      end
+
+      # Get result
+      stdout
+    end
+
+  end
+
+end

data/lib/nanoc/filters/bluecloth.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'bluecloth'
+
+module Nanoc::Filters
+  class BlueCloth < Nanoc::Filter
+
+    # Runs the content through [BlueCloth](http://deveiate.org/projects/BlueCloth).
+    # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      ::BlueCloth.new(content).to_html
+    end
+
+  end
+end

data/lib/nanoc/filters/coderay.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'coderay'
+
+module Nanoc::Filters
+  class CodeRay < Nanoc::Filter
+
+    # @deprecated Use the `:colorize_syntax` filter instead.
+    def run(content, params={})
+      # Warn
+      warn 'The :coderay filter is deprecated; consider using the :colorize_syntax filter instead.'
+
+      # Check params
+      raise ArgumentError, "CodeRay filter requires a :language argument which is missing" if params[:language].nil?
+
+      # Get result
+      ::CodeRay.scan(content, params[:language]).html
+    end
+
+  end
+end

data/lib/nanoc/filters/coffeescript.rb

@@ -0,0 +1,20 @@
+require 'coffee-script'
+
+module Nanoc::Filters
+
+  # @since 3.3.0
+  class CoffeeScript < Nanoc::Filter
+
+    # Runs the content through [CoffeeScript](http://coffeescript.org/).
+    # This method takes no options.
+    #
+    # @param [String] content The CoffeeScript content to turn into JavaScript
+    #
+    # @return [String] The resulting JavaScript
+    def run(content, params = {})
+      ::CoffeeScript.compile(content)
+    end
+
+  end
+
+end

data/lib/nanoc/filters/colorize_syntax.rb

@@ -0,0 +1,298 @@
+# encoding: utf-8
+
+require 'nokogiri'
+require 'stringio'
+require 'open3'
+
+module Nanoc::Filters
+  class ColorizeSyntax < Nanoc::Filter
+
+    # The default colorizer to use for a language if the colorizer for that
+    # language is not overridden.
+    DEFAULT_COLORIZER = :coderay
+
+    # 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 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
+    # invoked with a `:coderay => coderay_options_hash` option, the
+    # `coderay_options_hash` hash will be passed to the CodeRay colorizer.
+    #
+    # Currently, the following colorizers are supported:
+    #
+    # * `:coderay` for [Coderay](http://coderay.rubychan.de/)
+    # * `:pygmentize` for [pygmentize](http://pygments.org/docs/cmdline/), the
+    #   commandline frontend for [Pygments](http://pygments.org/)
+    # * `:pygmentsrb` for [pygments.rb](https://github.com/tmm1/pygments.rb),
+    #   a Ruby interface for [Pygments](http://pygments.org/)
+    # * `:simon_highlight` for [Highlight](http://www.andre-simon.de/doku/highlight/en/highlight.html)
+    #
+    # Additional colorizer implementations are welcome!
+    #
+    # @example Using a class to indicate type of code be highlighted
+    #
+    #     <pre><code class="language-ruby">
+    #     def foo
+    #       "asdf"
+    #     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,
+    #            :colorizers => { :ruby => :coderay },
+    #            :coderay    => { :line_numbers => :list }
+    #
+    # @param [String] content The content to filter
+    #
+    # @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 [Symbol] :syntax (:html) The syntax to use, which can be
+    #   `:html`, `:xml` or `:xhtml`, the latter two being the same.
+    #
+    # @option params [Hash] :colorizers ({}) A hash containing
+    #   a mapping of programming languages (symbols, not strings) onto
+    #   colorizers (symbols).
+    #
+    # @option params [Boolean] :outside_pre (false) `true` if the colorizer
+    #   should be applied on `code` elements outside `pre` elements, false
+    #   if only `code` elements inside` pre` elements should be colorized.
+    #
+    # @option params [Symbol] :is_fullpage (false) Whether to treat the input
+    #   as a full HTML page or a page fragment. When true, HTML boilerplate
+    #   such as the doctype, `html`, `head` and `body` elements will be added.
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      # Take colorizers from parameters
+      @colorizers = Hash.new(params[:default_colorizer] || DEFAULT_COLORIZER)
+      (params[:colorizers] || {}).each_pair do |language, colorizer|
+        @colorizers[language] = colorizer
+      end
+
+      # Determine syntax (HTML or XML)
+      syntax = params[:syntax] || :html
+      case syntax
+      when :html
+        klass = Nokogiri::HTML
+      when :xml, :xhtml
+        klass = Nokogiri::XML
+      else
+        raise RuntimeError, "unknown syntax: #{syntax.inspect} (expected :html or :xml)"
+      end
+
+      # Colorize
+      is_fullpage = params.fetch(:is_fullpage) { false }
+      doc = is_fullpage ? klass.parse(content, nil, 'UTF-8') : klass.fragment(content)
+      selector = params[:outside_pre] ? 'code' : 'pre > code'
+      doc.css(selector).each do |element|
+        # Get language
+        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
+        raw = strip(element.inner_text)
+        highlighted_code = highlight(raw, language, params)
+        element.children = Nokogiri::HTML.fragment(strip(highlighted_code), 'utf-8')
+
+        # Add class
+        unless has_class
+          klass = element['class'] || ''
+          klass << ' ' unless [' ', nil].include?(klass[-1,1])
+          klass << "language-#{language}"
+          element['class'] = klass
+        end
+      end
+
+      method = "to_#{syntax}".to_sym
+      doc.send(method, :encoding => 'UTF-8')
+    end
+
+  private
+
+    KNOWN_COLORIZERS = [ :coderay, :dummy, :pygmentize, :pygmentsrb, :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)
+        send(colorizer, code, language, params[colorizer] || {})
+      else
+        raise RuntimeError, "I don’t know how to highlight code using the “#{colorizer}” colorizer"
+      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
+
+    # Runs the content through [pygmentize](http://pygments.org/docs/cmdline/),
+    # the commandline frontend for [Pygments](http://pygments.org/).
+    #
+    # @api private
+    #
+    # @param [String] code The code to colorize
+    #
+    # @param [String] language The language the code is written in
+    #
+    # @option params [String, Symbol] :encoding The encoding of the code block
+    #
+    # @return [String] The colorized output
+    def pygmentize(code, language, params={})
+      require 'systemu'
+      check_availability('pygmentize', '-V')
+
+      params[:encoding] ||= 'utf-8'
+      params[:nowrap]   ||= 'True'
+
+      # Build command
+      cmd = [ 'pygmentize', '-l', language, '-f', 'html' ]
+      cmd << '-O' << params.map { |k,v| "#{k}=#{v}" }.join(',') unless params.empty?
+
+      # Run command
+      stdout = StringIO.new
+      systemu cmd, 'stdin' => code, 'stdout' => stdout
+
+      # Get result
+      stdout.rewind
+      stdout.read
+    end
+
+    # Runs the content through [Pygments](http://pygments.org/) via
+    # [pygments.rb](https://github.com/tmm1/pygments.rb).
+    #
+    # @api private
+    #
+    # @param [String] code The code to colorize
+    #
+    # @param [String] language The language the code is written in
+    #
+    # @return [String] The colorized output
+    def pygmentsrb(code, language, params={})
+      require 'pygments'
+
+      args = params.dup
+      args[:lexer] ||= language
+      args[:options] ||= {}
+      args[:options][:encoding] ||= 'utf-8'
+      args[:options][:nowrap]   ||= 'True'
+
+      Pygments.highlight(code, args)
+    end
+
+    SIMON_HIGHLIGHT_OPT_MAP = {
+        :wrap => '-W',
+        :include_style => '-I',
+        :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={})
+      require 'systemu'
+
+      check_availability('highlight', '--version')
+
+      # Build command
+      cmd = [ 'highlight', '--syntax', language, '--fragment' ]
+      params.each do |key, value|
+        if SIMON_HIGHLIGHT_OPT_MAP[key]
+          cmd << SIMON_HIGHLIGHT_OPT_MAP[key]
+        else
+          # TODO allow passing other options
+          case key
+          when :style
+            cmd << '--style' << params[:style]
+          end
+        end
+      end
+
+      # Run command
+      stdout = StringIO.new
+      systemu cmd, 'stdin' => code, 'stdout' => stdout
+
+      # Get result
+      stdout.rewind
+      stdout.read
+    end
+
+    def check_availability(*cmd)
+      systemu cmd
+      raise "Could not spawn #{cmd.join(' ')}" if $?.exitstatus != 0
+    end
+
+  end
+end