jfish 0.1.0

data/lib/template/jfish/_head.rhtml

@@ -0,0 +1,16 @@
+<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type">
+
+<title><%= h @title %></title>
+
+<link type="text/css" media="screen" href="<%= asset_rel_prefix %>/rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "<%= rel_prefix %>/";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= search_index_rel_prefix %>/js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/jfish.js"></script>

data/lib/template/jfish/_sidebar_VCS_info.rhtml

@@ -0,0 +1,18 @@
+<% if !svninfo.empty? then %>
+<nav id="file-svninfo-section" class="section">
+  <h3 class="section-header">VCS Info</h3>
+  <div class="section-body">
+    <dl class="svninfo">
+      <dt>Rev
+      <dd><%= svninfo[:rev] %>
+
+      <dt>Last Checked In
+      <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
+        (<%= svninfo[:commitdelta] %> ago)
+
+      <dt>Checked in by
+      <dd><%= svninfo[:committer] %>
+    </dl>
+  </div>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_classes.rhtml

@@ -0,0 +1,9 @@
+<nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  <% @modsort.each do |index_klass| %>
+    <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
+  <% end %>
+  </ul>
+</nav>

data/lib/template/jfish/_sidebar_extends.rhtml

@@ -0,0 +1,16 @@
+<% unless klass.extends.empty? then %>
+<!-- Extension Modules -->
+<nav id="extends-section" class="section">
+  <h3 class="section-header">Extended With Modules</h3>
+
+  <ul class="link-list">
+    <% klass.each_extend do |ext| %>
+  <% unless String === ext.module then %>
+    <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
+  <% else %>
+    <li><span class="extend"><%= ext.name %></span>
+  <% end %>
+  <% end %>
+  </ul>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_in_files.rhtml

@@ -0,0 +1,8 @@
+<nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+<% klass.in_files.each do |tl| %>
+    <li><%= h tl.relative_name %>
+<% end %>
+  </ul>
+</nav>

data/lib/template/jfish/_sidebar_includes.rhtml

@@ -0,0 +1,16 @@
+<% unless klass.includes.empty? then %>
+<!-- Included Modules -->
+<nav id="includes-section" class="section">
+  <h3 class="section-header">Included Modules</h3>
+
+  <ul class="link-list">
+  <% klass.each_include do |inc| %>
+  <% unless String === inc.module then %>
+    <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
+  <% else %>
+    <li><span class="include"><%= inc.name %></span>
+  <% end %>
+  <% end %>
+  </ul>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_installed.rhtml

@@ -0,0 +1,14 @@
+<nav id="home-section" class="section">
+  <h3 class="section-header">Documentation</h3>
+
+  <ul>
+  <% installed.each do |name, href, exists| %>
+    <li class="folder">
+    <% if exists then %>
+      <a href="<%= href %>"><%= h name %></a>
+    <% else %>
+      <%= h name %>
+    <% end %>
+  <% end %>
+  </ul>
+</nav>

data/lib/template/jfish/_sidebar_methods.rhtml

@@ -0,0 +1,12 @@
+<% unless klass.method_list.empty? then %>
+<!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    <% klass.each_method do |meth| %>
+    <li <% if meth.calls_super %>class="calls-super" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
+    <% end %>
+  </ul>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_navigation.rhtml

@@ -0,0 +1,10 @@
+<div id="logo">
+  <a href="<%= rel_prefix %>/"><img alt="<%= h @title %>" src="<%= rel_prefix %>/images/logo.png"/></a>
+</div>
+<nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="<%= rel_prefix %>/index.html">Home</a>
+    <a href="<%= rel_prefix %>/table_of_contents.html#classes">Classes</a>
+    <a href="<%= rel_prefix %>/table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>

data/lib/template/jfish/_sidebar_pages.rhtml

@@ -0,0 +1,12 @@
+<% simple_files = @files.select { |f| f.text? } %>
+<% unless simple_files.empty? then %>
+<nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  <% simple_files.each do |f| %>
+    <li class="file"><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
+  <% end %>
+  </ul>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_parent.rhtml

