nanoc 1.6.2 → 2.0

data/lib/nanoc/base/compiler.rb

@@ -0,0 +1,55 @@
+module Nanoc
+  class Compiler
+
+    attr_reader :stack
+
+    def initialize(site)
+      @site = site
+    end
+
+    def run(page=nil)
+      # Give feedback
+      log(:high, "Compiling #{page.nil? ? 'site' : 'page'}...")
+      time_before = Time.now
+
+      # Get the data we need
+      @site.load_data
+      eval(@site.code, $nanoc_binding)
+
+      # Create output directory if necessary
+      FileUtils.mkdir_p(@site.config[:output_dir])
+
+      # Compile
+      @stack = []
+      pages = (page.nil? ? @site.pages : [ page ])
+      pages.each do |current_page|
+        begin
+          current_page.compile
+        rescue => exception
+          handle_exception(exception, current_page, !page.nil?)
+        end
+      end
+
+      # Give feedback
+      log(:high, "No pages were modified.") unless pages.any? { |page| page.modified? }
+      log(:high, "#{page.nil? ? 'Site' : 'Pages'} compiled in #{format('%.2f', Time.now - time_before)}s.")
+    end
+
+    def handle_exception(exception, page, single_page)
+      raise exception if single_page
+
+      log(:high, "ERROR: An exception occured while compiling page #{page.path}.", $stderr)
+      log(:high, "", $stderr)
+      log(:high, "If you think this is a bug in nanoc, please do report it at", $stderr)
+      log(:high, "<http://nanoc.stoneship.org/trac/newticket> -- thanks!", $stderr)
+      log(:high, "", $stderr)
+      log(:high, 'Message:', $stderr)
+      log(:high, '  ' + exception.message, $stderr)
+      log(:high, 'Backtrace:', $stderr)
+      log(:high, exception.backtrace.map { |t| '  - ' + t }.join("\n"), $stderr)
+
+      exit(1)
+    end
+
+  end
+end

data/lib/nanoc/base/core_ext/hash.rb

@@ -0,0 +1,34 @@
+require 'time'
+
+class Hash
+
+  # Cleans up the hash and returns the result. It performs the following
+  # operations:
+  #
+  # * Values with keys ending in _at and _on are converted into Times and
+  #   Dates, respectively
+  # * All keys are converted to symbols
+  # * Value strings 'true', 'false', and 'none' are converted into
+  #   true, false, and nil, respectively
+  def clean
+    inject({}) do |hash, (key, value)|
+      real_key = key.to_s
+      if real_key =~ /_on$/
+        hash.merge(key.to_sym => Date.parse(value))
+      elsif real_key =~ /_at$/
+        hash.merge(key.to_sym => Time.parse(value))
+      elsif value == 'true'
+        hash.merge(key.to_sym => true)
+      elsif value == 'false'
+        hash.merge(key.to_sym => false)
+      elsif value == 'none'
+        hash.merge(key.to_sym => nil)
+      elsif value.is_a?(Hash)
+        hash.merge(key.to_sym => value.clean)
+      else
+        hash.merge(key.to_sym => value)
+      end
+    end
+  end
+
+end

data/lib/nanoc/base/data_source.rb

@@ -0,0 +1,53 @@
+module Nanoc
+  class DataSource < Plugin
+
+    attr_reader :config
+
+    def initialize(site)
+      @site       = site
+      @references = 0
+    end
+
+    # Preparation
+
+    def loading
+      # Load if necessary
+      up if @references == 0
+      @references += 1
+
+      yield
+    ensure
+      # Unload if necessary
+      @references -= 1
+      down if @references == 0
+    end
+
+    def up    ; end
+    def down  ; end
+
+    def setup ; end
+
+    # Loading data
+
+    def pages         ; error 'DataSource#pages must be overridden'         ; end
+    def page_defaults ; error 'DataSource#page_defaults must be overridden' ; end
+    def layouts       ; error 'DataSource#layouts must be overridden'       ; end
+    def templates     ; error 'DataSource#templates must be overridden'     ; end
+    def code          ; error 'DataSource#code must be overridden'          ; end
+
+    # Creating data
+
+    def create_page(name, template)
+      error 'DataSource#create_page must be overridden'
+    end
+
+    def create_layout(name)
+      error 'DataSource#create_layout must be overridden'
+    end
+
+    def create_template(name)
+      error 'DataSource#create_template must be overridden'
+    end
+
+  end
+end

data/lib/nanoc/base/enhancements.rb

