docjs 0.1

data/templates/tasks/api_index_task.rb

@@ -0,0 +1,26 @@
+module Tasks
+
+  class ApiIndexTask < RenderTask
+
+    describe     'renders the api_index.html file containing all documented elements as alphabetic listing'
+    layout       'application'
+    
+    start_method :render_api_index
+    
+    protected
+
+    def render_api_index
+    
+      in_context Dom.root do
+        @elements = []
+        Dom.root.each_child do |child|
+          @elements << child unless child.is_a? Dom::NoDoc
+        end
+        
+        render 'api_index', :to_file => 'api_index.html'
+      end    
+    end
+  end
+end
+
+Processor.register_render_task :api_index, Tasks::ApiIndexTask

data/templates/tasks/docs_task.rb

@@ -0,0 +1,33 @@
+module Tasks
+
+  class DocsTask < RenderTask
+
+    describe     'renders all specified Markdown files to static documentation'
+    layout       'application'
+    
+    start_method :render_docs
+    
+    protected
+
+    def render_docs
+      Dom.docs.each_child do |doc| 
+        next if doc.is_a? Dom::NoDoc 
+               
+        render_document doc        
+      end
+    end
+
+    def render_document(document)       
+    
+      Logger.info "Rendering Document '#{document.name}'"
+      
+      in_context document do
+        @document = document
+        render 'doc_page', :to_file => path_to(document, :format => :html)
+      end
+    end
+
+  end
+end
+
+Processor.register_render_task :docs, Tasks::DocsTask

data/templates/tasks/json_data_task.rb

@@ -0,0 +1,55 @@
+module Tasks
+
+  class JsonDataTask < RenderTask
+
+    describe     'renders all documented objects to a json file. Objects and Functions are handled seperatly'
+    layout       nil
+    
+    start_method :render_json
+    
+    protected
+
+    def render_json
+    
+      in_context Dom.root do
+        
+        functions = []        
+        objects = []
+        
+        Dom.root.each_child do |child|
+        
+          code_object = {
+              :namespace    => child.namespace,
+              :fullname     => child.qualified_name,
+              :path         => path_to(child , :format => :html)
+          }
+        
+          # it's a root level element
+          if child.namespace.nil? or child.namespace == ""
+            code_object[:name] = child.name            
+          else
+            code_object[:name] = '.'+child.name        
+          end
+        
+          if child.is_a? CodeObject::Function
+            functions << code_object.merge({
+              :constructor  => child.constructor?              
+            })
+          elsif child.is_a? CodeObject::Base
+            objects << code_object
+          end
+        end
+        
+        @varname = 'apisearch'
+        @data = {
+          :functions => functions.sort {|a,b| a[:name] <=> b[:name] },
+          :objects   => objects.sort {|a,b| a[:name] <=> b[:name] }
+        }
+        
+        render 'layout/json', :to_file => 'js/apisearch-data.js'
+      end    
+    end
+  end
+end
+
+Processor.register_render_task :json_data, Tasks::JsonDataTask

data/templates/tasks/typed_task.rb

@@ -0,0 +1,54 @@
+module Tasks
+
+  class TypedTask < RenderTask
+
+
+    # @todo those methods and therefore all class-variables @@configs are shared with all inheriting
+    #   classes. i.e. The last change will be applied to all
+    describe     'renders documented objects type-dependant (Functions and Objects)'
+    layout       'application'
+    
+    start_method :render_objects
+    
+    protected
+
+    def render_objects
+      Dom.root.each_child do |node| 
+        next if node.is_a? Dom::NoDoc 
+        
+        if node.is_a? CodeObject::Function
+          render_function node
+        else
+          render_object node
+        end
+      end
+    end
+
+    # @todo switch on registered Types to enable dynamic view-changing
+    def render_object(code_object)       
+    
+      Logger.info "Rendering CodeObject '#{code_object.name}'"
+      
+      in_context code_object do
+        @object = code_object
+        @methods = @object.children.values.select {|c| c.is_a? CodeObject::Function }
+        @children = @object.children.values - @methods
+        # Render has to be documented very well, because it will be used in RenderTasks
+        render 'object/index', :to_file => path_to(code_object, :format => :html)
+      end
+    end
+    
+    def render_function(code_object)
+      Logger.info "Rendering Function '#{code_object.name}'"
+      
+      in_context code_object do
+        @function = code_object
+        @prototype = code_object.prototype
+        @methods = @function.children.values.select {|c| c.is_a? CodeObject::Function }
+        render 'function/index', :to_file => path_to(code_object, :format => :html)
+      end
+    end    
+  end
+end
+
+Processor.register_render_task :typed, Tasks::TypedTask

