jeffreyhunter77-R2Doc 0.1

data/lib/r2doc/template.rb

@@ -0,0 +1,95 @@
+module R2Doc
+
+  # Thrown when a template file cannot be found
+  class TemplateMissingError < StandardError
+    # name of the missing template
+    attr_reader :template
+    
+    def initialize(template)
+      super "Could not find template \"#{template}\""
+      @template = template
+    end
+  end
+  
+  # The TemplateManager class handles loading and parsing of templates.
+  # The actual details of reading the file and creating a parsed template
+  # object is handled by a template engine class.  TemplateManager's
+  # responsibilities are to record registration of template directories
+  # and engines, to locate the correct template source file, and then
+  # dispatch to the right engine.
+  #
+  # A template engine class need only supply a very limited interface.
+  # It must supply a class method named +load+ which accepts a file name
+  # as a single argument.  The +load+ method is expected to return an
+  # instance representing that template.  The returned instance must
+  # supply a +result+ method wich accepts a binding as its single
+  # argument.  The +result+ method is expected to return the rendered
+  # template as a string.  A single template instance may have its
+  # +result+ method invoked multiple times with different bindings.
+  class TemplateManager
+    # The collection of template engines by extension
+    @@template_engines = {}
+    # The list of template directories
+    @@template_directories = [File.join(File.expand_path(File.dirname(__FILE__)), 'template')]
+    # Cache for loaded templates
+    @@templates = {}
+    
+    # Register a template engine for an extension
+    def self.register_engine(extension, klass)
+      @@template_engines[extension.to_sym] = klass
+    end
+    
+    # Add a template directory to search
+    def self.add_template_directory(dir)
+      @@template_directories.push dir
+    end
+    
+    # Return the list of template directories
+    def self.template_directories
+      @@template_directories
+    end
+    
+    # Return the list of registered extensions
+    def self.registered_extensions
+      @@template_engines.keys
+    end
+    
+    # Load a template and return its instance
+    def self.load_template(name)
+      return @@templates[name.to_sym] if @@templates.has_key?(name.to_sym)
+      
+      # find the file
+      filename = self.find_template_file(name) or raise TemplateMissingError.new(name)
+      fileext = self.file_extension(filename)
+      @@templates[name.to_sym] = @@template_engines[fileext.to_sym].load(filename)
+    end
+    
+    # Determine the extension for a filename (not including the leading dot)
+    def self.file_extension(name)
+      m = /\.([^.]+)$/.match(name)
+      m.nil? ? nil : m[1]
+    end
+    
+    # Determine if a given extension is a registered extension
+    def self.is_registered_extension?(ext)
+      @@template_engines.has_key?(ext.nil? ? nil : ext.to_sym)
+    end
+    
+    protected
+    
+    # Determine the filename for a template
+    def self.find_template_file(name)
+      @@template_directories.each do |d|
+        @@template_engines.each_key do |ext|
+          ['html', 'js'].each do |type|
+            test = File.join(File.expand_path(d), "#{name.to_s}.#{type}.#{ext.to_s}")
+            return test if File.exists?(test)
+          end
+        end
+      end
+      nil
+    end
+    
+  end
+  
+end

data/lib/r2doc/template/r2doc/_aliases.html.erb

@@ -0,0 +1,22 @@
+    <h2><a name="aliases"></a>Aliases</h2>
+    
+    <% if ctx.has_aliases? %>
+    <table class="members aliases">
+      <thead>
+        <tr>
+          <th class="namehead">Method</th>
+          <th>Alias</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+      <% ctx.aliases.each_with_index{|al,i| %>
+        <tr class="<%= stripe_class i %>">
+          <td class="name"><%=h al[:old_name] %></td>
+          <td class="new_name">&rarr; <%=h al[:new_name] %></td>
+          <td class="description"><%= al[:description] %></td>
+        </tr>
+      <% } %>
+      </tbody>
+    </table>
+    <% end %>

data/lib/r2doc/template/r2doc/_attributes.html.erb

