webby 0.8.2 → 0.8.3

data/lib/webby/filters/erb.rb

@@ -1,5 +1,3 @@
-# $Id: erb.rb 68 2007-12-09 07:45:37Z tim_pease $
-
 require 'erb'
 
 # Render text via ERB using the built in ERB library.

data/lib/webby/filters/haml.rb

@@ -1,5 +1,3 @@
-# $Id: haml.rb 112 2008-01-26 05:31:48Z tim_pease $
-
 try_require 'haml'
 
 # Render text via the Haml library

data/lib/webby/filters/markdown.rb

@@ -1,5 +1,3 @@
-# $Id: markdown.rb 68 2007-12-09 07:45:37Z tim_pease $
-
 try_require 'bluecloth'
 
 # Render text via markdown using the BlueCloth library.

data/lib/webby/filters/outline.rb

@@ -1,5 +1,3 @@
-# $Id: outline.rb 192 2008-03-08 16:27:29Z tim_pease $
-
 require 'hpricot'
 
 module Webby
@@ -24,6 +22,49 @@ module Filters
 # it should be used after any markup langauge filters (textile, markdown,
 # etc.).
 #
+# The following attributes can be specified in the <toc /> tag itself to
+# control how outline numbering is performed by the filter. The attributes
+# can be used in combination with one another.
+#
+# === numbering
+#
+# If set to "off", this will prevent numbers from being inserted into the
+# page. The default is "on".
+#
+#    <toc numbering="off" />
+#
+# === numbering_start
+#
+# This is the number to start with when inserting outline numbers into a
+# page. The default is 1.
+#
+#    <toc numbering_start="3" />
+#
+# === toc_style
+#
+# The style of the Table of Contents list to generated. This will be
+# either "ol" for an ordered list or "ul" for an unordered list. The
+# default is an ordered list.
+#
+#    <toc toc_style="ul" />
+#
+# === toc_range
+#
+# This limits the numbering to only a subset of the HTML heading tags. The
+# defaul is to number all the heading tags.
+#
+#    <toc toc_range="h1-h3" />
+#
+# In this example, only the heading tags h1, h2, and h3 will be numbered
+# and included in the table of contents listing.
+#
+# ==== Example
+#
+# Generate a table of contents using an unordered list, starting with the
+# number 2, and only numbering heading levels 2, 3, and 4.
+#
+#    <toc numbering_start="2" toc_style="ul" toc_range="h2-h4" />
+#
 class Outline
   include ERB::Util
 

data/lib/webby/filters/sass.rb

@@ -1,5 +1,3 @@
-# $Id: sass.rb 68 2007-12-09 07:45:37Z tim_pease $
-
 try_require 'sass'
 
 # Render text via the Sass library (part of Haml)

data/lib/webby/filters/slides.rb

