connfu-client 0.1

data/lib/rdoc/generator/template/connfu/_context.rhtml

@@ -0,0 +1,209 @@
+<div id="content">
+  <% unless (description = context.description).empty? %>
+    <div class="description">
+      <%= description %>
+    </div>
+  <% end %>
+
+
+  <% unless context.requires.empty? %>
+    <!-- File only: requires -->
+    <div class="sectiontitle">Required Files</div>
+    <ul>
+      <% context.requires.each do |req| %>
+        <li><%= h req.name %></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% sections = context.sections.select { |s| s.title }.sort_by{ |s| s.title.to_s } %>
+  <% unless sections.empty? then %>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+      <% sections.each do |section| %>
+        <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% unless context.classes_and_modules.empty? %>
+    <!-- Namespace -->
+    <div class="sectiontitle">Namespace</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.method_list.empty? %>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+      <% each_letter_group(context.method_list) do |group| %>
+        <dt><%= group[:name] %></dt>
+        <dd>
+          <ul>
+            <% group[:methods].each_with_index do |method, i|  %>
+              <%
+                comma = group[:methods].size == i+1 ? '' : ','
+              %>
+              <li>
+                <a href="#<%= method.aref %>"><%= h method.name %></a><%= comma %>
+              </li>
+            <% end %>
+          </ul>
+        </dd>
+      <% end %>
+    </dl>
+  <% end %>
+
+  <% unless context.includes.empty? %>
+    <!-- Includes -->
+    <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 %>
+            <%= h inc.name %>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+
+  <% context.each_section do |section, constants, attributes| %>
+
+    <% if section.title then %>
+      <div class="contenttitle" id="<%= h section.aref %>">
+        <%= h section.title %>
+      </div>
+    <% end %>
+
+    <% if section.comment then %>
+      <div class="description">
+        <%= section.description %>
+      </div>
+    <% end %>
+
+    <% unless constants.empty? %>
+      <!-- Section constants -->
+      <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>
+          <% if const.comment %>
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"><%= const.description.strip %></td>
+            </tr>
+          <% end %>
+        <% end %>
+      </table>
+    <% end %>
+
+
+    <% unless attributes.empty? %>
+      <!-- Section attributes -->
+      <div class="sectiontitle">Attributes</div>
+      <table border='0' cellpadding='5'>
+        <% attributes.each 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 %>
+
+
+    <!-- Methods -->
+    <%
+      context.methods_by_type(section).each do |type, visibilities|
+        next if visibilities.empty?
+
+        visibilities.each do |visibility, methods|
+          next if methods.empty?
+    %>
+      <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+      <% methods.each do |method| %>
+        <div class="method">
+          <div class="title method-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>
+          
+          <% if method.comment %>
+            <div class="description">
+              <%= method.description.strip %>
+            </div>
+          <% end %>
+          
+          <% unless method.aliases.empty? %>
+            <div class="aka">
+              Also aliased as: <%= method.aliases.map do |aka|
+                if aka.parent then # HACK lib/rexml/encodings
+                  %{<a href="#{context.aref_to aka.path}">#{h aka.name}</a>}
+                else
+                  h aka.name
+                end
+              end.join ", " %>
+            </div>
+          <% end %>
+          
+          <% if method.token_stream %>
+            <% markup = method.sdoc_markup_code %>
+            <div class="sourcecode">
+              <%
+                # generate github link
+                github = if options.github
+                  if markup =~ /File\s(\S+), line (\d+)/
+                    path = $1
+                    line = $2.to_i
+                  end
+                  path && github_url(path)
+                else
+                  false
+                end
+              %>
+              <p class="source-link">
+                Source: 
+                <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                <% 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><%= markup %></pre>
+              </div>
+            </div>
+            <% end %>
+          </div>
+        <% end #methods.each %>
+      <% end #visibilities.each %>
+    <% end #context.methods_by_type %>
+  <% end #context.each_section %>
+</div>

data/lib/rdoc/generator/template/connfu/_head.rhtml

@@ -0,0 +1,7 @@
+<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" />
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/github.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>
+<script src="<%= "#{rel_prefix}/js/highlight.pack.js" %>" type="text/javascript" charset="utf-8"></script>

data/lib/rdoc/generator/template/connfu/class.rhtml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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.full_name %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
+</head>
+
+<body>
+    <div class="banner">
+		<% project_name = "connFu DSL"; project_version = "1.0"%>
+            <span><%= ERB::Util.html_escape(project_name) %> <%= ERB::Util.html_escape(project_version)%></span><br />
+        <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/rdoc/generator/template/connfu/file.rhtml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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 %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
+</head>
+
+<body>     
+    <div class="banner">
+        <% project_name = "connFu DSL"; project_version = "1.0"%>
+            <span><%= ERB::Util.html_escape(project_name) %> <%= ERB::Util.html_escape(project_version)%></span><br />
+        <h1>
+            <%= h file.name %>
+        </h1>
+        <ul class="files">
+            <%
+                github = github_url(file.relative_name) if options.github
+            %>
+            <li>
+                <%= h file.relative_name %>
+                <% if github %>
+                    <a href="<%= github %>" target="_blank" class="github_url">on GitHub</a>
+                <% end %>
+            </li>
+            <li>Last modified: <%= file.file_stat.mtime %></li>
+        </ul>
+    </div>
+
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>

data/lib/rdoc/generator/template/connfu/index.rhtml

@@ -0,0 +1,13 @@
+<!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=<%= @options.charset %>" />
+    <title><%= @options.title %></title>
+</head>
+<frameset cols="300,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
+    <frame src="panel/index.html" title="Search" name="panel" />
+    <frame src="<%= index_path %>" name="docwin" />
+</frameset>
+</html>

data/lib/rdoc/generator/template/connfu/resources/css/github.css

@@ -0,0 +1,129 @@
+/*
+
+github.com style (c) Vasily Polovnyov <vast@whiteants.net>
+
+*/
+
+pre code {
+  display: block; padding: 0.5em;
+  color: #000;
+  background: #f8f8ff
+}
+
+pre .comment,
+pre .template_comment,
+pre .diff .header,
+pre .javadoc {
+  color: #998;
+  font-style: italic
+}
+
+pre .keyword,
+pre .css .rule .keyword,
+pre .winutils,
+pre .javascript .title,
+pre .lisp .title,
+pre .subst {
+  color: #000;
+  font-weight: bold
+}
+
+pre .number,
+pre .hexcolor {
+  color: #40a070
+}
+
+pre .string,
+pre .tag .value,
+pre .phpdoc,
+pre .tex .formula {
+  color: #d14
+}
+
+pre .title,
+pre .id {
+  color: #900;
+  font-weight: bold
+}
+
+pre .javascript .title,
+pre .lisp .title,
+pre .subst {
+  font-weight: normal
+}
+
+pre .class .title,
+pre .haskell .label,
+pre .tex .command {
+  color: #458;
+  font-weight: bold
+}
+
+pre .tag,
+pre .tag .title,
+pre .rules .property,
+pre .django .tag .keyword {
+  color: #000080;
+  font-weight: normal
+}
+
+pre .attribute,
+pre .variable,
+pre .instancevar,
+pre .lisp .body {
+  color: #008080
+}
+
+pre .regexp {
+  color: #009926
+}
+
+pre .class {
+  color: #458;
+  font-weight: bold
+}
+
+pre .symbol,
+pre .ruby .symbol .string,
+pre .ruby .symbol .keyword,
+pre .ruby .symbol .keymethods,
+pre .lisp .keyword,
+pre .tex .special,
+pre .input_number {
+  color: #990073
+}
+
+pre .builtin,
+pre .built_in,
+pre .lisp .title {
+  color: #0086b3
+}
+
+pre .preprocessor,
+pre .pi,
+pre .doctype,
+pre .shebang,
+pre .cdata {
+  color: #999;
+  font-weight: bold
+}
+
+pre .deletion {
+  background: #fdd
+}
+
+pre .addition {
+  background: #dfd
+}
+
+pre .diff .change {
+  background: #0086b3
+}
+
+pre .chunk {
+  color: #aaa
+}
+
+pre .tex .formula {
+  opacity: 0.5;
+}

data/lib/rdoc/generator/template/connfu/resources/css/main.css

@@ -0,0 +1,339 @@
+body {
+  font-family: "Helvetica Neue", Arial, sans-serif;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: 14px;
+  line-height: 1.25em;
+}
+
+a:link, a:active, a:visited, a:hover {
+  color: #980905;
+  text-decoration: none;
+}
+
+a:hover, .banner a:hover {
+  color: #333;
+  background: #FE8;
+}
+
+h1 a, h2 a, .banner a {
+  color: #fff;
+}
+
+h1 a:hover, h2 a:hover {
+  color: #fff;
+}
+
+p {
+  margin-bottom: 1em;
+}
+
+h1 {
+    font-size: 2.1em;
+    font-weight: normal;
+    line-height: 1.2em;
+    margin: 1.4em 0 0.7em 0;
+}
+
+h2 {
+    font-size: 1.6em;
+    margin: 1.8em 0 0.8em 0;
+    font-weight: normal;
+    line-height: 1.2em;
+}
+
+h3 {
+    font-size: 1.4em;
+    color:#555;
+    margin: 1.4em 0 0.7em 0;
+    font-weight: normal;
+}
+
+h4 {
+    margin: 1.4em 0 0.5em 0;
+    font-size: 1em;
+}
+
+table
+{
+    margin-bottom: 1em;
+}
+
+td, th
+{
+    padding: 0 0.7em 0.3em 0;
+}
+
+th
+{
+    font-weight: bold;
+}
+
+.clear
+{
+    clear: both;
+    width: 0; height: 0;
+}
+
+dt
+{
+    margin-bottom: 0.3em;
+    font-weight: bold;
+}
+
+dd
+{
+    margin-left: 2em;
+    margin-bottom: 1em;
+}
+
+dd p
+{
+    margin-top: 0.6em;
+}
+
+li
+{
+    margin: 0 0 0.5em 2em;
+}
+
+ul li
+{
+    list-style: disc;
+}
+
+ol li
+{
+    list-style: decimal;
+}
+
+.banner
+{
+    background: #D11E27;
+    color: #FFF;
+    border: 1px solid #980905;
+    padding: 1em;
+}
+.banner h1
+{
+    font-size: 1.2em;
+    margin: 0;
+}
+
+.banner h1 .type
+{
+    font-size: 0.833em;
+    display:block;
+}
+
+.banner h1 .type,
+.banner h1 .parent
+{
+    color: #CCC;
+}
+
+.banner ul
+{
+    margin-top: 0.3em;
+    margin-bottom: 0;
+    font-size: 0.85em;
+}
+
+.banner li
+{
+    list-style: none;
+    margin-left: 0;
+    margin-bottom: 0;
+}
+
+.banner .github_url {
+  color: #CCC;
+}
+
+pre
+{
+    margin-bottom: 1em;
+}
+
+.methods dt
+{
+    width: 1em;
+    font-size: 1.5em;
+    color:#AAA;
+    position: absolute;
+    font-weight: normal;
+    margin: 0;
+}
+
+.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;
+}
+
+.contenttitle {
+  margin-top: 4em;
+  margin-bottom: 1.3em;
+  margin-left: -0.9em;
+  font-size: 1.6em;
+  padding: 0 0 0.25em 0;
+  font-weight: bold;
+}
+
+.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 .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;
+}
+
+.ruby-constant {
+  color: teal;
+}
+.ruby-keyword {
+  color: #000;
+  font-weight: bold
+}
+.ruby-title {
+  color: #900;
+  font-weight: bold;
+}
+.ruby-ivar {
+  color: teal;
+}
+.ruby-operator {
+  color: #000;
+  font-weight: bold
+}
+.ruby-identifier {
+  color: #000;
+}
+.ruby-string,
+.ruby-node {
+  color: #D14;
+}
+.ruby-comment {
+  color: #998;
+  font-style: italic;
+}
+.ruby-regexp {
+  color: #009926;
+}
+.ruby-value {
+  color: #990073;
+}
+.ruby-number {
+  color: #40A070;
+}