webby 0.7.4 → 0.8.0

data/lib/webby/helpers/tex_img_helper.rb

@@ -0,0 +1,181 @@
+# $Id: tex_img_helper.rb 181 2008-02-29 05:09:49Z tim_pease $
+
+require Webby.libpath(*%w[webby stelan mktemp])
+require 'fileutils'
+require 'tempfile'
+
+module Webby::Helpers
+module TexImgHelper
+
+  # :stopdoc:
+  class Error < StandardError; end
+  # :startdoc:
+
+  # The +tex2img+ method converts a a section of mathematical TeX script
+  # into an image and embeds the resulting image into the page. The TeX
+  # engine must be installed on your system along with the ImageMagick
+  # +convert+ program.
+  #
+  # Options can be passed to the TeX engine via attributes in the
+  # +tex2img+ method.
+  #
+  #    <% tex2img( "wave_eq", :path => "images", :alt => "wave equation" ) do -%>
+  #      $\psi_{tot}(x,-t_0,r) = \frac{1}{(2\pi)^2} \int\!\!\!\int
+  #      \tilde\Psi_{tot}\left(k_x,\frac{c}{2}\sqrt{k_x^2 + k_r^2},r=0\right)$
+  #    <% end -%>
+  #    
+  # The supported TeX 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]
+  #    :bg           : the background color of the image (color name,
+  #                    TeX color spec, or #aabbcc) [default is white]
+  #    :fg           : the foreground color of the image (color name,
+  #                    TeX color spec, or #aabbcc) [default is black]
+  #    :resolution   : the desired resolution in dpi (HxV)
+  #                    [default is 150x150]
+  #    :antialias    : if false, disables anti-aliasing in the resulting image
+  #                    [default is true]
+  #
+  #    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 tex2img( *args, &block )
+    opts = args.last.instance_of?(Hash) ? args.pop : {}
+    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
+
+    # create a temporary file for holding any error messages
+    # from the graphviz program
+    err = Tempfile.new('graphviz_err')
+    err.close
+
+    path  = opts.getopt(:path)
+    type  = opts.getopt(:type, 'png')
+    bg    = opts.getopt(:bg, 'white')
+    fg    = opts.getopt(:fg, 'black')
+    res   = opts.getopt(:resolution, '150x150')
+    aa    = opts.getopt(:antialias, true)
+
+    # fix the color escaping
+    fg = TexImgHelper.tex_color(fg)
+    bg = TexImgHelper.tex_color(bg)
+
+    # 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
+
+    # generate the image using convert -- 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?
+
+    tex = <<-TEX
+      \\documentclass[12pt]{article}
+      \\usepackage[usenames,dvipsnames]{color}
+      \\usepackage[dvips]{graphicx}
+      \\pagestyle{empty}
+      \\pagecolor#{bg}
+      \\begin{document}
+      {\\color#{fg}
+      #{text}
+      }\\end{document}
+    TEX
+    tex.gsub!(%r/\n\s+/, "\n").strip!
+
+    # make a temporarty directory to store all the TeX files
+    pwd = Dir.pwd
+    tmpdir = ::Webby::MkTemp.mktempdir('tex2img_XXXXXX')
+
+    begin
+      Dir.chdir(tmpdir)
+      File.open('out.tex', 'w') {|fd| fd.puts tex}
+      dev_null = test(?e, "/dev/null") ? "/dev/null" : "NUL:"
+
+      %x[latex -interaction=batchmode out.tex &> #{dev_null}]
+      %x[dvips -o out.eps -E out.dvi &> #{dev_null}]
+      %x[convert +adjoin #{aa ? '-antialias' : '+antialias'} -density #{res} out.eps #{out_file} &> #{dev_null}]
+    ensure
+      Dir.chdir(pwd)
+      FileUtils.rm_rf(tmpdir) if test(?e, tmpdir)
+    end
+
+    # generate the HTML img tag to insert back into the document
+    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 << " />\n"
+
+    if @_cursor.remaining_filters.include? 'textile'
+      out.insert 0, "<notextile>\n"
+      out << "\n</notextile>"
+    end
+
+    buffer[pos..-1] = out
+    return
+  ensure
+  end
+
+  # call-seq:
+  #    TexImgHelper.tex_color( string )    => string
+  #
+  # Taken the given color _string_ and convert it to a TeX color spec. The
+  # input string can be either a RGB Hex value, a TeX color spec, or a color
+  # name.
+  #
+  #    tex_color( '#666666' )         #=> [rgb]{0.4,0.4,0.4}
+  #    tex_color( 'Tan' )             #=> {Tan}
+  #    tex_color( '[rgb]{1,0,0}' )    #=> [rgb]{1,0,0}
+  #
+  # This is an example of an invalid Hex RGB color -- they must contain six
+  # hexidecimal characters to be valid.
+  #
+  #    tex_color( '#333' )            #=> {#333}
+  #
+  def self.tex_color( color )
+    case color
+    when %r/^#([A-Fa-f0-9]{6})/o
+      hex = $1
+      rgb = []
+      hex.scan(%r/../) {|n| rgb << Float(n.to_i(16))/255.0}
+      "[rgb]{#{rgb.join(',')}}"
+    when %r/^[\{\[]/o
+      "{#{color}}"
+    else
+      color
+    end
+  end
+
+end  # module TexImgHelper
+
+%x[latex --version 2>&1]
+if 0 == $?.exitstatus
+  %x[convert --version 2>&1]
+  if 0 == $?.exitstatus
+    register(TexImgHelper)
+  end
+end
+
+end  # module Webby::Helpers
+
+# EOF

data/lib/webby/helpers/url_helper.rb

@@ -1,7 +1,6 @@
-# $Id: url_helper.rb 147 2008-02-14 20:14:04Z tim_pease $
+# $Id: url_helper.rb 175 2008-02-28 15:49:11Z tim_pease $
 
-module Webby
-module Helpers #:nodoc:
+module Webby::Helpers
 
 #
 #
@@ -38,9 +37,9 @@ module UrlHelper
     obj = args.first
 
     anchor = opts.delete(:anchor)
-    escape = opts.has_key?(:escape) ? opts.delte(:escape) : true
+    escape = opts.has_key?(:escape) ? opts.delete(:escape) : true
 
-    url = Webby::Resource === obj ? obj.url : obj.to_s
+    url = Webby::Resources::Resource === obj ? obj.url : obj.to_s
     url = escape_once(url) if escape
     url << "#" << anchor if anchor
 
@@ -55,8 +54,8 @@ module UrlHelper
   # 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.
+  # The Resources::DB#find method is used to locate the page; see the find
+  # method for the available options.
   #
   # ==== Examples
   #
@@ -97,7 +96,7 @@ module UrlHelper
     attrs = opts.delete(:attrs)
 
     url = case url
-      when String, Webby::Resource
+      when String, Webby::Resources::Resource
         self.url_for(url, opts)
       when :back
         'javascript:history.back()'
@@ -211,7 +210,7 @@ module UrlHelper
     link_opts = opts.delete(:url) || {}
     link_opts[:attrs] = opts.delete(:attrs)
 
-    if Webby::Resource === name
+    if Webby::Resources::Resource === name
       p, name = name, nil
     elsif opts.empty? && name
       p = @pages.find(Webby.site.find_by.to_sym => name)
@@ -227,7 +226,9 @@ module UrlHelper
   end
 
 end  # module UrlHelper
-end  # module Helpers
-end  # module Webby
+
+register(UrlHelper)
+
+end  # module Webby::Helpers
 
 # EOF

data/lib/webby/renderer.rb

@@ -1,10 +1,10 @@
-# $Id: renderer.rb 112 2008-01-26 05:31:48Z tim_pease $
+# $Id: renderer.rb 173 2008-02-27 02:58:43Z tim_pease $
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the spec helper from being loaded more than once
+unless defined? ::Webby::Renderer
 
 require 'erb'
-try_require 'bluecloth'
-try_require 'redcloth'
-try_require 'haml'
-try_require 'sass'
 
 module Webby
 
@@ -22,10 +22,11 @@ module Webby
 #
 class Renderer
   include ERB::Util
-  include Webby::Helpers::TagHelper
-  include Webby::Helpers::UrlHelper
 
-  class Error < StandardError; end    # :nodoc:
+  # :stopdoc:
+  class Error < StandardError; end
+  @@stack = []
+  # :startdoc:
 
   # call-seq:
   #    Renderer.write( page )
@@ -41,7 +42,7 @@ class Renderer
       ::File.open(page.destination, 'w') do |fd|
         fd.write renderer.layout_page
       end
-      break unless renderer.__send__(:next_page)
+      break unless renderer.__send__(:_next_page)
     }
   end
 
@@ -53,14 +54,16 @@ class Renderer
   # render the filtered page into the desired layout.
   #
   def initialize( page )
-    unless page.is_page?
+    unless page.instance_of? Resources::Page
       raise ArgumentError,
             "only page resources can be rendered '#{page.path}'"
     end
 
     @page = page
-    @pages = Resource.pages
+    @pages = Resources.pages
+    @partials = Resources.partials
     @content = nil
+    @config = ::Webby.site
 
     @log = Logging::Logger[self]
   end
@@ -74,20 +77,29 @@ class Renderer
   # page's meta-data.
   #
   def layout_page
-    layouts = Resource.layouts
+    layouts = Resources.layouts
     obj = @page
     str = @page.render(self)
 
+    @@stack << @page.path
     loop do
       lyt = layouts.find :filename => obj.layout
       break if lyt.nil?
 
-      @content, str = str, ::Webby::File.read(lyt.path)
-      str = Filters.process(self, lyt, str)
+      @content, str = str, ::Webby::Resources::File.read(lyt.path)
+      str = _track_rendering(lyt.path) {
+        Filters.process(self, lyt, str)
+      }
       @content, obj = nil, lyt
     end
 
+    @@stack.pop if @page.path == @@stack.last
+    raise Error, "rendering stack corrupted" unless @@stack.empty?
+
     str
+  rescue => err
+    @log.error "while rendering page '#{@page.path}'"
+    @log.error err
   end
 
   # call-seq:
@@ -97,7 +109,42 @@ class Renderer
   # determined from the page's meta-data.
   #
   def render_page
-    Filters.process(self, @page, ::Webby::File.read(@page.path))
+    _track_rendering(@page.path) {
+      Filters.process(self, @page, ::Webby::Resources::File.read(@page.path))
+    }
+  end
+
+  # call-seq:
+  #    render_partial( partial )    => string
+  #
+  # Render the given _partial_ into the current page. The _partial_ can
+  # either be the name of the partial to render or a Partial object.
+  #
+  # In the former case, the partial is found by first looking in the
+  # directory of the current for a partial of the same name. Failing that,
+  # the search is expanded to include all directories in the site. The first
+  # partial with a matching name is returned.
+  #
+  # In the latter case, Partial objects can be found by using the +find+
+  # method of the <tt>@partials</tt> database hash. Please refer to
+  # Webby::Resources::DB#find method for more information.
+  #
+  def render_partial( part, opts = {} )
+    part = case part
+      when String
+        fn = '_' + part
+        p = Resources.partials.find(
+            :filename => fn, :in_directory => @page.dir ) rescue nil
+        p ||= Resources.partials.find(:filename => fn)
+        raise Error, "could not find partial '#{part}'" if p.nil?
+        p
+      when ::Webby::Resources::Partial
+        part
+      else raise Error, "expecting a partial or a partial name" end
+
+    _track_rendering(part.path) {
+      Filters.process(self, part, ::Webby::Resources::File.read(part.path))
+    }
   end
 
   # call-seq:
@@ -119,7 +166,7 @@ class Renderer
       items[offset,per_page]
     end.first
 
-    @pager.each &block
+    @pager.each(&block)
   end
 
   # call-seq:
@@ -135,13 +182,13 @@ class Renderer
   private
 
   # call-seq:
-  #    next_page    => true or false
+  #    _next_page    => true or false
   #
   # Returns +true+ if there is a next page to render. Returns +false+ if
   # there is no next page or if pagination has not been configured for the
   # current page.
   #
-  def next_page
+  def _next_page
     return false unless defined? @pager and @pager
 
     # go to the next page; break out if there is no next page
@@ -155,7 +202,39 @@ class Renderer
     true
   end
 
+  # call-seq:
+  #    _track_rendering( path ) {block}
+  #
+  # Keep track of the page rendering for the given _path_. The _block_ is
+  # where the the page will be rendered.
+  #
+  # This method keeps a stack of the current pages being rendeered. It looks
+  # for duplicates in the stack -- an indication of a rendering loop. When a
+  # rendering loop is detected, an error is raised.
+  #
+  # This method returns whatever is returned from the _block_.
+  #
+  def _track_rendering( path )
+    loop_error = @@stack.include? path
+    @@stack << path
+
+    if loop_error
+      msg = "rendering loop detected for '#{path}'\n"
+      msg << "    current rendering stack\n\t"
+      msg << @@stack.join("\n\t")
+      raise Error, msg
+    end
+
+    yield
+  ensure
+    @@stack.pop if path == @@stack.last
+  end
+
 end  # class Renderer
 end  # module Webby
 
+Webby.require_all_libs_relative_to(__FILE__, 'stelan')
+
+end  # unless defined?
+
 # EOF

data/lib/webby/resources.rb

@@ -0,0 +1,82 @@
+# $Id: resources.rb 167 2008-02-24 00:59:54Z tim_pease $
+
+module Webby::Resources
+
+  class << self
+    # Returns the pages hash object.
+    #
+    def pages
+      @pages ||= ::Webby::Resources::DB.new
+    end
+
+    # Returns the layouts hash object.
+    #
+    def layouts
+      @layouts ||= ::Webby::Resources::DB.new
+    end
+
+    # Returns the partials hash object.
+    #
+    def partials
+      @partials ||= ::Webby::Resources::DB.new
+    end
+
+    # Clear the contents of the +layouts+, +pages+ and +partials+ hash
+    # objects.
+    #
+    def clear
+      self.pages.clear
+      self.layouts.clear
+      self.partials.clear
+    end
+
+    # call-seq:
+    #    Resources.new( filename )
+    #
+    #
+    def new( fn )
+      # normalize the path
+      fn = self.path(fn)
+
+      # see if we are dealing with a layout
+      if %r/\A#{::Webby.site.layout_dir}\//o =~ fn
+        r = ::Webby::Resources::Layout.new(fn)
+        self.layouts << r
+        return r
+      end
+
+      # see if we are dealing with a partial
+      filename = ::Webby::Resources::File.basename(fn)
+      if %r/\A_/o =~ filename
+        r = ::Webby::Resources::Partial.new(fn)
+        self.partials << r
+        return r
+      end
+
+      # see if we are dealing with a static resource
+      meta = ::Webby::Resources::File.meta_data(fn)
+      if meta.nil?
+        r = ::Webby::Resources::Static.new(fn)
+        self.pages << r
+        return r
+      end
+
+      # this is a renderable page
+      r = ::Webby::Resources::Page.new(fn)
+      self.pages << r
+      return r
+    end
+
+    # Returns a normalized path for the given filename.
+    #
+    def path( filename )
+      filename.sub(%r/\A(?:\.\/|\/)/o, '').freeze
+    end
+
+  end  # class << self
+
+end  # module Webby::Resources
+
+Webby.require_all_libs_relative_to(__FILE__)
+
+# EOF