nanoc 1.4 → 1.5

data/lib/nanoc/enhancements.rb

@@ -0,0 +1,93 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+require 'fileutils'
+
+def handle_exception(exception, text)
+  unless $quiet or exception.class == SystemExit
+    $stderr.puts "ERROR: Exception occured while #{text}:\n"
+    $stderr.puts exception
+    $stderr.puts exception.backtrace.join("\n")
+  end
+  exit
+end
+
+def deprecate(str)
+  $stderr.puts 'DEPRECATION WARNING: ' + str unless $quiet
+end
+
+class FileLogger
+  COLORS = {
+    :reset   => "\e[0m",
+
+    :bold    => "\e[1m",
+
+    :black   => "\e[30m",
+    :red     => "\e[31m",
+    :green   => "\e[32m",
+    :yellow  => "\e[33m",
+    :blue    => "\e[34m",
+    :magenta => "\e[35m",
+    :cyan    => "\e[36m",
+    :white   => "\e[37m"
+  }
+
+  ACTION_COLORS = {
+    :create     => COLORS[:bold] + COLORS[:green],
+    :update     => COLORS[:bold] + COLORS[:yellow],
+    :move       => COLORS[:bold] + COLORS[:blue],
+    :identical  => COLORS[:bold]
+  }
+
+  attr_reader :out
+
+  def initialize(a_out = $stdout)
+    @out = a_out
+  end
+
+  def log(a_action, a_path)
+    @out.puts('%s%12s%s  %s' % [ACTION_COLORS[a_action.to_sym], a_action, COLORS[:reset], a_path]) unless $quiet
+  end
+
+  private
+
+  def method_missing(a_method, *a_args)
+    log(a_method.to_s, a_args.first)
+  end
+end
+
+class FileManager
+  @@stack = []
+  @@logger = FileLogger.new
+
+  def self.create_dir(a_name)
+    @@stack.pushing(a_name) do
+      path = File.join(@@stack)
+      unless File.directory?(path)
+        FileUtils.mkdir_p(path)
+        @@logger.create(path)
+      end
+      yield if block_given?
+    end
+  end
+
+  def self.create_file(a_name)
+    path = File.join(@@stack + [ a_name ])
+    FileManager.create_dir(path.sub(/\/[^\/]+$/, '')) if @@stack.empty?
+    content = block_given? ? yield : nil
+    if File.exist?(path)
+      if block_given? and File.read(path) == content
+        @@logger.identical(path)
+      else
+        @@logger.update(path)
+      end
+    else
+      @@logger.create(path)
+    end
+    open(path, 'w') { |io| io.write(content) unless content.nil? }
+  end
+end
+
+def render(a_name, a_context={})
+  assigns = a_context.merge({ :page => @page, :pages => @pages })
+  File.read('layouts/' + a_name.to_s + '.erb').eruby(:assigns => assigns)
+end

data/lib/nanoc/filters.rb

@@ -0,0 +1,7 @@
+# Convenience function for registering filters
+def register_filter(*names, &block)
+  names.each { |name| $nanoc_compiler.register_filter(name, &block) }
+end
+
+# Load all filters
+Dir[File.join(File.dirname(__FILE__), 'filters', '*_filter.rb')].each { |f| require f }

data/lib/nanoc/filters/eruby_filter.rb

@@ -0,0 +1,44 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+require 'erb'
+try_require 'erubis'
+
+class ERBContext
+
+  def initialize(hash)
+    hash.each_pair do |key, value|
+      instance_variable_set('@' + key.to_s, value)
+    end
+  end
+
+  def get_binding
+    binding
+  end
+
+end
+
+class String
+
+  # Converts the string using eRuby
+  def eruby(params={})
+    params[:eruby_engine] == :erubis ? erubis(params) : erb(params)
+  end
+
+  # Converts the string using Erubis
+  def erubis(params={})
+    Erubis::Eruby.new(self).evaluate(params[:assigns] || {})
+  end
+
+  # Converts the string using ERB
+  def erb(params={})
+    ERB.new(self).result(ERBContext.new(params[:assigns] || {}).get_binding)
+  end
+
+end
+
+register_filter 'eruby' do |page, pages, config|
+  assigns = { :page => page, :pages => pages }
+  page.content.eruby(:assigns => assigns, :eruby_engine => config[:eruby_engine])
+end

data/lib/nanoc/filters/haml_filter.rb

