webby 0.4.0 → 0.5.0

data/lib/webby/file.rb

@@ -1,4 +1,4 @@
-# $Id: file.rb 2 2007-08-20 17:55:30Z tim_pease $
+# $Id: file.rb 46 2007-11-27 03:31:29Z tim_pease $
 
 require 'yaml'
 
@@ -40,7 +40,7 @@ class File < ::File
       fd = new name, 'r'
       fd.read *args
     ensure
-      fd.close
+      fd.close unless fd.nil?
     end
 
     # call-seq:
@@ -54,7 +54,7 @@ class File < ::File
       fd = new name, 'r'
       fd.readlines sep
     ensure
-      fd.close
+      fd.close unless fd.nil?
     end
 
     # call-seq:
@@ -67,7 +67,7 @@ class File < ::File
       fd = new name, 'r'
       fd.meta_data
     ensure
-      fd.close
+      fd.close unless fd.nil?
     end
   end
 
@@ -140,7 +140,7 @@ class File < ::File
     seek 0, IO::SEEK_END
   end
 
-  %w(getc gets read read_nonblock readbytes readchar readline readlines readpartial scanf sysread).each do |m|
+  %w(getc gets read read_nonblock readbytes readchar readline readlines readpartial scanf).each do |m|
     self.class_eval <<-CODE
       def #{m}(*a)
         skip_meta_data
@@ -169,17 +169,14 @@ class File < ::File
     cur = tell
 
     seek 0
-    line = readline
+    line = gets
     return unless META_SEP =~ line
 
-    loop do
-      line = readline
+    while line = gets
       break if META_SEP =~ line
     end
-    return tell
-
-  rescue EOFError
-    return
+    return if line.nil?
+    tell
 
   ensure
     seek cur

data/lib/webby/main.rb

@@ -1,4 +1,4 @@
-# $Id: main.rb 20 2007-08-28 23:24:14Z tim_pease $
+# $Id: main.rb 35 2007-09-25 23:31:03Z tim_pease $
 
 require 'fileutils'
 require 'find'
@@ -34,6 +34,15 @@ class Main
                 else m.create_site end
   end
 
+  # call-seq:
+  #    Main.new
+  #
+  # Create a new Main webby object for building websites.
+  #
+  def initialize
+    @log = Logging::Logger[self]
+  end
+
   # call-seq:
   #    parse( args )   => nil
   #
@@ -142,8 +151,7 @@ class Main
   # Prints a "creating _msg_" to the screen.
   #
   def creating( msg )
-    print "creating "
-    puts msg
+    @log.info "creating #{msg}"
   end
 
   # call-seq:
@@ -152,8 +160,7 @@ class Main
   # Prints a "updating _msg_" to the screen.
   #
   def updating( msg )
-    print "updating "
-    puts msg
+    @log.info "updating #{msg}"
   end
 
   # call-seq:
@@ -162,8 +169,7 @@ class Main
   # Prints an abort _msg_ to the screen and then exits the Ruby interpreter.
   #
   def abort( msg )
-    puts msg
-    puts "Aborting!"
+    @log.fatal msg
     exit 1
   end
 

data/lib/webby/pages_db.rb

@@ -1,56 +1,140 @@
-# $Id: pages_db.rb 18 2007-08-28 15:48:17Z tim_pease $
+# $Id: pages_db.rb 46 2007-11-27 03:31:29Z tim_pease $
 
 module Webby
 
-#
+# A rudimentary "database" for holding resource objects and finding them.
+# The database is held in a Ruby hash keyed by the directories in the
+# content folder.
 #
 class PagesDB
-  include Enumerable
 
   # call-seq:
   #    PagesDB.new
   #
+  # Create a new pages database object. This is used to store resources and
+  # to find them by their attributes.
+  #
   def initialize
     @db = Hash.new {|h,k| h[k] = []}
   end
 
   # call-seq:
-  #    add( resource )
+  #    add( resource )    => resource
+  #
+  # Add the given _resource_ to the database. It will not be added a second
+  # time if it already exists in the database.
   #
   def add( page )
-    @db[page.dir] << page
-    self
+    ary = @db[page.dir]
+
+    # make sure we don't duplicate pages
+    ary.delete page if ary.include? page
+    ary << page
+
+    page
   end
   alias :<< :add
 
   # call-seq:
-  #    clear
+  #    clear    => self
+  #
+  # Removes all resources from the database.
   #
   def clear
     @db.clear
+    self
   end
 
   # call-seq:
   #    each {|resource| block}
   #
