voloko-sdoc 0.2.0 → 0.2.1

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 2
-:patch: 0
+:patch: 1
 :major: 0

data/lib/sdoc/generator/shtml.rb

@@ -18,6 +18,7 @@ require 'rdoc/generator/markup'
 
 require 'sdoc/github'
 require 'sdoc/templatable'
+require 'sdoc/helpers'
 
 class RDoc::ClassModule
   def with_documentation?
@@ -30,6 +31,7 @@ class RDoc::Generator::SHtml
   include ERB::Util
   include SDoc::GitHub
   include SDoc::Templatable
+  include SDoc::Helpers
   
   GENERATOR_DIRS = [File.join('sdoc', 'generator'), File.join('rdoc', 'generator')]
   

data/lib/sdoc/generator/template/direct/_context.rhtml

@@ -0,0 +1,170 @@
+<div id="content">
+    <% unless (desc = context.description).empty? %>
+    <div class="description"><%= desc %></div>
+    <% end %>
+
+    <% unless context.requires.empty? %>
+    <div class="sectiontitle">Required Files</div>
+    <ul>
+        <% context.requires.each do |req| %>
+        <li><%= h req.name %></li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% sections = context.sections.select { |section| section.title } %>
+    <% unless sections.empty? %>
+    <div class="sectiontitle">Contents</div>
+    <ul>
+        <% sections.each do |section| %>
+        <li><a href="#<%= section.sequence %>"><%= h section.title %></a></li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% 
+        list = context.method_list
+        unless @options.show_all
+            list = list.find_all {|m| m.visibility == :public || m.visibility == :protected || m.force_documentation }
+        end
+    %>
+    <% unless list.empty? %>
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+    <% each_letter_group(list) do |group| %>
+        <dt><%= group[:name] %></dt>
+        <dd>
+            <ul>
+                <% group[:methods].each_with_index do |method, i|  %>
+                <li><a href="#<%= method.aref %>"><%= method.name %></a><%= ',' unless group[:methods].size == i+1 %></li>
+                <% end %>
+            </ul>
+        </dd>
+    <% end %>
+    </dl>
+    <% end %>
+
+    <% unless context.includes.empty? %>
+    <div class="sectiontitle">Included Modules</div>
+    <ul>
+        <% context.includes.each do |inc| %>
+        <li>
+            <% unless String === inc.module %>
+            <a href="<%= context.aref_to inc.module.path %>"><%= h inc.module.full_name %></a>
+            <% else %>
+            <span><%= h inc.name %></span>
+            <% end %>
+            START:includes
+        </li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% sections.each do |section| %>
+    <div class="sectiontitle"><a name="<%= h section.sequence %>"><%= h section.title %></a></div>
+    <% unless (description = section.description).empty? %>
+    <div class="description">
+        <%= description %>
+    </div>
+    <% end %>
+    <% end %>
+
+    <% unless context.classes_and_modules.empty? %>
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+        <% (context.modules.sort + context.classes.sort).each do |mod| %>
+        <li><span class="type"><%= mod.type.upcase %></span> <a href="<%= context.aref_to mod.path %>"><%= mod.full_name %></a></li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% unless context.constants.empty? %>
+    <div class="sectiontitle">Constants</div>
+    <table border='0' cellpadding='5'>
+        <% context.each_constant do |const| %>
+        <tr valign='top'>
+            <td class="attr-name"><%= h const.name %></td>
+            <td>=</td>
+            <td class="attr-value"><%= h const.value %></td>
+        </tr>
+        <% unless (description = const.description).empty? %>
+        <tr valign='top'>
+            <td>&nbsp;</td>
+            <td colspan="2" class="attr-desc"><%= description %></td>
+        </tr>
+        <% end %>
+        <% end %>
+    </table>
+    <% end %>
+
+    <% unless context.attributes.empty? %>
+    <div class="sectiontitle">Attributes</div>
+    <table border='0' cellpadding='5'>
+        <% context.each_attribute do |attrib| %>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [<%= attrib.rw %>]
+            </td>
+            <td class='attr-name'><%= h attrib.name %></td>
+            <td class='attr-desc'><%= attrib.description.strip %></td>
+        </tr>
+        <% end %>
+    </table>
+    <% end %>
+
+    <% context.methods_by_type.each do |type, visibilities|
+        next if visibilities.empty?
+        visibilities.each do |visibility, methods|
+            next if methods.empty? 
+            next unless visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
+            %>
+            <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+            <% methods.each do |method| %>
+            <div class="method">
+                <div class="title" id="<%= method.aref %>">
+                    <% if method.call_seq %>
+                    <a name="<%= method.aref %>"></a><b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+                    <% else %>
+                    <a name="<%= method.aref %>"></a><b><%= h method.name %></b><%= h method.params %>
+                    <% end %>
+                </div>
+                <% unless (description = method.description).empty? %>
+                <div class="description">
+                    <%= description %>
+                </div>
+                <% end %>
+                <% unless method.aliases.empty? %>
+                <div class="aka">
+                    This method is also aliased as
+                    <% method.aliases.each do |aka| %>
+                    <a href="<%= context.aref_to aka.path %>"><%= h aka.name %></a>
+                    <% end %>
+                </div>
+                <% end %>
+                <% if method.token_stream %>
+                <% markup = method.markup_code %>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                        <% 
+                            if markup =~ /File\s(\S+), line (\d+)/
+                                path = $1
+                                line = $2.to_i
+                            end
+                            github = github_url(path)
+                            if github
+                        %>
+                        | <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
+                        <% end %>
+                    </p>
+                    <div id="<%= method.aref %>_source" class="dyn-source">
+                        <pre><%= method.markup_code %></pre>
+                    </div>
+                </div>
+                <% end %>
+            </div>
+            <%      end
+        end
+    end
+    %>
+</div>

