zenweb 2.18.0

data/lib/ZenWeb/HeaderRenderer.rb

@@ -0,0 +1,52 @@
+require 'ZenWeb/GenericRenderer'
+
+=begin
+
+= Class HeaderRenderer
+
+Inserts a header based on metadata.
+
+=== Methods
+
+=end
+
+class HeaderRenderer < GenericRenderer
+
+=begin
+
+--- HeaderRenderer#render(content)
+
+    Adds a header if the ((|header|)) metadata item exists. If the
+    document contains a BODY HTML tag, then the header immediately
+    follows it, otherwise it is simply at the top.
+
+=end
+
+  def render(content)
+
+    header = @document['header'] || nil
+
+    if header then
+      placed = false
+
+      content.each { | line |
+
+	push(line)
+
+	if (line =~ /<BODY/i) then
+	  push(header)
+	  placed = true
+	end
+      }
+
+      unless placed then
+	unshift(header) unless placed
+      end
+    else
+      push(content)
+    end
+
+    return self.result
+  end
+end
+

data/lib/ZenWeb/HtmlRenderer.rb

@@ -0,0 +1,81 @@
+require 'ZenWeb/GenericRenderer'
+
+=begin
+
+= Class HtmlRenderer
+
+Abstract superclass that provides common functionality for those
+renderers that produce HTML.
+
+=== Methods
+
+=end
+
+class HtmlRenderer < GenericRenderer
+
+=begin
+
+--- HtmlRenderer#render(content)
+
+    Raises an exception. This is subclass responsibility as this is an
+    abstract class.
+
+=end
+
+  def render(content)
+    raise "Subclass Responsibility"
+  end
+
+=begin
+
+--- HtmlRenderer#array2html
+
+    Converts an array (of arrays, potentially) into an unordered list.
+
+=end
+
+  def array2html(list, ordered=false, indent=0)
+    result = []
+
+    indent1 = "  " * indent
+    indent2 = "  " * (indent + 1)
+
+    tag = ordered ? "OL" : "UL"
+
+    result << "#{indent1}<#{tag}>\n"
+    list.each { | l |
+      if (l.is_a?(Array)) then
+        x = result.pop
+        result.push "\n"
+        result.push self.array2html(l, ordered, indent+2)
+        result.push indent2 unless x =~ /^\s+/
+        result.push x
+      else
+	result.push(indent2, "<LI>", l.to_s, "</LI>\n")
+      end
+    }
+    result << "#{indent1}</#{tag}>\n"
+
+    return result.join
+  end
+
+  def hash2html(hash, order)
+    result = ""
+
+    if (hash) then
+      result += "<DL>\n"
+      order.each { | key |
+	val = hash[key] or raise "Key '#{key}' is missing!"
+	result += "  <DT>#{key}</DT>\n"
+	result += "  <DD>#{val}</DD>\n\n"
+      }
+      result += "</DL>\n"
+    else
+      result = "not a hash"
+    end
+
+    return result
+  end
+
+end
+

data/lib/ZenWeb/HtmlTableRenderer.rb

@@ -0,0 +1,94 @@
+require 'ZenWeb/GenericRenderer'
+
+class Hash
+  def %(style)
+    style.gsub(/%([-\d]*)\(([^\)]+)\)/) do |match|
+      result = ''
+      key = $2.intern
+      if self.has_key?(key) then
+	result = $1 ? sprintf("%*s", $1.to_i, self[key]) : self[key]
+      else
+	$stderr.puts "  WARNING: missing data for '#{key}' in #{self.inspect}" unless $TESTING
+      end
+      result
+    end
+  end
+end
+
+=begin
+
+= Class HtmlTableRenderer
+
+Converts tab delimited data (tagged with <tabs>) into HTML tables
+
+=== Methods
+
+=end
+
+class HtmlTableRenderer < GenericRenderer
+
+=begin
+
+     --- HtmlTableRenderer#render(content)
+
+     Converts tab delimited data (tagged with <tabs>) into HTML tables
+
+=end
+
+  def render(content)
+
+    first=true
+    pre_style = post_style = head_style = body_style = column_titles = nil
+
+    self.scan_region(content, /^<tabs/i, /^<\/tabs>/i) do |line, context|
+      line.chomp!
+      case context
+      when :START then
+	first = true
+	if line =~ /style\s*=\s*\"?([\w\.-]+)\"?/i then
+	  pre_style  = @document["style_#{$1}_pre"]  || ''
+	  post_style = @document["style_#{$1}_post"] || ''
+	  head_style = @document["style_#{$1}_head"] || ''
+	  body_style = @document["style_#{$1}"] or
+	    raise "You must specify a metadata entry for 'style_#{$1}'"
+	else
+	  pre_style = "<table border=\"0\">\n"
+	  post_style = "</table>\n" 
+	  head_style = nil
+	  body_style = nil
+	  column_titles = nil
+	end
+	line = pre_style
+      when :END then
+	line = post_style
+      else
+	columns = line.split(/\t+/)
+	
+	if body_style then
+	  if first then
+	    line = head_style
+	    # map the first row of data to column title positions
+	    column_titles = columns.map {|x| x.intern}
+	  else
+	    data = {}
+	    # use the column title positions to extract the data from the table
+	    column_titles.each_with_index do |title, index|
+	      data[title] = columns[index]
+	    end
+	    
+	    # use our extension to hash (see above) to format the data
+	    line = data % body_style
+	  end
+	else
+	  type = first ? "th" : "td"
+	  line = "<tr><#{type}>#{columns.join "</#{type}><#{type}>"}</#{type}></tr>\n"
+	end
+	first = false if first
+      end
+      push line
+    end
+  
+    return self.result
+  end
+
+end

