nanoc2 2.2.3

data/lib/nanoc2/base/plugin.rb

@@ -0,0 +1,71 @@
+module Nanoc2
+
+  # Nanoc2::Plugin is the superclass for all plugins, such as filters
+  # (Nanoc2::Filter), binary filters (Nanoc2::BinaryFilter), routers
+  # (Nanoc2::Router), data sources (Nanoc2::DataSource) and VCSes
+  # (Nanoc2::Extra::VCS). Each plugin has one or more unique identifiers, and
+  # several methods in this class provides functionality for finding plugins
+  # with given identifiers.
+  class Plugin
+
+    MAP = {}
+
+    class << self
+
+      # Sets or returns the identifiers for this plugin.
+      #
+      # When given a list of identifier symbols, sets the identifiers for
+      # this plugin. When given nothing, returns an array of identifier
+      # symbols for this plugin.
+      def identifiers(*identifiers)
+        # Initialize
+        if !instance_variables.include?('@identifiers') && !instance_variables.include?(:'@identifiers')
+          @identifiers = []
+        end
+
+        if identifiers.empty?
+          @identifiers
+        else
+          @identifiers = identifiers
+          @identifiers.each { |i| register(i, self) }
+        end
+      end
+
+      # Sets or returns the identifier for this plugin.
+      #
+      # When given an identifier symbols, sets the identifier for this plugin.
+      # When given nothing, returns the identifier for this plugin.
+      def identifier(identifier=nil)
+        # Initialize
+        if !instance_variables.include?('@identifiers') && !instance_variables.include?(:'@identifiers')
+          @identifiers = []
+        end
+
+        if identifier.nil?
+          @identifiers.first
+        else
+          @identifiers = [ identifier ]
+          register(identifier, self)
+        end
+      end
+
+      # Registers the given class +klass+ with the given name. This will allow
+      # the named method to find the class.
+      def register(name, klass)
+        MAP[klass.superclass] ||= {}
+        MAP[klass.superclass][name.to_sym] = klass
+      end
+
+      # Returns the the plugin with the given name. Only subclasses of this
+      # class will be searched. For example, calling this method on
+      # Nanoc2::Filter will cause only Nanoc2::Filter subclasses to be searched.
+      def named(name)
+        MAP[self] ||= {}
+        MAP[self][name.to_sym]
+      end
+
+    end
+
+  end
+
+end

data/lib/nanoc2/base/proxies.rb

@@ -0,0 +1,5 @@
+require 'nanoc2/base/proxies/asset_proxy'
+require 'nanoc2/base/proxies/asset_rep_proxy'
+require 'nanoc2/base/proxies/layout_proxy'
+require 'nanoc2/base/proxies/page_proxy'
+require 'nanoc2/base/proxies/page_rep_proxy'

data/lib/nanoc2/base/proxies/asset_proxy.rb

@@ -0,0 +1,29 @@
+module Nanoc2
+
+  # Nanoc2::AssetProxy is a proxy object for an asset (Nanoc2::Asset).
+  class AssetProxy < Proxy
+
+    # Requests the asset attribute with the given name. +key+ can be a string
+    # or a symbol, and it can contain a trailing question mark (which will be
+    # stripped).
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      if real_key == :mtime
+        @obj.mtime
+      elsif real_key == :path # backward compatibility
+        @obj.reps.find { |r| r.name == :default }.web_path
+      else
+        super(key)
+      end
+    end
+
+    # Returns the asset representation with the given name.
+    def reps(name)
+      rep = @obj.reps.find { |r| r.name == name }
+      rep.nil? ? nil : rep.to_proxy
+    end
+
+  end
+
+end

data/lib/nanoc2/base/proxies/asset_rep_proxy.rb

