Shazburg-webby 0.9.0

data/lib/webby/filters/sass.rb

@@ -0,0 +1,17 @@
+
+# Render text via the Sass library (part of Haml)
+if try_require('sass', 'haml')
+
+  Webby::Filters.register :sass do |input, cursor|
+    opts = ::Webby.site.sass_options.merge(cursor.page.sass_options || {})
+    Sass::Engine.new(input, opts).render
+  end
+
+# Otherwise raise an error if the user tries to use sass
+else
+  Webby::Filters.register :sass do |input, cursor|
+    raise Webby::Error, "'haml' must be installed to use the sass filter"
+  end
+end
+
+# EOF

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

@@ -0,0 +1,16 @@
+
+# If RedCloth is installed, then configure the textile filter
+if try_require('redcloth', 'RedCloth')
+
+  Webby::Filters.register :textile do |input|
+    RedCloth.new(input, %w(no_span_caps)).to_html
+  end
+
+# Otherwise raise an error if the user tries to use textile
+else
+  Webby::Filters.register :textile do |input|
+    raise Webby::Error, "'RedCloth' must be installed to use the textile filter"
+  end
+end
+
+# EOF

data/lib/webby/filters/tidy.rb

@@ -0,0 +1,76 @@
+require 'fileutils'
+require 'tempfile'
+
+module Webby
+module Filters
+
+# The Tidy filter is used to process HTML (or XHTML) through the _tidy_
+# program and outpu nicely formatted and correct HTML (or XHTML).
+#
+# Options can be passed to the _tidy_ program via the
+# <code>Webby.site</code> struct. Setting the +tidy_options+ to the string
+# of desired options will do the trick.
+#
+# From a project's Rakefile, include the following line (or one that's more
+# to your liking):
+#
+#    SITE.tidy_options = "-indent -wrap 80 -utf8"
+#
+class Tidy
+
+  # call-seq:
+  #    Tidy.new( html )
+  #
+  # Create a new filter that will process the given _html_ through the tidy
+  # program.
+  #
+  def initialize( str )
+    @log = ::Logging::Logger[self]
+    @str = str
+
+    # create a temporary file for holding any error messages
+    # from the tidy program
+    @err = Tempfile.new('tidy_err')
+    @err.close
+  end
+
+  # call-seq:
+  #    process    => formatted html
+  #
+  # Process the original HTML text string passed to the filter when it was
+  # created and output Tidy formatted HTML or XHTML.
+  #
+  def process
+    cmd = "tidy %s -q -f #{@err.path}" % ::Webby.site.tidy_options
+    out = IO.popen(cmd, 'r+') do |tidy|
+      tidy.write @str
+      tidy.close_write
+      tidy.read
+    end
+
+    if File.size(@err.path) != 0
+      @log.warn File.read(@err.path).strip
+    end
+
+    return out
+  end
+
+end  # class Tidy
+
+# Render html into html/xhtml via the Tidy program
+if cmd_available? %w[tidy -v]
+  register :tidy do |input|
+    Filters::Tidy.new(input).process
+  end
+
+# Otherwise raise an error if the user tries to use tidy
+else
+  register :tidy do |input|
+    raise Webby::Error, "'tidy' must be installed to use the tidy filter"
+  end
+end
+
+end  # module Filters
+end  # module Webby
+
+# EOF

data/lib/webby/helpers.rb

@@ -0,0 +1,30 @@
+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/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

@@ -0,0 +1,69 @@
+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 : {}
+
+    text = capture_erb(&block)
+    return if text.empty?
+
+    defaults = ::Webby.site.coderay
+    lang = opts.getopt(:lang, defaults[:lang]).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|
+      key = key.to_sym
+      val = opts.getopt(key, defaults[key])
+      next if val.nil?
+      cr_opts[key] = 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>'
+
+    # put some guards around the output (specifically for textile)
+    out = _guard(out)
+
+    concat_erb(out, block.binding)
+    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,136 @@
+require 'fileutils'
+require 'tempfile'
+
+module Webby::Helpers
+module GraphvizHelper
+
+  # 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 ::Webby::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 : {}
+
+    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
+
+    defaults = ::Webby.site.graphviz
+    path = opts.getopt(:path, defaults[:path])
+    cmd  = opts.getopt(:cmd, defaults[:cmd])
+    type = opts.getopt(:type, defaults[:type])
+
+    # 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)
+
+    # put some guards around the output (specifically for textile)
+    out = _guard(out)
+
+    concat_erb(out, block.binding)
+    return
+  end
+end  # module GraphvizHelper
+
+if cmd_available? %w[dot -V]
+  register(GraphvizHelper)
+end
+
+end  # module Webby::Helpers
+
+# EOF