nanoc 2.2.2 → 3.0.0a1

data/lib/nanoc/base/defaults.rb

@@ -1,30 +0,0 @@
-module Nanoc
-
-  # Nanoc::Defaults represent the default attributes for a given set of
-  # objects in the site. It is basically a hash with an optional modification
-  # time.
-  class Defaults
-
-    # Th site where this set of defaults belongs to.
-    attr_accessor :site
-
-    # A hash containing the default attributes.
-    attr_reader   :attributes
-
-    # The time when this set of defaults was last modified.
-    attr_reader   :mtime
-
-    # Creates a new set of defaults.
-    #
-    # +attributes+:: The hash containing the metadata that individual objects
-    #                will override.
-    #
-    # +mtime+:: The time when the defaults were last modified (optional).
-    def initialize(attributes, mtime=nil)
-      @attributes = attributes.clean
-      @mtime      = mtime
-    end
-
-  end
-
-end

data/lib/nanoc/base/filter.rb

@@ -1,93 +0,0 @@
-module Nanoc
-
-  # Nanoc::Filter is responsible for filtering pages and textual assets
-  # (binary assets are filtered using Nanoc::BinaryFilter). It is the
-  # (abstract) superclass for all textual filters. Subclasses should override
-  # the +run+ method.
-  class Filter < Plugin
-
-    # Deprecated
-    EXTENSIONS_MAP = {}
-
-    # Creates a new filter for the given object (page or asset) and site.
-    #
-    # +kind+:: The kind of object that is passed. Can be either +:page+ or
-    #          +:asset+.
-    #
-    # +obj_rep+:: A proxy for the page or asset representation (Nanoc::PageRep
-    #             or Nanoc::AssetRep) that should be compiled by this filter.
-    #
-    # +obj+:: A proxy for the page or asset's page (Nanoc::Page or
-    #         Nanoc::Asset).
-    #
-    # +site+:: The site (Nanoc::Site) this filter belongs to.
-    #
-    # +other_assigns+:: A hash containing other variables that should be made
-    #                   available during filtering.
-    def initialize(obj_rep, other_assigns={})
-      # Determine kind
-      @kind = obj_rep.is_a?(Nanoc::PageRep) ? :page : :asset
-
-      # Set object
-      @obj_rep = obj_rep
-      @obj     = (@kind == :page ? @obj_rep.page : @obj_rep.asset)
-
-      # Set page/asset and page/asset reps
-      if @kind == :page
-        @page       = @obj
-        @page_rep   = @obj_rep
-      else
-        @asset      = @obj
-        @asset_rep  = @obj_rep
-      end
-
-      # Set site
-      @site = @obj.site
-
-      # Set other assigns
-      @other_assigns  = other_assigns
-    end
-
-    # Runs the filter. This method returns the filtered content.
-    #
-    # +content+:: The unprocessed content that should be filtered.
-    #
-    # Subclasses must implement this method.
-    def run(content)
-      raise NotImplementedError.new("Nanoc::Filter subclasses must implement #run")
-    end
-
-    # Returns a hash with data that should be available.
-    def assigns
-      @assigns ||= @other_assigns.merge({
-        :_obj_rep   => @obj_rep,
-        :_obj       => @obj,
-        :page_rep   => @kind == :page  ? @page_rep.to_proxy  : nil,
-        :page       => @kind == :page  ? @page.to_proxy      : nil,
-        :asset_rep  => @kind == :asset ? @asset_rep.to_proxy : nil,
-        :asset      => @kind == :asset ? @asset.to_proxy     : nil,
-        :pages      => @site.pages.map    { |obj| obj.to_proxy },
-        :assets     => @site.assets.map   { |obj| obj.to_proxy },
-        :layouts    => @site.layouts.map  { |obj| obj.to_proxy },
-        :config     => @site.config,
-        :site       => @site
-      })
-    end
-
-    # Returns the filename associated with the item that is being filtered.
-    # The returned filename is in the format "page <path> (rep <name>)".
-    def filename
-      if assigns[:layout]
-        "layout #{assigns[:layout].path}"
-      elsif assigns[:page]
-        "page #{assigns[:_obj].path} (rep #{assigns[:_obj_rep].name})"
-      elsif assigns[:asset]
-        "asset #{assigns[:_obj].path} (rep #{assigns[:_obj_rep].name})"
-      else
-        '?'
-      end
-    end
-
-  end
-
-end