@@ -0,0 +1,56 @@
+module Webby
+module Filters
+
+# The Slides filter is used to generate an S5 presentation from HTML input
+# text. The input HTML is scanned for <h1> tags and slide divs are inserted
+# before each <h1> tag found.
+#
+# When the HTML is rendered into the presentation layout, the result is an
+# S5 presentation -- provided that the layout includes the appropriate S5
+# javascript and CSS files.
+#
+class Slides
+
+  START_SLIDE = %{<div class="slide">#$/}
+  END_SLIDE   = %{</div>#$/#$/}
+
+  # call-seq:
+  #    Slides.new( html )
+  #
+  # Creates a new slides filter that will operate on the given
+  # _html_ string.
+  #
+  def initialize( str )
+    @str = str
+    @open = false
+  end
+
+  # call-seq:
+  #    filter    => html
+  #
+  # Process the original html document passed to the filter when it was
+  # created. The document will be scanned for H1 heading tags and slide
+  # divs will be inserted into the page before each H1 tag that is found.
+  #
+  def filter
+    result = []
+
+    @str.split(%r/\<h1\>/i).each do |slide|
+      next if slide.strip.empty?
+      result << START_SLIDE << '<h1>' << slide << END_SLIDE
+    end
+
+    result.join
+  end
+end  # class Slides
+
+# Insert slide divs into the input HTML text.
+#
+register :slides do |input|
+  Slides.new(input).filter
+end
+
+end  # module Filters
+end  # module Webby
+
+# EOF

data/lib/webby/filters/textile.rb

@@ -1,5 +1,3 @@
-# $Id: textile.rb 71 2007-12-13 05:45:53Z tim_pease $
-
 try_require 'redcloth'
 
 # Render text via textile using the RedCloth library.

data/lib/webby/filters/tidy.rb

@@ -1,5 +1,3 @@
-# $Id: tidy.rb 192 2008-03-08 16:27:29Z tim_pease $
-
 require 'fileutils'
 require 'tempfile'
 

data/lib/webby/helpers.rb

@@ -1,5 +1,3 @@
-# $Id: helpers.rb 167 2008-02-24 00:59:54Z tim_pease $
-
 require Webby.libpath(*%w[webby renderer])
 
 module Webby

data/lib/webby/helpers/capture_helper.rb

@@ -0,0 +1,141 @@
+
+module Webby::Helpers
+
+# Based on code from Rails and Merb.
+#
+module CaptureHelper
+
+  # Called in pages and partials to store up content for later use. Takes a
+  # string and/or a block. First, the string is evaluated, and then the
+  # block is captured using the capture() helper provided by the template
+  # languages. The two are concatenated together.
+  #
+  # Content is retrieved by calling the method without a string or a block.
+  #
+  # ==== Parameters
+  # obj<Object>:: The key in the conetnt_for hash.
+  # string<String>:: Textual content. Defaults to nil.
+  # &block:: A block to be evaluated and concatenated to string.
+  #
+  # ==== Returns
+  # Any content associated with the key (or nil).
+  #
+  # ==== Example
+  #   content_for(:foo, "Foo")
+  #   content_for(:foo)             #=> "Foo"
+  #   content_for(:foo, "Bar")
+  #   content_for(:foo)             #=> "FooBar"
+  #
+  def content_for( obj, string = nil, &block )
+    return @_content_for[obj] unless string || block_given?
+
+    cur = @_content_for[obj].to_s
+    new = string.to_s + (block_given? ? capture_erb(&block) : "")
+    @_content_for[obj] = cur + new
+  end
+
+  # Returns true if there is content for the given key. Otherwise returns
+  # false.
+  #
+  # ==== Parameters
+  # obj<Object>:: The key in the conetnt_for hash.
+  #
+  # ==== Example
+  #   content_for(:foo, "Foo")
+  #   content_for?(:foo)            #=> true
+  #   content_for?(:bar)            #=> false
+  #
+  def content_for?( obj )
+    @_content_for.key?(obj)
+  end
+
+  # Deletes any content associated with the given object in the content_for
+  # hash.
+  #
+  # ==== Parameters
+  # obj<Object>:: The key in the conetnt_for hash.
+  #
+  # ==== Returns
+  # Any content associated with the key (or nil).
+  #
+  # ==== Example
+  #   content_for(:foo, "Foo")
+  #   content_for?(:foo)            #=> true
+  #   delete_content_for(:foo)
+  #   content_for?(:foo)            #=> false
+  #
+  def delete_content_for( obj )
+    @_content_for.delete(obj)
+  end
+
+  # This method is used to capture content from an ERB filter evaluation. It
+  # is useful to helpers that need to process chunks of data during ERB filter
+  # processing.
+  #
+  # ==== Parameters
+  # *args:: Arguments to pass to the block.
+  # &block:: The ERB block to call.
+  #
+  # ==== Returns
+  # String:: The output of the block.
+  #
+  # ==== Examples
+  # Capture being used in an ERB page:
+  # 
+  #   <% @foo = capture_erb do %>
+  #     <p>Some Foo content!</p> 
+  #   <% end %>
+  #
+  def capture_erb( *args, &block )
+    # get the buffer from the block's binding
+    buffer = _erb_buffer(block.binding) rescue nil
+
+    # If there is no buffer, just call the block and get the contents
+    if buffer.nil?
+      block.call(*args)
+    # If there is a buffer, execute the block, then extract its contents
+    else
+      pos = buffer.length
+      block.call(*args)
+
+      # extract the block
+      data = buffer[pos..-1]
+
+      # replace it in the original with empty string
+      buffer[pos..-1] = ""
+
+      data
+    end
+  end
+
+  # This method is used to concatenate content into the ERB output buffer.
+  # It is usefule to helpers that need to insert transformed text back into
+  # the ERB output buffer.
+  #
+  # ==== Parameters
+  # string<String>:: The string to insert into the ERB output.
+  # the_binding<Binding>:: The binding to pass to the buffer.
+  #
+  def concat_erb( string, the_binding )
+    _erb_buffer(the_binding) << string
+  end
+
+  # Provides direct acccess to the ERB buffer in the conext of the binding.
+  #
+  # ==== Parameters
+  # the_binding<Binding>:: The binding to pass to the buffer.
+  #
+  # ==== Returns
+  # The current ERB output buffer.
+  #
+  def _erb_buffer( the_binding )
+    eval("_erbout", the_binding, __FILE__, __LINE__)
+  end
+
+end  # module CaptureHelper
+
+register(CaptureHelper)
+
+end  # module Webby::Helpers
+
+# EOF

data/lib/webby/helpers/coderay_helper.rb

@@ -1,5 +1,3 @@
-# $Id: coderay_helper.rb 199 2008-03-11 18:54:45Z tim_pease $
-
 if try_require 'coderay'
 require 'enumerator'
 
@@ -33,15 +31,8 @@ module CodeRayHelper
   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]
-    if text.empty?
-      buffer[pos..-1] = ''
-      return
-    end
+    text = capture_erb(&block)
+    return if text.empty?
 
     defaults = ::Webby.site.coderay
     lang = opts.getopt(:lang, defaults[:lang]).to_sym
@@ -62,12 +53,10 @@ module CodeRayHelper
     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
+    # put some guards around the output (specifically for textile)
+    out = _guard(out)
 
-    buffer[pos..-1] = out
+    concat_erb(out, block.binding)
     return
   end
 end  # module CodeRayHelper

data/lib/webby/helpers/graphviz_helper.rb

@@ -1,5 +1,3 @@
-# $Id: graphviz_helper.rb 193 2008-03-09 02:32:37Z tim_pease $
-
 require 'fileutils'
 require 'tempfile'
 
@@ -64,24 +62,18 @@ module GraphvizHelper
   def graphviz( *args, &block )
     opts = args.last.instance_of?(Hash) ? args.pop : {}
 
+    text = capture_erb(&block)
+    return if text.empty?
+
     # 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)
-
     defaults = ::Webby.site.graphviz
     path = opts.getopt(:path, defaults[:path])
     cmd  = opts.getopt(:cmd, defaults[:cmd])
     type = opts.getopt(:type, defaults[:type])
-    text = buffer[pos..-1].strip
-    if text.empty?
-      buffer[pos..-1] = ''
-      return
-    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]
@@ -127,14 +119,10 @@ module GraphvizHelper
     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
