webby 0.9.0 → 0.9.1

data/lib/webby.rb

@@ -18,9 +18,10 @@ Logging::Appender.stdout.layout = Logging::Layouts::Pattern.new(
 module Webby
 
   # :stopdoc:
-  VERSION = '0.9.0'   # :nodoc:
+  VERSION = '0.9.1'   # :nodoc:
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  YAML_SEP = '---'
   # :startdoc:
 
   class Error < StandardError; end  # :nodoc:

data/lib/webby/apps/main.rb

@@ -37,10 +37,12 @@ class Main
     opts.banner = 'Usage: webby [options] target [target args]'
 
     opts.separator ''
-    opts.on('-D', '--describe [PATTERN]', 'describe the tasks (matching optional PATTERN), then exit') {|pattern| app.do_option('--describe', pattern)}
-    opts.on('-P', '--prereqs', 'display the tasks and dependencies, then exit') {app.do_option('--prereqs', nil)}
-    opts.on('-T', '--tasks [PATTERN]', 'display the tasks (matching optional PATTERN) with descriptions, then exit') {|pattern| app.do_option('--tasks', pattern)}
-    opts.on('-t', '--trace', 'turn on invoke/execute tracing, enable full backtrace') {app.do_option('--trace', nil)}
+
+    desired_opts = %[--describe --prereqs --tasks --trace]
+    app.standard_rake_options.each do |options|
+      next unless desired_opts.include?(options.first)
+      opts.on(*options)
+    end
 
     opts.separator ''
     opts.separator 'common options:'
@@ -75,9 +77,10 @@ class Main
   #
   def init( args )
     # Make sure we're in a folder with a Sitefile
-    app.do_option('--rakefile', 'Sitefile')
-    app.do_option('--nosearch', nil)
-    app.do_option('--silent', nil)
+    options = app.standard_rake_options
+    [['--rakefile', 'Sitefile'],
+     ['--no-search', nil],
+     ['--silent', nil]].each {|opt, value| options.assoc(opt).last.call(value)}
 
     unless app.have_rakefile
       raise RuntimeError, "Sitefile not found"
@@ -104,6 +107,12 @@ class Main
     Rake.application
   end
 
+  # Returns the options hash from the Rake application object.
+  #
+  def options
+    app.options
+  end
+
   # Search for the "Sitefile" starting in the current directory and working
   # upwards through the filesystem until the root of the filesystem is
   # reached. If a "Sitefile" is not found, a RuntimeError is raised.
@@ -144,12 +153,15 @@ class Main
     dir = ::File.dirname(dashed)
 
     args.dir   = ('.' == dir ? '' : dir)
-    args.slug  = ::Webby::Resources::File.basename(dashed).to_url
-    args.title = ::Webby::Resources::File.basename(spaced).titlecase
+    args.slug  = ::Webby::Resources.basename(dashed).to_url
+    args.title = ::Webby::Resources.basename(spaced).titlecase
 
     # page should be dir/slug without leading /
     args.page  = ::File.join(args.dir, args.slug).gsub(/^\//, '')
 
+    ext = ::File.extname(dashed)
+    args.page << ext unless ext.empty?
+
     ::Webby.site.args = args
     Object.const_set(:SITE, Webby.site)
     args
@@ -184,10 +196,10 @@ class Rake::Application
       end
     else
       width = displayable_tasks.collect { |t| t.name_with_args.length }.max || 10
-      max_column = 80 - name.size - width - 7
+      max_column = truncate_output? ? terminal_width - name.size - width - 7 : nil
       displayable_tasks.each do |t|
         printf "#{name} %-#{width}s  # %s\n",
-          t.name_with_args, truncate(t.comment, max_column)
+          t.name_with_args, max_column ? truncate(t.comment, max_column) : t.comment
       end
     end
   end
@@ -199,12 +211,12 @@ class Rake::Application
     rescue SystemExit => ex
       # Exit silently with current status
       exit(ex.status)
-    rescue SystemExit, GetoptLong::InvalidOption => ex
+    rescue SystemExit, OptionParser::InvalidOption => ex
       # Exit silently
       exit(1)
     rescue Exception => ex
       # Exit with error message
-      $stderr.puts "webby aborted!"
+      $stderr.puts "#{name} aborted!"
       $stderr.puts ex.message
       if options.trace
         $stderr.puts ex.backtrace.join("\n")

data/lib/webby/auto_builder.rb

@@ -30,6 +30,8 @@ class AutoBuilder
     @log = Logging::Logger[self]
 
     @builder = Builder.new
+    @builder.load_files
+
     @watcher = DirectoryWatcher.new '.', :interval => 2
     @watcher.add_observer self
 

data/lib/webby/builder.rb

@@ -35,8 +35,8 @@ class Builder
       tmpl = opts[:from]
       raise Error, "template not given" unless tmpl
 
-      name = ::Webby::Resources::File.basename(page)
-      ext  = ::Webby::Resources::File.extname(page)
+      name = ::Webby::Resources.basename(page)
+      ext  = ::Webby::Resources.extname(page)
       dir  = ::File.dirname(page)
       dir  = '' if dir == '.'
 
@@ -157,9 +157,6 @@ class Builder
     nil
   end
 
-
-  private
-
   # Scan the <code>layouts/</code> folder and the <code>content/</code>
   # folder and create a new Resource object for each file found there.
   #

data/lib/webby/filters.rb

@@ -5,7 +5,7 @@ module Filters
     
     # Register a handler for a filter
     def register( filter, &block )
-      handlers[filter.to_s] = block
+      _handlers[filter.to_s] = block
     end
     
     # Process input through filters
@@ -16,15 +16,11 @@ module Filters
     
     # Access a filter handler
     def []( name )
-      handlers[name]
+      _handlers[name]
     end
       
-    #######
-    private
-    #######
-
     # The registered filter handlers
-    def handlers
+    def _handlers
       @handlers ||= {}
     end
     
@@ -53,7 +49,7 @@ module Filters
           raise ::Webby::Error, "unknown filter: #{filter.inspect}" if handler.nil?
 
           args = [result, self][0, handler.arity]
-          handle(filter, handler, *args)
+          _handle(filter, handler, *args)
         end
       ensure
         @renderer.instance_variable_set(:@_cursor, @prev_cursor)
@@ -69,12 +65,8 @@ module Filters
         filters[@processed]
       end
       
-      #######
-      private
-      #######
-
       # Process arguments through a single filter
-      def handle(filter, handler, *args)
+      def _handle(filter, handler, *args)
         result = handler.call(*args)
         @processed += 1
         result

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.rb

@@ -44,25 +44,36 @@ module Webby::Resources
       end
 
       # see if we are dealing with a partial
-      filename = ::Webby::Resources::File.basename(fn)
+      filename = self.basename(fn)
       if %r/\A_/o =~ filename
         r = ::Webby::Resources::Partial.new(fn)
         self.partials << r
         return r
       end
 
-      # see if we are dealing with a static resource
-      meta = ::Webby::Resources::File.meta_data(fn)
-      if meta.nil?
-        r = ::Webby::Resources::Static.new(fn)
-        self.pages << r
-        return r
+      begin
+        fd = ::File.open(fn, 'r')
+        mf = MetaFile.new fd
+
+        # see if we are dealing with a static resource
+        unless mf.meta_data?
+          r = ::Webby::Resources::Static.new(fn)
+          self.pages << r
+          return r
+        end
+
+        # this is a renderable page
+        mf.each do |meta_data|
+          r = ::Webby::Resources::Page.new(fn, meta_data)
+          self.pages << r
+          r
+        end
+      rescue MetaFile::Error => err
+        logger.error "error loading file #{fn.inspect}"
+        logger.error err
+      ensure
+        fd.close if fd
       end
-
-      # this is a renderable page
-      r = ::Webby::Resources::Page.new(fn)
-      self.pages << r
-      return r
     end
 
     # Returns a normalized path for the given filename.
@@ -77,7 +88,7 @@ module Webby::Resources
     def find_layout( filename )
       return if filename.nil?
 
-      fn  = ::Webby::Resources::File.basename(filename)
+      fn  = self.basename(filename)
       dir = ::File.dirname(filename)
       dir = '.' == dir ? '' : dir
 
@@ -87,8 +98,37 @@ module Webby::Resources
       raise Webby::Error, "could not find layout #{filename.inspect}"
     end
 
-  end  # class << self
+    # Returns the directory component of the _filename_ with the content
+    # directory removed from the beginning if it is present.
+    #
+    def dirname( filename )
+      rgxp = %r/\A(?:#{::Webby.site.content_dir}|#{::Webby.site.layout_dir})\//o
+      dirname = ::File.dirname(filename)
+      dirname << '/' if dirname.index(?/) == nil
+      dirname.sub(rgxp, '')
+    end
+
+    # Returns the last component of the _filename_ with any extension
+    # information removed.
+    #
+    def basename( filename )
+      ::File.basename(filename, '.*')
+    end
+
+    # Returns the extension (the portion of file name in path after the
+    # period). This method excludes the period from the extension name.
+    #
+    def extname( filename )
+      ::File.extname(filename).tr('.', '')
+    end
 
+    # :stopdoc:
+    def logger
+      @logger ||= ::Logging::Logger[self]
+    end
+    # :startdoc:
+
+  end  # class << self
 end  # module Webby::Resources
 
 Webby.require_all_libs_relative_to(__FILE__)

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