data/templates/tokens/tokens.rb

@@ -0,0 +1,22 @@
+module Token::Handler
+
+  register :author, :area => :sidebar
+  register :public, :area => :sidebar
+  register :private, :area => :sidebar
+  register :version, :area => :sidebar
+  
+  register :see, :area => :footer
+
+  register :deprecated, :area => :notification  
+  register :todo, :area => :notification
+  register :note, :area => :notification
+  register :warn, :area => :notification
+  
+  register :example, :template => 'examples', :handler => :named_multiline
+  
+  register :overload, :area => :none do |token, content|
+  
+  
+  end
+  
+end

data/templates/types/prototype.rb

@@ -0,0 +1,20 @@
+module CodeObject
+
+  class Prototype < CodeObject::Object
+    
+    def initialize(*args)
+      super(*args)
+      @path += '.prototype'
+    end
+    
+    # get the constructor, for which this prototype is used
+    def constructor
+      self.parent
+    end
+    
+  end
+    
+end
+
+CodeObject::Type.register :prototype, CodeObject::Prototype
+Token::Handler.register :prototype, :handler => :noop, :area => :none

data/templates/views/api_index.html.erb

@@ -0,0 +1,21 @@
+<article class="api-index">  
+  <header>
+    <h1>Alphabetic API-Overview</h1>
+  </header>
+  
+  <section class="api-list">
+  <% @elements.sort {|a,b| a.name.downcase <=> b.name.downcase }
+              .group_by {|n| n.name.upcase.chr }
+              .each do |letter, elements| %>
+  <%= tag :h2, letter %>
+  <ul>
+    <% elements.each do |element| %>
+      <li><%= link_to element, element.name %> 
+        <% if element.namespace != "" %>
+          <span class="namespace">(<%= element.namespace %>)</span>
+        <% end %>      
+    <% end %>
+  </ul>
+  <% end %>
+  </section>
+</article>

data/templates/views/doc_page.html.erb

@@ -0,0 +1,11 @@
+<article class="documentation">
+  
+  <nav class="sidebar">
+    <div class="table-of-contents">
+      <h3>Table of Contents</h3>
+      <%= toc @document.content %>
+    </div>
+  </nav>
+
+  <%= to_html @document.content, :generate_toc %>
+</article>

data/templates/views/function/_detail.html.erb

@@ -0,0 +1,8 @@
+<section class="section method" id="method-<%= detail.name %>">
+  <h2 class="signature"><%= signature detail %></h2>
+  <%= to_html detail.docs %>
+  <%= render_tokens :of => detail, :in => :body %>
+    
+  <h3 class="source">Source</h3>
+  <%= code detail.source %>
+</section>

data/templates/views/function/index.html.erb

@@ -0,0 +1,53 @@
+<article class="function"> 
+  
+  <header>
+    <nav class="sidebar">
+      <p><%= @function.filepath %>:<%= @function.line_start %></p>
+
+      <div class="hierarchy">
+        <h3>Hierarchy</h3>
+        <%= hierarchy @function %>
+      </div>
+      
+      <% unless @prototype.nil? %>
+      <div>
+        <h3>Prototype</h3>
+        <%= link_to @prototype %>
+      </div>    
+      <% end %>
+      
+      <% unless @methods.empty? %>
+      <div class="method-list">
+        <h3>Methods</h3>
+        <ul>
+          <% @methods.each do |child| %>
+          <li><%= link_to child %></li>
+          <% end %>
+        </ul>
+      </div>
+      <% end %>
+      
+      <%= render_tokens :of => @function, :in => :sidebar %>
+    </nav>
+  
+    <h1><%= @function.qualified_name %></h1>
+    <section class="notification">
+      <%= render_tokens :of => @function, :in => :notification %>
+    </section> 
+  </header>
+    
+  <div class="body">
+    
+    <%= to_html @function.docs %>
+    
+    <!--span class="flag">constructor</span-->
+    
+    <h2 class="signature"><%= signature @function %></h2>
+    <%= render_tokens :of => @function, :in => :body %>  
+    
+    <h3 class="source">Source</h3>
+    <%= code @function.source %>
+  
+  </div>
+ 
+</article> 