@@ -0,0 +1,26 @@
+module Nanoc2
+
+  # Nanoc2::AssetRepProxy is a proxy object for an asset representation
+  # (Nanoc2::AssetRep).
+  class AssetRepProxy < Proxy
+
+    # Requests the asset representation attribute with the given name. +key+
+    # can be a string or a symbol, and it can contain a trailing question mark
+    # (which will be stripped).
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      if real_key == :name
+        @obj.name
+      elsif real_key == :path
+        @obj.web_path
+      elsif real_key == :asset
+        @obj.asset.to_proxy
+      else
+        super(key)
+      end
+    end
+
+  end
+
+end

data/lib/nanoc2/base/proxies/layout_proxy.rb

@@ -0,0 +1,25 @@
+module Nanoc2
+
+  # Nanoc2::LayoutProxy is a proxy object for a layout (Nanoc2::Layout).
+  class LayoutProxy < Proxy
+
+    # Requests the layout attribute with the given name. +key+ can be a string
+    # or a symbol, and it can contain a trailing question mark (which will be
+    # stripped).
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      if real_key == :content
+        @obj.content
+      elsif real_key == :path
+        @obj.path
+      elsif real_key == :mtime
+        @obj.mtime
+      else
+        super(key)
+      end
+    end
+
+  end
+
+end

data/lib/nanoc2/base/proxies/page_proxy.rb

@@ -0,0 +1,35 @@
+module Nanoc2
+
+  # Nanoc2::PageProxy is a proxy object for a page (Nanoc2::Page).
+  class PageProxy < Proxy
+
+    # Requests the page attribute with the given name. +key+ can be a string
+    # or a symbol, and it can contain a trailing question mark (which will be
+    # stripped).
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      if real_key == :mtime
+        @obj.mtime
+      elsif real_key == :parent
+        @obj.parent.nil? ? nil : @obj.parent.to_proxy
+      elsif real_key == :children
+        @obj.children.map { |page| page.to_proxy }
+      elsif real_key == :content # backward compatibility
+        @obj.reps.find { |r| r.name == :default }.content
+      elsif real_key == :path # backward compatibility
+        @obj.reps.find { |r| r.name == :default }.web_path
+      else
+        super(key)
+      end
+    end
+
+    # Returns the page representation with the given name.
+    def reps(name)
+      rep = @obj.reps.find { |r| r.name == name }
+      rep.nil? ? nil : rep.to_proxy
+    end
+
+  end
+
+end

data/lib/nanoc2/base/proxies/page_rep_proxy.rb

@@ -0,0 +1,28 @@
+module Nanoc2
+
+  # Nanoc2::PageRepProxy is a proxy object for a page representation
+  # (Nanoc2::PageRep).
+  class PageRepProxy < Proxy
+
+    # Requests the page representation attribute with the given name. +key+
+    # can be a string or a symbol, and it can contain a trailing question mark
+    # (which will be stripped).
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      if real_key == :name
+        @obj.name
+      elsif real_key == :content
+        @obj.content
+      elsif real_key == :path
+        @obj.web_path
+      elsif real_key == :page
+        @obj.page.to_proxy
+      else
+        super(key)
+      end
+    end
+
+  end
+
+end

data/lib/nanoc2/base/proxy.rb

@@ -0,0 +1,37 @@
+module Nanoc2
+
+  # Nanoc2::Proxy is used when making data available to pages and layouts.
+  # It provides an easy way to access data without the risk of accidentally
+  # calling destructive methods.
+  class Proxy
+
+    instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
+
+    # Creates a proxy for the given object.
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # Requests the attribute with the given name. +key+ can be a string or a
+    # symbol, and it can contain a trailing question mark (which will be
+    # stripped).
+    def [](key)
+      real_key = key.to_s.sub(/\?$/, '').to_sym
+
+      @obj.attribute_named(real_key)
+    end
+
+    # Sets a given attribute. The use of setting an object's attributes is not
+    # recommended but may be necessary in some cases.
+    def []=(key, value)
+      @obj.attributes[key.to_sym] = value
+    end
+
+    # Used for requesting attributes without accessing the proxy like a hash.
+    def method_missing(method, *args)
+      self[method]
+    end
+
+  end
+
+end