@@ -0,0 +1,10 @@
+<% if klass.type == 'class' then %>
+<nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  <% if klass.superclass and not String === klass.superclass then %>
+  <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
+  <% else %>
+  <p class="link"><%= klass.superclass %>
+  <% end %>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_search.rhtml

@@ -0,0 +1,10 @@
+<nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>

data/lib/template/jfish/_sidebar_sections.rhtml

@@ -0,0 +1,10 @@
+<% unless klass.sections.length == 1 then %>
+<nav id="sections-section" class="section">
+  <h3 class="section-header">Sections</h3>
+  <ul class="link-list">
+    <% klass.sort_sections.each do |section| %>
+      <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+    <% end %>
+  </ul>
+</nav>
+<% end %>

data/lib/template/jfish/_sidebar_table_of_contents.rhtml

@@ -0,0 +1,19 @@
+<% comment = if current.respond_to? :comment_location then
+               current.comment_location
+             else
+               current.comment
+             end
+   table = current.parse(comment).table_of_contents
+
+   if table.length > 1 then %>
+<div id="table-of-contents">
+  <nav class="section">
+    <h3 class="section-header">Table of Contents</h3>
+    <ul>
+<%   table.each do |heading| %>
+      <li><a href="#<%= heading.aref %>"><%= heading.plain_html %></a>
+<%   end %>
+    </ul>
+  </nav>
+</div>
+<% end %>

data/lib/template/jfish/class.rhtml

