webby 0.7.4 → 0.8.0

data/lib/webby/auto_builder.rb

@@ -1,4 +1,4 @@
-# $Id: auto_builder.rb 60 2007-12-04 05:05:50Z tim_pease $
+# $Id: auto_builder.rb 167 2008-02-24 00:59:54Z tim_pease $
 
 require 'directory_watcher'
 
@@ -11,6 +11,8 @@ module Webby
 #
 class AutoBuilder
 
+  # TODO: hit Ctrl-C once to rebuild everything, and hit it twice to stop the autobuild loop
+
   # call-seq:
   #    AutoBuilder.run
   #
@@ -54,7 +56,7 @@ class AutoBuilder
       @log.debug "changed #{evt.path}"
       next unless test ?f, evt.path
       next if evt.path =~ ::Webby.exclude
-      Resource.new evt.path
+      Resources.new evt.path
     end
 
     @builder.run :load_files => false

data/lib/webby/builder.rb

@@ -1,4 +1,4 @@
-# $Id: builder.rb 92 2008-01-03 19:41:51Z tim_pease $
+# $Id: builder.rb 167 2008-02-24 00:59:54Z tim_pease $
 
 require 'find'
 require 'fileutils'
@@ -90,7 +90,7 @@ class Builder
     load_files if opts[:load_files]
     loop_check
 
-    Resource.pages.each do |page|
+    Resources.pages.each do |page|
       next unless page.dirty? or opts[:rebuild]
 
       @log.info "creating #{page.destination}"
@@ -99,8 +99,9 @@ class Builder
       FileUtils.mkdir_p ::File.dirname(page.destination)
 
       # copy the resource to the output directory if it is static
-      if page.is_static?
+      if page.instance_of? Resources::Static
         FileUtils.cp page.path, page.destination
+        FileUtils.chmod 0644, page.destination
 
       # otherwise, layout the resource and write the results to
       # the output directory
@@ -123,7 +124,7 @@ class Builder
     ::Find.find(layout_dir, content_dir) do |path|
       next unless test ?f, path
       next if path =~ ::Webby.exclude
-      Resource.new path
+      Resources.new path
     end
   end
 
@@ -132,7 +133,7 @@ class Builder
   # error if one is detected.
   #
   def loop_check
-    layouts = Resource.layouts
+    layouts = Resources.layouts
 
     layouts.each do |lyt|
       stack = []

data/lib/webby/filters.rb

@@ -1,4 +1,4 @@
-# $Id: filters.rb 68 2007-12-09 07:45:37Z tim_pease $
+# $Id: filters.rb 179 2008-02-29 04:47:19Z tim_pease $
 
 module Webby
 module Filters
@@ -47,11 +47,14 @@ module Filters
       end
       
       def start_for(input)
+        @renderer.instance_variable_set(:@_cursor, self)
         filters.inject(input) do |result, filter|
           handler = Filters[filter]
           args = [result, self][0, handler.arity]
           handle(filter, handler, *args)
         end
+      ensure
+        @renderer.instance_variable_set(:@_cursor, nil)
       end
       
       # The list of filters yet to be processed
@@ -73,12 +76,6 @@ module Filters
         result = handler.call(*args)
         @processed += 1
         result
-      rescue NameError => e
-        @log.fatal "Name error in filter `#{filter}' (missing dependency?): #{e.message}"
-        exit 1
-      rescue => e
-        @log.fatal "Error in filter `#{filter}': #{e.message}"
-        exit 1
       end
       
     end  # class Cursor
@@ -87,4 +84,6 @@ module Filters
 end  # module Filters
 end  # module Webby
 
+Webby.require_all_libs_relative_to(__FILE__)
+
 # EOF

data/lib/webby/filters/outline.rb

@@ -1,4 +1,4 @@
-# $Id: outline.rb 151 2008-02-15 21:09:47Z tim_pease $
+# $Id: outline.rb 181 2008-02-29 05:09:49Z tim_pease $
 
 require 'hpricot'
 
@@ -27,7 +27,9 @@ module Filters
 class Outline
   include ERB::Util
 
-  class Error < StandardError; end    # :nodoc:
+  # :stopdoc:
+  class Error < StandardError; end
+  # :startdoc:
 
   # call-seq:
   #    Outline.new( html )

data/lib/webby/filters/tidy.rb

@@ -1,4 +1,4 @@
-# $Id: tidy.rb 68 2007-12-09 07:45:37Z tim_pease $
+# $Id: tidy.rb 181 2008-02-29 05:09:49Z tim_pease $
 
 require 'fileutils'
 require 'tempfile'
@@ -20,7 +20,9 @@ module Filters
 #
 class Tidy
 
-  class Error < StandardError; end    # :nodoc:
+  # :stopdoc:
+  class Error < StandardError; end
+  # :startdoc:
 
   # call-seq:
   #    Tidy.new( html )

data/lib/webby/helpers.rb