+    # put some guards around the output (specifically for textile)
+    out = _guard(out)
 
-    buffer[pos..-1] = out
+    concat_erb(out, block.binding)
     return
   end
 end  # module GraphvizHelper

data/lib/webby/helpers/tag_helper.rb

@@ -1,5 +1,3 @@
-# $Id: tag_helper.rb 157 2008-02-20 17:41:00Z tim_pease $
-
 require 'erb'
 require 'set'
 

data/lib/webby/helpers/tex_img_helper.rb

@@ -1,5 +1,3 @@
-# $Id: tex_img_helper.rb 193 2008-03-09 02:32:37Z tim_pease $
-
 require Webby.libpath(*%w[webby stelan mktemp])
 require 'fileutils'
 
@@ -43,15 +41,8 @@ module TexImgHelper
     name = args.first
     raise 'TeX graphics must have a name' if name.nil?
 
-    buffer = eval('_erbout', block.binding)
-    pos = buffer.length
-    block.call(*args)
-
-    text = buffer[pos..-1].strip
-    if text.empty?
-      buffer[pos..-1] = ''
-      return
-    end
+    text = capture_erb(&block)
+    return if text.empty?
 
     defaults = ::Webby.site.tex2img
     path = opts.getopt(:path, defaults[:path])
@@ -125,12 +116,10 @@ module TexImgHelper
     end
     out << " />\n"
 
-    if @_cursor.remaining_filters.include? 'textile'
-      out.insert 0, "<notextile>\n"
-      out << "\n</notextile>"
-    end
+    # put some guards around the output (specifically for textile)
+    out = _guard(out)
 
-    buffer[pos..-1] = out
+    concat_erb(out, block.binding)
     return
   end
 end  # module TexImgHelper

data/lib/webby/helpers/ultraviolet_helper.rb

@@ -1,5 +1,3 @@
-# $Id: ultraviolet_helper.rb 199 2008-03-11 18:54:45Z tim_pease $
-
 # This code was provided by Guillaume Carbonneau -- http://radr.ca/
 # Many thanks for his support of Webby!
 
@@ -19,17 +17,17 @@ module UltraVioletHelper
   #    <% uv( :lang => "ruby", :line_numbers => true ) do -%>
   #    # Initializer for the class.
   #    def initialize( string )
-  #      @str = stirng
+  #      @str = string
   #    end
   #    <% end -%>
   #    
   # The supported UltraViolet options are the following:
   #
-  #    :lang               : the language to highlight (ruby, c, html, ...)
-  #                          [defaults to 'ruby']
-  #    :line_numbers       : true or false [defaults to false]
-  #    :theme              : see list of available themes in ultraviolet
-  #                          [defaults to 'mac_classic']
+  #    :lang           : the language to highlight (ruby, c, html, ...)
+  #                      [defaults to 'ruby']
+  #    :line_numbers   : true or false [defaults to false]
+  #    :theme          : see list of available themes in ultraviolet
+  #                      [defaults to 'mac_classic']
   #
   # The defaults can be overridden for an entire site by changing the SITE.uv
   # options hash in the Rakefile.
@@ -37,15 +35,8 @@ module UltraVioletHelper
   def uv( *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]
-    if text.empty?
-      buffer[pos..-1] = ''
-      return
-    end
+    text = capture_erb(&block)
+    return if text.empty?
     
     defaults = ::Webby.site.uv
     lang = opts.getopt(:lang, defaults[:lang])
@@ -56,12 +47,10 @@ module UltraVioletHelper
     out << Uv.parse(text, "xhtml", lang, line_numbers, theme)
     out << '</div>'
 
-    if @_cursor.remaining_filters.include? 'textile'
-      out.insert 0, "<notextile>\n"
-      out << "\n</notextile>"
-    end
+    # put some guards around the output (specifically for textile)
+    out = _guard(out)
 
-    buffer[pos..-1] = out
+    concat_erb(out, block.binding)
     return
   end
 end  # module UltraVioletHelper