+  # Iterate over each resource in the database and pass it to the given
+  # block.
+  #
   def each( &b )
     keys = @db.keys.sort
     keys.each do |k|
       @db[k].sort.each(&b)
     end
+    self
   end
 
   # call-seq:
-  #    find_by_name( name )
+  #    find( opts = {} )                       => resource or nil
+  #    find( opts = {} ) {|resource| block}    => resource or nil
+  #
+  # Find a specific resource in the database. A resource can be found using
+  # any combination of attributes by passing them in as options to the
+  # +find+ method. This will used simple equality comparison to find the
+  # resource.
+  # 
+  # For more complex finders, a block should be supplied. The usage
+  # follows that of of the Enumerable#find method. The method will return
+  # the first resource for which the block returns true.
+  #
+  # If the :all option is given as true, then all resources that match the
+  # finder criteria will be returned in an array. If none are found, an
+  # empty array will be returned.
+  #
+  # Options include:
+  #
+  #    :all          => true
+  #    :in_directory => 'directory'
   #
-  def find_by_name( name )
-    self.find {|page| page.filename == name}
+  # Examples:
+  #
+  #    # find the "index" resource in the "foo/bar" directory
+  #    pages_db.find( :filename => 'index', :in_directory => 'foo/bar' )
+  #
+  #    # find all resources named "widgets" whose color is "blue"
+  #    pages_db.find( :name => 'widgets', :color => 'blue', :all => true )
+  #
+  #    # find all resources created in the past week
+  #    pages_db.find( :all => true ) do |resource|
+  #      resource.created_at > Time.now - (7 * 24 * 3600)
+  #    end
+  #
+  def find( opts = {}, &block )
+    find_all = if opts.has_key?(:all) then opts.delete(:all)
+               else false end
+
+    dir = if opts.has_key?(:in_directory) then opts.delete(:in_directory)
+          else nil end
+    if dir && !@db.has_key?(dir)
+      raise RuntimeError, "unknown directory '#{dir}'"
+    end
+
+    block ||= lambda do |page|
+      found = true
+      opts.each do |key, value|
+        found &&= page.__send__(key.to_sym) == value
+        break if not found
+      end
+      found
+    end
+
+    ary = []
+    search = dir ? @db[dir] : self
+    search.each do |page|
+      if block.call(page)
+        ary << page
+        break unless find_all
+      end
+    end
+
+    return ary if find_all
+    return ary.first 
   end
 
   # call-seq:
   #    siblings( page, opts = {} )    => array
   #
+  # Returns an array of resources that are siblings of the given _page_
+  # resource. A sibling is any resource that is in the same directory as the
+  # _page_.
+  #
   # Options include:
+  #
   #    :sorty_by => 'attribute'
   #    :reverse  => true
   #
@@ -60,7 +144,7 @@ class PagesDB
     return ary unless opts.has_key? :sort_by
 
     m = opts[:sort_by]
-    ary.sort! {|a,b| a.send(m) <=> b.send(m)}
+    ary.sort! {|a,b| a.__send__(m) <=> b.__send__(m)}
     ary.reverse! if opts[:reverse]
     ary
   end
@@ -68,7 +152,12 @@ class PagesDB
   # call-seq:
   #    children( page, opts = {} )    => array
   #
+  # Returns an array of resources that are children of the given _page_
+  # resource. A child is any resource that exists in a subdirectory of the
+  # page's directory.
+  #
   # Options include:
+  #
   #    :sorty_by => 'attribute'
   #    :reverse  => true
   #
@@ -82,7 +171,7 @@ class PagesDB
     return ary unless opts.has_key? :sort_by
 
     m = opts[:sort_by]
-    ary.sort! {|a,b| a.send(m) <=> b.send(m)}
+    ary.sort! {|a,b| a.__send__(m) <=> b.__send__(m)}
     ary.reverse! if opts[:reverse]
     ary
   end

data/lib/webby/renderer.rb

@@ -1,8 +1,10 @@
-# $Id: renderer.rb 27 2007-09-18 18:09:25Z tim_pease $
+# $Id: renderer.rb 46 2007-11-27 03:31:29Z tim_pease $
 
 require 'erb'
 try_require 'bluecloth'
 try_require 'redcloth'
+try_require 'haml'
+try_require 'sass'
 
 module Webby
 
@@ -11,7 +13,7 @@ module Webby
 #
 # A page is filtered based on the settings of the 'filter' option in the
 # page's meta-data information. For example, if 'textile' is specified as
