webby 0.7.1 → 0.7.2

data/lib/webby/filters/coderay.rb

@@ -1,4 +1,4 @@
-# $Id: coderay.rb 68 2007-12-09 07:45:37Z tim_pease $
+# $Id: coderay.rb 113 2008-01-26 23:09:13Z tim_pease $
 
 require 'enumerator'
 require 'hpricot'
@@ -25,7 +25,7 @@ module Filters
 # The supported CodeRay options are the following:
 #
 #    lang               : the language to highlight (ruby, c, html, ...)
-#    line_numbers       : include line nubers in 'table', 'inline',
+#    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

data/lib/webby/filters/graphviz.rb

@@ -1,4 +1,4 @@
-# $Id: graphviz.rb 71 2007-12-13 05:45:53Z tim_pease $
+# $Id: graphviz.rb 113 2008-01-26 23:09:13Z tim_pease $
 
 require 'hpricot'
 require 'fileutils'
@@ -25,9 +25,9 @@ module Filters
 #     }
 #     </graphviz>
 #
-# If the DOT script contains *URL* or *href* cursorments on any of the nodes
+# 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* cursorments do not appear in
+# "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
@@ -108,8 +108,8 @@ class Graphviz
 
       # 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
+      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}\""
@@ -119,7 +119,7 @@ class Graphviz
         out << " %s=\"%s\"" % [attr, gviz[attr]]
       end
 
-      out << " usemap=\"#{name}\"" if usemap
+      out << " usemap=\"\##{name}\"" if usemap
       out << " />\n"
 
       # generate the image map if needed
@@ -135,8 +135,8 @@ class Graphviz
       # 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?
+      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}
@@ -169,8 +169,8 @@ class Graphviz
   # and log an error message and raise an exception.
   #
   def error_check
-    if File.size(@err.path) != 0
-      msg = "\n" << File.read(@err.path).strip
+    if ::File.size(@err.path) != 0
+      msg = "\n" << ::File.read(@err.path).strip
       raise Error, msg
     end
   end

data/lib/webby/filters/haml.rb

@@ -1,16 +1,12 @@
-# $Id: haml.rb 68 2007-12-09 07:45:37Z tim_pease $
+# $Id: haml.rb 112 2008-01-26 05:31:48Z tim_pease $
 
 try_require 'haml'
 
 # Render text via the Haml library
 Webby::Filters.register :haml do |input, cursor|
   opts = cursor.page.haml_options || {}
-  opts[:locals] ||= {}
-  opts[:locals].merge!(
-    :page => cursor.renderer.page,
-    :pages => cursor.renderer.pages
-  )
-  Haml::Engine.new(input, opts).to_html
+  b = cursor.renderer.get_binding
+  Haml::Engine.new(input, opts).to_html(b)
 end
 
 # EOF

data/lib/webby/filters/outline.rb

