zena 0.15.2 → 0.16.0

data/doc/template/allison.js

@@ -0,0 +1,307 @@
+
+// Javascript for Allison RDoc template
+// Copyright 2006 Cloudburst LLC
+// Some sections originally from public domain material
+
+var href_base = '%style_url%'.replace(/(.*\/).*/, '$1'); // haha! inline js is good for something
+
+function $(id) {
+    if (document.getElementById)
+      elem = document.getElementById(id);
+    else if ( document.all )
+      elem = eval("document.all." + id);
+    else
+      return false;
+    return elem;
+}
+
+  function toggle(id) {
+    elem = $(id);
+    elemStyle = elem.style;
+    if (elemStyle.display == "block") {
+      elemStyle.display = "none"
+    } else {
+      elemStyle.display = "block"
+    }
+    return true;
+  }
+
+  function toggleText(id) {
+    elem = $(id)
+    if (m = elem.innerHTML.match(/(Hide)(.*)/)) {
+      elem.innerHTML = "Show" + m[2];
+    } else if (m = elem.innerHTML.match(/(Show)(.*)/)) {
+      elem.innerHTML = "Hide" + m[2];
+    }
+    return true;
+  }
+
+function span(s, klass) {
+  return '<span class="' + klass + '">' + s + '</span>';
+}
+
+function highlightSymbols() {
+  pres = document.getElementsByTagName('pre');
+  for(var i = 0; i < pres.length; i++) {
+    pre = pres[i];
+    spans = pre.getElementsByTagName('span');
+    for(var k = 0; k < spans.length; k++) {
+      span = spans[k];
+      if (span.className.match(/ruby-identifier/)) {
+        if (span.innerHTML.match(/^:/)) {
+          span.className += " ruby-symbol";
+        }
+      }
+    }
+  }
+}
+
+ function hasClass(obj) {
+     var result = false;
+     if (obj.getAttributeNode("class") != null) {
+         result = obj.getAttributeNode("class").value;
+     }
+     return result;
+  }
+
+ function stripe() {
+    var even = true;
+    var color = "#EEF0F3";
+    var tables = $('content').getElementsByTagName('table');
+    if (tables.length == 0) { return; }
+    for (var h = 0; h < tables.length; h++) {
+        var trs = tables[h].getElementsByTagName("tr");
+        for (var i = 0; i < trs.length; i++) {
+          var tds = trs[i].getElementsByTagName("td");
+            for (var j = 0; j < tds.length; j++) {
+              if (hasClass(tds[j]) != "first") {
+              var mytd = tds[j];
+              if (even) {
+                mytd.style.backgroundColor = color;
+              }
+            }
+          }
+          even =  ! even;
+      }
+    }
+  }
+
+function ajaxGet(url) {
+  url = (href_base + url).replace('/./', '/')
+  var req = false;
+
+  if (window.ActiveXObject) {
+    try {
+      // stupid hack because IE7 disables local Ajax with the native xmlhttprequest object
+      // for security purposes. Yet ActiveX still works. Thanks, Microsoft. I hate you. Die.
+      req = new ActiveXObject("MSXML2.XMLHTTP.3.0");
+    } catch (e) {
+      try {
+        /* IE 6 and maybe 5, don't know, don't care */
+        req = new ActiveXObject("Msxml2.XMLHTTP");
+      } catch (e) {
+        try {
+          req = new ActiveXObject("Microsoft.XMLHTTP");
+        } catch (e) {
+          req = false;
+        }
+      }
+    }
+  }
+
+  /* real browsers */
+  if (!req && window.XMLHttpRequest) {
+    try {
+      req = new XMLHttpRequest();
+    } catch (e) {
+      req = false;
+    }
+  }
+
+  if (req) {
+    req.open('GET', url, false);
+    req.send(null);
+    return req.responseText;
+  } else {
+    return "Ajax error";
+  }
+}
+
+
+function addEvent(elm, evType, fn, useCapture) {
+	if (elm.addEventListener) {
+	  elm.addEventListener(evType, fn, useCapture);
+  	return true;
+	} else if (elm.attachEvent) {
+  	var r = elm.attachEvent('on' + evType, fn);
+	  return r;
+	} else {
+  	elm['on' + evType] = fn;
+	}
+}
+
+function insertIndices() {
+  pages = ["class", "file", "method"]
+  for (x in pages) {
+    $(pages[x]).innerHTML += ajaxGet('fr_' + pages[x] + '_index.html').replace(/(href=")/g, '$1' + href_base);
+  }
+  /* mouseoverify method links */
+  links = $('method').getElementsByTagName('a');
+  for (var x = 0; x < links.length; x++) {
+    if (m = links[x].innerHTML.match(/(.*)\s\((.*)\)/)) {
+      links[x].innerHTML = m[1] + '<br>';
+      links[x].title = m[2];
+    }
+  }
+  /* this is stupid */
+  $('class').style.display = "block";
+  $('file').style.display = "block";
+
+  /* has to be here because IE7 does not guarantee the onLoad callback order */
+  abbreviateIndicesInner(["class", "file"], 25, "a");
+  /* same, linkTitle() depends on the class link list */
+  linkTitle();
+}
+
+function abbreviateIndices() {
+  abbreviateIndicesInner(["defined_in", "child_of", "includes"], 20, 'a');
+  abbreviateIndicesInner(["defined_in", "requires", "child_of", "includes"], 20, 'span');
+}
+
+function abbreviateIndicesInner(indices, amount, tag) {
+  for (var x = 0; x < indices.length; x++) {
+    var the_index = $(indices[x]);
+    if (the_index) {
+      links = the_index.getElementsByTagName(tag);
+      for (var y = 0; y < links.length; y++) {
+        var link = links[y];
+        if (link.getElementsByTagName('span').length == 0 && link.getElementsByTagName('a').length == 0) {
+          // avoid nesting
+          link.innerHTML = abbreviate(link.innerHTML, amount);
+        }
+      }
+    }
+  }
+}
+
+function linkTitle() {
+  /* grab the correct title element from the index */
+  var index_page = ajaxGet('index.html');
+  title_text = index_page.match(/<title>(.*)<\/title>/m)[1];
+  document.title = title_text + " - " + document.title;
+  var p = $('header').getElementsByTagName('p')[0]
+  if (p.innerHTML.match(/^\s*$/)) {
+    p.innerHTML = title_text;
+  } else {
+    p.innerHTML = title_text + ": " + p.innerHTML;
+  }
+  /* set the link properly */
+  title_link = index_page.match(/<a\s+href="(.*?)"/)[1];
+  var element = $('title');
+  var item_type = "";
+  var item_name = "";
+  if (m = element.innerHTML.match(/(Class:|Module:|File:)\s*(.*)/)) {
+    item_type = m[1];
+    item_name = m[2];
+  } else {
+    item_name = element.innerHTML;
+  }
+  element.innerHTML = '<a href="' + href_base + title_link + '">' + item_type + " " + abbreviate(item_name, 25) + '</a>';
+  /* breadcrumb navigation for the win */
+  items = item_name.split("::");
+  items_new = item_name.split("::");
+  var s = ""
+  file_links = $('class').getElementsByTagName('a');
+  for (var x = 0; x < items.length - 1; x++ ){
+    var item = items[x];
+    link = ("/classes/" + items.slice(0,x).join("/") + "/" + item + ".html").replace('//', '/');
+    regex = new RegExp(RegExp.escape(link) + '$');
+    for (var y = 0; y < file_links.length; y++) {
+      if (file_links[y].href.match(regex)) {
+         items_new[x] = '<a href="' + href_base + link + '">' + item + '</a>';
+         break;
+      }
+    }
+  }
+  $('item_name').innerHTML = item_type + ' ' + items_new.join(" :: ");
+}
+
+function abbreviate(s, size) {
+  while (s.length > size) {
+    var old_s = s;
+    s = s.replace(/\s|\n/mg, '');
+    s = s.replace(/([A-Z])[a-z]+/m, '$1');
+    if (!s || old_s == s) {
+      return "..." + s.substring(s.length - size, s.length);
+    }
+  }
+  return s;
+}
+
+function disableSubmit(event) {
+  var keyCode = event.keyCode ? event.keyCode : event.which ? event.which : event.charCode;
+  if (keyCode == 13) {
+    return false;
+  } else {
+    return true;
+  }
+}
+
+function filterList(id, s, event) {
+
+  /* some half-assed escaping */
+  s = s.replace(/[^\w\d\.\_\-\/\:\=\[\]\?\!]/g, '');
+  s = RegExp.escape(s);
+
+  var show_all = false;
+  if (s.match(/^\s*$/)) {
+    show_all = true;
+  }
+
+  links = $(id).getElementsByTagName('a')
+  regex = new RegExp(s, 'i');
+
+  for (var x = 0; x < links.length; x++) {
+    var link = links[x];
+    if (show_all) {
+      link.style.display = 'inline';
+    } else {
+       if (link.innerHTML.match(regex)) {
+         link.style.display = 'inline';
+       } else {
+         link.style.display = 'none';
+       }
+    }
+  }
+  return true;
+}
+
+RegExp.escape = function(text) {
+  if (!arguments.callee.sRE) {
+    var specials = [
+      '/', '.', '*', '+', '?', '|',
+      '(', ')', '[', ']', '{', '}', '\\\\'
+    ];
+    arguments.callee.sRE = new RegExp(
+      '(\\\\' + specials.join('|\\\\') + ')', 'g'
+    );
+  }
+  return text.replace(arguments.callee.sRE, '\\\\$1');
+}
+
+
+function hacks() {
+  // show the spacer if necessary,
+  divs = document.getElementsByTagName('div');
+  for (x in divs) {
+    if (divs[x].className && divs[x].className.match(/top/)) {
+      document.getElementById('spacer').style.display = 'block';
+    }
+  }
+}
+
+addEvent(window, 'load', insertIndices, false);
+addEvent(window, 'load', abbreviateIndices, false);
+addEvent(window, 'load', stripe, false);
+addEvent(window, 'load', highlightSymbols, false);
+addEvent(window, 'load', hacks, false);

data/doc/template/allison.rb

@@ -0,0 +1,260 @@
+# Allison RDoc template
+# Copyright 2006 Cloudburst LLC
+
+class String
+  # fuck this stupid rdoc templater system
+  def if_exists (item = nil)
+    unless item
+      self unless self =~ /(%(\w+)%)/
+      "\nIF:#{$2}\n#{self}\nENDIF:#{$2}\n"
+    else
+      "\nIF:#{item}\n#{self}\nENDIF:#{item}\n"
+    end
+  end
+  def loop(item)
+    "\nSTART:#{item}\n#{self}\nEND:#{item}\n"
+  end
+end
+
+module RDoc
+  module Page
+
+    puts "Invoking Allison template..."
+
+    require 'pathname'
+    CACHE_DIR = Pathname.new(__FILE__).dirname.to_s + "/cache"
+
+    begin
+      require 'rubygems'
+      require_gem 'markaby', '>= 0.5' # how come this isn't activate_gem(), since that's what it does?
+      require 'markaby'
+      require 'base64'
+
+      module Allison
+        # markaby page says markaby is better in its own module...
+
+        URL = "http://blog.evanweaver.com/articles/2006/06/02/allison"
+        IMGPATH = 'allison.gif'
+
+        FONTS = METHOD_LIST = SRC_PAGE = FILE_PAGE = CLASS_PAGE = ""
+
+        FR_INDEX_BODY = "!INCLUDE!" # who knows
+
+        STYLE, JAVASCRIPT = ["css", "js"].map do |extension|
+          File.open(File.dirname(__FILE__) + "/allison.#{extension}").read
+        end
+
+        puts "Compiling XHTML..."
+
+        INDEX = Markaby::Builder.new.xhtml_strict do
+          head do
+            title '%title%'
+            link :rel => 'stylesheet', :type => 'text/css', :href => 'rdoc-style.css', :media => 'screen'
+            tag! :meta, 'http-equiv' => 'refresh', 'content' => '0;url=%initial_page%'
+          end
+          body do
+            div.container! do
+              div.header! do
+                span.title! do
+                  h1 "Zena Documentation"
+                end
+              end
+              div.clear {}
+              div.redirect! do
+                a :href => '%initial_page%' do
+                  h1 "Redirect"
+                end
+              end
+            end
+            p.allison! do
+               self << 'template adapted from '
+               a 'Allison', :href => URL
+            end
+          end
+        end.to_s
+
+        FILE_INDEX = METHOD_INDEX = CLASS_INDEX = Markaby::Builder.new.capture do
+          a :href => '%href%' do
+            self << '%name%'
+            br
+          end
+        end.loop('entries')
+
+        BODY = Markaby::Builder.new.xhtml_strict do
+          head do
+            title "%title%"
+            link :rel => 'stylesheet', :type => 'text/css', :href => '%style_url%', :media => 'screen'
+            script :type => 'text/javascript' do
+              JAVASCRIPT
+            end
+          end
+          body do
+              div.header! do
+                p {'%full_path%'.if_exists}
+                span do
+                  h1.title! '%title%'.if_exists
+                end
+                self << "!INCLUDE!" # always empty
+              end
+              table.container! do
+              self << tr do
+                td.left! do
+                  self << (div.navigation.dark.top.child_of! do
+                    # death to you, horrible templater >:(
+                    h3 "Child of"
+                    self << "<span>\n#{"<a href='%par_url%'>".if_exists}%parent%#{"</a>".if_exists('par_url')}</span>"
+                  end).if_exists('parent')
+
+                  self << div.navigation.dark.top.defined_in! do
+                    h3('Defined in')
+                    self << a('%full_path%', :href => '%full_path_url%').if_exists.loop('infiles')
+                  end.if_exists('infiles')
+
+                  ['includes', 'requires', 'methods'].each do |item|
+                    self << div.navigation.top(:id => item) do
+                      self << h3(item.capitalize)
+                      self << "<span class='bpink'>\n#{"<a href='%aref%'>".if_exists}%name%#{br}#{"</a>".if_exists('aref')}</span>".if_exists('name').loop(item)
+                    end.if_exists(item)
+                  end
+
+                  div.spacer! ''
+
+                  # for the javascript ajaxy includes
+                  ['class', 'file', 'method'].each do |item|
+                    div.navigation.dark.index :id => "#{item}_wrapper" do
+                     div.list_header do
+                       h3 'All ' + (item == 'class' ? 'classes' : item + 's')
+                     end
+                     div.list_header_link do
+                       a((item == 'method' ? 'Show...' : 'Hide...'),
+                          :id => "#{item}_link", :href => "#",
+                          :onclick=> "toggle('#{item}'); toggleText('#{item}_link'); return false;")
+                     end
+                     div.clear {}
+                     div(:id => item) do
+                       form do
+                         label(:for => "filter_#{item}") { 'Filter:' + '&nbsp;' * 2 }
+                         input '', :type => 'text', :id => "filter_#{item}",
+                                     :onKeyUp => "return filterList('#{item}', this.value, event);",
+                                     :onKeyPress => "return disableSubmit(event);"
+                       end
+                     end
+                     # insert classes here...
+                    end
+                  end
+                end
+
+                td.content! do
+                  self << capture do
+                    h1.item_name! '%title%'
+                  end.if_exists('title')
+
+                  self << capture do
+                    self << '%description%'
+                  end.if_exists('description')
+
+                  self << capture do
+                    self << h1 {a '%sectitle%', :name => '%secsequence%'}.if_exists('sectitle')
+                    self << p {'%seccomment%'}.if_exists
+
+                    self << capture do
+                      h1 "Child modules and classes"
+                      p '%classlist%'
+                    end.if_exists('classlist')
+
+                    ['constants', 'aliases', 'attributes'].each do |item|
+                      self << capture do
+                        h1(item.capitalize)
+                        p do
+                          table do
+                            fields = %w[name value old_name new_name rw desc a_desc]
+                            self << tr do
+                              # header row
+                              if item == 'constants'
+                                th 'Name'
+                                th 'Value'
+                              elsif item == 'aliases'
+                                th 'Old name'
+                                th 'New name'
+                              elsif item == 'attributes'
+                                th 'Name'
+                                th 'Read/write?'
+                              end
+                              th.description(:colspan => 2){"Description"}
+                            end
+                            self << tr do
+                              # looped item rows
+                              fields.each do |field|
+                                if field !~ /desc/
+                                  self << td('%' + field + '%', :class => field =~ /^old|^name/ ? "highlight" : "normal").if_exists
+                                else
+                                  self << td(('%' + field+ '%').if_exists)
+                                end
+                              end
+                            end.loop(item)
+                          end
+                        end
+                      end.if_exists(item)
+                    end
+
+                    self << capture do
+                      div.section_spacer ''
+                      h1('%type% %category% methods')
+                      self << capture do
+                        self << a.small(:name => '%aref%') {br}.if_exists
+                        div.a_method do
+                          div do
+                            h3 do
+                              self << "<a href='#%aref%'>".if_exists + '%callseq%'.if_exists + '%name%'.if_exists + "</a>".if_exists('aref')+'<span class="params">%params%</span>'.if_exists('params')
+                            end
+                            self << '%m_desc%'.if_exists
+
+                            self << capture do
+                             p.source_link :id => '%aref%-show-link' do
+                               self << "[ "
+                               a "show source", :id => '%aref%-link', :href => "#",
+                                             :onclick=> "toggle('%aref%-source'); toggleText('%aref%-link'); return false;"
+                               self << " ]"
+                             end
+                             div.source :id => '%aref%-source' do
+                                  pre { '%sourcecode%' }
+                               end
+                             end.if_exists('sourcecode')
+                            end
+                          end
+
+                      end.loop('methods').if_exists('methods')
+                    end.loop('method_list').if_exists('method_list')
+
+                  end.loop('sections').if_exists('sections')
+
+                end
+              end
+            end
+            p.allison! do
+               self << 'template adapted from '
+               a 'Allison', :href => URL
+            end
+          end
+        end.to_s
+      end
+
+    Allison.constants.each do |c|
+      eval "#{c} = Allison::#{c}" # jump out of the namespace
+      File.open("#{CACHE_DIR}/#{c}", 'w') do |f|
+        f.puts eval(c) # write cache
+      end
+    end
+
+    rescue LoadError => e
+      # guess we don't have some dependency. hope the cache is fresh!
+      lib = (e.to_s[/(.*)\(/, 1] or e.to_s).split(" ").last.capitalize
+      puts "Loading from cache (#{lib} was missing)..."
+      Dir[CACHE_DIR + '/*'].each do |filename|
+        eval("#{filename.split("/").last} = File.open(filename) {|s| s.read}")
+      end
+    end
+
+  end
+
+end