-# a filter, then the page will be run through the RedCloth markup filer.
+# a filter, then the page will be run through the RedCloth markup filter.
 # More than one filter can be used on a page; they will be run in the
 # order specified in the meta-data.
 #
@@ -21,6 +23,24 @@ module Webby
 class Renderer
   include ERB::Util
 
+  # call-seq:
+  #    Renderer.write( page )
+  #
+  # Render the given _page_ and write the resulting output to the page's
+  # destination. If the _page_ uses pagination, then multiple destination
+  # files will be created -- one for each paginated data set in the page.
+  #
+  def self.write( page )
+    renderer = self.new(page)
+
+    loop {
+      ::File.open(page.destination, 'w') do |fd|
+        fd.write renderer.layout_page
+      end
+      break unless renderer.next_page
+    }
+  end
+
   # call-seq:
   #    Renderer.new( page )
   #
@@ -37,6 +57,8 @@ class Renderer
     @page = page
     @pages = Resource.pages
     @content = nil
+
+    @log = Logging::Logger[self]
   end
 
   # call-seq:
@@ -50,10 +72,10 @@ class Renderer
   def layout_page
     layouts = Resource.layouts
     obj = @page
-    str = @page.render
+    str = @page.render(self)
 
     loop do
-      lyt = layouts.find_by_name obj.layout
+      lyt = layouts.find :filename => obj.layout
       break if lyt.nil?
 
       @content, str = str, ::Webby::File.read(lyt.path)
@@ -84,6 +106,49 @@ class Renderer
     str
   end
 
+  # call-seq:
+  #    paginate( items, per_page ) {|item| block}
+  #
+  # Iterate the given _block_ for each item selected from the _items_ array
+  # using the given number of items _per_page_. The first time the page is
+  # rendered, the items passed to the block are selected using the range
+  # (0...per_page). The next rendering selects (per_page...2*per_page). This
+  # continues until all _items_ have been paginated.
+  #
+  # Calling this method creates a <code>@pager</code> object that can be
+  # accessed from the _page_. The <code>@pager</code> contains information
+  # about the next page, the current page number, the previous page, and the
+  # number of items in the current page.
+  #
+  def paginate( items, count, &block )
+    @pager ||= Paginator.new(items.length, count, @page) do |offset, per_page|
+      items[offset,per_page]
+    end.first
+
+    @pager.each &block
+  end
+
+  # call-seq:
+  #    next_page    => true or false
+  #
+  # Returns +true+ if there is a next page to render. Returns +false+ if
+  # there is no next page or if pagination has not been configured for the
+  # current page.
+  #
+  def next_page
+    return false unless defined? @pager and @pager
+
+    # go to the next page; break out if there is no next page
+    if @pager.next?
+      @pager = @pager.next
+    else
+      @page.number = nil
+      return false
+    end
+
+    true
+  end
+
   # Render text via ERB using the built in ERB library.
   #
   def erb_filter( str )
@@ -96,7 +161,7 @@ class Renderer
   def markdown_filter( str )
     BlueCloth.new(str).to_html
   rescue NameError
-    $stderr.puts 'ERROR: markdown filter failed (BlueCloth not installed?)'
+    @log.error 'markdown filter failed (BlueCloth not installed?)'
     exit
   end
 
@@ -105,7 +170,7 @@ class Renderer
   def textile_filter( str )
     RedCloth.new(str).to_html
   rescue NameError
-    $stderr.puts 'ERROR: textile filter failed (RedCloth not installed?)'
+    @log.error 'textile filter failed (RedCloth not installed?)'
     exit
   end
 
@@ -114,7 +179,29 @@ class Renderer
   def coderay_filter( str )
     CodeRayFilter.new(str).to_html
   rescue NameError
-    $stderr.puts "ERROR: coderay filter failed (CodeRay not installed?)"
+    @log.error 'coderay filter failed (CodeRay not installed?)'
+    exit
+  end
+
+  # Render text via the Haml library
+  #
+  def haml_filter( str )
+    opts = @page.haml_options || {}
+    opts[:locals] ||= {}
+    opts[:locals].merge!({:page => @page, :pages => @pages})
+    Haml::Engine.new(str, opts).to_html
+  rescue NameError
+    @log.error 'haml filter failed (Haml not installed?)'
+    exit
+  end
+
+  # Render text via the Sass library (part of Haml)
+  #
+  def sass_filter( str )
+    opts = @page.sass_options || {}
+    Sass::Engine.new(str, opts).render
+  rescue NameError
+    @log.error 'sass filter failed (Haml not installed?)'
     exit
   end