jamesgolick-webby 0.9.5

data/lib/webby/resources/page.rb

@@ -0,0 +1,81 @@
+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
+
+  # call-seq:
+  #    Resource.new( path )
+  #
+  # Creates a new page object from the full path to the page file.
+  #
+  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:
+  #    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 unless @url.nil?
+
+    @url = super
+    @url = File.dirname(@url) if filename == 'index'
+    @url
+  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 _meta_data['extension'] if _meta_data.has_key? 'extension'
+
+    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
+  end
+
+end  # class Page
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/resources/partial.rb

@@ -0,0 +1,85 @@
+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
+
+    @_meta_data = MetaFile.meta_data(@path)
+    @_meta_data ||= {}
+    @_meta_data.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 _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)
+
+    # 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
+
+  # :stopdoc:
+  def _read
+    MetaFile.read(@path)
+  end
+  # :startdoc:
+
+end  # class Partial
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/resources/resource.rb

@@ -0,0 +1,201 @@
+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 name of the file excluding the directory and extension
+  attr_reader :name
+
+  # The directory of the resource excluding the content directory
+  attr_reader :dir
+
+  # 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.dirname(@path)
+    @name  = ::Webby::Resources.basename(@path)
+    @ext   = ::Webby::Resources.extname(@path)
+    @mtime = ::File.mtime @path
+
+    @_meta_data =  {}
+    self._reset
+  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
+    (self.destination == other.destination) && (self.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
+    self.destination <=> other.destination
+  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 )
+    _meta_data[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 )
+    _meta_data[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 )
+    _meta_data[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 _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)
+
+    # 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 _meta_data.has_key? 'layout'
+      lyt = ::Webby::Resources.find_layout(_meta_data['layout'])
+      unless lyt.nil?
+        return true if lyt.dirty?
+      end
+    end
+
+    # if we got here, then we are not dirty
+    false
+  end
+
+  # 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.
+  #
+  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 unless @url.nil?
+    @url = destination.sub(::Webby.site.output_dir, '')
+  end
+
+  # :stopdoc:
+  def _read
+    MetaFile.read(@path)
+  end
+
+  def _reset( meta_data = nil )
+    _meta_data.replace(meta_data) if meta_data.instance_of?(Hash)
+    @url = nil
+    @destination = nil
+  end
+  # :startdoc:
+
+end  # class Resource
+end  # module Webby::Resources
+
+end  # unless defined?
+
+# EOF

data/lib/webby/resources/static.rb

@@ -0,0 +1,36 @@
+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
+
+  # Returns the contents of the file.
+  #
+  def render
+    Webby.deprecated "render", "it is being replaced by the Renderer#render() method"
+    self._read
+  end
+
+  # 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
+
+  # :stopdoc:
+  def _read
+    ::File.read(path)
+  end
+  # :startdoc:
+
+end  # class Layout
+end  # module Webby::Resources
+
+# EOF

data/lib/webby/stelan/mktemp.rb

@@ -0,0 +1,135 @@
+# :stopdoc:
+# Skeleton module for the 'mktemp' routine.
+#
+# Ideally, one would do this in their code to import the "mktemp" call
+# directly into their current namespace:
+#
+#     require 'mktemp'
+#     include MkTemp
+#     # do something with mktemp()
+#
+#
+# It is recommended that you look at the documentation for the mktemp()
+# call directly for specific usage.
+#
+#--
+#
+# The compilation of software known as mktemp.rb is distributed under the
+# following terms:
+# Copyright (C) 2005-2006 Erik Hollensbe. All rights reserved.
+#
+# Redistribution and use in source form, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+#++
+
+module Webby
+module MkTemp
+  VALID_TMPNAM_CHARS = (?a..?z).to_a + (?A..?Z).to_a
+
+  #
+  # This routine just generates a temporary file similar to the
+  # routines from 'mktemp'. A trailing series of 'X' characters will
+  # be transformed into a randomly-generated set of alphanumeric
+  # characters.
+  # 
+  # This routine performs no file testing, at all. It is not suitable
+  # for anything beyond that.
+  #
+  
+  def tmpnam(filename)
+    m = filename.match(/(X*)$/)
+    
+    retnam = filename.dup
+    
+    if m[1]
+      mask = ""
+      m[1].length.times { mask += VALID_TMPNAM_CHARS[rand(52)].chr }
+      retnam.sub!(/(X*)$/, mask) 
+    end
+
+    return retnam
+  end
+  
+  module_function :tmpnam
+
+  #
+  # This routine works similarly to mkstemp(3) in that it gets a new
+  # file, and returns a file handle for that file. The mask parameter
+  # determines whether or not to process the filename as a mask by
+  # calling the tmpnam() routine in this module. This routine will
+  # continue until it finds a valid filename, which may not do what
+  # you expect.
+  #
+  # While all attempts have been made to keep this as secure as
+  # possible, due to a few problems with Ruby's file handling code, we
+  # are required to allow a few concessions. If a 0-length file is
+  # created before we attempt to create ours, we have no choice but to
+  # accept it. Do not rely on this code for any expected level of
+  # security, even though we have taken all the measures we can to
+  # handle that situation.
+  #
+
+  def mktemp(filename, mask=true)
+    fh = nil
+
+    begin 
+      loop do
+        fn = mask ? tmpnam(filename) : filename
+
+        if File.exist? fn
+          fail "Unable to create a temporary filename" unless mask
+          next
+        end
+
+        fh = File.new(fn, "a", 0600)
+        fh.seek(0, IO::SEEK_END)
+        break if fh.pos == 0 
+  
+        fail "Unable to create a temporary filename" unless mask
+        fh.close
+      end
+    rescue Exception => e
+      # in the case that we hit a locked file...
+      fh.close if fh
+      raise e unless mask
+    end
+    
+    return fh
+  end
+
+  module_function :mktemp
+
+  # 
+  # Create a directory. If mask is true (default), it will use the
+  # random name generation rules from the tmpnam() call in this
+  # module.
+  #
+ 
+  def mktempdir(filename, mask=true)
+    fn = mask ? tmpnam(filename) : filename
+    Dir.mkdir(fn)
+    return fn
+  end
+
+  module_function :mktempdir
+end  # module MkTemp
+end  # module Webby
+
+# :startdoc:
+# EOF