@@ -0,0 +1,89 @@
+# Get requirements
+begin ; require 'rubygems' ; rescue LoadError ; end
+require 'yaml'
+require 'fileutils'
+
+# Logging (level can be :off, :high, :low)
+$log_level = :high
+def log(log_level, s, io=$stdout)
+  io.puts s if ($log_level == :low or $log_level == log_level) and $log_level != :off
+end
+
+# Convenience function for printing errors
+def error(s, pre='ERROR')
+  log(:high, pre + ': ' + s, $stderr)
+  exit(1)
+end
+
+# Convenience function for requiring libraries
+def nanoc_require(x, message="'#{x}' is required to compile this site.")
+  require x
+rescue LoadError
+  error(message)
+end
+
+# Rendering sub-layouts
+def render(name, other_assigns={})
+  layout = @site.layouts.find { |l| l[:name] == name }
+  layout_processor_class = Nanoc::PluginManager.layout_processor_for_extension(layout[:extension])
+  layout_processor = layout_processor_class.new(@page, @pages, @site.config, @site, other_assigns)
+  layout_processor.run(layout[:content])
+end
+
+# Convenience function for cd'ing in and out of a directory
+def in_dir(path)
+  FileUtils.cd(File.join(path))
+  yield
+ensure
+  FileUtils.cd(File.join(path.map { |n| '..' }))
+end
+
+class FileManager
+
+  ACTION_COLORS = {
+    :create     => "\e[1m" + "\e[32m", # bold + green
+    :update     => "\e[1m" + "\e[33m", # bold + yellow
+    :identical  => "\e[1m"             # bold
+  }
+
+  def self.file_log(log_level, action, path)
+    log(log_level, '%s%12s%s  %s' % [ACTION_COLORS[action.to_sym], action, "\e[0m", path])
+  end
+
+  def self.create_dir(name)
+    # Check whether directory exists
+    return if File.exist?(name)
+
+    # Create dir
+    FileUtils.mkdir_p(name)
+    log(:create, name)
+  end
+
+  def self.create_file(path)
+    # Create parent directory if necessary
+    if path =~ /\//
+      parent_path = path.sub(/\/[^\/]+$/, '')
+      FileManager.create_dir(parent_path)
+    end
+
+    # Get contents
+    content_old = File.exist?(path) ? File.read(path) : nil
+    content_new = yield
+    content_new = content_new.force_encoding(content_old.encoding) if content_old and String.method_defined?(:force_encoding)
+    modified = (content_old != content_new)
+
+    # Log
+    if File.exist?(path)
+      file_log(*(modified ? [ :high, :update, path ] : [ :low, :identical, path ]))
+    else
+      file_log(:high, :create, path)
+    end
+
+    # Write
+    open(path, 'w') { |io| io.write(content_new) }
+
+    # Report back
+    modified
+  end
+
+end

data/lib/nanoc/base/filter.rb

@@ -0,0 +1,16 @@
+module Nanoc
+  class Filter < Plugin
+
+    def initialize(page, pages, config, site)
+      @page   = page
+      @pages  = pages
+      @config = config
+      @site   = site
+    end
+
+    def run(content)
+      error 'Filter#run must be overridden'
+    end
+
+  end
+end

data/lib/nanoc/base/layout_processor.rb

@@ -0,0 +1,33 @@
+module Nanoc
+  class LayoutProcessor < Plugin
+
+    def initialize(page, pages, config, site, other_assigns={})
+      @page          = page
+      @pages         = pages
+      @config        = config
+      @site          = site
+      @other_assigns = other_assigns
+    end
+
+    def run(layout)
+      error 'LayoutProcessor#run must be overridden'
+    end
+
+    # Extensions
+
+    class << self
+      attr_accessor :_extensions
+    end
+
+    def self.extensions(*extensions)
+      self._extensions = [] unless instance_variable_defined?(:@_extensions)
+      extensions.empty? ? self._extensions || [] : self._extensions = (self._extensions || []) + extensions
+    end
+
+    def self.extension(extension=nil)
+      self._extensions = [] unless instance_variable_defined?(:@_extensions)
+      extension.nil? ? self.extensions.first : self.extensions(extension)
+    end
+
+  end
+end

data/lib/nanoc/base/page.rb