@@ -0,0 +1,179 @@
+<body id="top" class="<%= klass.type %>">
+<nav id="metadata">
+  <%= render '_sidebar_navigation.rhtml' %>
+
+  <%= render '_sidebar_search.rhtml' %>
+
+  <%= render '_sidebar_table_of_contents.rhtml' %>
+
+  <div id="file-metadata">
+    <%= render '_sidebar_in_files.rhtml' %>
+    <%= render '_sidebar_VCS_info.rhtml' %>
+  </div>
+
+  <div id="class-metadata">
+    <%= render '_sidebar_sections.rhtml' %>
+    <%= render '_sidebar_parent.rhtml' %>
+    <%= render '_sidebar_includes.rhtml' %>
+    <%= render '_sidebar_extends.rhtml' %>
+    <%= render '_sidebar_methods.rhtml' %>
+  </div>
+
+  <div id="project-metadata">
+    <%= render '_sidebar_pages.rhtml' %>
+    <%= render '_sidebar_classes.rhtml' %>
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="<%= klass.type %>"><%= klass.type %> <%= klass.full_name %></h1>
+
+  <div id="description" class="description">
+    <%= klass.description %>
+  </div><!-- description -->
+
+  <% klass.each_section do |section, constants, attributes| %>
+  <% constants = constants.select { |const| const.display? } %>
+  <% attributes = attributes.select { |attr| attr.display? } %>
+  <section id="<%= section.aref %>" class="documentation-section">
+    <% if section.title then %>
+    <div class="documentation-section-title">
+      <h2 class="section-header">
+        <%= section.title %>
+      </h2>
+      <span class="section-click-top">
+        <a href="#top">&uarr; top</a>
+      </span>
+    </div>
+    <% end %>
+
+    <% if section.comment then %>
+    <div class="description">
+      <%= section.description %>
+    </div>
+    <% end %>
+
+    <% unless constants.empty? then %>
+    <!-- Constants -->
+    <section id="constants-list" class="section">
+      <h3 class="section-header">Constants</h3>
+      <dl>
+      <% constants.each do |const| %>
+        <dt id="<%= const.name %>"><%= const.name %>
+        <% if const.comment then %>
+        <dd class="description"><%= const.description.strip %>
+        <% else %>
+        <dd class="description missing-docs">(Not documented)
+        <% end %>
+      <% end %>
+      </dl>
+    </section>
+    <% end %>
+
+    <% unless attributes.empty? then %>
+    <!-- Attributes -->
+    <section id="attribute-method-details" class="method-section section">
+      <h3 class="section-header">Attributes</h3>
+
+      <% attributes.each do |attrib| %>
+      <div id="<%= attrib.aref %>" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name"><%= h attrib.name %></span><span
+            class="attribute-access-type">[<%= attrib.rw %>]</span>
+        </div>
+
+        <div class="method-description">
+        <% if attrib.comment then %>
+        <%= attrib.description.strip %>
+        <% else %>
+        <p class="missing-docs">(Not documented)
+        <% end %>
+        </div>
+      </div>
+      <% end %>
+    </section><!-- attribute-method-details -->
+    <% end %>
+
+    <!-- Methods -->
+    <% klass.methods_by_type(section).each do |type, visibilities|
+       next if visibilities.empty?
+       visibilities.each do |visibility, methods|
+         next if methods.empty? %>
+     <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section section">
+      <h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
+
+    <% methods.each do |method| %>
+      <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
+        <% if method.call_seq then %>
+        <%   method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+        <div class="method-heading">
+          <span class="method-callseq">
+            <%= h(call_seq.strip.
+                  gsub( /^\w+\./m, '')).
+                  gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+          </span>
+          <% if i == 0 and method.token_stream then %>
+          <span class="method-click-advice">click to toggle source</span>
+          <% end %>
+        </div>
+        <%   end %>
+        <% else %>
+        <div class="method-heading">
+          <span class="method-name"><%= h method.name %></span><span
+            class="method-args"><%= method.param_seq %></span>
+          <% if method.token_stream then %>
+          <span class="method-click-advice">click to toggle source</span>
+          <% end %>
+        </div>
+        <% end %>
+
+        <div class="method-description">
+          <% if method.comment then %>
+          <%= method.description.strip %>
+          <% else %>
+          <p class="missing-docs">(Not documented)
+          <% end %>
+          <% if method.calls_super then %>
+            <div class="method-calls-super">
+              Calls superclass method
+              <%=
+                  method.superclass_method ?
+                  method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
+              %>
+            </div>
+          <% end %>
+
+          <% if method.token_stream then %>
+          <div class="method-source-code" id="<%= method.html_name %>-source">
+            <pre><%= method.markup_code %></pre>
+          </div><!-- <%= method.html_name %>-source -->
+          <% end %>
+        </div>
+
+        <% unless method.aliases.empty? then %>
+        <div class="aliases">
+          Also aliased as: <%= method.aliases.map do |aka|
+            if aka.parent then # HACK lib/rexml/encodings
+              %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
+            else
+              h aka.name
+            end
+          end.join ", " %>
+        </div>
+        <% end %>
+
+        <% if method.is_alias_for then %>
+        <div class="aliases">
+          Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+        </div>
+        <% end %>
+      </div><!-- <%= method.html_name %>-method -->
+
+    <% end %>
+    </section><!-- <%= visibility %>-<%= type %>-method-details -->
+  <% end
+     end %>
+  </section><!-- <%= section.aref %> -->
+<% end %>
+
+</div><!-- documentation -->

data/lib/template/jfish/index.rhtml

@@ -0,0 +1,19 @@
+<body>
+<nav id="metadata">
+  <%= render '_sidebar_navigation.rhtml' %>
+
+  <%= render '_sidebar_search.rhtml' %>
+
+  <div id="project-metadata">
+    <%= render '_sidebar_pages.rhtml' %>
+    <%= render '_sidebar_classes.rhtml' %>
+  </div>
+</nav>
+
+<div id="documentation" class="description">
+<% if @options.main_page && main_page = @files.find { |f| f.full_name == @options.main_page } then %>
+<%= main_page.description %>
+<% else %>
+<p>This is the API documentation for <%= @title %>.
+<% end %>
+</div>

data/lib/template/jfish/js/darkfish.js