@@ -0,0 +1,32 @@
+# $Id: helpers.rb 167 2008-02-24 00:59:54Z tim_pease $
+
+require Webby.libpath(*%w[webby renderer])
+
+module Webby
+
+# The Helpers module is used to register helper modules that provide extra
+# functionality to the Webby renderer. The most notable example is the
+# UrlHelpers module that provides methods to link to another page in a
+# Webby webiste.
+#
+# Helpers are registered with the Webby framework by calling:
+#
+#    Webby::Helpers.register( MyHelper )
+#
+module Helpers
+
+  # call-seq:
+  #    Helpers.register( module )
+  #
+  # Register the given _module_ as a helper module for the Webby framework.
+  #
+  def self.register( helper )
+    ::Webby::Renderer.__send__( :include, helper )
+  end
+
+end  # module Helper
+end  # module Webby
+
+Webby.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/webby/helpers/coderay_helper.rb

@@ -0,0 +1,78 @@
+# $Id: coderay_helper.rb 155 2008-02-17 00:48:30Z tim_pease $
+
+if try_require 'coderay'
+require 'enumerator'
+
+module Webby::Helpers
+module CodeRayHelper
+
+  # The +coderay+ method applies syntax highlighting to source code embedded
+  # in a webpage. The CodeRay highlighting engine is used for the HTML
+  # markup of the source code. The page sections to be highlighted are given
+  # as blocks of text to the +coderay+ method.
+  #
+  # Options can be passed to the CodeRay engine via attributes in the
+  # +coderay+ method.
+  #
+  #    <% coderay( :lang => "ruby", :line_numbers => "inline" ) do -%>
+  #    # Initializer for the class.
+  #    def initialize( string )
+  #      @str = stirng
+  #    end
+  #    <% end -%>
+  #    
+  # The supported CodeRay options are the following:
+  #
+  #    :lang               : the language to highlight (ruby, c, html, ...)
+  #    :line_numbers       : include line numbers in 'table', 'inline',
+  #                          or 'list'
+  #    :line_number_start  : where to start with line number counting
+  #    :bold_every         : make every n-th number appear bold
+  #    :tab_width          : convert tab characters to n spaces
+  #
+  def coderay( *args, &block )
+    opts = args.last.instance_of?(Hash) ? args.pop : {}
+
+    buffer = eval('_erbout', block.binding)
+    pos = buffer.length
+    block.call(*args)
+
+    text = buffer[pos..-1].strip
+    if text.empty?
+      buffer[pos..-1] = ''
+      return
+    end
+
+    lang = opts.getopt(:lang, :ruby).to_sym
+
+    cr_opts = {}
+    %w(line_numbers       to_sym
+       line_number_start  to_i
+       bold_every         to_i
+       tab_width          to_i).each_slice(2) do |key,convert|
+      val = opts.getopt(key)
+      next if val.nil?
+      cr_opts[key.to_sym] = val.send(convert)
+    end
+
+    #cr.swap(CodeRay.scan(text, lang).html(opts).div)
+    out = '<div class="CodeRay"><pre>'
+    out << ::CodeRay.scan(text, lang).html(cr_opts)
+    out << '</pre></div>'
+
+    if @_cursor.remaining_filters.include? 'textile'
+      out.insert 0, "<notextile>\n"
+      out << "\n</notextile>"
+    end
+
+    buffer[pos..-1] = out
+    return
+  end
+end  # module CodeRayHelper
+
+register(CodeRayHelper)
+
+end  # module Webby::Helpers
+end  # try_require
+
+# EOF

data/lib/webby/helpers/graphviz_helper.rb

