webby 0.7.4 → 0.8.0

data/lib/webby/{pages_db.rb → resources/db.rb}

@@ -1,18 +1,18 @@
-# $Id: pages_db.rb 137 2008-02-08 05:05:55Z tim_pease $
+# $Id: db.rb 169 2008-02-24 03:59:37Z tim_pease $
 
-module Webby
+module Webby::Resources
 
 # 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
+class DB
 
   # call-seq:
-  #    PagesDB.new
+  #    DB.new
   #
-  # Create a new pages database object. This is used to store resources and
-  # to find them by their attributes.
+  # Create a new resources database object. This is used to store resources
+  # and to find them by their attributes.
   #
   def initialize
     @db = Hash.new {|h,k| h[k] = []}
@@ -63,40 +63,43 @@ class PagesDB
   #    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.
+  # Find a specific resource or collection of resources in the pages database.
+  # Resources 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 or resources.
   # 
-  # 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:
-  #
-  #    :in_directory => 'directory'
+  # If the :include option is given as :all then all resources that match
+  # the finder criteria will be returned in an array. If none are found, an
+  # empty array will be returned. If the :include option is given as an
+  # integer then the first n resources found will be returned. Otherwise, or
+  # if the :include option is not given, the first resource found will be
+  # returned
+  # 
+  # For more complex finders, a block should be supplied. The usage follows
+  # that of of the Enumerable#find or Enumerable#find_all methods, depending
+  # on the limit. The method will return the first resource or all
+  # resources, respectively, for which the block returns true.
+  # 
+  # Options:
+  #    :limit        => :all, integer or nil
+  #    :in_directory => directory
   #    :recursive    => true or false
-  #
-  #    :limit        => :all or integer
-  #    :sorty_by     => 'attribute'
+  #    :sort_by      => attribute
+  #    :reverse      => true or false
   #
   # Examples:
   #
   #    # find the "index" resource in the "foo/bar" directory
-  #    pages_db.find( :filename => 'index', :in_directory => 'foo/bar' )
+  #    @pages.find( :filename => 'index', :in_directory => 'foo/bar' )
   #
-  #    # find any "index" resource under the "foo/bar" directory
-  #    pages_db.find( :filename => 'index', :in_directory => 'foo/bar', :recursive => true )
+  #    # find all resources under the "foo/bar" directory recursively
+  #    @pages.find( :limit => :all, :in_directory => 'foo/bar', :recursive => true )
   #
-  #    # find all resources named "widgets" whose color is "blue"
-  #    pages_db.find( :all, :name => 'widgets', :color => 'blue' )
+  #    # find the resource named "widgets" whose color is "blue"
+  #    @pages.find( :name => 'widgets', :color => 'blue' )
   #
   #    # find all resources created in the past week
-  #    pages_db.find( :all ) do |resource|
+  #    @pages.find( :limit => :all ) do |resource|
   #      resource.created_at > Time.now - (7 * 24 * 3600)
   #    end
   #
@@ -105,12 +108,13 @@ class PagesDB
 
     limit = opts.delete(:limit)
     sort_by = opts.delete(:sort_by)
+    reverse = opts.delete(:reverse)
 
     # figure out which directories to search through and whether to recurse
     # into directories or not
     search = if (dir = opts.delete(:in_directory))
       strategy = if opts.delete(:recursive)