@@ -0,0 +1,24 @@
+    <h2><a name="attributes"></a>Attributes</h2>
+    
+    <% if ctx.has_attributes? %>
+    <table class="members attributes">
+      <thead>
+        <tr>
+          <th class="namehead">Name</th>
+          <th>Visibility</th>
+          <th>R/W</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+      <% ctx.attributes.each_with_index{|attribute,i| %>
+        <tr class="<%= stripe_class i %> <%=h attribute[:visibility].to_s %>">
+          <td class="name"><%=h attribute[:name] %></td>
+          <td class="visiblity"><%=h attribute[:visibility].to_s %></td>
+          <td class="rw"><%=h attribute[:rw] %></td>
+          <td class="description"><%= attribute[:description] %></td>
+        </tr>
+      <% } %>
+      </tbody>
+    </table>
+    <% end %>

data/lib/r2doc/template/r2doc/_classes_and_modules.html.erb

@@ -0,0 +1,13 @@
+    <h2><a name="classes_and_modules"></a>Classes &amp; Modules</h2>
+    
+    <% if ctx.has_classes_or_modules? %>
+    <ul class="classlist">
+      <% ctx.modules.each {|m| %>
+        <li class="module"><%= link_to h(m.name), m %></li>
+      <% } %>
+      <% ctx.classes.each {|c| %>
+        <li class="class"><%= link_to h(c.name), c %></li>
+      <% } %>
+    </ul>
+    <% end %>
+    

data/lib/r2doc/template/r2doc/_constants.html.erb

@@ -0,0 +1,22 @@
+    <h2><a name="constants"></a>Constants</h2>
+    
+    <% if ctx.has_constants? %>
+    <table class="members constants">
+      <thead>
+        <tr>
+          <th class="namehead">Name</th>
+          <th>&nbsp;</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+      <% ctx.constants.each_with_index{|constant,i| %>
+        <tr class="<%= stripe_class i %>">
+          <td class="name"><%=h constant[:name] %></td>
+          <td class="value">= <%=h constant[:value] %></td>
+          <td class="description"><%= constant[:description] %></td>
+        </tr>
+      <% } %>
+      </tbody>
+    </table>
+    <% end %>

data/lib/r2doc/template/r2doc/_method_detail.html.erb

@@ -0,0 +1,10 @@
+      <h4 class="method_detail"><a name="<%=h method[:anchor] %>"></a>
+        <% if method[:callseq] %>
+          <span class="name"><%= method[:callseq] %></span>
+        <% else %>
+          <span class="name"><%= h(method[:name]) %></span><span class="args"><%= method[:params] %></span>
+        <% end %>
+      </h4>
+      <div class="method_description">
+        <%= method[:description] %>
+      </div>

data/lib/r2doc/template/r2doc/_method_details.html.erb

@@ -0,0 +1,17 @@
+    <a name="method_detail"></a>
+
+    <% if ctx.has_class_methods? %>
+    <h2 class="detail"><a name="class_method_detail"></a>Class Method Detail</h2>
+    
+    <% ctx.class_methods.each{|method| %>
+      <%= render_partial :method_detail, {:method=>method} %>
+    <% } %>
+    <% end %>
+    
+    <% if ctx.has_instance_methods? %>
+    <h2 class="detail"><a name="instance_method_detail"></a>Instance Method Detail</h2>
+
+    <% ctx.instance_methods.each{|method| %>
+      <%= render_partial :method_detail, {:method=>method} %>
+    <% } %>
+    <% end %>

data/lib/r2doc/template/r2doc/_method_listing.html.erb

@@ -0,0 +1,37 @@
+    <h2><a name="methods"></a>Methods</h2>
+    
+    <% if ctx.has_class_methods? %>
+    <h3><a name="class_methods"></a>Class</h3>
+    
+    <table class="members methods">
+      <thead>
+        <tr>
+          <th class="namehead">Visibility</th>
+          <th>Signature</th>
+        </tr>
+      </thead>
+      <tbody>
+      <% ctx.class_methods.each_with_index{|method,i| %>
+        <%= render_partial :method_listing_row, {:method=>method, :i=>i} %>
+      <% } %>
+      </tbody>
+    </table>
+    <% end %>
+    
+    <% if ctx.has_instance_methods? %>
+    <h3><a name="instance_methods"></a>Instance</h3>
+    
+    <table class="members methods">
+      <thead>
+        <tr>
+          <th class="namehead">Visibility</th>
+          <th>Signature</th>
+        </tr>
+      </thead>
+      <tbody>
+      <% ctx.instance_methods.each_with_index{|method,i| %>
+        <%= render_partial :method_listing_row, {:method=>method, :i=>i} %>
+      <% } %>
+      </tbody>
+    </table>
+    <% end %>