@@ -0,0 +1,24 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'haml'
+
+class String
+
+  # Converts the string using Haml
+  def haml(params={})
+    options = (params[:haml_options] || {})
+    options[:locals] = params[:assigns] unless params[:assigns].nil?
+    Haml::Engine.new(self, options).to_html
+  rescue NameError
+    $stderr.puts 'ERROR: String#haml failed (Haml not installed?)' unless $quiet
+    exit
+  end
+
+end
+
+register_filter 'haml' do |page, pages, config|
+  assigns = { :page => page, :pages => pages }
+  page.content.haml(:assigns => assigns, :haml_options => page[:haml_options])
+end

data/lib/nanoc/filters/liquid_filter.rb

@@ -0,0 +1,51 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'liquid'
+
+class String
+
+  # Converts the string using Liquid
+  def liquid(params={})
+    Liquid::Template.parse(self).render((params[:assigns] || {}).stringify_keys)
+  rescue NameError
+    $stderr.puts 'ERROR: String#liquid failed (Liquid not installed?)' unless $quiet
+    exit
+  end
+
+end
+
+begin
+  class Nanoc::LiquidRenderTag < ::Liquid::Tag
+    Syntax = /(['"])([^'"]+)\1/
+
+    def initialize(markup, tokens)
+      if markup =~ Syntax
+        @layout_name = $2
+      else
+        raise SyntaxError.new("Error in tag 'render' - Valid syntax: render '[layout]'")
+      end
+
+      super
+    end
+
+    def parse(tokens)
+    end
+
+    def render(context)
+      source  = File.read('layouts/' + @layout_name + '.liquid')
+      partial = Liquid::Template.parse(source)
+
+      partial.render(context)
+    end
+  end
+
+  Liquid::Template.register_tag('render', Nanoc::LiquidRenderTag)
+rescue NameError
+end
+
+register_filter 'liquid' do |page, pages, config|
+  assigns = { :page => page, :pages => pages }
+  page.content.liquid(:assigns => assigns)
+end

data/lib/nanoc/filters/markaby_filter.rb

@@ -0,0 +1,25 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+require 'erb'
+
+try_require 'markaby'
+
+class String
+
+  # Converts the string using Markaby
+  # TODO perhaps add support for helpers
+  def markaby(params={})
+    Markaby::Builder.new((params[:assigns] || {})).instance_eval(self).to_s
+  rescue NameError
+    $stderr.puts 'ERROR: String#markaby failed (Markaby not installed?)' unless $quiet
+    exit
+  end
+
+end
+
+register_filter 'markaby' do |page, pages, config|
+  assigns = { :page => page, :pages => pages }
+  page.content.markaby(:assigns => assigns)
+end

data/lib/nanoc/filters/markdown_filter.rb

@@ -0,0 +1,21 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'bluecloth'
+
+class String
+
+  # Converts the string to HTML using BlueCloth/Markdown.
+  def markdown
+    BlueCloth.new(self).to_html
+  rescue NameError
+    $stderr.puts 'ERROR: String#markdown failed: BlueCloth not installed' unless $quiet
+    exit
+  end
+
+end
+
+register_filter 'markdown', 'bluecloth' do |page, pages, config|
+  page.content.markdown
+end

data/lib/nanoc/filters/rdoc_filter.rb

@@ -0,0 +1,19 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'rdoc/markup/simple_markup'
+try_require 'rdoc/markup/simple_markup/to_html'
+
+class String
+
+  # Converts the string using RDoc
+  def rdoc
+    SM::SimpleMarkup.new.convert(self, SM::ToHtml.new)
+  end
+
+end
+
+register_filter 'rdoc' do |page, pages, config|
+  page.content.rdoc
+end

data/lib/nanoc/filters/sass_filter.rb

@@ -0,0 +1,18 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'haml'
+
+class String
+
+  # Converts the string using Sass
+  def sass
+    Sass::Engine.new(self).render
+  end
+
+end
+
+register_filter 'sass' do |page, pages, config|
+  page.content.sass
+end

data/lib/nanoc/filters/smartypants_filter.rb

@@ -0,0 +1,21 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'rubypants'
+
+class String
+
+  # Converts the string using RubyPants/SmartyPants
+  def smartypants
+    RubyPants.new(self).to_html
+  rescue NameError
+    $stderr.puts 'ERROR: String#smartypants failed (RubyPants not installed?)' unless $quiet
+    exit
+  end
+
+end
+
+register_filter 'smartypants', 'rubypants' do |page, pages, config|
+  page.content.smartypants
+end

data/lib/nanoc/filters/textile_filter.rb

@@ -0,0 +1,21 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+
+try_require 'redcloth'
+
+class String
+
+  # Converts the string using RedCloth/Textile
+  def textile
+    RedCloth.new(self).to_html
+  rescue NameError
+    $stderr.puts 'ERROR: String#textile failed (RedCloth not installed?)' unless $quiet
+    exit
+  end
+
+end
+
+register_filter 'textile', 'redcloth' do |page, pages, config|
+  page.content.textile
+end

data/lib/nanoc/page.rb

@@ -0,0 +1,147 @@
+def try_require(s) ; begin ; require s ; rescue LoadError ; end ; end
+
+try_require 'rubygems'
+try_require 'liquid'
+
+module Nanoc
+
+  # Page drop
+
+  begin
+    class PageDrop < ::Liquid::Drop
+      def initialize(page)
+        @page = page
+      end
+
+      def before_method(name)
+        name == 'content' ? @page.content : @page.attributes[name.to_sym]
+      end
+    end
+  rescue NameError
+    class PageDrop
+      def initialize(*args)
+        $stderr.puts 'ERROR: Liquid not installed; cannot use Liquid in layouts.'
+        exit
+      end
+    end
+  end
+
+  # Page proxy
+
+  class PageProxy
+    def initialize(page, params={})
+      @page       = page
+      @do_compile = (params[:compile] != false)
+    end
+
+    def [](key)
+      if key.to_sym == :content and @do_compile
+        @page.content
+      else
+        if key.to_s.starts_with?('_')
+          nil
+        elsif key.to_s.ends_with?('?')
+          @page.attributes[key.to_s[0..-2].to_sym]
+        else
+          @page.attributes[key]
+        end
+      end
+    end
+
+    def method_missing(method, *args)
+      self[method]
+    end
+  end
+
+  # Page
+
+  class Page
+
+    def initialize(hash={})
+      @attributes = hash
+    end
+
+    def attributes
+      @attributes
+    end
+
+    def content
+      compile
+      @attributes[:content]
+    end
+
+    # Proxy/Liquid support
+
+    def to_proxy(params={})
+      PageProxy.new(self, :compile => params[:compile])
+    end
+
+    def to_liquid
+      PageDrop.new(self)
+    end
+
+    # Compiling
+
+    def self.compile(pages)
+      @@compilation_stack = []
+      @@pages = pages
+
+      # Compile all pages
+      pages.each { |page| page.compile }
+    end
+
+    def compile
+      # Check for recursive call
+      if @@compilation_stack.include?(self)
+        # Print compilation stack
+        unless $quiet
+          $stderr.puts 'ERROR: Recursive call to page content.'
+          print_compilation_stack
+        end
+
+        exit
+      # Compile if not yet compiled
+      elsif @attributes[:content].nil?
+        @@compilation_stack.pushing(self) do
+          # Read page
+          content = File.read(@attributes[:_content_filename])
+
+          begin
+            # Get params
+            page   = self.to_proxy(:compile => false)
+            pages  = @@pages.map { |p| p.to_proxy }
+            config = $nanoc_compiler.config
+
+            # Filter page
+            @attributes[:content] = content
+            @attributes[:filters].each do |filter_name|
+              filter = $nanoc_compiler.filter_named(filter_name)
+              if filter.nil?
+                $stderr.puts 'WARNING: Unknown filter: ' + filter_name unless $quiet
+              else
+                @attributes[:content] = filter.call(page, pages, config)
+              end
+            end
+          rescue Exception => exception
+            handle_exception(exception, "compiling page '#{@attributes[:_content_filename]}'")
+          end
+        end
+      end
+    end
+
+    def print_compilation_stack
+      # Determine relevant part of compilation stack
+      stack_begin = @@compilation_stack.index(self)
+      stack_end   = @@compilation_stack.size
+      relevant_stack_part = @@compilation_stack.last(stack_end - stack_begin)
+
+      # Print relevant part of compilation stack
+      $stderr.puts 'Page compilation stack:'
+      relevant_stack_part.each_with_index do |page, i|
+        $stderr.puts "#{i}  #{page.attributes[:_content_filename]}"
+      end
+    end
+
+  end
+
+end