data/lib/ZenWeb/HtmlTemplateRenderer.rb

@@ -0,0 +1,173 @@
+require 'ZenWeb/HtmlRenderer'
+
+=begin
+
+= Class HtmlTemplateRenderer
+
+Generates a consistant HTML page header and footer, including a
+navigation bar, title, subtitle, and appropriate META tags.
+
+=== Methods
+
+=end
+
+class HtmlTemplateRenderer < HtmlRenderer
+
+=begin
+
+--- HtmlTemplateRenderer#render(content)
+
+    Renders a standardized HTML header and footer. This currently also
+    includes a navigation bar and a list of subpages, which will
+    probably be broken out to their own renderers soon.
+
+    Metadata variables used:
+
+    + author
+    + banner - graphic at the top of the page, usually a logo
+    + bgcolor - defaults to not being defined
+    + copyright
+    + description
+    + dtd (default: 'DTD HTML 4.0')
+    + email - used in a mailto in metadata
+    + keywords
+    + rating (default: 'general')
+    + stylesheet - reference to a CSS file
+    + style - CSS code directly (for smaller snippets)
+    + subtitle
+    + title (default: 'Unknown Title')
+    + icbm - longitude and latitude for geourl.org
+    + icbm_title - defaults to the page title
+
+=end
+
+  def render(content)
+    author      = @document['author']
+    banner      = @document['banner']
+    bgcolor     = @document['bgcolor']
+    dtd		= @document['dtd'] || 'DTD HTML 4.0'
+    copyright   = @document['copyright']
+    description = @document['description']
+    email       = @document['email']
+    keywords    = @document['keywords']
+    rating      = @document['rating'] || 'general'
+    stylesheet  = @document['stylesheet']
+    subtitle    = @document['subtitle']
+    title       = @document['title'] || 'Unknown Title'
+    icbm        = @document['icbm']
+    icbm_title  = @document['icbm_title'] || @document['title']
+    charset     = @document['charset']
+    style       = @document['style']
+    naked_page  = @document['naked_page']
+    head_extra  = @document['head_extra'] || []
+
+    titletext   = @document.fulltitle
+
+    # TODO: iterate over a list of metas and add them in one nicely organized block
+
+    if bgcolor then
+      style ||= ""
+      style = "body { background-color: #{bgcolor} }\n" + style
+    end
+
+    # header
+    push([
+	   "<!DOCTYPE HTML PUBLIC \"-//W3C//#{dtd}//EN\">\n",
+	   "<HTML>\n",
+	   "<HEAD>\n",
+	   "<TITLE>#{titletext}</TITLE>\n",
+	   email ? "<LINK REV=\"MADE\" HREF=\"#{email}\">\n" : [],
+	   stylesheet ? "<LINK REL=\"STYLESHEET\" HREF=\"#{stylesheet}\" TYPE=\"text/css\" title=\"#{stylesheet}\">\n" : [],
+	   "<META NAME=\"rating\" CONTENT=\"#{rating}\">\n",
+	   "<META NAME=\"GENERATOR\" CONTENT=\"#{ZenWebsite.banner}\">\n",
+	   style ? "<STYLE TYPE=\"text/css\">\n#{style}\n</STYLE>" : [],
+	   author ? "<META NAME=\"author\" CONTENT=\"#{author}\">\n" : [],
+	   copyright ? "<META NAME=\"copyright\" CONTENT=\"#{copyright}\">\n" : [],
+	   keywords ? "<META NAME=\"keywords\" CONTENT=\"#{keywords}\">\n" : [],
+	   description ? "<META NAME=\"description\" CONTENT=\"#{description}\">\n" : [],
+	   charset ? "<META HTTP-EQUIV=\"content-type\" CONTENT=\"text/html; charset=#{charset}\">" : [],
+	   icbm ? "<meta name=\"ICBM\" content=\"#{icbm}\">\n<meta name=\"DC.title\" content=\"#{icbm_title}\">" : [],
+
+           "<link rel=\"up\" href=\"#{@document.parentURL}\" title=\"#{@document.parent.title}\">\n",
+           "<link rel=\"contents\" href=\"#{@sitemap.url}\" title=\"#{@sitemap.title}\">\n",
+           "<link rel=\"top\" href=\"#{@website.top.url}\" title=\"#{@website.top.title}\">\n",
+
+          head_extra.join("\n"),
+
+	   "</HEAD>\n",
+	   "<BODY>\n",
+	 ])
+
+    unless naked_page then
+      self.navbar
+
+      if banner then
+        push("<H1><IMG SRC=\"#{banner}\" ALT=\"#{File.basename banner}\"></H1>\n")
+        unless (subtitle) then
+          push("<H2>#{title}</H2>\n")
+        end
+      else
+        push("<H1>#{title}</H1>\n")
+      end
+    
+      push([
+            subtitle ? "<H2>#{subtitle}</H2>\n" : [],
+            "<HR CLASS=\"thick\">\n\n",
+           ])
+    end
+
+    push content
+
+    unless naked_page then
+      push([
+            "<HR CLASS=\"thick\">\n\n",
+           ])
+
+      self.navbar
+    end
+    
+    push("\n</BODY>\n</HTML>\n")
+
+    return self.result
+  end
+
+=begin
+
+--- HtmlTemplateRenderer#navbar
+
+    Generates a navbar that contains a link to the sitemap, search
+    page (if any), and a fake "breadcrumbs" trail which is really just
+    a list of all of the parent titles up the chain to the top.
+
+=end
+
+  def navbar
+
+    sep = " / "
+    search  = @website["/Search.html"]
+
+    push([
+	   "<P class=\"navbar\">\n",
+	   "<A HREF=\"#{@sitemap.url}\">Sitemap</A>",
+	   search ? " | <A HREF=\"#{search.url}\"><EM>Search</EM></A>" : [],
+	   " || ",
+	 ])
+
+    path = []
+    current = @document
+    while current and current != current.parent do
+      current = current.parent
+      path.unshift(current) if current
+    end
+
+    push([
+	   path.map{|doc| ["<A HREF=\"#{doc.url}\">#{doc['title']}</A>\n", sep]},
+	   @document['title'],
+	   "</P>\n",
+	 ])
+
+    return []
+  end
+
+end
+