data/lib/r2doc/template/r2doc/_method_listing_row.html.erb

@@ -0,0 +1,4 @@
+        <tr class="<%= stripe_class i %> <%=h method[:visibility].to_s %>">
+          <td class="visibility"><%=h method[:visibility].to_s %></td>
+          <td class="name"><%= link_to h(method[:name]), method[:url] %> <span class="params"><%= method[:params] %></span></td>
+        </tr>

data/lib/r2doc/template/r2doc/_nav.html.erb

@@ -0,0 +1,40 @@
+  <div id="nav">
+    <div class="search"><div class="searchback">
+      <form id="searchform">
+      <input type="text" id="search_criteria" name="q" accesskey="s" />
+      <input type="submit" class="invisible" name="go" value="search" />
+      <div class="autocompleteChoices" id="search_choices"></div>
+      </form>
+    </div></div>
+    <div id="searchresults"></div>
+    <div id="navcontents">
+    <% if ctx.name_path_to_parent.length > 0 %>
+    <ul>
+      <li><%= link_to h(@options.title), 'index.html', :title=>@options.title %></li>
+      <% ctx.name_path_to_parent.each{|mod| %>
+      <li>
+        <%= link_to h(mod.short_name), mod, :title=>mod.name %>
+        <% if ((mod == ctx.parent) && mod.has_classes_or_modules?) %>
+        <ul>
+          <% mod.modules.each {|child| %><%= render_partial(:nav_item, {:type=>'module', :ctx=>ctx, :child=>child}) %><% } %>
+          <% mod.classes.each {|child| %><%= render_partial(:nav_item, {:type=>'class', :ctx=>ctx, :child=>child}) %><% } %>
+        </ul>
+        <% end %>
+      </li>
+      <% } %>
+    </ul>
+    <% else %>
+    <ul>
+      <li><%= link_to h(@options.title), 'index.html', :title=>@options.title %>
+        <% if (@topclasses.length > 0 || @topmodules.length > 0) %>
+        <ul>
+          <% @topmodules.find_all{|m| m.document_self || m.has_classes_or_modules?}.each {|child| %><%= render_partial(:nav_item, {:type=>'module', :ctx=>ctx, :child=>child}) %><% } %>
+          <% @topclasses.find_all{|c| c.document_self}.each {|child| %><%= render_partial(:nav_item, {:type=>'class', :ctx=>ctx, :child=>child}) %><% } %>
+        </ul>
+        <% end %>
+      </li>
+    </ul>
+    <% end %>
+    </div>
+    <div class="endcap"></div>
+  </div>

data/lib/r2doc/template/r2doc/_nav_item.html.erb

@@ -0,0 +1 @@
+            <li class="<%= type %><%= (child == ctx) ? ' thispage' : '' %>"><%= (child == ctx) ? h(child.short_name) : link_to(h(child.short_name), child, :title=>child.name) %></li>