data/templates/views/layout/application.html.erb

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Documentation</title>
+    <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link href='http://fonts.googleapis.com/css?family=Terminal+Dosis+Light' rel='stylesheet' type='text/css'>
+    <%= style "application" %>
+  </head>
+  <body>
+    <header id="header" class="s">
+      <div class="wrapper">
+        <nav>
+          <h1><%= Configs.options[:appname] %></h1>
+          
+          <ul id="page-menu">
+            <li><%= link_to 'doc:README', 'Documentation' %>
+            <li><%= relative_link 'api_index.html', 'Api-Docs' %>
+          </ul>
+          
+          <form>
+            <input type="search" id="search" placeholder="search API-docs" autocomplete="off" autofocus/>
+          </form>
+        </nav>
+        
+        <section class="browsers col50">          
+          <section class="docs">
+            <h1>Documents</h1>
+            <ul>
+             <% Dom.docs.each_child do |doc| %>
+               <li><%= link_to doc %></li>
+             <% end %>
+            </ul>
+          </section>        
+          <section class="api-browser">
+            <h1>API-Browser</h1>
+            <%= api_browser(Dom.root) %>
+          </section>  
+        </section>
+        
+        <section class="search-results col50">
+          <section class="functions">
+            <h1 class="icon function">Functions</h1>
+          </section>        
+          <section class="objects">
+            <h1 class="icon object">Objects</h1>
+          </section>
+        </section> 
+        
+        <a href="#" class="collapse">Collapse</a>      
+        <a href="#" class="expand" style="display: none;">Expand</a>         
+      </div>
+    </header>
+    <div role="main" id="main">
+      <%= yield %>
+    </div>
+    <footer id="footer">
+      <div class="wrapper">
+        Documentation created automagically with <a href="http://www.github.com/b-studios/jsdoc">JSDoc for Ruby</a>.
+      </div>
+    </footer>
+    <%= script "jcore" %>    
+    <script>
+      var JSDOC = JSDOC || {};
+      JSDOC.root = "<%= to_relative(Configs.output) + '/' %>";
+      window.jQuery || document.write("<script src='"+JSDOC.root+"js/jquery.js'>\x3C/script>")
+    </script>
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6/jquery.js"></script>
+    <%= script "jquery.treeview", "jquery.cookie", "jquery.tooltip", "application", "apisearch-data" %>
+  <body>
+</html>

data/templates/views/layout/json.html.erb

@@ -0,0 +1,3 @@
+var JSDOC = JSDOC || {};
+JSDOC.data = JSDOC.data || {};
+JSDOC.data.<%= @varname %> = <%= @data.to_json %>

data/templates/views/object/index.html.erb

@@ -0,0 +1,63 @@
+<article>
+
+  <header>
+     <nav class="sidebar">
+      <p><%= @object.filepath %>:<%= @object.line_start %></p>
+
+      <div class="hierarchy">
+        <h3>Hierarchy</h3>
+        <%= hierarchy @object %>
+      </div>
+      
+      <% unless @methods.empty? %>
+      <div class="method-list">
+        <h3>Methods</h3>
+        <ul>
+          <% @methods.each do |child| %>
+          <li><%= link_to child %></li>
+          <% end %>
+        </ul>
+      </div>
+      <% end %>
+      
+      <%= render_tokens :of => @object, :in => :sidebar %>
+    </nav>
+  
+    <h1><%= @object.qualified_name %></h1>
+    <section class="notification">
+      <%= render_tokens :of => @object, :in => :notification %>
+    </section>
+  </header> 
+
+  <div class="body">
+
+    <%= to_html @object.docs %>
+
+    <!-- SUMMARY -->
+    <% unless @methods.nil? or @methods.size == 0 %>
+      <section>
+        <h3 class="icon function">Methods</h3>
+        <ul class="summary collapsed">
+          <% @methods.each do |child| %>
+          <li><%= link_to child %></li>
+          <% end %>
+        </ul>
+      </section>
+    <% end %>
+
+    <% unless @children.nil? or @children.size == 0 %>
+      <section>
+       <h3 class="icon object">Children</h3>
+        <ul class="summary collapsed">
+          <% @children.each do |child| %>
+          <li><%= link_to child, ".#{child.name}" %></li>
+          <% end %>
+        </ul>
+      </section>
+    <% end %>
+
+    <%= render_tokens :of => @object, :in => :body %>
+    
+  </div>
+
+</article>