data/lib/nanoc2/base/router.rb

@@ -0,0 +1,72 @@
+module Nanoc2
+
+  # A Nanoc2::Router is an abstract superclass that determines the paths of
+  # page and asset representations, both the path on the disk (relative to the
+  # site's output directory) and the path as it appears on the web site.
+  class Router < Plugin
+
+    # Creates a new router for the given site.
+    def initialize(site)
+      @site = site
+    end
+
+    # Returns the routed path for the given page representation, including the
+    # filename and the extension. It should start with a slash, and should be
+    # relative to the web root (i.e. should not include any references to the
+    # output directory). There is no need to let this method handle custom
+    # paths.
+    #
+    # Subclasses must implement this method.
+    def path_for_page_rep(page_rep)
+      raise NotImplementedError.new("Nanoc2::Router subclasses must implement #path_for_page_rep.")
+    end
+
+    # Returns the routed path for the given asset representation, including
+    # the filename and the extension. It should start with a slash, and should
+    # be relative to the web root (i.e. should not include any references to
+    # the output directory). There is no need to let this method handle custom
+    # paths.
+    #
+    # Subclasses must implement this method.
+    def path_for_asset_rep(asset_rep)
+      raise NotImplementedError.new("Nanoc2::Router subclasses must implement #path_for_asset_rep.")
+    end
+
+    # Returns the web path for the given page or asset representation, i.e.
+    # the page or asset rep's custom path or routed path with index filenames
+    # stripped.
+    def web_path_for(obj)
+      # Get actual path
+      path ||= obj.attribute_named(:custom_path)
+      if obj.is_a?(Nanoc2::PageRep) # Page rep
+        path ||= path_for_page_rep(obj)
+      else # Asset rep
+        path ||= path_for_asset_rep(obj)
+      end
+
+      # Try stripping each index filename
+      @site.config[:index_filenames].each do |index_filename|
+        if path[-index_filename.length..-1] == index_filename
+          # Strip and stop
+          path = path[0..-index_filename.length-1]
+          break
+        end
+      end
+
+      # Return possibly stripped path
+      path
+    end
+
+    # Returns the disk path for the given page or asset representation, i.e.
+    # the page or asset's custom path or routed path relative to the output
+    # directory.
+    def disk_path_for(obj)
+      @site.config[:output_dir] + (
+        obj.attribute_named(:custom_path) ||
+        (obj.is_a?(Nanoc2::PageRep) ? path_for_page_rep(obj) : path_for_asset_rep(obj))
+      )
+    end
+
+  end
+
+end

data/lib/nanoc2/base/site.rb

