pdoc 0.2.0

data/templates/html/assets/stylesheets/pdoc/pygments.css

@@ -0,0 +1,62 @@
+.highlight .hll { background-color: #ffffcc }
+.highlight  { background: #f8f8f8; }
+.highlight .c { color: #408080; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
+.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #808080 } /* Generic.Output */
+.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #008000 } /* Keyword.Pseudo */
+.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #B00040 } /* Keyword.Type */
+.highlight .m { color: #666666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #7D9029 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.highlight .no { color: #880000 } /* Name.Constant */
+.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nl { color: #A0A000 } /* Name.Label */
+.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #666666 } /* Literal.Number.Float */
+.highlight .mh { color: #666666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666666 } /* Literal.Number.Oct */
+.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+.highlight .sc { color: #BA2121 } /* Literal.String.Char */
+.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.highlight .sx { color: #008000 } /* Literal.String.Other */
+.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
+.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+.highlight .ss { color: #19177C } /* Literal.String.Symbol */
+.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #19177C } /* Name.Variable.Class */
+.highlight .vg { color: #19177C } /* Name.Variable.Global */
+.highlight .vi { color: #19177C } /* Name.Variable.Instance */
+.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */

data/templates/html/helpers.rb

@@ -0,0 +1,35 @@
+module PDoc
+  module Generators
+    module Html
+      module Helpers
+        module BaseHelper
+          def layout_section(title, classname = title.downcase)
+            <<-EOS
+              <div class="section section-#{classname}">
+                <div class="section-title">
+                  <h3>#{title}</h3>
+                </div> <!-- .section-title -->
+                <div class="section-content">
+            EOS
+          end
+          
+          def end_layout_section
+            <<-EOS
+              </div> <!-- .section-content -->
+            </div> <!-- .section -->
+            EOS
+          end
+        end
+        
+        module LinkHelper
+        end
+        
+        module CodeHelper
+        end
+        
+        module MenuHelper
+        end
+      end
+    end
+  end
+end

data/templates/html/index.erb

@@ -0,0 +1,18 @@
+<% @title = "Home" %>
+
+<div class="page-introduction">
+  <%= @index_page_content %>
+</div> <!-- .section -->
+
+<%= layout_section('Sections') %>
+  <ul class="section-list">
+    <% @root.sections.each do |section| %>
+    <li>
+      <h4>
+        <a href="<%= path_to(section) %>"><%= section.name %></a>
+      </h4>
+      <p><%= htmlize(section.short_description) %></p>
+    </li>      
+    <% end %>
+  </ul>
+<%= end_layout_section %>

data/templates/html/item_index.js.erb

@@ -0,0 +1,6 @@
+if (!window.PDoc) window.PDoc = {};
+PDoc.elements = {
+  <%= @root.registry.map do |k, v|
+    "'#{k}': { 'name': '#{k}', 'type': '#{v.type}', 'path': '#{path_to(v)}' }"
+  end.join(",\n") %>
+};

data/templates/html/layout.erb

@@ -0,0 +1,67 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title><%= @short_name %>  v<%= @version %> API documentation | <%= @title %></title>
+  <meta name="generator" content="PDoc" />
+  
+  <%= javascript_include_tag "pdoc/prototype" %>
+  <%= javascript_include_tag "pdoc/application", "pdoc/tabs" %>
+  <%= javascript_include_tag "pdoc/item_index" %>
+  
+  <%= stylesheet_link_tag "pdoc/api", "pdoc/pygments" %>
+  
+  <script type="text/javascript">
+    PDoc.pathPrefix = '<%= path_prefix %>';
+  </script>
+</head>
+  <body>
+
+    <div id="sidebar">
+      <ul id="sidebar_tabs" class="sidebar-tabs">
+        <li>
+          <a href="#menu_pane">Menu</a>
+        </li>
+        <li>
+          <a href="#search_pane">Search</a>
+        </li>
+      </ul> <!-- .sidebar-tabs -->
+
+      <form class="search-ribbon">
+        <label>
+          <span class="hidden">Search</span>
+          <input type="text" id="search" size="20" title="Search" />
+        </label>
+      </form>
+      
+      <div class="sidebar-pane scrollable" id="menu_pane">
+        <%= menu(@root) %><!--- #api_menu =-->
+      </div> <!-- .sidebar-pane -->
+      <div class="sidebar-pane" id="search_pane">
+        <ul id="search_results" class="search-results menu-items scrollable"></ul>
+      </div> <!-- .sidebar-pane -->
+    </div> <!-- #sidebar -->
+
+    <div id="page">
+      <%= @home ? @index_header : @header %>
+
+      <div id="main" class="page-content">
+        <%= @content_for_layout %>
+      </div> <!-- #main -->
+      
+      <div id="footer">
+        <p><a href="<%= @home_url %>"><%= @name %></a> v<%= @version %> API documentation.</p>
+        <p>
+          <% if @timestamp %>
+            Last updated on <%= @timestamp.strftime('%B %d, %Y at %H:%M UTC') %>.
+          <% end %>
+          Generated by <a href="http://pdoc.org">PDoc</a>.
+          Uses <a href="http://famfamfam.com/lab/icons/silk/" title="famfamfam.com: Silk Icons">Silk Icons</a> and portions of <a href="http://github.com/280north/aristo/tree/master" title="280north's aristo at master - GitHub">Aristo</a>.
+        </p>
+        <%= @footer %>
+      </div> <!-- #footer -->
+
+    </div> <!-- #page -->
+  </body>
+</html>

data/templates/html/leaf.erb

@@ -0,0 +1,22 @@
+<% @title = "#{@doc_instance.full_name} #{@doc_instance.type}" %>
+
+<%= include "partials/title", :object => @doc_instance %>
+
+<div class="section">
+  <div class="section-title">
+  </div> <!-- .section-title -->
+  <div class="section-content">
+    <div class="method-description">
+      <% if @doc_instance.respond_to?(:signatures) %>
+        <%= include "partials/method_signatures", :object => @doc_instance %>
+      <% else %>
+        <pre class="syntax"><code class="ebnf"><%= @doc_instance.signature.name %> &rarr; <%= auto_link_types(@doc_instance.signature.return_value, :name => :long).join(' | ') %></code></pre>
+      <% end %>
+
+      <%= htmlize(@doc_instance.description) %>
+      
+      <%= include "partials/relationships", :object => @doc_instance %>
+      <%= include "partials/methodized_note", :object => @doc_instance %>
+    </div>
+  </div> <!-- .section-content -->
+</div> <!-- .section -->

data/templates/html/node.erb

@@ -0,0 +1,30 @@
+<% d = @doc_instance %>
+
+<%= include "partials/title", :object => @doc_instance %>
+<%= include "partials/description", :object => @doc_instance %>
+
+<%= include "partials/namespaces", :object => @doc_instance %>
+<%= include "partials/classes", :object => @doc_instance %>
+
+<%= include "partials/class_relationships", :object => @doc_instance %>
+<%= include "partials/related_utilities",   :object => @doc_instance %>
+<%= include "partials/constructor",         :object => @doc_instance %>
+
+<%
+types = [
+  [:class_methods, 'Class methods'],
+  [:class_properties, 'Class properties'],
+  [:instance_methods, 'Instance methods'],
+  [:instance_properties, 'Instance properties'],
+  [:constants, 'Constants']
+].each do |a| %>
+  <% method, title = a %>
+  <% methods = @doc_instance.send(method) %>
+  <% unless methods.empty? %>
+    <%= layout_section(title, method) %>
+      <ul class="method-list">
+        <%= include "partials/link_list", :collection => methods.sort! %>
+      </ul>
+    <%= end_layout_section %>
+  <% end %>
+<% end %>

data/templates/html/partials/class_relationships.erb

@@ -0,0 +1,19 @@
+<% if object.is_a?(Models::Class) %>
+  <% if object.superclass %>
+    <%= layout_section('Superclass') %>
+      <p><%= auto_link_code(object.superclass, :name => :long) %></p>
+    <%= end_layout_section %>
+  <% end %>
+
+  <% if object.subclasses? %>
+    <%= layout_section('Subclasses') %>
+      <p><%= object.subclasses.sort!.map { |s| auto_link_code(s, :name => :long) }.join(', ') %></p>
+    <%= end_layout_section %>
+  <% end %>
+<% end %>
+
+<% if object.included_mixins? %>
+  <%= layout_section('Includes', :mixins) %>
+    <p><%= object.included_mixins.sort!.map { |m| auto_link_code(m, :name => :long) }.join(', ') %></p>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/classes.erb

@@ -0,0 +1,7 @@
+<% if object.classes? %>
+  <%= layout_section('Classes') %>
+    <ul class="method-details-list">
+      <%= include "partials/short_description_list", :collection => object.classes.sort! %>
+    </ul>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/constructor.erb

@@ -0,0 +1,5 @@
+<% if object.respond_to?(:constructor) && object.constructor %>
+  <%= layout_section('Constructor') %>
+    <p><%= auto_link_code(object.constructor, :name => :long) %></p>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/description.erb

@@ -0,0 +1,5 @@
+<% if object.description && !object.description.empty? %>
+  <%= layout_section('Description') %>
+    <%= htmlize(object.description) %>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/link_list.erb

@@ -0,0 +1 @@
+<li><%= auto_link_code(object, :name => :short, :class => class_names_for(object)) %></li>

data/templates/html/partials/method_signatures.erb

@@ -0,0 +1,14 @@
+<pre class="syntax"><code class="ebnf"><%= method_synopsis(object).join('<br />') %></code></pre>
+<% if object.respond_to?(:arguments) && object.arguments? %>
+  <ul class="argument-list">
+    <% object.arguments.each do |arg| %>
+      <li>
+        <code class="argument-name"><%= arg.name %></code>
+        <% unless arg.types.empty? %>
+          <span class="argument-types">(<%= auto_link_types(arg.types).map { |t| "<code>#{t}</code>"}.join(' | ') %>)</span>
+        <% end %>
+        <%= ' &ndash; ' + inline_htmlize(arg.description) unless arg.description.empty? %>
+      </li>
+    <% end %>
+  </ul> <!-- .argument-list -->
+<% end %>

data/templates/html/partials/methodized_note.erb

@@ -0,0 +1,9 @@
+<% if object.methodized? %>
+  <p class="note">
+    <% if object.respond_to?(:methodized_self) %>
+      This method can be called <em>either</em> as an <a href="<%= path_to(object.methodized_self) %>">instance method</a> <em>or</em> as a generic method.
+    <% else %>
+    This method can be called <em>either</em> as an instance method <em>or</em> as a <a href="<%= path_to(object.functionalized_self) %>">generic method</a>.
+    <% end %>
+  If calling as a generic, pass the instance in as the first argument.<p>
+<% end %>

data/templates/html/partials/mixins.erb

@@ -0,0 +1,7 @@
+<% if object.mixins? %>
+  <%= layout_section('Mixins') %>
+    <ul class="method-details-list">
+      <%= include "partials/short_description_list", :collection => object.mixins.sort! %>
+    </ul>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/namespaces.erb

@@ -0,0 +1,7 @@
+<% if object.namespaces? %>
+  <%= layout_section('Namespaces') %>
+    <ul class="method-details-list">
+      <%= include "partials/short_description_list", :collection => object.namespaces %>
+    </ul>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/related_utilities.erb

@@ -0,0 +1,5 @@
+<% if object.respond_to?(:utilities) && object.utilities? %>
+  <%= layout_section('Related utilities', :utilities) %>
+    <p><%= object.utilities.map { |u| auto_link_code(u, :name => :long) }.join(', ') %></p>
+  <%= end_layout_section %>
+<% end %>

data/templates/html/partials/relationships.erb

@@ -0,0 +1,11 @@
+<% if object.aliases? %>
+  <p class="alias aliases">Aliased as: <%= object.aliases.map.map { |a| auto_link_code(a, :name => :long) }.join(', ') %></p>
+<% end %>
+
+<% if object.alias? %>
+  <p class="alias alias-of">Alias of: <%= auto_link_code(object.alias, :name => :long) %></p>
+<% end %>
+
+<% if object.respond_to?(:related_to) && related_to = object.related_to %>
+  <p class="related-to">Related to: <%= auto_link_code(related_to, :name => :long) %></p>      
+<% end %>

data/templates/html/partials/short_description_list.erb

@@ -0,0 +1,7 @@
+<li class="method-description">
+  <h4><a href="<%= path_to(object) %>"><%= object.full_name %></a></h4>
+
+  <% unless object.short_description.nil? %>
+    <p><%= htmlize(object.short_description) %></p>
+  <% end %>
+</li>

data/templates/html/partials/title.erb

@@ -0,0 +1,22 @@
+<% @title = object.full_name %>
+
+<% if object.deprecated? %>
+  <div id="deprecated"><%= img_tag('pdoc/deprecated.png', :alt => "Deprecated", :width => 150, :height => 150) %></div>
+<% end %>
+
+<ul class="breadcrumbs clearfix">
+  <li><a href="<%= path_prefix %>">Home</a></li>
+  <% breadcrumb(object).each do |crumb| %>
+    <li>&rarr; <%= crumb %></li>
+  <% end %>
+</ul>
+
+<% if object.respond_to?(:src_code_href) && object.src_code_href %>
+  <p id="src_code_href"><a href="<%= object.src_code_href %>">src code</a></p>
+<% end %>
+
+<h2 class="page-title">
+  <span class="type"><%= object.type %></span> <%= object.full_name %>
+</h2>
+
+

data/templates/html/section.erb

@@ -0,0 +1,18 @@
+<% @title = "#{@doc_instance.full_name} " %>
+
+<%= include "partials/title", :object => @doc_instance %>
+<%= include "partials/description", :object => @doc_instance %>
+
+<% if @doc_instance.respond_to?(:utilities) && @doc_instance.utilities? %>
+  <%= layout_section('Utilities') %>
+    <ul class="method-list">
+      <% @doc_instance.utilities.each do |utility| %>  
+        <li><%= auto_link_code(utility) %></li>
+      <% end %>
+    </ul>
+  <%= end_layout_section %>
+<% end %>
+
+<%= include "partials/namespaces", :object => @doc_instance %>
+<%= include "partials/classes", :object => @doc_instance %>
+<%= include "partials/mixins", :object => @doc_instance %>

data/test/unit/parser/argument_description_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+
+class ArgumentDescriptionTest < Test::Unit::TestCase
+  include PDocTestHelper
+  include Basic
+  include ArgumentDescription
+  
+  def setup
+    @parser = ArgumentDescriptionParser.new
+  end
+  
+  def test_argument_with_no_type
+    fixture = parse("\n * - foo: a definition#{blank_line}")
+    assert_equal "foo",                            fixture.name
+    assert_equal [],                               fixture.types
+    assert_equal "a definition",                   fixture.description
+    
+    fixture = parse("\n * - @foo: a definition#{blank_line}")
+    assert_equal "foo",                            fixture.name
+    assert_equal [],                               fixture.types
+    assert_equal "a definition",                   fixture.description
+    
+    fixture = parse("\n * - foo:    a rather long definition  \n*     that extends to a second line.  #{blank_line}")
+    assert_equal "a rather long definition that extends to a second line.", fixture.description
+  end
+  
+  def test_argument_with_single_type
+    fixture = parse("\n * - foo (String): a definition#{blank_line}")
+    assert_equal "foo",                            fixture.name
+    assert_equal %w[String],                       fixture.types
+  end
+  
+  def test_argument_with_multiple_types
+    fixture = parse("\n * - foo (String | Number): a definition#{blank_line}")
+    assert_equal "foo",                            fixture.name
+    assert_equal %w[String Number],                fixture.types
+    fixture = parse("\n * - foo (String | Number | Object): a definition#{blank_line}")
+    assert_equal %w[String Number Object],         fixture.types
+  end
+end