data/lib/sdoc/generator/template/direct/class.rhtml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="%charset%"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+    <title><%= h klass.full_name %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" />
+    <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
+    <script src="<%= "#{rel_prefix}/js/jquery-1.3.2.min.js" %>" type="text/javascript" charset="utf-8"></script>
+    <script src="<%= "#{rel_prefix}/js/jquery-effect.js" %>" type="text/javascript" charset="utf-8"></script>
+    <script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
+</head>
+
+<body>     
+    <div class="banner">
+        <h1>
+            <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span> 
+            <%= h klass.full_name %> 
+            <% if klass.type == 'class' %>
+                <span class="parent">&lt; 
+                    <% if String === klass.superclass %>
+                    <%= klass.superclass %>
+                    <% elsif !klass.superclass.nil? %>
+                    <a href="<%= klass.aref_to klass.superclass.path %>"><%= h klass.superclass.full_name %></a>
+                    <% end %>
+                </span>
+            <% end %>
+        </h1>
+        <ul class="files">
+            <% klass.in_files.each do |file| %>
+            <li><a href="<%= "#{rel_prefix}/#{h file.path}" %>"><%= h file.absolute_name %></a></li>
+            <% end  %>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>    

data/lib/sdoc/generator/template/direct/file.rhtml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="%charset%"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+    <title><%= h file.name %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" />
+    <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
+    <script src="<%= "#{rel_prefix}/js/jquery-1.3.2.min.js" %>" type="text/javascript" charset="utf-8"></script>
+    <script src="<%= "#{rel_prefix}/js/jquery-effect.js" %>" type="text/javascript" charset="utf-8"></script>
+    <script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
+</head>
+
+<body>     
+    <div class="banner">
+        <h1>
+            <span class="type">File</span> <%= h file.name %>
+        </h1>
+        <ul class="files">
+            <li><%= h file.relative_name %></li>
+        </ul>
+    </div>
+
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>

data/lib/sdoc/generator/template/direct/index.rhtml

@@ -0,0 +1,14 @@
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">    
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=%charset%"/>
+
+	<title><%= @options.title %></title>
+</head>
+<frameset cols="300,*" frameborder="1" border="1" bordercolor="#666666" framespacing="1">
+    <frame src="panel/index.html" title="Search" name="panel" />
+    <frame src="<%= index_path %>" name="docwin" />
+</frameset>
+</html>

data/lib/sdoc/generator/template/direct/resources/css/main.css