@@ -0,0 +1,194 @@
+# $Id: outline.rb 124 2008-02-03 00:24:10Z tim_pease $
+
+require 'hpricot'
+
+module Webby
+module Filters
+
+# The Outline filter is used to insert outline numbering into HTML heading
+# tags (h1, h2, h3, etc.) and to generate a table of contents based on the
+# heading tags. The table of contents is inserted into the page at the
+# location of the <toc /> tag. If there is no <toc /> tag, then a table of
+# contents will not be created but outline numbering will still take place.
+#
+# If a table of contents is desired without outline number being inserted
+# into the heading tags, this can be specified in the attibutes of the
+# <toc /> tag itself.
+#
+#    <toc outline_numbering="off" />
+#
+# This will generate a table of contents, but not insert outline numbering
+# into the heading tags.
+#
+# The Outline filter will only work on valid HTML or XHTML pages. Therefore
+# it should be used after any markup langauge filters (textile, markdown,
+# etc.).
+#
+class Outline
+
+  class Error < StandardError; end    # :nodoc:
+
+  # call-seq:
+  #    Outline.new( html )
+  #
+  # Creates a new outline filter that will operate on the given
+  # _html_ string.
+  #
+  def initialize( str )
+    @str = str
+
+    @cur_level, @base_level, @cur_depth = nil
+    @level = [0] * 6
+    @h_rgxp = %r/^h(\d)$/o
+    @toc = []
+    @outline_numbering = true
+  end
+
+  # call-seq:
+  #    filter    => html
+  #
+  # Process the original html document passed to the filter when it was
+  # created. The document will be scanned for heading tags (h1, h2, etc.)
+  # and outline numbering and id attributes will be inserted. A table of
+  # contents will also be created and inserted into the page if a <toc />
+  # tag is found.
+  #
+  # For example, if there is a heading tag
+  #
+  #    <h3>Get Fuzzy</h3>
+  #
+  # somewhere in a page about comic strips, the tag might be altered as such
+  #
+  #    <h3 id="h2_2_1"><span class="heading-num>2.2.1</span>Get Fuzzy</h3>
+  # 
+  # The id attribute is used to generate a linke from the table of contents
+  # to this particular heading tag. The original text of the tag is used in
+  # the table of contents -- "Get Fuzzy" in this example.
+  #
+  def filter
+    doc = Hpricot(@str)
+
+    # extract directives from the "toc" tag
+    toc_elem = doc.search('toc').first
+
+    unless toc_elem.nil?
+      @outline_numbering = toc_elem['outline_numbering'] !~ %r/off/i
+    end
+
+    doc.traverse_element(*%w[h1 h2 h3 h4 h5 h6]) do |elem|
+      text, id = heading_info(elem)
+      add_to_toc(text, id)
+    end
+
+    # create the TOC ordered list
+
+    toc_elem.swap(toc) unless toc_elem.nil?
+    
+    # replace the "toc" tag with the ordered list
+
+    doc.to_html
+  end
+
+
+  private
+
+  # Returns information for the given heading element. The information is
+  # returned as a two element array: [text, id].
+  #
+  # This method will also insert outline numbering and an id attribute. The
+  # outline numbering can be disabled, but the id attribute must be present
+  # for TOC generation.
+  #
+  def heading_info( elem )
+    m = @h_rgxp.match(elem.name)
+    level = Integer(m[1])
+
+    self.current_level = level
+    text = elem.inner_text
+
+    lbl = label
+    if outline_numbering?
+      elem.children.first.before {tag!(:span, lbl, :class => 'heading-num')}
+    end
+    elem['id'] = "h#{lbl.tr('.','_')}" if elem['id'].nil?
+
+    return [text, elem['id']]
+  end
+
+  # Set the current heading level. This will set the label and depth as
+  # well. An error will be raised if the _level_ is less than the base
+  # heading level.
+  #
+  # The base heading level will be set to the _level_ if it has not already
+  # been set. Therefore, the first heading tag encountered defines the base
+  # heading level.
+  #
+  def current_level=( level )
+    @base_level ||= level
+    @cur_level ||= level
+
+    if level < @base_level
+      raise Error, "heading tags are not in order, cannot outline"
+    end
+
+    if level == @cur_level
+      @level[level-1] += 1
+    elsif level > @cur_level
+      @cur_level.upto(level-1) {|ii| @level[ii] += 1}
+    else
+      @cur_level.downto(level+1) {|ii| @level[ii-1] = 0}
+      @level[level-1] += 1
+    end
+
+    @cur_level = level
+  end
+
+  # Return the label string for the current heading level.
+  #
+  def label
+    rv = @level.dup
+    rv.delete(0)
+    rv.join('.')
+  end
+
+  # Return the nesting depth of the current heading level with respect to the
+  # base heading level. This is a one-based number.
+  #
+  def depth
+    @cur_level - @base_level + 1
+  end
+
+  # Add the given text and id reference to the table of contents.
+  #
+  def add_to_toc( text, id )
+    str = '#' * depth
+    str << ' ' << "\"#{text}\":##{id}"
+    @toc << str
+  end
+
+  # Returns the table of contents as a collection of nested ordered lists.
+  # This is fully formatted HTML.
+  #
+  def toc
+    RedCloth.new(@toc.join("\n"), %w(no_span_caps)).to_html
+  end
+
+  # Returns +true+ if outline numbering should be inserted into the heading
+  # tags. Returns +false+ otherwise.
+  #
+  def outline_numbering?
+    @outline_numbering
+  end
+end  # class Outline
+
+# Generate a outline numbering and/or a table of contents in the input HTML
+# text.
+#
+register :outline do |input|
+  Outline.new(input).filter
+end
+
+end  # module Filters
+end  # module Webby
+
+# EOF

