TwP-webby 0.9.0 → 0.9.1

data/lib/webby/renderer.rb

@@ -120,6 +120,8 @@ class Renderer
         ::Webby::Renderer.new(resource)._render_page
       when Resources::Partial
         _render_partial(resource, opts)
+      when Resources::Static
+        resource._read
       else
         raise ::Webby::Error, "expecting a page or a partial but got '#{resource.class.name}'"
       end
@@ -189,7 +191,7 @@ class Renderer
   #
   def _render_page
     _track_rendering(@page.path) {
-      Filters.process(self, @page, ::Webby::Resources::File.read(@page.path))
+      Filters.process(self, @page, @page._read)
     }
   end
 
@@ -203,7 +205,7 @@ class Renderer
   def _render_partial( part, opts = {} )
     _track_rendering(part.path) {
       _configure_locals(opts[:locals])
-      Filters.process(self, part, ::Webby::Resources::File.read(part.path))
+      Filters.process(self, part, part._read)
     }
   end
 
@@ -248,8 +250,7 @@ class Renderer
     return if lyt.nil?
 
     _track_rendering(lyt.path) {
-      @content = Filters.process(
-          self, lyt, ::Webby::Resources::File.read(lyt.path))
+      @content = Filters.process(self, lyt, lyt._read)
       _render_layout_for(lyt)
     }
   end
@@ -270,7 +271,8 @@ class Renderer
       @_content_for.clear
       @_bindings.clear
     else
-      @page.number = nil
+      @pager.pager.done
+      @pager = nil
       return false
     end
 

data/lib/webby/resources/db.rb

@@ -23,7 +23,7 @@ class DB
   # time if it already exists in the database.
   #
   def add( page )
-    ary = @db[page.dir]
+    ary = @db[page.directory]
 
     # make sure we don't duplicate pages
     ary.delete page if ary.include? page
@@ -183,7 +183,7 @@ class DB
   #   Reverse the order of the results
   #
   def siblings( page, opts = {} )
-    ary = @db[page.dir].dup
+    ary = @db[page.directory].dup
     ary.delete page
     return ary unless opts.has_key? :sort_by
 
@@ -207,7 +207,7 @@ class DB
   #   Reverse the order of the results
   #
   def children( page, opts = {} )
-    rgxp = Regexp.new "\\A#{page.dir}/[^/]+"
+    rgxp = Regexp.new "\\A#{page.directory}/[^/]+"
 
     keys = @db.keys.find_all {|k| rgxp =~ k}
     ary  = keys.map {|k| @db[k]}
@@ -229,7 +229,7 @@ class DB
   #  of the current directory or the next directory up the chain.
   #
   def parent_of( page )
-    dir = page.dir
+    dir = page.directory
 
     loop do
       if @db.has_key? dir

data/lib/webby/resources/layout.rb

@@ -16,41 +16,32 @@ class Layout < Resource
   def initialize( fn )
     super
 
-    @mdata = ::Webby::Resources::File.meta_data(@path)
-    @mdata ||= {}
-    @mdata.sanitize!
+    @_meta_data = MetaFile.meta_data(@path)
+    @_meta_data ||= {}
+    @_meta_data.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'
+    return _meta_data['extension'] if _meta_data.has_key? 'extension'
 
-    if @mdata.has_key? 'layout'
-      lyt = ::Webby::Resources.find_layout(@mdata['layout'])
-      ext = lyt ? lyt.extension : nil
+    if _meta_data.has_key? 'layout'
+      lyt = ::Webby::Resources.find_layout(_meta_data['layout'])
+      lyt ? lyt.extension : nil
     end
   end
 
-  # call-seq:
-  #    url    => nil
+  # 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
+
   # Layouts do not have a URL. This method will alwasy return +nil+.
   #
   def url

data/lib/webby/resources/meta_file.rb