@@ -0,0 +1,233 @@
+body {
+  font-family: "Helvetica Neue", Arial, sans-serif;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: 0.82em;
+  line-height: 1.25em;
+}
+
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  color: #333;
+  background: #FE8;
+}
+
+p {
+  margin-bottom: 1em;
+}
+
+h1 {
+    font-size: 2em;
+    font-weight: normal;
+    line-height: 1.2em;
+}
+
+h2 {
+    font-size: 1.6em;
+    margin: 1.8em 0 0.8em 0;
+    font-weight: normal;
+    line-height: 1.2em;
+}
+
+h3 {
+    
+}
+
+h4 {
+    margin: 1.4em 0 0.5em 0;
+    font-size: 1em;
+}
+
+.clear
+{
+    clear: both;
+    width: 0; height: 0;
+}
+
+
+
+li
+{
+    margin: 0 0 0.5em 2em;
+    list-style: disc;
+}
+
+.banner
+{
+    background: #DDF;
+    border-bottom: 1px solid #ccc;
+    padding: 1em 2em 0.5em 2em;
+}
+.banner h1
+{
+    font-size: 1.2em;
+}
+
+.banner h1 .type
+{
+    font-size: 0.833em;
+    display:block;
+}
+
+.banner h1 .type,
+.banner h1 .parent
+{
+    color: #666;
+}
+
+.banner ul
+{
+    margin-top: 0.3em;
+    margin-bottom: 0;
+    font-size: 0.85em;
+}
+
+.banner li
+{
+    list-style: none;
+    margin-left: 0;
+    margin-bottom: 0;
+}
+
+pre 
+{
+    margin-bottom: 1em;
+}
+
+.methods dt
+{
+    width: 1em;
+    font-size: 1.5em;
+    color:#AAA;
+    position: absolute;
+    font-weight: normal;
+}
+
+.methods dd
+{
+    margin-left: 2.5em;
+    min-height: 1.8em;
+    -height: 1.8em;
+    padding-bottom: 0.8em;
+}
+
+
+.methods ul li
+{
+    margin-right: 0.7em;
+    margin-left: 0;
+    list-style: none;
+    display: inline;
+}
+
+#content {
+  margin: 2em;
+  margin-left: 3.5em;
+  margin-right: 3.5em;
+}
+
+
+.sectiontitle {
+  margin-top: 2em;
+  margin-bottom: 1.3em;
+  margin-left: -1.2em;
+  font-size: 1.2em;
+  padding: 0 0 0.25em 0;
+  font-weight: bold;
+  border-bottom: 1px solid #000;
+}
+
+.attr-rw {
+  padding-right: 1em;
+  text-align: center;
+  color: #055;
+}
+
+.attr-name {
+  font-weight: bold;
+  padding-right: 1em;
+}
+
+.attr-desc {
+}
+
+tt {
+  font-size: 1.15em;
+}
+
+.attr-value {
+  font-family: monospace;
+  padding-left: 1em;
+  font-size: 1.15em;
+}
+
+.dyn-source {
+  display: none;
+  background: #fffde8;
+  color: #000;
+  border: #ffe0bb dotted 1px;
+  margin: 0.5em 2em 0.5em 0;
+  padding: 0.5em;
+}
+
+.dyn-source .cmt {
+  color: #00F;
+  font-style: italic;
+}
+
+.dyn-source .kw {
+  color: #070;
+  font-weight: bold;
+}
+
+.description pre {
+  padding: 0.5em;
+  border: #ffe0bb dotted 1px;
+  background: #fffde8;
+}
+
+.method {
+    margin-bottom: 2em;
+}
+.method .description,
+.method .sourcecode
+{
+    margin-left: 1.2em;
+}
+.method h4
+{
+    border-bottom: 1px dotted #999;
+    padding: 0 0 0.2em 0;
+    margin-bottom: 0.8em;
+    font-size: 1.1em;
+    color:#333;
+}
+.method .title {
+    border-bottom: 1px dotted #666;
+    padding: 0 0 0.15em 0;
+    margin: 0 0 0.5em 0;
+    font-size: 1.2em;
+    line-height: 1.25em;
+}
+
+.method .sourcecode p.source-link {
+  text-indent: 0em;
+  margin-top: 0.5em;
+}
+
+.method .aka {
+  margin-top: 0.3em;
+  margin-left: 1em;
+  font-style: italic;
+  text-indent: 2em;
+}
+
+.method .source-link
+{
+    font-size: 0.85em;
+}