data/lib/nanoc/base/layout.rb

@@ -1,91 +0,0 @@
-module Nanoc
-
-  # A Nanoc::Layout represents a layout in a nanoc site. It has content,
-  # attributes (for determining which filter to use for laying out a page), a
-  # path (because layouts are organised hierarchically), and a modification
-  # time (to speed up compilation).
-  class Layout
-
-    # Default values for layouts.
-    DEFAULTS = {
-      :filter => 'erb'
-    }
-
-    # The Nanoc::Site this layout belongs to.
-    attr_accessor :site
-
-    # The raw content of this layout.
-    attr_reader :content
-
-    # A hash containing this layout's attributes.
-    attr_reader :attributes
-
-    # This layout's path, starting and ending with a slash.
-    attr_reader :path
-
-    # The time when this layout was last modified.
-    attr_reader :mtime
-
-    # Creates a new layout.
-    #
-    # +content+:: The raw content of this layout.
-    #
-    # +attributes+:: A hash containing this layout's attributes.
-    #
-    # +path+:: This layout's path, starting and ending with a slash.
-    #
-    # +mtime+:: The time when this layout was last modified.
-    def initialize(content, attributes, path, mtime=nil)
-      @content    = content
-      @attributes = attributes.clean
-      @path       = path.cleaned_path
-      @mtime      = mtime
-    end
-
-    # Returns a proxy (Nanoc::LayoutProxy) for this layout.
-    def to_proxy
-      @proxy ||= LayoutProxy.new(self)
-    end
-
-    # Returns the attribute with the given name.
-    def attribute_named(name)
-      return @attributes[name] if @attributes.has_key?(name)
-      return DEFAULTS[name]
-    end
-
-    # Returns the filter class needed for this layout.
-    def filter_class
-      Nanoc::Filter.named(attribute_named(:filter))
-    end
-
-    # Saves the layout in the database, creating it if it doesn't exist yet or
-    # updating it if it already exists. Tells the site's data source to save
-    # the layout.
-    def save
-      @site.data_source.loading do
-        @site.data_source.save_layout(self)
-      end
-    end
-
-    # Moves the layout to a new path. Tells the site's data source to move the
-    # layout.
-    def move_to(new_path)
-      @site.data_source.loading do
-        @site.data_source.move_layout(self, new_path)
-      end
-    end
-
-    # Deletes the layout. Tells the site's data source to delete the layout.
-    def delete
-      @site.data_source.loading do
-        @site.data_source.delete_layout(self)
-      end
-    end
-
-    def inspect
-      "<#{self.class} path=#{self.path}>"
-    end
-
-  end
-
-end

data/lib/nanoc/base/notification_center.rb

@@ -1,66 +0,0 @@
-module Nanoc
-
-  # Nanoc::NotificationCenter provides a way to send notifications between
-  # objects. It allows blocks associated with a certain notification name to
-  # be registered; these blocks will be called when the notification with the
-  # given name is posted.
-  #
-  # It is a slightly different implementation of the Observer pattern; the
-  # table of subscribers is not stored in the observable object itself, but in
-  # the notification center.
-  class NotificationCenter
-
-    class << self
-
-      # Adds the given block to the list of blocks that should be called when
-      # the notification with the given name is received.
-      #
-      # +name+:: The name of the notification that will be posted.
-      #
-      # +id+:: An identifier for the block. This is only used to be able to
-      #        remove the block (using the remove method) later. Defaults to
-      #        nil.
-      def on(name, id=nil, &block)
-        initialize_if_necessary(name)
-
-        # Add observer
-        @notifications[name] << { :id => id, :block => block }
-      end
-
-      # Posts a notification with the given name. All arguments wil be passed
-      # to the blocks handling the notification.
-      def post(name, *args)
-        initialize_if_necessary(name)
-
-        # Notify all observers
-        @notifications[name].each do |observer|
-          observer[:block].call(*args)
-        end
-      end
-
-      # Removes the block with the given identifier from the list of blocks
-      # that should be called when the notification with the given name is
-      # posted.
-      #
-      # +name+:: The name of the notification that will be posted.
-      #
-      # +id+:: The identifier of the block that should be removed.
-      def remove(name, id)
-        initialize_if_necessary(name)
-
-        # Remove relevant observers
-        @notifications[name].reject! { |i| i[:id] == id }
-      end
-
-    private
-
-      def initialize_if_necessary(name)
-        @notifications ||= {}       # name => observers dictionary
-        @notifications[name] ||= [] # list of observers
-      end
-
-    end
-
-  end
-
-end