data/lib/webby/helpers/tag_helper.rb

@@ -37,22 +37,23 @@ module TagHelper
   end
 
   private
-    def tag_options( options, escape = true )
-      unless options.empty?
-        attrs = []
-        if escape
-          options.each do |key, value|
-            next if value.nil?
-            key = key.to_s
-            value = BOOLEAN_ATTRIBUTES.include?(key) ? key : escape_once(value)
-            attrs << %Q(#{key}="#{value}")
-          end
-        else
-          attrs = options.map {|key, value| %Q(#{key}="#{value}")}
+
+  def tag_options( options, escape = true )
+    unless options.empty?
+      attrs = []
+      if escape
+        options.each do |key, value|
+          next if value.nil?
+          key = key.to_s
+          value = BOOLEAN_ATTRIBUTES.include?(key) ? key : escape_once(value)
+          attrs << %Q(#{key}="#{value}")
         end
-        %Q( #{attrs.sort * ' '}) unless attrs.empty?
+      else
+        attrs = options.map {|key, value| %Q(#{key}="#{value}")}
       end
+      %Q( #{attrs.sort * ' '}) unless attrs.empty?
     end
+  end
 
 end  # module TagHelper
 end  # module Helpers

data/lib/webby/helpers/url_helper.rb

@@ -1,4 +1,4 @@
-# $Id: url_helper.rb 75 2007-12-20 23:10:19Z tim_pease $
+# $Id: url_helper.rb 103 2008-01-20 23:58:14Z tim_pease $
 
 module Webby
 module Helpers #:nodoc:
@@ -8,14 +8,30 @@ module Helpers #:nodoc:
 module UrlHelper
 
   # call-seq:
-  #    url_for( string, opts = {} ) 
-  #    url_for( page, opts ={} )
+  #    url_for( name, opts = {} ) 
   #
-  # Options
+  # Creates a URL for the given _name_ and _opts_. If _name_ is a string
+  # then it is used as the URL base. If _name_ is a Resource then it is
+  # converted to a URL by calling its +url+ method.
+  #
+  # ==== Options
   # 
-  #    :escape  => determins whether the returned URL will be HTML escaped
-  #                or not (+true+ by default)
-  #    :anchor  => specifies the anchor name to be appended to the path
+  # * <tt>:escape</tt> -- determines whether the returned URL will be HTML escaped or not (+true+ by default)
+  # * <tt>:anchor</tt> -- specifies the anchor name to be appended to the path
+  #
+  # ==== Examples
+  #
+  #    <%= url_for('/some/page.html') %>
+  #    # => /some/page
+  #
+  #    <%= url_for('/some/page.html', :anchor => 'tidbit') %>
+  #    # => /some/page#tidbit
+  #
+  #    <%= url_for(@page) %>
+  #    # => /current/page.html
+  #
+  #    <%= url_for(@page, :anchor => 'this&that') %>
+  #    # => /current/page.html#this&amp;that
   #
   def url_for( *args )
     opts = Hash === args.last ? args.pop : {}
@@ -31,6 +47,22 @@ module UrlHelper
     return url
   end
 
+  # call-seq:
+  #    url_for_page( :key => value, :url => {} )
+  #
+  # Creates a URL for the page identified by the set of <em>:key /
+  # value</em> pairs. The <em>:url</em> options are passed to the url_for
+  # method for final URL creation; see the url_for method for
+  # documentation on those options.
+  #
+  # The PagesDB#find method is used to locate the page; see the find method
+  # for the available options.
+  #
+  # ==== Examples
+  #
+  #    <%= url_for_page(:title => 'Funny Story', :anchor => 'punchline') %>
+  #    # => /humor/funny_story.html#punchline
+  #
   def url_for_page( opts = {} )
     opts = opts.symbolize_keys
     url_opts = opts.delete(:url)
@@ -42,7 +74,22 @@ module UrlHelper
     self.url_for(p, url_opts)
   end
 
+  # call-seq:
+  #    link_to( name, url, :attrs => {} )
   #
+  # Create an HTTP anchor tag with 
+  #
+  # url can be a url string, a page, :back, or nothing
+  #
+  # :attrs are used to generate HTML anchor tag attributes
+  #
+  # ==== Examples
+  #
+  #    <%= link_to('Google', 'http://www.google.com/', :attrs => {:name => 'google'}) %>
+  #    # => <a href="http://www.google.com/" name="google">Google</a>
+  #
+  #    <%= link_to('A Page', @page, :anchor => 'blah') %>
+  #    # => <a href="/a/page.html#blah">A Page</a>
   #
   def link_to( name, *args )
     opts = Hash === args.last ? args.pop : {}
@@ -50,9 +97,7 @@ module UrlHelper
     attrs = opts.delete(:attrs)
 
     url = case url
-      when String
-        url
-      when Webby::Resource
+      when String, Webby::Resource
         self.url_for(url, opts)
       when :back
         'javascript:history.back()'
@@ -82,9 +127,8 @@ module UrlHelper
   # Creates a link tag of the given _name_ using a URL created by finding
   # the associated page from the key/value pairs. If the key/value pairs are
   # omitted, the _name_ is used in conjunction with the default site +find_by+
-  # attribute. If the _name_ is omitted, then either the page +title+
-  # attribute or the page +filename+ attribute is used as the name (in that
-  # order of preference).
+  # attribute. Unless changed by the user, the default +find_by+ attribute
+  # is the page title.
   #
   # Pages are found using key/value pairs. The key is any of the page
   # attributes, and the value is what that attribute should be. Any number
@@ -108,11 +152,33 @@ module UrlHelper
   #
   # ==== Examples
   #
+  #    <%= link_to_page('Funny Story', :url => {:anchor => 'punchline'}) %>
+  #    # => <a href="/humor/funny_story.html#punchline">Funny Story</a>
+  #
+  #    <%= link_to_page('Hilarious', :title => 'Funny Story') %>
+  #    # => <a href="/humor/funn_story.html">Hilarious</a>
+  #
   def link_to_page( *args )
     self.link_to(*_find_page(args))
   end
 
+  # call-seq:
+  #    link_to_page_unless_current( name )
+  #    link_to_page_unless_current( :key => value )
+  #    link_to_page_unless_current( name, :key => value )
+  #    link_to_page_unless_current( page )
+  #
+  # This function operates in the same fashion as the +link_to_page+ fuction
+  # with the exception that if the page to be linked to is the current page,
+  # then only the _name_ is rendered without an HTML anchor tag.
+  #
+  # ==== Examples
   #
+  #    <%= link_to_page_unless_current('Funny Story') %>
+  #    # => <a href="/humor/funny_story.html">Funny Story</a>
+  #
+  #    <%= link_to_page_unless_current(@page) %>
+  #    # => This Page
   #
   def link_to_page_unless_current( *args )
     name, page, link_opts = _find_page(args)
@@ -132,6 +198,11 @@ module UrlHelper
   #
   # Returns an array of the [name, page, options]. 
   #
+  # ==== Options
+  # 
+  # * <tt>:url</tt> -- hash of options for the +url_for+ method
+  # * <tt>:attrs</tt> -- hash of options for the +link_to+ method
+  #
   def _find_page( args )
     raise ArgumentError, 'wrong number of arguments (0 for 1)' if args.empty?