data/lib/ZenWeb/MetadataRenderer.rb

@@ -0,0 +1,83 @@
+require 'ZenWeb/GenericRenderer'
+
+=begin
+
+= Class MetadataRenderer
+
+Converts all metadata references into their values.
+
+=== Methods
+
+=end
+
+class MetadataRenderer < GenericRenderer
+
+  @@cache = {}
+
+=begin
+
+--- MetadataRenderer#render(content)
+
+    Converts all metadata references into their values.
+
+=end
+
+  def render(content)
+
+    content = content.gsub(/\#\{([^\}]+)\}/) {
+      key = $1
+      
+      # check to see if this is a metadata entry
+      val = @document[key] || nil
+      
+      # otherwise try to eval it. If that fails, just give text.
+      unless (val) then
+	begin
+	  # this allows evals that fail (expensive) to be cached, 
+	  # and good code to be eval'd every time.
+	  # I think this is a good balance.
+	  if @@cache[key] then
+	    val = @@cache[key]
+	  else
+	    val = eval(key)
+	  end
+	rescue NameError => err
+	  val = key
+	  @@cache[key] = key
+	rescue Exception => err
+	  $stderr.puts "eval failed in MetadataRenderer for #{@document.datapath}: #{err}. Code = '#{key}'"
+	  val = key
+	  @@cache[key] = key
+	end
+      end
+      
+      val
+    }
+
+    return content
+  end
+
+  @@paths = {}
+
+  def include(path, remove_metadata=false, escape=false)
+    unless @@paths.include? path then
+      full_path = File.expand_path(File.join(File.dirname(@document.datapath), path))
+      @@paths[path] = full_path
+    else
+      full_path = @@paths[path]
+    end
+
+    content = File.new(full_path).readlines
+
+    if remove_metadata then
+      content = content.reject { |line| line =~ /^\s*\#/ }
+    end
+
+    content = self.render(content.join(''))
+    content.gsub!(/([<>&])/) { |x| '\\' + x } if escape
+
+    content
+  end
+
+end
+