data/lib/nanoc/base/page.rb

@@ -1,132 +0,0 @@
-module Nanoc
-
-  # A Nanoc::Page represents a page in a nanoc site. It has content and
-  # attributes, as well as a path. It can also store the modification time to
-  # speed up compilation.
-  #
-  # Each page has a list of page representations or reps (Nanoc::PageRep);
-  # compiling a page actually compiles all of its representations.
-  class Page
-
-    # Default values for pages.
-    DEFAULTS = {
-      :custom_path  => nil,
-      :extension    => 'html',
-      :filename     => 'index',
-      :filters_pre  => [],
-      :filters_post => [],
-      :layout       => 'default',
-      :skip_output  => false
-    }
-
-    # The Nanoc::Site this page belongs to.
-    attr_accessor :site
-
-    # The parent page of this page. This can be nil even for non-root pages.
-    attr_accessor :parent
-
-    # The child pages of this page.
-    attr_accessor :children
-
-    # This page's raw, uncompiled content.
-    attr_reader   :content
-
-    # A hash containing this page's attributes.
-    attr_accessor :attributes
-
-    # This page's path.
-    attr_reader   :path
-
-    # The time when this page was last modified.
-    attr_reader   :mtime
-
-    # This page's list of page representations.
-    attr_reader   :reps
-
-    # Creates a new page.
-    #
-    # +content+:: This page's unprocessed content.
-    #
-    # +attributes+:: A hash containing this page's attributes.
-    #
-    # +path+:: This page's path.
-    #
-    # +mtime+:: The time when this page was last modified.
-    def initialize(content, attributes, path, mtime=nil)
-      # Set primary attributes
-      @attributes     = attributes.clean
-      @content        = content
-      @path           = path.cleaned_path
-      @mtime          = mtime
-
-      # Start disconnected
-      @parent         = nil
-      @children       = []
-      @reps           = []
-    end
-
-    # Builds the individual page representations (Nanoc::PageRep) for this
-    # page.
-    def build_reps
-      # Get list of rep names
-      rep_names_default = (@site.page_defaults.attributes[:reps] || {}).keys
-      rep_names_this    = (@attributes[:reps] || {}).keys + [ :default ]
-      rep_names         = rep_names_default | rep_names_this
-
-      # Get list of reps
-      reps = rep_names.inject({}) do |memo, rep_name|
-        rep = (@attributes[:reps] || {})[rep_name]
-        is_bad = (@attributes[:reps] || {}).has_key?(rep_name) && rep.nil?
-        is_bad ? memo : memo.merge(rep_name => rep || {})
-      end
-
-      # Build reps
-      @reps = []
-      reps.each_pair do |name, attrs|
-        @reps << PageRep.new(self, attrs, name)
-      end
-    end
-
-    # Returns a proxy (Nanoc::PageProxy) for this page.
-    def to_proxy
-      @proxy ||= PageProxy.new(self)
-    end
-
-    # Returns the attribute with the given name.
-    def attribute_named(name)
-      return @attributes[name] if @attributes.has_key?(name)
-      return @site.page_defaults.attributes[name] if @site.page_defaults.attributes.has_key?(name)
-      return DEFAULTS[name]
-    end
-
-    # Saves the page in the database, creating it if it doesn't exist yet or
-    # updating it if it already exists. Tells the site's data source to save
-    # the page.
-    def save
-      @site.data_source.loading do
-        @site.data_source.save_page(self)
-      end
-    end
-
-    # Moves the page to a new path. Tells the site's data source to move the
-    # page.
-    def move_to(new_path)
-      @site.data_source.loading do
-        @site.data_source.move_page(self, new_path)
-      end
-    end
-
-    # Deletes the page. Tells the site's data source to delete the page.
-    def delete
-      @site.data_source.loading do
-        @site.data_source.delete_page(self)
-      end
-    end
-
-    def inspect
-      "<#{self.class} path=#{self.path}>"
-    end
-
-  end
-
-end