@@ -0,0 +1,208 @@
+require 'yaml'
+
+module Webby::Resources
+
+# The MetaFile class is used to read meta-data and content from files. The
+# meta-data is in a YAML block located at the top of the file. The content
+# is the remainder of the file (everything after the YAML block).
+#
+# The meta-data data must be found between two YAML block separators "---",
+# each on their own line.
+#
+# Example:
+#
+#     ---
+#     layout: blog
+#     filter: markdown
+#     tags:
+#       - ruby
+#       - web development
+#     ---
+#     This is a blog entry formatted using MarkDown and tagged as "ruby" and
+#     "web development". The layout being used is the "blog" format.
+#
+class MetaFile
+
+  class Error < StandardError; end
+
+  META_SEP = %r/\A---\s*(?:\r\n|\n)?\z/   # :nodoc:
+  ERR_MSG = "corrupt meta-data (perhaps there is an errant YAML marker '---' in the file)" # :nodoc:
+
+  # call-seq:
+  #    MetaFile.read( filename )    => string
+  #
+  # Opens the file identified by _filename_ and returns the contents of the
+  # file as a string. Any meta-data at the top of the file is skipped and
+  # is not included in the returned string. If the file contains no
+  # meta-data, then this method behaves the same as File#read.
+  #
+  def self.read( name )
+    ::File.open(name, 'r') {|fd| MetaFile.new(fd).read}
+  end
+
+  # call-seq:
+  #    MetaFile.meta_data( filename )    => object or nil
+  #
+  # Opens the file identified by _filename_ and returns the meta-data
+  # located at the top of the file. If the file contains no meta-data, then
+  # +nil+ is returned.
+  #
+  def self.meta_data( name )
+    ::File.open(name, 'r') {|fd| MetaFile.new(fd).meta_data}
+  end
+
+  # call-seq:
+  #    MetaFile.meta_data?( filename )    => true or false
+  #
+  # Opens the file identified by _filename_ and returns true if there is a
+  # meta-data block at the top of the file, and returns false if there is
+  # not a meta-data block at the top of the file.
+  #
+  def self.meta_data?( name )
+    ::File.open(name, 'r') {|fd| MetaFile.new(fd).meta_data?}
+  end
+
+  # Creates a new MetaFile parser that will read from the given _io_ stream.
+  #
+  def initialize( io )
+    raise ArgumentError, "expecting an IO stream" unless io.respond_to? :gets
+    @io = io
+    @meta_count = 0
+  end
+
+  # Returns the entire contents of the IO stream exluding any meta-data
+  # found at the beginning of the stream.
+  #
+  def read
+    @io.seek(meta_end || 0)
+    @io.read
+  end
+
+  # Reads in each meta-data section and yields it to the given block. The
+  # first meta-data section is yielded "as is", but subsequent meta-data
+  # sections are merged with this first section and then yielded. This
+  # allows the user to define common items in the first meta-data section
+  # and only include items that are different in the subsequent sections.
+  #
+  # Example:
+  #
+  #    ---
+  #    title:      First Title
+  #    author:     me
+  #    directory:  foo/bar/baz
+  #    ---
+  #    title:      Second Title
+  #    author:     you
+  #    ---
+  #    title:      Third Title
+  #    author:     them
+  #    ---
+  #
+  # and parsing the meta-data above yields ...
+  #
+  #    meta_file.each do |hash|
+  #      pp hash
+  #    end
+  #
+  # the following output
+  #
+  #    { 'title' => 'First Title',
+  #      'author' => 'me',
+  #      'directory' => 'foo/bar/baz' }
+  #
+  #    { 'title' => 'Second Title',
+  #      'author' => 'you',
+  #      'directory' => 'foo/bar/baz' }
+  #
+  #    { 'title' => 'Third Title',
+  #      'author' => 'them',
+  #      'directory' => 'foo/bar/baz' }
+  #
+  # Even though the "directory" item only appears in the first meta-data
+  # block, it is copied to all the subsequent blocks.
+  #
+  def each
+    return unless meta_data?
+
+    first, count = nil, 0
+    @io.seek 0
+
+    buffer = @io.gets
+    while count < @meta_count
+      while (line = @io.gets) !~ META_SEP
+        buffer << line
+      end
+
+      h = YAML.load(buffer)
+      raise Error, ERR_MSG unless h.instance_of?(Hash)
+
+      if first then h = first.merge(h)
+      else first = h.dup end
+
+      buffer = line
+      count += 1
+
+      yield h
+    end
+  rescue ArgumentError => err
+    msg = ERR_MSG.dup << "\n\t-- " << err.message
+    raise Error, msg
+  end
+
+  # Returns the meta-data defined at the top of the file. Returns +nil+ if
+  # no meta-data is defined. The meta-data is returned as Ruby objects
+  #
+  # Meta-data is stored in YAML format between two YAML separators "---" on
+  # their own lines.
+  #
+  def meta_data
+    return if meta_end.nil?
+
+    @io.seek 0
+    return YAML.load(@io)
+  end
+
+  # Returns true if the IO stream contains meta-data. Returns false if the
+  # IO stream does not contain meta-data.
+  #
+  def meta_data?
+    meta_end.nil? ? false : true
+  end
+
+  # Returns the number of meta-data blocks at the top of the file.
+  #
+  def meta_count
+    meta_end
+    @meta_count
+  end
+
+  # Returns the position in the IO stream where the meta-data ends and the
+  # regular data begins. If there is no meta-data in the stream, returns +nil+.
+  #
+  def meta_end
+    return @meta_end if defined? @meta_end
+    @meta_end = nil
+
+    @io.seek 0
+    line = @io.read(4)
+    return unless META_SEP =~ line
+
+    @io.seek 0
+    pos = nil
+    buffer = @io.gets.length
+    while line = @io.gets
+      buffer += line.length
+      if META_SEP =~ line
+        pos = buffer
+        @meta_count += 1
+      end
+    end
+    return if pos.nil?
+
+    @meta_end = pos
+  end
+
+end  # class MetaFile
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/resources/page.rb