@@ -0,0 +1,158 @@
+# $Id: graphviz_helper.rb 181 2008-02-29 05:09:49Z tim_pease $
+
+require 'fileutils'
+require 'tempfile'
+
+module Webby::Helpers
+module GraphvizHelper
+
+  # :stopdoc:
+  class Error < StandardError; end
+  # :startdoc:
+
+  # call-seq:
+  #    GraphvizHelper.error_check( file )
+  #
+  # Check the temporary error file to see if it contains any error messages
+  # from the graphviz program. If it is not empty, then read the contents
+  # and log an error message and raise an exception.
+  #
+  def self.error_check( file )
+    if ::File.size(file.path) != 0
+      msg = "\n" << ::File.read(file.path).strip
+      raise Error, msg
+    end
+  end
+
+  # The +graphviz+ method processes DOT scripts in a webpage and replaces them
+  # with generated image files. The page sections to be processed are given
+  # as blocks of text to the +graphviz+ method.
+  #
+  # Options can be passed to the Graphviz program using attributes in the
+  # +graphviz+ method.
+  #
+  #     <% graphviz( :path => "images", :type => "gif", cmd => "dot" ) do %>
+  #     digraph graph_1 {
+  #       graph [URL="default.html"]
+  #       a [URL="a.html"]
+  #       b [URL="b.html"]
+  #       c [URL="c.html"]
+  #       a -> b -> c
+  #       a -> c
+  #     }
+  #     <% end %>
+  #
+  # If the DOT script contains *URL* or *href* attributes on any of the nodes
+  # or edges, then an image map will be generated and the image will be
+  # "clikcable" in the webpage. If *URL* or *href* attributes do not appear in
+  # the DOT script, then a regular image will be inserted into the webpage.
+  #
+  # The image is inserted into the page using an HTML <img /> tag. A
+  # corresponding <map>...</map> element will be inserted if needed.
+  #
+  # The supported Graphviz options are the following:
+  #
+  #    :path     : where generated images will be stored
+  #                [default is "/"]
+  #    :type     : the type of image to generate (png, jpeg, gif)
+  #                [default is png]
+  #    :cmd      : the Graphviz command to use when generating images
+  #                (dot, neato, twopi, circo, fdp) [default is dot]
+  #
+  #    the following options are passed as-is to the generated <img /> tag
+  #    :style    : CSS styles to apply to the <img />
+  #    :class    : CSS class to apply to the <img />
+  #    :id       : HTML identifier
+  #    :alt      : alternate text for the <img />
+  #
+  def graphviz( *args, &block )
+    opts = args.last.instance_of?(Hash) ? args.pop : {}
+
+    # create a temporary file for holding any error messages
+    # from the graphviz program
+    err = Tempfile.new('graphviz_err')
+    err.close
+
+    buffer = eval('_erbout', block.binding)
+    pos = buffer.length
+    block.call(*args)
+
+    path = opts.getopt(:path)
+    cmd  = opts.getopt(:cmd, 'dot')
+    type = opts.getopt(:type, 'png')
+    text = buffer[pos..-1].strip
+    if text.empty?
+      buffer[pos..-1] = ''
+      return
+    end
+
+    # ensure the requested graphviz command actually exists
+    %x[#{cmd} -V 2>&1]
+    unless 0 == $?.exitstatus
+      raise NameError, "'#{cmd}' not found on the path"
+    end
+
+    # pull the name of the graph|digraph out of the DOT script
+    name = text.match(%r/\A\s*(?:strict\s+)?(?:di)?graph\s+([A-Za-z_][A-Za-z0-9_]*)\s+\{/o)[1]
+
+    # see if the user includes any URL or href attributes
+    # if so, then we need to create an imagemap
+    usemap = text.match(%r/(?:URL|href)\s*=/o) != nil
+
+    # generate the image filename based on the path, graph name, and type
+    # of image to generate
+    image_fn = path.nil? ? name.dup : ::File.join(path, name)
+    image_fn = ::File.join('', image_fn) << '.' << type
+
+    # create the HTML img tag
+    out = "<img src=\"#{image_fn}\""
+
+    %w[class style id alt].each do |atr|
+      val = opts.getopt(atr)
+      next if val.nil?
+      out << " %s=\"%s\"" % [atr, val]
+    end
+
+    out << " usemap=\"\##{name}\"" if usemap
+    out << " />\n"
+
+    # generate the image map if needed
+    if usemap
+      IO.popen("#{cmd} -Tcmapx 2> #{err.path}", 'r+') do |io|
+        io.write text
+        io.close_write
+        out << io.read
+      end
+      GraphvizHelper.error_check(err)
+    end
+
+    # generate the image using graphviz -- but first ensure that the
+    # path exists
+    out_dir = ::Webby.site.output_dir
+    out_file = ::File.join(out_dir, image_fn)
+    FileUtils.mkpath(::File.join(out_dir, path)) unless path.nil?
+    cmd = "#{cmd} -T#{type} -o #{out_file} 2> #{err.path}"
+
+    IO.popen(cmd, 'w') {|io| io.write text}
+    GraphvizHelper.error_check(err)
+
+    # see if we need to put some guards around the output
+    # (specifically for textile)
+    if @_cursor.remaining_filters.include? 'textile'
+      out.insert 0, "<notextile>\n"
+      out << "\n</notextile>"
+    end
+
+    buffer[pos..-1] = out
+    return
+  end
+end  # module GraphvizHelper
+
+%x[dot -V 2>&1]
+if 0 == $?.exitstatus
+  register(GraphvizHelper)
+end
+
+end  # module Webby::Helpers
+
+# EOF

data/lib/webby/helpers/tag_helper.rb

@@ -1,6 +1,9 @@
+# $Id: tag_helper.rb 157 2008-02-20 17:41:00Z tim_pease $
+
 require 'erb'
 require 'set'
 
+# :stopdoc:
 class ERB
   module Util
     HTML_ESCAPE = { '&' => '&amp;', '"' => '&quot;', '>' => '&gt;', '<' => '&lt;' }
@@ -10,9 +13,9 @@ class ERB
     end
   end
 end
+# :startdoc:
 
-module Webby
-module Helpers #:nodoc:
+module Webby::Helpers
 
 # Provides methods to generate HTML tags programmatically.
 # By default, they output XHTML compliant tags.
@@ -56,7 +59,9 @@ module TagHelper
   end
 
 end  # module TagHelper
-end  # module Helpers
-end  # module Webby
+
+register(TagHelper)
+
+end  # module Webby::Helpers
 
 # EOF