brite 0.6.0 → 0.7.0

data/lib/brite/config.rb

@@ -7,32 +7,48 @@ module Brite
   class Config
 
     # Configuration file name glob.
-    CONFIG_FILE = '{.brite,brite.yml,brite.yaml}'
+    CONFIG_FILE          = '{.brite,brite.yml,brite.yaml}'
 
     # Default URL, which is just for testing purposes.
-    DEFAULT_URL     = 'http://0.0.0.0:4321'
+    DEFAULT_URL          = 'http://0.0.0.0:3000'
 
     # Default stencil.
-    DEFAULT_STENCIL = 'rhtml' #'liquid' # 'rhtml'
+    DEFAULT_STENCIL      = 'erb'
 
     # Default format.
-    DEFAULT_FORMAT  = nil #html
+    DEFAULT_FORMAT       = nil #html
 
     # Default page layout file name (less `.layout` extension).
-    DEFAULT_PAGE_LAYOUT = 'page'
+    DEFAULT_PAGE_LAYOUT  = 'page'
 
     # Default post layout file name (less `.layout` extension).
-    DEFAULT_POST_LAYOUT = 'post'
+    DEFAULT_POST_LAYOUT  = 'post'
 
-    # Location of brite files.
+    # Default page route (`:path`).
+    DEFAULT_PAGE_ROUTE   = ':path'
+
+    # Default post route (`:path`).
+    DEFAULT_POST_ROUTE   = ':path'
+
+    # Default author for pages and posts.
+    DEFAULT_AUTHOR       = 'Anonymous'
+
+    # Default location of layouts.
+    DEFAULT_LAYOUT_PATH  = ['assets/layouts']
+
+    # Default location of partials.
+    DEFAULT_PARTIAL_PATH = ['assets/partials']
+
+    # Location of brite project files. By necessity the configuration file
+    # will be located in this directory.
     attr :location
 
+    # Configuration file.
+    attr :file
+
     # Site's absolute URL. Where possible links are relative,
     # but it is not alwasy possible. So a URL should *ALWAYS*
     # be provided for the site.
-    #--
-    # TODO: Allow +url+ to be set via the command line when generating the site.
-    #++
     attr_accessor :url
 
     # Defaut section template engine.
@@ -47,23 +63,51 @@ module Brite
     # Default post layout file name (less extension).
     attr_accessor :post_layout
 
+    # Default page route.
+    attr_accessor :page_route
+
+    # Default post route.
+    attr_accessor :post_route
+
+    # Default author.
+    attr_accessor :author
+
+    # Paths to look for layouts.
+    attr_accessor :layout_path
+
+    # Paths to look for layouts.
+    attr_accessor :partial_path
+
     # New instance of Config.
     def initialize(location=nil)
-      @location = location || Dir.pwd
+      @location     = location || Dir.pwd
+      @file         = Dir.glob(File.join(@location, CONFIG_FILE)).first
+
+      @url          = DEFAULT_URL
+      @stencil      = DEFAULT_STENCIL
+      @format       = DEFAULT_FORMAT
+
+      @page_layout  = DEFAULT_PAGE_LAYOUT
+      @post_layout  = DEFAULT_POST_LAYOUT
 
-      @url     = DEFAULT_URL
-      @stencil = DEFAULT_STENCIL
-      @format  = DEFAULT_FORMAT
+      @page_route   = DEFAULT_PAGE_ROUTE
+      @post_route   = DEFAULT_POST_ROUTE
 
-      @page_layout = DEFAULT_PAGE_LAYOUT
-      @post_layout = DEFAULT_POST_LAYOUT
+      @author       = DEFAULT_AUTHOR
+
+      @layout_path  = DEFAULT_LAYOUT_PATH
+      @partial_path = DEFAULT_PARTIAL_PATH
+
+      @custom      = {}
 
       configure
     end
 
+    #
     # Load configuration file.
+    #
     def configure
-      if file = Dir[File.join(location, CONFIG_FILE)].first
+      if file
         data = YAML.load(File.new(file))
         data.each do |k,v|
           __send__("#{k}=", v)
@@ -71,32 +115,70 @@ module Brite
       end
     end
 
-    #def initialize_defaults
-    #  if file = Dir['{.,}config/defaults{,.yml,.yaml}'].first
-    #    custom_defaults = YAML.load(File.new(file))
-    #  else
-    #    custom_defaults = {}
-    #  end
-    #  @defaults = OpenStruct.new(DEFAULTS.merge(custom_defaults))
-    #end
-
-    # FIXME: Is this used? What about page vs pagelayout?
-    #def defaults
-    #  @defaults ||= OpenStruct.new(
-    #    :stencil    => stencil,
-    #    :format     => format,
-    #    :pagelayout => page,
-    #    :postlayout => post
-    #  )
-    #end
-
-    # Use Gemdo.
-    def gemdo=(set)
+    #
+    # Make sure layout_path is a list.
+    #
+    def layout_path=(path)
+      @layout_path = [path].flatten
+    end
+
+    #
+    # Make sure partial_path is a list.
+    #
+    def partial_path=(path)
+      @partial_path = [path].flatten
+    end
+
+=begin
+    #
+    # Locate a layout looking in layout paths.
+    #
+    def find_layout(name)
+      # look for layout in layout_path locations
+      file = nil
+      @layout_path.find do |path|
+        file = Dir.glob(File.join(path, "#{name}.layout")).first
+      end
+      # fallback to site's root location
+      if !file
+        file = Dir.glob(File.join(@location, "#{name}.layout")).first
+      end
+      # if not found raise an error
+      raise "Cannot locate layout #{name}." unless file
+      # return layout file
+      file
+    end
+=end
+
+    #
+    # Provide access to POM.
+    #
+    # @todo Will become GemDo in future ?
+    #
+    def pom=(set)
       return unless set
-      require 'gemdo'        
+      require 'pom'
       Brite::Context.class_eval do
         def project
-          @project ||= Gemdo::Project.new
+          @project ||= POM::Project.new
+        end
+      end
+    end
+
+    #
+    alias_method :gemdo=, :pom=
+
+    #
+    def method_missing(s, v=nil, *a, &b)
+      s = s.to_s
+      case s
+      when /=$/
+        @custom[s.chomp('=')] = v
+      else
+        if @custom.key?(s)
+          @custom[s]
+        else
+          super(s.to_sym, v, *a, &b)
         end
       end
     end

data/lib/brite/controller.rb

@@ -1,159 +1,101 @@
 require 'neapolitan'
 require 'brite/config'
 require 'brite/layout'
-require 'brite/models/site'
-require 'brite/models/page'
-require 'brite/models/post'
+require 'brite/site'
+require 'brite/page'
+require 'brite/post'
+require 'brite/part'
 
 module Brite
 
   # The Controller class is the primary Brite class, handling
   # the generation of site files.
+  #
   class Controller
 
     # New Controller.
+    #
+    # @param [Hash] options
+    #   Controller options.
+    #
+    # @option options [String] :location
+    #   Location of brite project.   
+    #
+    # @option options [String] :output
+    #   Redirect all output to this directory.
+    #
     def initialize(options={})
       @location = options[:location] || Dir.pwd
       @output   = options[:output]
-      @url      = options[:url]
-      @dryrun   = options[:dryrun]
-      @trace    = options[:trace]
-
-      @layouts  = []
+      #@dryrun   = options[:dryrun]
+      #@trace    = options[:trace]
 
-      initialize_site
-    end
-
-    # Returns an instance of Site.
-    def initialize_site
-      @site = Site.new(:url=>url)
-
-      Dir.chdir(location) do
-        files = Dir['**/*']
-        files.each do |file|
-          name = File.basename(file)
-          ext  = File.extname(file)
-          case ext
-          when '.layout'
-            layouts << Layout.new(self, file)
-          when '.page' #*%w{.markdown .rdoc .textile .whtml}
-            @site.pages << initialize_page(file)
-          when '.post'
-            @site.posts << initialize_post(file)
-          end
-        end
-      end
-      @site.posts.sort!{ |a,b| b.date <=> a.date }
-      @site
-    end
-
-    # Returns an instance of Page.
-    #++
-    # TODO: Limit Neapolitan to Markup formats only.
-    #--
-    def initialize_page(file)
-      template = Neapolitan.file(file, :stencil=>config.stencil)
-      settings = template.header
-
-      settings[:site] = site
-      settings[:file] = file
-
-      Page.new(settings){ |page| render(template, page) }
-    end
-
-    # Returns an instance of Post.
-    def initialize_post(file)
-      template = Neapolitan.file(file, :stencil=>config.stencil)
-      settings = template.header
-
-      settings[:site] = site
-      settings[:file] = file
-
-      Post.new(settings){ |post| render(template, post) }
+      @site = Site.new(location, :url=>options[:url])
     end
 
     # Returns an instance of Site.
     attr :site
 
-    #
+    # Directory of site files on disk.
     attr :location
 
-    #
+    # Where to save results. Usually the templates are shadowed, which means
+    # the ouput is the same a location.
     attr :output
 
-    # Is `dryrun` mode on?
-    def dryrun?
-      @dryrun
-    end
-
-    # Is `trace` mode on?
-    def trace?
-      @trace
-    end
-
-    # Returns an Array of Layouts.
-    def layouts
-      @layouts
-    end
+    ## Returns an Array of Layouts.
+    #def layouts
+    #  @site.layouts
+    #end
 
     # Access to configuration file data.
     def config
-      @config ||= Config.new(location)
+      site.config
     end
 
     # URL of site as set in initializer or configuration file.
     def url
-      @url ||= config.url
+      site.url
     end
 
-    #
-    def render(template, model) #scope=nil, &body)
-      #if scope
-      #  scope.merge!(attributes)
-      #else
-      #  scope = to_scope
-      #end
-
-      render = template.render(model) #, &body)
-
-      model.summary = render.summary  # TODO: make part of neapolitan?
-
-      result = render.to_s
-
-      if model.layout
-        layout = lookup_layout(model.layout)
-        raise "No such layout -- #{layout}" unless layout
-        result = layout.render(model){ result }
-      end
-
-      result.to_s.strip
+    # Is `dryrun` mode on? Checks the global variable `$DRYRUN`.
+    def dryrun?
+      $DRYRUN #@dryrun
     end
 
-    # Lookup layout by name.
-    def lookup_layout(name)
-      layouts.find{ |layout| name == layout.name }
+    # Is `trace` mode on? Checks global variable `$TRACE`.
+    def trace?
+      $TRACE #@trace
     end
 
-    # Build site.
+    # Build the site.
     def build
       if trace?
-        puts "Layouts: " + layouts.map{ |layout| layout.name }.join(", ")
-        puts "Pages:   " + pages.map{ |page| page.file }.join(", ")
-        puts "Posts:   " + posts.map{ |post| post.file }.join(", ")
+        puts "Layouts: " + site.layouts.map{ |layout| layout.name }.join(", ")
+        puts "Parts:   " + site.parts.map{ |part| part.name }.join(", ")
+        puts "Pages:   " + site.pages.map{ |page| page.file }.join(", ")
+        puts "Posts:   " + site.posts.map{ |post| post.file }.join(", ")
         puts
       end
+
       Dir.chdir(location) do
         site.posts.each do |post|
+          puts "Rendering #{post.file}" if $DEBUG
           save(post)
         end
         site.pages.each do |page|
+          puts "Rendering #{page.file}" if $DEBUG
           save(page)
         end
       end
-      puts "#{site.pages.size + site.posts.size} Files: #{site.pages.size} Pages, #{site.posts.size} Posts"
+      puts "\n#{site.pages.size + site.posts.size} Files: #{site.pages.size} Pages, #{site.posts.size} Posts"
     end
 
     # Save page/post redering to disk.
+    #
+    # @param [Model] model
+    #   The {Page} or {Post} to save to disk.
+    #
     def save(model)
       file = output ? File.join(output, model.output) : model.output
       text = model.to_s

data/lib/brite/layout.rb

@@ -1,35 +1,49 @@
+require 'brite/model'
+
 module Brite
 
   # Layout class
-  class Layout
+  class Layout < Model
 
     #
-    def initialize(controller, file)
-      @controller = controller
-      @file       = file
-      @name       = file.chomp('.layout')
-      @path       = File.expand_path(file)
+    def initialize(site, file)
+      @site = site
+      @file = file
+
+      @name = file.chomp('.layout')
+      @path = File.expand_path(file)
     end
 
-    attr :controller
+    #
+    attr :site
 
+    #
     attr :file
 
+    #
+    attr :name
+
+    #
     attr :path
 
-    attr :name
+    # TODO: merge layout header ?
 
-    # TODO: merge in layout header
+    # Render layout.
     def render(model, &content)
-      template = Neapolitan.file(path, :stencil=>controller.config.stencil)
+      template = Neapolitan.file(path, :stencil=>site.config.stencil)
+
+      # update the model's metadata
+      #model.update(template.metadata)
 
       result = template.render(model, &content).to_s
 
-      layout = template.header['layout']
+      layout_name = template.metadata['layout']
+
+      if layout_name
+        layout = site.lookup_layout(layout_name)
 
-      if layout
-        layout = controller.lookup_layout(layout)
         raise "No such layout -- #{layout}" unless layout
+
         result = layout.render(model){ result }
       end