@@ -9,22 +9,22 @@ module Webby::Resources
 #
 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!
+  def initialize( fn, meta_data = nil )
+    super(fn)
+
+    if meta_data.instance_of?(Hash)
+      @_meta_data = meta_data
+    else
+      @_meta_data = MetaFile.meta_data(@path)
+      @_meta_data ||= {}
+    end
+    @_meta_data = ::Webby.site.page_defaults.merge(@_meta_data)
+    @_meta_data.sanitize!
   end
 
   # call-seq:
@@ -46,51 +46,13 @@ class Page < Resource
   # is returned for layouts.
   #
   def url
-    return @url if defined? @url and @url
+    return @url unless @url.nil?
 
-    @url = destination.sub(::Webby.site.output_dir, '')
-    @url = File.dirname(@url) if filename == 'index' and number.nil?
+    @url = super
+    @url = File.dirname(@url) if filename == 'index'
     @url
   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
-    @url = @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
   #
@@ -102,14 +64,15 @@ class Page < Resource
   # * the extension of this page file
   #
   def extension
-    return @mdata['extension'] if @mdata.has_key? 'extension'
+    return _meta_data['extension'] if _meta_data.has_key? 'extension'
 
-    if @mdata.has_key? 'layout'
-      lyt = ::Webby::Resources.find_layout(@mdata['layout'])
-      ext = lyt ? lyt.extension : nil
-      return ext if ext
+    if _meta_data.has_key? 'layout'
+      lyt = ::Webby::Resources.find_layout(_meta_data['layout'])
+      lyt_ext = lyt ? lyt.extension : nil
+      return lyt_ext if lyt_ext
     end
-    @ext
+
+    ext
   end
 
 end  # class Page

data/lib/webby/resources/partial.rb

@@ -24,9 +24,9 @@ class Partial < Resource
   def initialize( fn )
     super
 
-    @mdata = ::Webby::Resources::File.meta_data(@path)
-    @mdata ||= {}
-    @mdata.sanitize!
+    @_meta_data = MetaFile.meta_data(@path)
+    @_meta_data ||= {}
+    @_meta_data.sanitize!
   end
 
   # call-seq:
@@ -37,7 +37,7 @@ class Partial < Resource
   # copied (if a static file) to the output directory.
   #
   def dirty?
-    return @mdata['dirty'] if @mdata.has_key? 'dirty'
+    return _meta_data['dirty'] if _meta_data.has_key? 'dirty'
 
     # if the destination file does not exist, then we are dirty
     return true unless test(?e, destination)
@@ -73,6 +73,12 @@ class Partial < Resource
     nil
   end
 
+  # :stopdoc:
+  def _read
+    MetaFile.read(@path)
+  end
+  # :startdoc:
+
 end  # class Partial
 end  # module Webby::Resources
 

data/lib/webby/resources/resource.rb

@@ -16,31 +16,34 @@ class Resource
   # The full path to the resource file
   attr_reader :path
 
+  # The name of the file excluding the directory and extension
+  attr_reader :name
+
   # The directory of the resource excluding the content directory
   attr_reader :dir
 
-  # The resource filename excluding path and extension
-  attr_reader :filename
-
   # Extesion of the resource file
   attr_reader :ext
 
   # Resource file modification time
   attr_reader :mtime
 
+  attr_reader :_meta_data  #:nodoc:
+
   # call-seq:
   #    Resource.new( filename )    => resource
   #
   # Creates a new resource object given the _filename_.
   #
   def initialize( fn )