data/lib/nanoc/base/page_defaults.rb

@@ -1,20 +0,0 @@
-module Nanoc
-
-  # Nanoc::PageDefaults represent the default attributes for all pages in the
-  # site. If a specific page attribute is requested, but not found, then the
-  # page defaults will be queried for this attribute. (If the attribute
-  # doesn't even exist in the page defaults, hardcoded defaults will be used.)
-  class PageDefaults < Defaults
-
-    # Saves the page defaults in the database, creating it if it doesn't exist
-    # yet or updating it if it already exists. Tells the site's data source to
-    # save the page defaults.
-    def save
-      @site.data_source.loading do
-        @site.data_source.save_page_defaults(self)
-      end
-    end
-
-  end
-
-end

data/lib/nanoc/base/page_rep.rb

@@ -1,324 +0,0 @@
-module Nanoc
-
-  # A Nanoc::PageRep is a single representation (rep) of a page (Nanoc::Page).
-  # A page can have multiple representations. A representation has its own
-  # attributes and its own output file. A single page can therefore have
-  # multiple output files, each run through a different set of filters with a
-  # different layout.
-  #
-  # A page representation is observable. The following events will be
-  # notified:
-  #
-  # * :compilation_started
-  # * :compilation_ended
-  # * :filtering_started
-  # * :filtering_ended
-  #
-  # The compilation-related events have one parameters (the page
-  # representation); the filtering-related events have two (the page
-  # representation, and a symbol containing the filter class name).
-  class PageRep
-
-    # The page (Nanoc::Page) to which this representation belongs.
-    attr_reader   :page
-
-    # A hash containing this page representation's attributes.
-    attr_accessor :attributes
-
-    # This page representation's unique name.
-    attr_reader   :name
-
-    # Creates a new page representation for the given page and with the given
-    # attributes.
-    #
-    # +page+:: The page (Nanoc::Page) to which the new representation will
-    #          belong.
-    #
-    # +attributes+:: A hash containing the new page representation's
-    #                attributes. This hash must have been run through
-    #                Hash#clean before using it here.
-    #
-    # +name+:: The unique name for the new page representation.
-    def initialize(page, attributes, name)
-      # Set primary attributes
-      @page           = page
-      @attributes     = attributes
-      @name           = name
-
-      # Get page content from page
-      @content        = { :pre => nil, :post => nil }
-
-      # Reset flags
-      @compiled       = false
-      @modified       = false
-      @created        = false
-    end
-
-    # Returns a proxy (Nanoc::PageRepProxy) for this page representation.
-    def to_proxy
-      @proxy ||= PageRepProxy.new(self)
-    end
-
-    # Returns true if this page rep's output file was created during the last
-    # compilation session, or false if the output file did already exist.
-    def created?
-      @created
-    end
-
-    # Returns true if this page rep's output file was modified during the last
-    # compilation session, or false if the output file wasn't changed.
-    def modified?
-      @modified
-    end
-
-    # Returns true if this page rep has been compiled, false otherwise.
-    def compiled?
-      @compiled
-    end
-
-    # Returns true if this page rep's output file is outdated and must be
-    # regenerated, false otherwise.
-    def outdated?
-      # Outdated if we don't know
-      return true if @page.mtime.nil?
-
-      # Outdated if compiled file doesn't exist
-      return true if !File.file?(disk_path)
-
-      # Get compiled mtime
-      compiled_mtime = File.stat(disk_path).mtime
-
-      # Outdated if file too old
-      return true if @page.mtime > compiled_mtime
-
-      # Outdated if layouts outdated
-      return true if @page.site.layouts.any? do |l|
-        l.mtime.nil? or l.mtime > compiled_mtime
-      end
-
-      # Outdated if page defaults outdated
-      return true if @page.site.page_defaults.mtime.nil?
-      return true if @page.site.page_defaults.mtime > compiled_mtime
-
-      # Outdated if code outdated
-      return true if @page.site.code.mtime.nil?
-      return true if @page.site.code.mtime > compiled_mtime
-
-      return false
-    end
-
-    # Returns the path to the output file, including the path to the output
-    # directory specified in the site configuration, and including the
-    # filename and extension.
-    def disk_path
-      @disk_path ||= @page.site.router.disk_path_for(self)
-    end
-
-    # Returns the path to the output file as it would be used in a web
-    # browser: starting with a slash (representing the web root), and only
-    # including the filename and extension if they cannot be ignored (i.e.
-    # they are not in the site configuration's list of index files).
-    def web_path
-      @web_path ||= @page.site.router.web_path_for(self)
-    end
-
-    # Returns the attribute with the given name. This method will look in
-    # several places for the requested attribute:
-    #
-    # 1. This page representation's attributes;
-    # 2. The attributes of this page representation's page;
-    # 3. The page defaults' representation corresponding to this page
-    #    representation;
-    # 4. The page defaults in general;
-    # 5. The hardcoded page defaults, if everything else fails.
-    def attribute_named(name)
-      # Check in here
-      return @attributes[name] if @attributes.has_key?(name)
-
-      # Check in page
-      return @page.attributes[name] if @page.attributes.has_key?(name)
-
-      # Check in page defaults' page rep
-      page_default_reps = @page.site.page_defaults.attributes[:reps] || {}
-      page_default_rep  = page_default_reps[@name] || {}
-      return page_default_rep[name] if page_default_rep.has_key?(name)
-
-      # Check in site defaults (global)
-      page_defaults_attrs = @page.site.page_defaults.attributes
-      return page_defaults_attrs[name] if page_defaults_attrs.has_key?(name)
-
-      # Check in hardcoded defaults
-      return Nanoc::Page::DEFAULTS[name]
-    end
-
-    # Returns the page representation content at the given stage.
-    #
-    # +stage+:: The stage at which the content should be fetched. Can be
-    #           either +:pre+ or +:post+. To get the raw, uncompiled content,
-    #           use Nanoc::Page#content.
-    def content(stage=:pre)
-      compile(stage == :post, true, false)
-
-      @content[stage]
-    end
-
-    # Returns the layout used for this page representation.
-    def layout
-      # Check whether layout is present
-      return nil if attribute_named(:layout).nil?
-
-      # Find layout
-      @layout ||= @page.site.layouts.find { |l| l.path == attribute_named(:layout).cleaned_path }
-      raise Nanoc::Errors::UnknownLayoutError.new(attribute_named(:layout)) if @layout.nil?
-
-      @layout
-    end
-
-    # Compiles the page representation and writes the result to the disk. This
-    # method should not be called directly; please use Nanoc::Compiler#run
-    # instead, and pass this page representation's page as its first argument.
-    #
-    # The page representation will only be compiled if it wasn't compiled
-    # before yet. To force recompilation of the page rep, forgetting any
-    # progress, set +from_scratch+ to true.
-    #
-    # +also_layout+:: true if the page rep should also be laid out and
-    #                 post-filtered, false if the page rep should only be
-    #                 pre-filtered.
-    #
-    # +even_when_not_outdated+:: true if the page rep should be compiled even
-    #                            if it is not outdated, false if not.
-    #
-    # +from_scratch+:: true if all compilation stages (pre-filter, layout,
-    #                  post-filter) should be performed again even if they
-    #                  have already been performed, false otherwise.
-    def compile(also_layout, even_when_not_outdated, from_scratch)
-      # Don't compile if already compiled
-      return if @content[also_layout ? :post : :pre] and !from_scratch
-
-      # Skip unless outdated
-      unless outdated? or even_when_not_outdated
-        if also_layout
-          Nanoc::NotificationCenter.post(:compilation_started, self)
-          Nanoc::NotificationCenter.post(:compilation_ended,   self)
-        end
-        return
-      end
-
-      # Reset flags
-      @compiled = false
-      @modified = false
-      @created  = false
-
-      # Forget progress if requested
-      @content = { :pre => nil, :post => nil } if from_scratch
-
-      # Check for recursive call
-      if @page.site.compiler.stack.include?(self)
-        @page.site.compiler.stack.push(self)
-        raise Nanoc::Errors::RecursiveCompilationError.new
-      end
-
-      # Start
-      @page.site.compiler.stack.push(self)
-      Nanoc::NotificationCenter.post(:compilation_started, self) if also_layout
-
-      # Pre-filter if necesary
-      if @content[:pre].nil?
-        do_filter(:pre)
-      end
-
-      # Post-filter if necessary
-      if @content[:post].nil? and also_layout
-        do_layout
-        do_filter(:post)
-
-        # Update status
-        @compiled = true
-        unless attribute_named(:skip_output)
-          @created  = !File.file?(self.disk_path)
-          @modified = @created ? true : File.read(self.disk_path) != @content[:post]
-        end
-
-        # Write if necessary
-        write unless attribute_named(:skip_output)
-      end
-
-      # Stop
-      Nanoc::NotificationCenter.post(:compilation_ended, self) if also_layout
-      @page.site.compiler.stack.pop
-    end
-
-  private
-
-    # Runs the content through the filters in the given stage.
-    def do_filter(stage)
-      # Get content if necessary
-      content = (stage == :pre ? @page.content : @content[:post])
-
-      # Get filters
-      check_for_outdated_filters
-      filters = attribute_named(stage == :pre ? :filters_pre : :filters_post)
-
-      # Run each filter
-      filters.each do |filter_name|
-        # Create filter
-        klass = Nanoc::Filter.named(filter_name)
-        raise Nanoc::Errors::UnknownFilterError.new(filter_name) if klass.nil?
-        filter = klass.new(self)
-
-        # Run filter
-        Nanoc::NotificationCenter.post(:filtering_started, self, klass.identifier)
-        content = filter.run(content)
-        # FIXME hacky
-        content.force_encoding('utf-8') if content.respond_to?(:'force_encoding')
-        Nanoc::NotificationCenter.post(:filtering_ended,   self, klass.identifier)
-      end
-
-      # Set content
-      @content[stage] = content
-    end
-
-    # Runs the content through this rep's layout.
-    def do_layout
-      # Don't layout if not necessary
-      if attribute_named(:layout).nil?
-        @content[:post] = @content[:pre]
-        return
-      end
-
-      # Create filter
-      klass = layout.filter_class
-      raise Nanoc::Errors::CannotDetermineFilterError.new(layout.path) if klass.nil?
-      filter = klass.new(self, :layout => layout.to_proxy)
-
-      # Layout
-      Nanoc::NotificationCenter.post(:filtering_started, self, klass.identifier)
-      @content[:post] = filter.run(layout.content)
-      Nanoc::NotificationCenter.post(:filtering_ended,   self, klass.identifier)
-    end
-
-    # Writes the compiled content to the disk.
-    def write
-      # TODO add ruby 1.9 support
-      FileUtils.mkdir_p(File.dirname(self.disk_path))
-      File.open(self.disk_path, 'w') { |io| io.write(@content[:post]) }
-    end
-
-    # Raises an error when the outdated 'filters' attribute is used.
-    def check_for_outdated_filters
-      unless attribute_named(:filters).nil?
-        raise Nanoc::Errors::NoLongerSupportedError.new(
-          'The `filters` property is no longer supported; please use ' +
-          '`filters_pre` instead.'
-        )
-      end
-    end
-
-    def inspect
-      "<#{self.class} name=#{self.name} page.path=#{self.page.path}>"
-    end
-
-  end
-
-end