@@ -0,0 +1,274 @@
+module Nanoc2
+
+  # A Nanoc2::Site is the in-memory representation of a nanoc site. It holds
+  # references to the following site data:
+  #
+  # * +pages+ is a list of Nanoc2::Page instances representing pages
+  # * +assets+ is a list of Nanoc2::Asset instances representing assets
+  # * +page_defaults+ is a Nanoc2::PageDefaults instance representing page
+  #   defaults
+  # * +asset_defaults+ is a Nanoc2::AssetDefaults instance representing asset
+  #   defaults
+  # * +layouts+ is a list of Nanoc2::Layout instances representing layouts
+  # * +templates+ is a list of Nanoc2::Template representing templates
+  # * +code+ is a Nanoc2::Code instance representing custom site code
+  #
+  # In addition, each site has a +config+ hash which stores the site
+  # configuration. This configuration hash can have the following keys:
+  #
+  # +output_dir+:: The directory to which compiled pages and assets will be
+  #                written. This path is relative to the current working
+  #                directory, but can also be an absolute path.
+  #
+  # +data_source+:: The identifier of the data source that will be used for
+  #                 loading site data.
+  #
+  # +router+:: The identifier of the router that will be used for determining
+  #            page and asset representation paths.
+  #
+  # +index_filenames+:: A list of filenames that will be stripped off full
+  #                     page and asset paths to create cleaner URLs (for
+  #                     example, '/about/' will be used instead of
+  #                     '/about/index.html'). The default value should be okay
+  #                     in most cases.
+  #
+  # A site also has several helper classes:
+  #
+  # * +router+ is a Nanoc2::Router subclass instance used for determining page
+  #   and asset paths.
+  # * +data_source+ is a Nanoc2::DataSource subclass instance used for managing
+  #   site data.
+  # * +compiler+ is a Nanoc2::Compiler instance that compiles page and asset
+  #   representations.
+  #
+  # The physical representation of a Nanoc2::Site is usually a directory that
+  # contains a configuration file, site data, and some rake tasks. However,
+  # different frontends may store data differently. For example, a web-based
+  # frontend would probably store the configuration and the site content in a
+  # database, and would not have rake tasks at all.
+  class Site
+
+    # The default configuration for a site. A site's configuration overrides
+    # these options: when a Nanoc2::Site is created with a configuration that
+    # lacks some options, the default value will be taken from
+    # +DEFAULT_CONFIG+.
+    DEFAULT_CONFIG = {
+      :output_dir       => 'output',
+      :data_source      => 'filesystem',
+      :router           => 'default',
+      :index_filenames  => [ 'index.html' ]
+    }
+
+    attr_reader :config
+    attr_reader :compiler, :data_source, :router
+    attr_reader :page_defaults, :asset_defaults
+    attr_reader :pages, :assets, :layouts, :templates, :code
+
+    # Returns a Nanoc2::Site object for the site specified by the given
+    # configuration hash +config+.
+    #
+    # +config+:: A hash containing the site configuration.
+    def initialize(config)
+      # Load configuration
+      @config = DEFAULT_CONFIG.merge(config.clean)
+
+      # Create data source
+      @data_source_class = Nanoc2::DataSource.named(@config[:data_source])
+      raise Nanoc2::Errors::UnknownDataSourceError.new(@config[:data_source]) if @data_source_class.nil?
+      @data_source = @data_source_class.new(self)
+
+      # Create compiler
+      @compiler = Compiler.new(self)
+
+      # Load code (necessary for custom routers)
+      load_code
+
+      # Create router
+      @router_class = Nanoc2::Router.named(@config[:router])
+      raise Nanoc2::Errors::UnknownRouterError.new(@config[:router]) if @router_class.nil?
+      @router = @router_class.new(self)
+
+      # Initialize data
+      @page_defaults        = PageDefaults.new({})
+      @page_defaults.site   = self
+      @asset_defaults       = AssetDefaults.new({})
+      @asset_defaults.site  = self
+      @pages                = []
+      @assets               = []
+      @layouts              = []
+      @templates            = []
+    end
+
+    # Loads the site data. This will query the Nanoc2::DataSource associated
+    # with the site and fetch all site data. The site data is cached, so
+    # calling this method will not have any effect the second time, unless
+    # +force+ is true.
+    #
+    # +force+:: If true, will force load the site data even if it has been
+    #           loaded before, to circumvent caching issues.
+    def load_data(force=false)
+      # Don't load data twice
+      @data_loaded ||= false
+      return if @data_loaded and !force
+
+      # Load all data
+      @data_source.loading do
+        load_code(force)
+        load_page_defaults
+        load_pages
+        load_asset_defaults
+        load_assets
+        load_layouts
+        load_templates
+      end
+
+      # Set loaded
+      @data_loaded = true
+    end
+
+  private
+
+    # Loads this site's code and executes it.
+    def load_code(force=false)
+      # Don't load code twice
+      @code_loaded ||= false
+      return if @code_loaded and !force
+
+      # Get code
+      @code = @data_source.code
+
+      # Fix code if outdated
+      if @code.is_a? String
+        warn_data_source('Code', 'code', false)
+        @code = Code.new(code)
+      end
+
+      # Set site
+      @code.site = self
+
+      # Execute code
+      # FIXME This could be dangerous when using nanoc as a framework
+      # (a separate ruby process should probably be forked, and the code
+      # should only be loaded in this forked process)
+      @code.load
+
+      # Set loaded
+      @code_loaded = true
+    end
+
+    # Loads this site's page defaults.
+    def load_page_defaults
+      # Get page defaults
+      @page_defaults = @data_source.page_defaults
+
+      # Fix page defaults if outdated
+      if @page_defaults.is_a? Hash
+        warn_data_source('PageDefaults', 'page_defaults', false)
+        @page_defaults = PageDefaults.new(@page_defaults)
+      end
+
+      # Set site
+      @page_defaults.site = self
+    end
+
+    # Loads this site's pages, sets up page child-parent relationships and
+    # builds each page's list of page representations.
+    def load_pages
+      # Get pages
+      @pages = @data_source.pages
+
+      # Fix pages if outdated
+      if @pages.any? { |p| p.is_a? Hash }
+        warn_data_source('Page', 'pages', true)
+        @pages.map! { |p| Page.new(p[:uncompiled_content], p, p[:path]) }
+      end
+
+      # Set site
+      @pages.each { |p| p.site = self }
+
+      # Setup child-parent links
+      @pages.each do |page|
+        # Get parent
+        parent_path = page.path.sub(/[^\/]+\/$/, '')
+        parent = @pages.find { |p| p.path == parent_path }
+        next if parent.nil? or page.path == '/'
+
+        # Link
+        page.parent = parent
+        parent.children << page
+      end
+
+      # Build page representations
+      @pages.each { |p| p.build_reps }
+    end
+
+    # Loads this site's asset defaults.
+    def load_asset_defaults
+      # Get page defaults
+      @asset_defaults = @data_source.asset_defaults
+
+      # Set site
+      @asset_defaults.site = self
+    rescue NotImplementedError
+      @asset_defaults = AssetDefaults.new({})
+      @asset_defaults.site = self
+    end
+
+    # Loads this site's assets and builds each asset's list of asset
+    # representations.
+    def load_assets
+      # Get assets
+      @assets = @data_source.assets
+
+      # Set site
+      @assets.each { |a| a.site = self }
+
+      # Build asset representations
+      @assets.each { |p| p.build_reps }
+    rescue NotImplementedError
+      @assets = []
+    end
+
+    # Loads this site's layouts.
+    def load_layouts
+      # Get layouts
+      @layouts = @data_source.layouts
+
+      # Fix layouts if outdated
+      if @layouts.any? { |l| l.is_a? Hash }
+        warn_data_source('Layout', 'layouts', true)
+        @layouts.map! { |l| Layout.new(l[:content], l, l[:path] || l[:name]) }
+      end
+
+      # Set site
+      @layouts.each { |l| l.site = self }
+    end
+
+    # Loads this site's templates.
+    def load_templates
+      # Get templates
+      @templates = @data_source.templates
+
+      # Fix templates if outdated
+      if @templates.any? { |t| t.is_a? Hash }
+        warn_data_source('Template', 'templates', true)
+        @templates.map! { |t| Template.new(t[:content], t[:meta].is_a?(String) ? YAML.load(t[:meta]) : t[:meta], t[:name]) }
+      end
+
+      # Set site
+      @templates.each { |t| t.site = self }
+    end
+
+    # Raises a warning about an outdated data source method.
+    def warn_data_source(class_name, method_name, is_array)
+      warn(
+        "DEPRECATION WARNING: In nanoc 2.1, DataSource##{method_name} " +
+        "should return #{is_array ? 'an array of' : 'a' } " +
+        "Nanoc2::#{class_name} object#{is_array ? 's' : ''}. Future " +
+        "versions will not support these outdated data sources."
+      )
+    end
+
+  end
+
+end