-    @path     = fn
-    @dir      = ::Webby::Resources::File.dirname(@path)
-    @filename = ::Webby::Resources::File.basename(@path)
-    @ext      = ::Webby::Resources::File.extname(@path)
-    @mtime    = ::File.mtime @path
-
-    @mdata = @@mdata ||= {}
+    @path  = fn
+    @dir   = ::Webby::Resources.dirname(@path)
+    @name  = ::Webby::Resources.basename(@path)
+    @ext   = ::Webby::Resources.extname(@path)
+    @mtime = ::File.mtime @path
+
+    @_meta_data =  {}
+    self._reset
   end
 
   # call-seq:
@@ -51,7 +54,7 @@ class Resource
   #
   def equal?( other )
     return false unless other.kind_of? ::Webby::Resources::Resource
-    @path == other.path
+    self.destination == other.destination
   end
   alias :== :equal?
   alias :eql? :equal?
@@ -65,7 +68,7 @@ class Resource
   #
   def <=>( other )
     return unless other.kind_of? ::Webby::Resources::Resource
-    @path <=> other.path
+    self.destination <=> other.destination
   end
 
   # call-seq:
@@ -75,7 +78,7 @@ class Resource
   # converted into a string.
   #
   def []( key )
-    @mdata[key.to_s]
+    _meta_data[key.to_s]
   end
 
   # call-seq:
@@ -85,7 +88,7 @@ class Resource
   # string.
   #
   def []=( key, value )
-    @mdata[key.to_s] = value
+    _meta_data[key.to_s] = value
   end
 
   # call-seq:
@@ -97,7 +100,7 @@ class Resource
   # meta-data item is returned; otherwise, +nil+ is returned.
   #
   def method_missing( name, *a, &b )
-    @mdata[name.to_s]
+    _meta_data[name.to_s]
   end
 
   # call-seq:
@@ -108,7 +111,7 @@ class Resource
   # copied (if a static file) to the output directory.
   #
   def dirty?
-    return @mdata['dirty'] if @mdata.has_key? 'dirty'
+    return _meta_data['dirty'] if _meta_data.has_key? 'dirty'
 
     # if the destination file does not exist, then we are dirty
     return true unless test(?e, destination)
@@ -120,8 +123,8 @@ class Resource
 
     # check to see if the layout is dirty, and if it is then we
     # are dirty, too
-    if @mdata.has_key? 'layout'
-      lyt = ::Webby::Resources.find_layout(@mdata['layout'])
+    if _meta_data.has_key? 'layout'
+      lyt = ::Webby::Resources.find_layout(_meta_data['layout'])
       unless lyt.nil?
         return true if lyt.dirty?
       end
@@ -131,24 +134,62 @@ class Resource
     false
   end
 
-  # call-seq
-  #    url    => string or nil
+  # The resource filename excluding path and extension. This will either be
+  # the name of the file or the 'filename' attribute from the meta-data if
+  # present.
   #
-  # Returns a string suitable for use as a URL linking to this page. Nil
-  # is returned for layouts.
+  def filename
+    return _meta_data['filename'] if _meta_data.has_key? 'filename'
+    name
+  end
+
+  # The resource file extension. This will either be the extension of the
+  # file or the 'extension' attribute from the meta-data if present.
+  #
+  def extension
+    return _meta_data['extension'] if _meta_data.has_key? 'extension'
+    ext
+  end
+
+  # The location of this resource in the directory structure. This directory
+  # does not include the content folder or the output folder.
+  #
+  def directory
+    return _meta_data['directory'] if _meta_data.has_key? 'directory'
+    dir
+  end
+
+  # Returns the path in the output directory where the resource will be
+  # generated. This path is used to determine if the resource is dirty
+  # and in need of generating.
+  #
+  def destination
+    return @destination unless @destination.nil?
+
+    @destination = ::File.join(::Webby.site.output_dir, directory, filename)
+    ext = extension
+    unless ext.nil? or ext.empty?
+      @destination << '.' << ext
+    end
+    @destination
+  end
+
+  # Returns a string suitable for use as a URL linking to this resource.
   #
   def url
-    return @url if defined? @url and @url
+    return @url unless @url.nil?
     @url = destination.sub(::Webby.site.output_dir, '')
   end
 
   # :stopdoc:
-  def destination
-    raise NotImplementedError
+  def _read
+    MetaFile.read(@path)
   end
 
-  def extension
-    raise NotImplementedError
+  def _reset( meta_data = nil )
+    _meta_data.replace(meta_data) if meta_data.instance_of?(Hash)
+    @url = nil
+    @destination = nil
   end
   # :startdoc: