sdoc-templates-42floors 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8366bbc4b95b0307a085532b4b3ad59fae6216bb
+  data.tar.gz: 7b6f57d41844c99cb2ef37504132ea01caf22f48
+SHA512:
+  metadata.gz: 2c1e8f9620916b4a742dabb68887bff6c4755206a43a48ce05e4c21a96dc3254963de96a91dfdbeae0d8cf9816e875f39770fe8538d5cc568072b495b6457cd8
+  data.tar.gz: f8d4d0e774f6997c0a77f58ca27163c36ce4b61fc2eb6ee78687ff66f86eddd2639d2d06cb2b07a966d01e9291aab3584ee30ad8a4e13b45c76964065b6e8fe1

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+.tm_properties
+pkg/*
+.rvmrc
+coverage
+doc
+*#*
+*~

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 42Floors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+42Floors SDoc Template
+======================
+
+This contains the 42Floors [SDoc](https://github.com/voloko/sdoc) template for
+use in generating Ruby Documentaiton with [RDoc](http://docs.seattlerb.org/rdoc/).
+
+Example Useage:
+---------------
+
+```ruby
+# ...
+require 'sdoc/templates/42floors'
+
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.title = 'My Documentation'
+  rd.rdoc_dir = 'doc'
+  
+  rd.options << '-f' << 'sdoc'
+  rd.options << '-T' << '42floors'
+  
+  rd.rdoc_files.include('README.rdoc')
+  rd.rdoc_files.include('lib/**/*.rb')
+end
+```

data/lib/sdoc/templates/42floors.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH << File.expand_path(File.join(
+  File.dirname(__FILE__),
+  "..",
+  "..",
+  "..",
+  "template"
+))

data/sdoc-templates-42floors.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sdoc-templates-42floors"
+  s.version     = '0.2'
+  s.licenses    = ['MIT']
+  s.authors     = ["Jon Bracy"]
+  s.email       = ["jon@42floors.com"]
+  s.homepage    = "https://github.com/42floors/sdoc-templates-42floors"
+  s.summary     = %q{42Floors SDoc template}
+  s.description = %q{42Floors SDoc template for RDoc}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'sdoc'
+end

data/template/rdoc/generator/template/42floors/_context.rhtml

@@ -0,0 +1,216 @@
+<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 %>
+              <b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+            <% else %>
+              <b><%= h method.name %></b><%= h method.params %>
+            <% end %>
+            <a href="<%= "#{rel_prefix}/#{context.path}##{method.aref}"%>" name="<%= method.aref %>" class="permalink">Link</a>
+          </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.is_alias_for then %>
+            <div class="aka">
+              Alias for: <a href="<%= context.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+            </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/template/rdoc/generator/template/42floors/_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/template/rdoc/generator/template/42floors/class.rhtml

@@ -0,0 +1,39 @@
+<?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">
+        <% if ENV['HORO_PROJECT_NAME'] %>
+            <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
+        <% end %>
+        <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/template/rdoc/generator/template/42floors/file.rhtml

@@ -0,0 +1,37 @@
+<?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">
+        <% if ENV['HORO_PROJECT_NAME'] %>
+            <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
+        <% end %>
+        <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/template/rdoc/generator/template/42floors/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/template/rdoc/generator/template/42floors/resources/css/github.css

@@ -0,0 +1,123 @@
+/*
+
+github.com style (c) Vasily Polovnyov <vast@whiteants.net>
+
+*/
+
+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;
+}