@@ -0,0 +1,155 @@
+/**
+ *
+ * JFish Page Functions
+ * $Id: jfish.js 53 2009-01-07 02:52:03Z deveiant $
+ *
+ * Author: Michael Granger <mgranger@laika.com>
+ *
+ */
+
+/* Provide console simulation for firebug-less environments */
+if (!("console" in window) || !("firebug" in console)) {
+  var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
+    "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
+
+  window.console = {};
+  for (var i = 0; i < names.length; ++i)
+    window.console[names[i]] = function() {};
+};
+
+
+/**
+ * Unwrap the first element that matches the given @expr@ from the targets and return them.
+ */
+$.fn.unwrap = function( expr ) {
+  return this.each( function() {
+    $(this).parents( expr ).eq( 0 ).after( this ).remove();
+  });
+};
+
+
+function showSource( e ) {
+  var target = e.target;
+  var codeSections = $(target).
+    parents('.method-detail').
+    find('.method-source-code');
+
+  $(target).
+    parents('.method-detail').
+    find('.method-source-code').
+    slideToggle();
+};
+
+function hookSourceViews() {
+  $('.method-heading').click( showSource );
+};
+
+function toggleDebuggingSection() {
+  $('.debugging-section').slideToggle();
+};
+
+function hookDebuggingToggle() {
+  $('#debugging-toggle img').click( toggleDebuggingSection );
+};
+
+function hookTableOfContentsToggle() {
+  $('.indexpage li .toc-toggle').each( function() {
+    $(this).click( function() {
+      $(this).toggleClass('open');
+    });
+
+    var section = $(this).next();
+
+    $(this).click( function() {
+      section.slideToggle();
+    });
+  });
+}
+
+function hookSearch() {
+  var input  = $('#search-field').eq(0);
+  var result = $('#search-results').eq(0);
+  $(result).show();
+
+  var search_section = $('#search-section').get(0);
+  $(search_section).show();
+
+  var search = new Search(search_data, input, result);
+
+  search.renderItem = function(result) {
+    var li = document.createElement('li');
+    var html = '';
+
+    // TODO add relative path to <script> per-page
+    html += '<p class="search-match"><a href="' + rdoc_rel_prefix + result.path + '">' + this.hlt(result.title);
+    if (result.params)
+      html += '<span class="params">' + result.params + '</span>';
+    html += '</a>';
+
+
+    if (result.namespace)
+      html += '<p class="search-namespace">' + this.hlt(result.namespace);
+
+    if (result.snippet)
+      html += '<div class="search-snippet">' + result.snippet + '</div>';
+
+    li.innerHTML = html;
+
+    return li;
+  }
+
+  search.select = function(result) {
+    var result_element = result.get(0);
+    window.location.href = result_element.firstChild.firstChild.href;
+  }
+
+  search.scrollIntoView = search.scrollInWindow;
+};
+
+function highlightTarget( anchor ) {
+  console.debug( "Highlighting target '%s'.", anchor );
+
+  $("a[name]").each( function() {
+    if ( $(this).attr("name") == anchor ) {
+      if ( !$(this).parent().parent().hasClass('target-section') ) {
+        console.debug( "Wrapping the target-section" );
+        $('div.method-detail').unwrap( 'div.target-section' );
+        $(this).parent().wrap( '<div class="target-section"></div>' );
+      } else {
+        console.debug( "Already wrapped." );
+      }
+    }
+  });
+};
+
+function highlightLocationTarget() {
+  console.debug( "Location hash: %s", window.location.hash );
+  if ( ! window.location.hash || window.location.hash.length == 0 ) return;
+
+  var anchor = window.location.hash.substring(1);
+  console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
+
+  highlightTarget( anchor );
+};
+
+function highlightClickTarget( event ) {
+  console.debug( "Highlighting click target for event %o", event.target );
+  try {
+    var anchor = $(event.target).attr( 'href' ).substring(1);
+    console.debug( "Found target anchor: %s", anchor );
+    highlightTarget( anchor );
+  } catch ( err ) {
+    console.error( "Exception while highlighting: %o", err );
+  };
+};
+
+
+$(document).ready( function() {
+  hookSourceViews();
+  hookDebuggingToggle();
+  hookSearch();
+  highlightLocationTarget();
+  hookTableOfContentsToggle();
+
+  $('ul.link-list a').bind( "click", highlightClickTarget );
+});