Shazburg-webby 0.9.0

data/lib/webby/resources/layout.rb

@@ -0,0 +1,63 @@
+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.find_layout(@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,118 @@
+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
+  #
+  # This method is being deprecated. Please use the +Renderer#render+ method
+  # instead.
+  #
+  def render( renderer = nil )
+    Webby.deprecated "render", "it is being replaced by the Renderer#render() method"
+    renderer ||= ::Webby::Renderer.new(self)
+    renderer._render_page
+  end
+
+  # call-seq
+  #    url    => string or nil
+  #
+  # Returns a string suitable for use as a URL linking to this page. Nil
+  # is returned for layouts.
+  #
+  def url
+    return @url if defined? @url and @url
+
+    @url = destination.sub(::Webby.site.output_dir, '')
+    @url = File.dirname(@url) if filename == 'index' and number.nil?
+    @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
+  #
+  # 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.find_layout(@mdata['layout'])
+      ext = lyt ? lyt.extension : nil
+      return ext if ext
+    end
+    @ext
+  end
+
+end  # class Page
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/resources/partial.rb

@@ -0,0 +1,79 @@
+require Webby.libpath(*%w[webby resources resource])
+
+module Webby::Resources
+
+# A Partial is a file in the content folder whose filename starts with an
+# underscore "_" character. Partials contain text that can be included into
+# other pages. Partials are not standalone pages, and they will never
+# correspond directly to an output file.
+#
+# Partials can contain YAML meta-data at the top of the file. This
+# information is only used to determine the filters to apply to the
+# partial. If there is no meta-data, then the partial text is used "as is"
+# without any processing by the Webby rendering engine.
+#
+class Partial < Resource
+
+  # call-seq:
+  #    Partial.new( path )
+  #
+  # Creates a new Partial object given the full path to the partial file.
+  # Partial filenames start with an underscore (this is an enforced
+  # convention).
+  #
+  def initialize( fn )
+    super
+
+    @mdata = ::Webby::Resources::File.meta_data(@path)
+    @mdata ||= {}
+    @mdata.sanitize!
+  end
+
+  # call-seq:
+  #    dirty?    => true or false
+  #
+  # Returns +true+ if this resource is newer than its corresponding output
+  # product. The resource needs to be rendered (if a page or layout) or
+  # copied (if a static file) to the output directory.
+  #
+  def dirty?
+    return @mdata['dirty'] if @mdata.has_key? 'dirty'
+
+    # if the destination file does not exist, then we are dirty
+    return true unless test(?e, destination)
+
+    # if this file's mtime is larger than the destination file's
+    # mtime, then we are dirty
+    dirty = @mtime > ::File.mtime(destination)
+    return dirty if dirty
+
+    # if we got here, then we are not dirty
+    false
+  end
+
+  # call-seq:
+  #    destination    => string
+  #
+  # The output file destination for the partial. This is the ".cairn" file in
+  # the output folder. It is used to determine if the partial is newer than
+  # the build products.
+  #
+  def destination
+    ::Webby.cairn
+  end
+
+  alias :extension :ext
+
+  # call-seq:
+  #    url    => nil
+  #
+  # Partials do not have a URL. This method will alwasy return +nil+.
+  #
+  def url
+    nil
+  end
+
+end  # class Partial
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/resources/resource.rb

@@ -0,0 +1,160 @@
+unless defined? Webby::Resources::Resource
+
+module Webby::Resources
+
+# A Webby::Resource is any file that can be found in the content directory
+# or in the layout directory. This class contains information about the
+# resources available to Webby.
+#
+class Resource
+
+  instance_methods.each do |m|
+      undef_method(m) unless m =~ %r/\A__|\?$/ ||
+                             m == 'class'
+  end
+
+  # The full path to the resource file
+  attr_reader :path
+
+  # 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
+
+  # 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 ||= {}
+  end
+
+  # call-seq:
+  #    equal?( other )    => true or false
+  #
+  # Returns +true+ if the path of this resource is equivalent to the path of
+  # the _other_ resource. Returns +false+ if this is not the case.
+  #
+  def equal?( other )
+    return false unless other.kind_of? ::Webby::Resources::Resource
+    @path == other.path
+  end
+  alias :== :equal?
+  alias :eql? :equal?
+
+  # call-seq:
+  #    resource <=> other    => -1, 0, +1, or nil
+  #
+  # Resource comparison operates on the full path of the resource objects
+  # and uses the standard String comparison operator. Returns +nil+ if
+  # _other_ is not a Resource instance.
+  #
+  def <=>( other )
+    return unless other.kind_of? ::Webby::Resources::Resource
+    @path <=> other.path
+  end
+
+  # call-seq:
+  #    resource[key]    => value or nil
+  #
+  # Returns the value associated with the given meta-data key. Key is
+  # converted into a string.
+  #
+  def []( key )
+    @mdata[key.to_s]
+  end
+
+  # call-seq:
+  #    resource[key] = value
+  #
+  # Sets the given meta-data key to the value. Key is converted into a
+  # string.
+  #
+  def []=( key, value )
+    @mdata[key.to_s] = value
+  end
+
+  # call-seq:
+  #    method_missing( symbol [, *args, &block] )    => result
+  #
+  # Invoked by Ruby when a message is sent to the resource that it cannot
+  # handle. The default behavior is to convert _symbol_ to a string and
+  # search for that string in the resource's meta-data. If found, the
+  # meta-data item is returned; otherwise, +nil+ is returned.
+  #
+  def method_missing( name, *a, &b )
+    @mdata[name.to_s]
+  end
+
+  # call-seq:
+  #    dirty?    => true or false
+  #
+  # Returns +true+ if this resource is newer than its corresponding output
+  # product. The resource needs to be rendered (if a page or layout) or
+  # copied (if a static file) to the output directory.
+  #
+  def dirty?
+    return @mdata['dirty'] if @mdata.has_key? 'dirty'
+
+    # if the destination file does not exist, then we are dirty
+    return true unless test(?e, destination)
+
+    # if this file's mtime is larger than the destination file's
+    # mtime, then we are dirty
+    dirty = @mtime > ::File.mtime(destination)
+    return dirty if dirty
+
+    # 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'])
+      unless lyt.nil?
+        return true if lyt.dirty?
+      end
+    end
+
+    # if we got here, then we are not dirty
+    false
+  end
+
+  # call-seq
+  #    url    => string or nil
+  #
+  # Returns a string suitable for use as a URL linking to this page. Nil
+  # is returned for layouts.
+  #
+  def url
+    return @url if defined? @url and @url
+    @url = destination.sub(::Webby.site.output_dir, '')
+  end
+
+  # :stopdoc:
+  def destination
+    raise NotImplementedError
+  end
+
+  def extension
+    raise NotImplementedError
+  end
+  # :startdoc:
+
+end  # class Resource
+end  # module Webby::Resources
+
+end  # unless defined?
+
+# EOF

data/lib/webby/resources/static.rb

@@ -0,0 +1,52 @@
+require Webby.libpath(*%w[webby resources resource])
+
+module Webby::Resources
+
+# A Static resource is any file in the content folder that does not
+# contain YAML meta-data at the top of the file and does not start with
+# and underscore "_" character (those are partials). Static resources will
+# be copied as-is from the content directory to the output directory.
+#
+class Static < Resource
+
+  # call-seq:
+  #    render   => string
+  #
+  # Returns the contents of the file.
+  #
+  def render
+    ::File.read(path)
+  end
+
+  # call-seq:
+  #    dirty?    => true or false
+  #
+  # Returns +true+ if this static file is newer than its corresponding output
+  # product. The static file needs to be copied to the output directory.
+  #
+  def dirty?
+    return true unless test(?e, destination)
+    @mtime > ::File.mtime(destination)
+  end
+
+  # call-seq:
+  #    destination    => string
+  #
+  # Returns the path in the output directory where the static file should
+  # be copied. This path is used to determine if the static file is dirty
+  # and in need of copying to the output file.
+  #
+  def destination
+    return @dest if defined? @dest and @dest
+
+    @dest = ::File.join(::Webby.site.output_dir, dir, filename)
+    @dest << '.' << @ext if @ext and !@ext.empty?
+    @dest
+  end
+
+  alias :extension :ext
+
+end  # class Layout
+end  # module Webby::Resources
+
+# EOF