brite 0.5 → 0.6.0

data/lib/brite/config.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 require 'ostruct'
 
 module Brite
@@ -5,26 +6,101 @@ module Brite
   # Configuration
   class Config
 
-    #
-    DEFAULTS = {
-      :stencil    => 'rhtml',
-      #:format     => 'html',
-      :pagelayout => 'page',
-      :postlayout => 'post',
-      :maxchars   => 500,
-    }
-
-    attr :defaults
-
-    def initialize
-      if File.exist?('.config/defaults')
-        custom_defaults = YAML.load(File.new('.config/defaults'))
-      else
-        custom_defaults = {}
+    # Configuration file name glob.
+    CONFIG_FILE = '{.brite,brite.yml,brite.yaml}'
+
+    # Default URL, which is just for testing purposes.
+    DEFAULT_URL     = 'http://0.0.0.0:4321'
+
+    # Default stencil.
+    DEFAULT_STENCIL = 'rhtml' #'liquid' # 'rhtml'
+
+    # Default format.
+    DEFAULT_FORMAT  = nil #html
+
+    # Default page layout file name (less `.layout` extension).
+    DEFAULT_PAGE_LAYOUT = 'page'
+
+    # Default post layout file name (less `.layout` extension).
+    DEFAULT_POST_LAYOUT = 'post'
+
+    # Location of brite files.
+    attr :location
+
+    # 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.
+    attr_accessor :stencil
+
+    # Default section markup format.
+    attr_accessor :format
+
+    # Default page layout file name (less extension).
+    attr_accessor :page_layout
+
+    # Default post layout file name (less extension).
+    attr_accessor :post_layout
+
+    # New instance of Config.
+    def initialize(location=nil)
+      @location = location || Dir.pwd
+
+      @url     = DEFAULT_URL
+      @stencil = DEFAULT_STENCIL
+      @format  = DEFAULT_FORMAT
+
+      @page_layout = DEFAULT_PAGE_LAYOUT
+      @post_layout = DEFAULT_POST_LAYOUT
+
+      configure
+    end
+
+    # Load configuration file.
+    def configure
+      if file = Dir[File.join(location, CONFIG_FILE)].first
+        data = YAML.load(File.new(file))
+        data.each do |k,v|
+          __send__("#{k}=", v)
+        end
+      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)
+      return unless set
+      require 'gemdo'        
+      Brite::Context.class_eval do
+        def project
+          @project ||= Gemdo::Project.new
+        end
       end
-      @defaults = OpenStruct.new(DEFAULTS.merge(custom_defaults))
     end
+
   end
 
 end
-

data/lib/brite/controller.rb

@@ -0,0 +1,181 @@
+require 'neapolitan'
+require 'brite/config'
+require 'brite/layout'
+require 'brite/models/site'
+require 'brite/models/page'
+require 'brite/models/post'
+
+module Brite
+
+  # The Controller class is the primary Brite class, handling
+  # the generation of site files.
+  class Controller
+
+    # New Controller.
+    def initialize(options={})
+      @location = options[:location] || Dir.pwd
+      @output   = options[:output]
+      @url      = options[:url]
+      @dryrun   = options[:dryrun]
+      @trace    = options[:trace]
+
+      @layouts  = []
+
+      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) }
+    end
+
+    # Returns an instance of Site.
+    attr :site
+
+    #
+    attr :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
+
+    # Access to configuration file data.
+    def config
+      @config ||= Config.new(location)
+    end
+
+    # URL of site as set in initializer or configuration file.
+    def url
+      @url ||= config.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
+    end
+
+    # Lookup layout by name.
+    def lookup_layout(name)
+      layouts.find{ |layout| name == layout.name }
+    end
+
+    # Build 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
+      end
+      Dir.chdir(location) do
+        site.posts.each do |post|
+          save(post)
+        end
+        site.pages.each do |page|
+          save(page)
+        end
+      end
+      puts "#{site.pages.size + site.posts.size} Files: #{site.pages.size} Pages, #{site.posts.size} Posts"
+    end
+
+    # Save page/post redering to disk.
+    def save(model)
+      file = output ? File.join(output, model.output) : model.output
+      text = model.to_s
+
+      if File.exist?(file)
+        current = File.read(file)
+      else
+        current = nil
+      end
+
+      if current != text or $FORCE
+        if dryrun?
+          puts "    dry run: #{file}"
+        else
+          puts "      write: #{file}"
+          File.open(file, 'w'){ |f| f << text }
+        end
+      else
+        puts "  unchanged: #{file}"
+      end
+    end
+
+  end
+
+end

data/lib/brite/layout.rb

@@ -1,34 +1,39 @@
 module Brite
 
   # Layout class
-  class Layout < Page
-    undef_method :save
-
-    #def to_contextual_attributes
-    #  { 'site'=>site.to_h }
-    #end
+  class Layout
 
     #
-    def render(attributes={})
-      #attributes = to_contextual_attributes
-      #attributes['content'] = content if content
+    def initialize(controller, file)
+      @controller = controller
+      @file       = file
+      @name       = file.chomp('.layout')
+      @path       = File.expand_path(file)
+    end
+
+    attr :controller
+
+    attr :file
 
-      output = parts.map{ |part| part.render(stencil, attributes) }.join("\n")
+    attr :path
 
-      #@content = output
+    attr :name
 
-      attributes = attributes.merge('content'=>output)
+    # TODO: merge in layout header
+    def render(model, &content)
+      template = Neapolitan.file(path, :stencil=>controller.config.stencil)
+
+      result = template.render(model, &content).to_s
+
+      layout = template.header['layout']
 
       if layout
-        output = site.lookup_layout(layout).render(attributes)
+        layout = controller.lookup_layout(layout)
+        raise "No such layout -- #{layout}" unless layout
+        result = layout.render(model){ result }
       end
 
-      output
-    end
-
-    # Layouts have no default layout.
-    def default_layout
-      nil
+      result.to_s
     end
 
   end

data/lib/brite/meta/data.rb

@@ -0,0 +1,26 @@
+module Brite
+
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/package'))
+    )
+  end
+
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/profile'))
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    package[key] || profile[key] || super(name)
+  end
+
+end
+
+# becuase Ruby 1.8~ gets in the way
+Object.__send__(:remove_const, :VERSION) if Object.const_defined?(:VERSION)
+

data/lib/brite/meta/package

@@ -0,0 +1,8 @@
+---
+name    : brite
+date    : 2010-11-12
+version : 0.6.0
+
+requires:
+  - neapolitan 0.3.0+
+

data/lib/brite/meta/profile

@@ -0,0 +1,19 @@
+--- 
+title    : Brite
+subtitle : Light Up Your Site
+summary  : Super Simple Static Site Generation
+copyright: Copyright (c) 2006,2009 Thomas Sawyer
+license  : Apache v2.0
+suite    : proutils
+contact  : http://googlegroups.com/group/proutils
+authors  : Thomas Sawyer
+
+description:
+  Brite is a remarkably easy to use, light-weight website
+  generator. It supports a variety of backend rendering engines
+  including rhtml via eruby, textile via redcloth, markdown
+  via rdiscount, with others on the way.
+
+resources:
+  homepage: http://proutils.github.com/brite
+  repository: git://github.com/proutils/brite.git

data/lib/brite/models/model.rb

@@ -0,0 +1,97 @@
+module Brite
+
+  #
+  class Model
+
+    # Designate a field to be omitted from rendering context.
+    def self.omit_field(name)
+      omit_fields << (RUBY_VERSION >= "1.9" ? name.to_sym : name.to_s)
+    end
+
+    # Returns an Array of omitted fields for this class.
+    def self.omit_fields
+      @omit_fields ||= []
+    end
+
+    #
+    def self.attr_accessor(name, &default)
+      name = name.to_sym
+      if default
+        define_method(name) do
+          value = instance_variable_get("@#{name}") || instance_eval(&default)
+          (class << self; self; end).class_eval do
+            define_method(name){ value }
+          end
+          value
+        end
+      else
+        attr_reader(name)
+      end
+      attr_writer(name)
+    end
+
+    # Define a singleton method for given key-value pair.
+    def []=(k,v)
+      (class << self; self; end).class_eval do
+        define_method(k){v}
+      end
+    end
+
+    # Returns a Binding for this instance.
+    def to_binding(&block)
+      binding
+    end
+
+    # Returns a Hash of rendering fields.
+    def to_h
+      hash   = {}
+      fields = rendering_fields
+      fields.each do |field|
+        hash[field.to_s] = __send__(field)
+      end
+      #extra.each do |k,v|
+      #  hash[k.to_s] == v
+      #end
+      hash
+    end
+
+    # In case Liquid template is used.
+    def to_liquid
+      to_h
+    end
+
+    # Returns an Array of attribute/method names to be visible to the page
+    # rendering.
+    def rendering_fields
+      list = public_methods 
+      list -= Model.public_instance_methods
+      list -= omit_fields
+      list.select do |name|
+        case name.to_s
+        when /\W+/  then false
+        when /^to_/ then false
+        else
+          true
+        end
+      end
+    end
+
+    # Returns an Array of attribute/method names explicitly omitted from
+    # being visible from the rendering.
+    def omit_fields
+      list = []
+      self.class.ancestors.reverse_each do |ancestor|
+        list.concat(ancestor.omit_fields) if ancestor.respond_to?(:omit_fields)
+      end
+      list
+    end
+
+    #
+    def singleton_class
+      (class << self; self; end)
+    end
+
+  end
+
+end
+