-        lambda { |key| key =~ /^#{Regexp.escape(dir)}(?:\/|$)/ }
+        lambda { |key| key =~ %r/^#{Regexp.escape(dir)}(?:\/|$)/ }
       else
         lambda { |key| key == dir }
       end
@@ -141,7 +145,9 @@ class PagesDB
     if sort_by
       m = sort_by.to_sym
       ary.delete_if {|p| p.__send__(m).nil?}
-      ary.sort! {|a,b| a.__send__(m) <=> b.__send__(m)}
+      reverse ? 
+          ary.sort! {|a,b| b.__send__(m) <=> a.__send__(m)} :
+          ary.sort! {|a,b| a.__send__(m) <=> b.__send__(m)} 
     end
 
     # limit the search results
@@ -205,7 +211,31 @@ class PagesDB
     ary
   end
 
-end  # class PagesDB
+  # call-seq:
+  #    parent_of( resource )    => resource or nil
+  #
+  #  Returns the parent page of the given resource or nil if the resource is
+  #  at the root of the directory structure. The parent is the "index" page
+  #  of the current directory or the next directory up the chain.
+  #
+  def parent_of( page )
+    dir = page.dir
+
+    loop do
+      if @db.has_key? dir
+        parent = @db[dir].find {|p| p.filename == 'index'}
+        return parent unless parent.nil? or parent == page
+      end
+
+      break if dir.empty?
+      dir = ::File.dirname(dir)
+      dir = '' if dir == '.'
+    end
+
+    return
+  end
+
+end  # class DB
 end  # module Webby
 
 # EOF

data/lib/webby/{file.rb → resources/file.rb}

@@ -1,13 +1,13 @@
-# $Id: file.rb 134 2008-02-05 16:12:48Z tim_pease $
+# $Id: file.rb 167 2008-02-24 00:59:54Z tim_pease $
 
 require 'yaml'
 
-module Webby
+module Webby::Resources
 
-# The Webby::File class is identical to the core Ruby file class except for
-# YAML meta-data stored at the top of the file. This meta-data is made
-# available through the <code>meta_data</code> and <code>meta_data=</code>
-# functions.
+# The Webby::Resources::File class is identical to the core Ruby file class
+# except for YAML meta-data stored at the top of the file. This meta-data
+# is made available through the <code>meta_data</code> and
+# <code>meta_data=</code> functions.
 #
 # The meta-data data must be found between two YAML block separators "---",
 # each on their own line.
@@ -30,7 +30,7 @@ class File < ::File
 
   class << self
     # call-seq:
-    #    Webby::File.read( name [, length [, offset]])    => string
+    #    File.read( name [, length [, offset]])    => string
     #
     # Opens the file, optionally seeks to the given _offset_, then returns
     # _length_ bytes (defaulting to the rest of the file). +read+ ensures
@@ -38,13 +38,13 @@ class File < ::File
     #
     def read( name, *args )
       fd = new name, 'r'
-      fd.read *args
+      fd.read(*args)
     ensure
       fd.close unless fd.nil?
     end
 
     # call-seq:
-    #    Webby::File.readlines( name, sep_string = $/ )    => array
+    #    File.readlines( name, sep_string = $/ )    => array
     #
     # Reads the entire file specified by _name_ as individual lines, and
     # returns those lines in an array. Lines are separated by _sep_string_.
@@ -58,7 +58,7 @@ class File < ::File
     end
 
     # call-seq:
-    #    Webby::File.meta_data( name )    => object or nil
+    #    File.meta_data( name )    => object or nil
     #
     # Reads the meta-data from the file specified by _name_. +meta_data+
     # ensures the files is closed before returning.
@@ -71,7 +71,7 @@ class File < ::File
     end
 
     # call-seq:
-    #    Webby::File.dirname( filename )    => dir_name
+    #    File.dirname( filename )    => dir_name
     #
     # Returns all components of the _filename_ except the last one. The
     # filename must be formed using forward slashes ("/") regardless of the
@@ -82,7 +82,7 @@ class File < ::File
     end
 
     # call-seq:
-    #    Webby::File.basename( filename )    => base_name
+    #    File.basename( filename )    => base_name
     #
     # Returns the last component of the _filename_, which must be formed
     # using forward slashes ("/"regardless of the separator used on the
@@ -93,7 +93,7 @@ class File < ::File
     end
 
     # call-seq:
-    #    Webby::File.extname( filename )    => ext_name
+    #    File.extname( filename )    => ext_name
     #
     # Returns the extension (the portion of file name in path after the
     # period). This method excludes the period from the extension name.
@@ -104,16 +104,16 @@ class File < ::File
   end
 
   # call-seq:
-  #    Webby::File.new( filename, mode = "r" )          => file
-  #    Webby::File.new( filename [, mode [, perm]] )    => file
+  #    File.new( filename, mode = "r" )          => file
+  #    File.new( filename [, mode [, perm]] )    => file
   #
   # Opens the file named by _filename_ according to _mode_ (default is 'r')
-  # and returns a new +Webby::File+ object. See the description of class
-  # +IO+ for a description of _mode_. The file _mode_ may optionally be
-  # specified as a +Fixnum+ by or-ing together the flags (+O_RDONLY+ etc,
-  # again described under +IO+). Optional permission bits may be given in
-  # _perm_. These _mode_ and permission bits are platform dependent; on Unix
-  # systems, see +open(2)+ for details. 
+  # and returns a new +Webby::Resources::File+ object. See the description
+  # of class +IO+ for a description of _mode_. The file _mode_ may
+  # optionally be specified as a +Fixnum+ by or-ing together the flags
+  # (+O_RDONLY+ etc, again described under +IO+). Optional permission bits
+  # may be given in _perm_. These _mode_ and permission bits are platform
+  # dependent; on Unix systems, see +open(2)+ for details. 
   #
   #    f = File.new("testfile", "r")
   #    f = File.new("newfile",  "w+")
@@ -172,6 +172,9 @@ class File < ::File
     seek 0, IO::SEEK_END
   end
 
+  alias :_gets :gets
+  private :_gets
+
   %w(getc gets read read_nonblock readbytes readchar readline readlines readpartial scanf).each do |m|
     self.class_eval <<-CODE
       def #{m}(*a)
@@ -201,10 +204,10 @@ class File < ::File
     cur = tell
 
     seek 0
-    line = gets
+    line = _gets
     return unless META_SEP =~ line
 
-    while line = gets
+    while line = _gets
       break if META_SEP =~ line
     end
     return if line.nil?
@@ -215,6 +218,6 @@ class File < ::File
   end
 
 end  # class File
-end  # module Webby
+end  # module Webby::Resources
 
 # EOF

data/lib/webby/resources/layout.rb

@@ -0,0 +1,65 @@
+# $Id: layout.rb 167 2008-02-24 00:59:54Z tim_pease $
+
+require Webby.libpath(*%w[webby resources resource])
+
+module Webby::Resources
+
+# A Layout is any file that is found in the layout folder of the webiste
+# directory. Layouts container the common elements of all the pages in a
+# website, and pages from the content folder are rendered into the layout.
+#
+class Layout < Resource
+
+  # call-seq:
+  #    Layout.new( path )
+  #
+  # Creates a new Layout object given the full path to the layout file.
+  #
+  def initialize( fn )
+    super
+
+    @mdata = ::Webby::Resources::File.meta_data(@path)
+    @mdata ||= {}
+    @mdata.sanitize!
+  end
+
+  # call-seq:
+  #    destination    => string
+  #
+  # The output file destination for the layout. This is the ".cairn" file in
+  # the output folder. It is used to determine if the layout is newer than
+  # the build products.
+  #
+  def destination
+    ::Webby.cairn
+  end
+
+  # call-seq:
+  #    extension    => string or nil
+  #
+  # Returns the extension to be applied to output files rendered by the
+  # layotut. This will either be a string or +nil+ if the layout does not
+  # specify an extension to use.
+  #
+  def extension
+    return @mdata['extension'] if @mdata.has_key? 'extension'
+
+    if @mdata.has_key? 'layout'
+      lyt = ::Webby::Resources.layouts.find :filename => @mdata['layout']
+      ext = lyt ? lyt.extension : nil
+    end
+  end
+
+  # call-seq:
+  #    url    => nil
+  #
+  # Layouts do not have a URL. This method will alwasy return +nil+.
+  #
+  def url
+    nil
+  end
+
+end  # class Layout
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/resources/page.rb

@@ -0,0 +1,109 @@
+# $Id: page.rb 167 2008-02-24 00:59:54Z tim_pease $
+
+require Webby.libpath(*%w[webby resources resource])
+
+module Webby::Resources
+
+# A Page is a file in the content folder that contains YAML meta-data at
+# the top of the file. Pages are processed by the Webby rendering engine
+# and then inserted into the desired layout. The string resulting from
+# processing and layout is then written to the output directory.
+#
+class Page < Resource
+
+  # Resource page number (if needed)
+  attr_reader :number
+
+  # call-seq:
+  #    Resource.new( path )
+  #
+  # Creates a new page object from the full path to the page file.
+  #
+  def initialize( fn )
+    super
+    @number = nil
+
+    @mdata = ::Webby::Resources::File.meta_data(@path)
+    @mdata ||= {}
+    @mdata = ::Webby.site.page_defaults.merge(@mdata)
+    @mdata.sanitize!
+  end
+
+  # call-seq:
+  #    render   => string
+  #
+  # Creates a new Webby::Renderer instance and uses that instance to render
+  # the page contents using the configured filter(s). The filter(s) to
+  # use is defined in the page's meta-data as the 'filter' key.
+  #
+  # Note, this only renders this page. The returned string does not include
+  # any layout rendering.
+  #
+  def render( renderer = nil )
+    renderer ||= ::Webby::Renderer.new(self)
+    renderer.render_page
+  end
+
+  # call-seq:
+  #    page.number = Integer
+  #
+  # Sets the page number for the current resource to the given integer. This
+  # number is used to modify the output destination for resources that
+  # require pagination.
+  #
+  def number=( num )
+    @number = num
+    @dest = nil
+  end
+
+  # call-seq:
+  #    destination    => string
+  #
+  # Returns the path in the output directory where the rendered page should
+  # be stored. This path is used to determine if the page is dirty and in
+  # need of rendering.
+  #
+  # The destination for a page can be overridden by explicitly setting
+  # the 'destination' property in the page's meta-data.
+  #
+  def destination
+    return @dest if defined? @dest and @dest
+
+    @dest = if @mdata.has_key? 'destination' then @mdata['destination']
+            else ::File.join(dir, filename) end
+
+    @dest = ::File.join(::Webby.site.output_dir, @dest)
+    @dest << @number.to_s if @number
+
+    ext = extension
+    unless ext.nil? or ext.empty?
+      @dest << '.' << ext
+    end
+    @dest
+  end
+
+  # call-seq:
+  #    extension    => string
+  #
+  # Returns the extension that will be appended to the output destination
+  # filename. The extension is determined by looking at the following:
+  #
+  # * this page's meta-data for an 'extension' property
+  # * the meta-data of this page's layout for an 'extension' property
+  # * the extension of this page file
+  #
+  def extension
+    return @mdata['extension'] if @mdata.has_key? 'extension'
+
+    if @mdata.has_key? 'layout'
+      lyt = ::Webby::Resources.layouts.find :filename => @mdata['layout']
+      ext = lyt ? lyt.extension : nil
+      return ext if ext
+    end
+    @ext
+  end
+
+end  # class Page
+end  # module Webby::Resources
+
+# EOF