data/lib/r2doc/template/r2doc/class.html.erb

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="<%=h @options.charset %>"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title><%=h "#{klass.name} - #{@options.title}"%></title>
+  <meta http-equiv="Content-Type" content="text/html; charset=<%=h @options.charset %>" />
+  <link rel="stylesheet" href="<%=h path_to(@options.css.nil? ? 'r2doc.css' : @options.css)%>" type="text/css" />
+  <script type="text/javascript" src="<%= path_to 'jquery.js' %>"></script>
+  <script type="text/javascript" src="<%= path_to 'prototype.js' %>"></script>
+  <script type="text/javascript" src="<%= path_to 'rdoc-utils.js' %>"></script>
+  <script type="text/javascript" src="<%= path_to 'rdoc.js' %>"></script>
+  <script type="text/javascript">
+  // <![CDATA[
+  rdoc.currentPath = "<%= @current_path %>";
+  // ]]>
+  </script>
+</head>
+<body>
+  <%= render_partial :nav, {:ctx=>klass} %>
+  
+  <div id="rightside">
+  <div id="topbar">
+    <div class="topcap"><div class="endcap">
+    <div class="quicklinks">
+      <a href="#constants">constants</a> |
+      <a href="#attributes">attributes</a> |
+      <a href="#methods">methods</a>
+    </div>
+    <div class="type"><%= klass.context.is_module? ? 'Module' : 'Class' %></div>
+    <h1><%=h klass.name %></h1>
+    </div></div>
+  </div>
+  
+  <div id="content">
+    <dl class="class_properties">
+      <dt>Inheritance</dt>
+      <dd><% p = klass.superclass; while p do %>
+        <% if p.respond_to?(:path) %>
+        &lt; <%= link_to h(p.name), p %> <% p = p.superclass %>
+        <% else %>
+        &lt; <%= h(p) %> <% p = nil %>
+        <% end %>
+      <% end %></dd>
+      <% if klass.has_includes? %>
+      <dt>Included Modules</dt>
+      <dd><%= klass.includes.collect{|m| m.has_key?(:url) ? link_to(h(m[:name]), m[:url]) : m[:name]}.join(', ') %></dd>
+      <% end %>
+    </dl>
+    
+    <div class="description">
+      <%= klass.description %>
+    </div>
+    
+    <%= render_partial(:classes_and_modules, {:ctx=>klass}) if klass.has_classes_or_modules? %>
+    
+    <%= render_partial(:constants, {:ctx=>klass}) if klass.has_constants? %>
+    
+    <%= render_partial(:attributes, {:ctx=>klass}) if klass.has_attributes? %>
+    
+    <%= render_partial(:aliases, {:ctx=>klass})if klass.has_aliases?  %>
+    
+    <%= render_partial(:method_listing, {:ctx=>klass}) if (klass.has_class_methods? || klass.has_instance_methods?) %>
+    
+    <%= render_partial(:method_details, {:ctx=>klass}) if (klass.has_class_methods? || klass.has_instance_methods?) %>
+
+  </div>
+  </div>
+
+<!-- R2Doc template by Mission Critical Labs, Inc.  -  http://www.missioncriticallabs.com/ --> 
+</body>
+</html>

data/lib/r2doc/template/r2doc/file.html.erb

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="<%=h @options.charset %>"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title><%=h "#{file.name} - #{@options.title}"%></title>
+  <meta http-equiv="Content-Type" content="text/html; charset=<%=h @options.charset %>" />
+  <link rel="stylesheet" href="<%=h path_to(@options.css.nil? ? 'r2doc.css' : @options.css)%>" type="text/css" />
+  <script type="text/javascript" src="<%= path_to 'jquery.js' %>"></script>
+  <script type="text/javascript" src="<%= path_to 'prototype.js' %>"></script>
+  <script type="text/javascript" src="<%= path_to 'rdoc-utils.js' %>"></script>
+  <script type="text/javascript" src="<%= path_to 'rdoc.js' %>"></script>
+  <script type="text/javascript">
+  // <![CDATA[
+  rdoc.currentPath = "<%= @current_path %>";
+  // ]]>
+  </script>
+</head>
+<body>
+  <%= render_partial :nav, {:ctx=>file} %>
+  
+  <div id="rightside">
+  <div id="topbar">
+    <div class="topcap"><div class="endcap">
+    <div class="type">File</div>
+    <h1><%=h file.name %></h1>
+    </div></div>
+  </div>
+  
+  <div id="content">
+    
+    <div class="description">
+      <%= file.description %>
+    </div>
+    
+    <%= render_partial(:classes_and_modules, {:ctx=>file}) if file.has_classes_or_modules? %>
+    
+    <%= render_partial(:constants, {:ctx=>file}) if file.has_constants? %>
+    
+    <%= render_partial(:attributes, {:ctx=>file}) if file.has_attributes? %>
+    
+    <%= render_partial(:aliases, {:ctx=>file}) if file.has_aliases? %>
+    
+    <%= render_partial(:method_listing, {:ctx=>file}) if (file.has_class_methods? || file.has_instance_methods?) %>
+    
+    <%= render_partial(:method_details, {:ctx=>file}) if (file.has_class_methods? || file.has_instance_methods?) %>
+
+  </div>
+  </div>
+  
+<!-- R2Doc template by Mission Critical Labs, Inc.  -  http://www.missioncriticallabs.com/ --> 
+</body>
+</html>