francois-webby 0.9.4.1

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/filters/wiki_words.rb

@@ -0,0 +1,14 @@
+
+Webby::Filters.register :wikiwords do |input, cursor|
+
+  renderer = cursor.renderer
+  input.gsub %r/\[\[([^\]]+)\]\]/ do
+    name = $1
+    renderer.link_to_page(name) {
+      %Q(<a class="missing internal">#{name}</a>)
+    }
+  end
+
+end
+
+# EOF

data/lib/webby/filters.rb

@@ -0,0 +1,85 @@
+module Webby
+module Filters
+   
+  class << self
+    
+    # Register a handler for a filter
+    def register( filter, &block )
+      _handlers[filter.to_s] = block
+    end
+    
+    # Process input through filters
+    def process( renderer, page, input )
+      # Start a new cursor for this page
+      Cursor.new(renderer, page).start_for(input)
+    end
+    
+    # Access a filter handler
+    def []( name )
+      _handlers[name]
+    end
+      
+    # The registered filter handlers
+    def _handlers
+      @handlers ||= {}
+    end
+    
+    # Instances of this class handle processing a set of filters
+    # for a given renderer and page.
+    # Note: The instance is passed as the second argument to filters
+    #       that require two parameters and can be used to access 
+    #       information on the renderer, page, or filters being
+    #       processed.
+    class Cursor
+      
+      attr_reader :renderer, :page, :filters
+      def initialize(renderer, page)
+        @renderer, @page = renderer, page
+        @filters = Array(page.filter)
+        @log = Logging::Logger[Webby::Renderer]
+        @processed = 0
+        @prev_cursor = nil
+      end
+      
+      def start_for(input)
+        @prev_cursor = @renderer.instance_variable_get(:@_cursor)
+        @renderer.instance_variable_set(:@_cursor, self)
+        filters.inject(input) do |result, filter|
+          handler = Filters[filter]
+          raise ::Webby::Error, "unknown filter: #{filter.inspect}" if handler.nil?
+
+          args = [result, self][0, handler.arity]
+          _handle(filter, handler, *args)
+        end
+      ensure
+        @renderer.instance_variable_set(:@_cursor, @prev_cursor)
+      end
+      
+      # The list of filters yet to be processed
+      def remaining_filters
+        filters[@processed..-1]
+      end
+      
+      # The name of the current filter
+      def current_filter
+        filters[@processed]
+      end
+      
+      # Process arguments through a single filter
+      def _handle(filter, handler, *args)
+        result = handler.call(*args)
+        @processed += 1
+        result
+      rescue StandardError => err
+        raise ::Webby::Error, "#{filter} filter error: #{err.message.inspect}"
+      end
+      
+    end  # class Cursor
+  end  # class << self
+    
+end  # module Filters
+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 = %Q{<div class="CodeRay">\n<pre>}
+    out << ::CodeRay.scan(text, lang).html(cr_opts)
+    out << %Q{</pre>\n</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