@@ -0,0 +1,155 @@
+module Nanoc
+  class Page
+
+    PAGE_DEFAULTS = {
+      :custom_path  => nil,
+      :extension    => 'html',
+      :filename     => 'index',
+      :filters_pre  => [],
+      :filters_post => [],
+      :haml_options => {},
+      :is_draft     => false,
+      :layout       => 'default',
+      :path         => nil,
+      :skip_output  => false
+    }
+
+    attr_reader   :attributes
+    attr_accessor :parent, :children
+
+    def initialize(hash, site)
+      @site                   = site
+      @compiler               = site.compiler
+
+      @attributes             = hash
+      @content                = { :pre => attribute_named(:uncompiled_content), :post => nil }
+
+      @parent                 = nil
+      @children               = []
+
+      @filtered_pre           = false
+      @layouted               = false
+      @filtered_post          = false
+      @written                = false
+    end
+
+    # Proxy support
+
+    def to_proxy
+      @proxy ||= PageProxy.new(self)
+    end
+
+    # Accessors, kind of
+
+    def modified? ; @modified ; end
+
+    def attribute_named(name)
+      return @attributes[name]         if @attributes.has_key?(name)
+      return @site.page_defaults[name] if @site.page_defaults.has_key?(name)
+      return PAGE_DEFAULTS[name]
+    end
+
+    def content
+      compile(false) unless @filtered_pre
+      @content[:pre]
+    end
+
+    def layouted_content
+      compile(true)
+      @content[:post]
+    end
+
+    def skip_output? ; attribute_named(:skip_output)  ; end
+    def path         ; attribute_named(:path)         ; end
+
+    def path_on_filesystem
+      if attribute_named(:custom_path).nil?
+        @site.config[:output_dir] + attribute_named(:path) +
+          attribute_named(:filename) + '.' + attribute_named(:extension)
+      else
+        @site.config[:output_dir] + attribute_named(:custom_path)
+      end
+    end
+
+    # Compiling
+
+    def compile(full=true)
+      @modified = false
+
+      # Check for recursive call
+      if @compiler.stack.include?(self)
+        log(:high, "\n" + 'ERROR: Recursive call to page content. Page filter stack:', $stderr)
+        log(:high, "  - #{self.attribute_named(:path)}", $stderr)
+        @compiler.stack.each_with_index do |page, i|
+          log(:high, "  - #{page.attribute_named(:path)}", $stderr)
+        end
+        exit(1)
+      end
+
+      @compiler.stack.push(self)
+
+      # Filter pre
+      unless @filtered_pre
+        filter(:pre)
+        @filtered_pre = true
+      end
+
+      # Layout
+      if !@layouted and full
+        layout
+        @layouted = true
+      end
+
+      # Filter post
+      if !@filtered_post and full
+        filter(:post)
+        @filtered_post = true
+      end
+
+      # Write
+      if !@written and full
+        @modified = FileManager.create_file(self.path_on_filesystem) { @content[:post] } unless skip_output?
+        @written = true
+      end
+
+      @compiler.stack.pop
+    end
+
+    def filter(stage)
+      # Get filters
+      error 'The `filters` property is no longer supported; please use `filters_pre` instead.' unless attribute_named(:filters).nil?
+      filters = attribute_named(stage == :pre ? :filters_pre : :filters_post)
+
+      filters.each do |filter_name|
+        # Create filter
+        filter_class = PluginManager.filter_named(filter_name)
+        error "Unknown filter: '#{filter_name}'" if filter_class.nil?
+        filter = filter_class.new(self.to_proxy, @site.pages.map { |p| p.to_proxy }, @site.config, @site)
+
+        # Run filter
+        @content[stage] = filter.run(@content[stage])
+      end
+    end
+
+    def layout
+      # Don't layout if not necessary
+      if attribute_named(:layout).nil?
+        @content[:post] = @content[:pre]
+        return
+      end
+
+      # Find layout
+      layout = @site.layouts.find { |l| l[:name] == attribute_named(:layout) }
+      error 'Unknown layout: ' + attribute_named(:layout) if layout.nil?
+
+      # Find layout processor
+      layout_processor_class = PluginManager.layout_processor_for_extension(layout[:extension])
+      error "Unknown layout processor: '#{layout[:extension]}'" if layout_processor_class.nil?
+      layout_processor = layout_processor_class.new(self.to_proxy, @site.pages.map { |p| p.to_proxy }, @site.config, @site)
+
+      # Layout
+      @content[:post] = layout_processor.run(layout[:content])
+    end
+
+  end
+end

data/lib/nanoc/base/page_proxy.rb

@@ -0,0 +1,31 @@
+module Nanoc
+  class PageProxy
+
+    def initialize(page)
+      @page = page
+    end
+
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      if real_key == :content
+        @page.content
+      elsif real_key == :parent
+        @page.parent.nil? ? nil : @page.parent.to_proxy
+      elsif real_key == :children
+        @page.children.map { |page| page.to_proxy }
+      else
+        @page.attribute_named(real_key)
+      end
+    end
+
+    def []=(key, value)
+      @page.attributes[key.to_sym] = value
+    end
+
+    def method_missing(method, *args)
+      self[method]
+    end
+
+  end
+end