trak3r-iphone-rdoc-template 0.1.1

data/Capfile

@@ -0,0 +1 @@
+load 'config/deploy'

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008  Thomas 'Ted' Davis
+
+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/Manifest

@@ -0,0 +1,20 @@
+Capfile
+config/deploy.rb
+lib/iphone_rdoc_template.rb
+lib/templates/adsense.html
+lib/templates/analytics.html
+lib/templates/body.html
+lib/templates/class.html
+lib/templates/file.html
+lib/templates/files.html
+lib/templates/footer.html
+lib/templates/header.html
+lib/templates/index.html
+lib/templates/methods.html
+lib/templates/search.html
+lib/templates/source.html
+lib/templates/styles.css
+LICENSE
+Manifest
+Rakefile
+README.rdoc

data/README.rdoc

@@ -0,0 +1,21 @@
+= iPhone RDoc Template
+
+== What is it?
+
+It's an RDoc template tailored to look better in the iPhone web browser (no frames, a lot less styling, etc.).
+
+== How do I use it?
+
+Download it then write yourself a Rake task like the one in this project (changing the appropriate paths, of course).
+
+== Caveats
+
+For the sake of simplicity, I removed the source code links and embedding.
+
+== Thanks
+
+I referred to the following projects when I got lost and confused:
+
+http://github.com/rails/rails/tree/master/doc/template/horo.rb
+
+http://github.com/mislav/hanna/tree/master

data/Rakefile

@@ -0,0 +1,21 @@
+require 'echoe'
+require 'rake/rdoctask'
+
+task :default => :rerdoc
+
+Echoe.new('iphone_rdoc_template') do |gem|
+  gem.version = '0.0.1'
+  gem.summary = 'An RDoc template to look good in the iPhone web browser'
+  gem.description = gem.summary
+  gem.author = "Thomas 'Ted' Davis"
+  gem.email = 'ted@pocketrails.com'
+  gem.url = 'https://github.com/trak3r/iphone-rdoc-template'
+end
+
+RAILS_PATH = '~/Desktop/rails'
+TEMPLATE_PATH = '~/Desktop/pocketrails/lib/iphone_rdoc_template'
+
+desc "Generate the RDoc for Rails"
+task :rerdoc do
+  system "cd #{RAILS_PATH} && rake rerdoc template=#{TEMPLATE_PATH}"
+end

data/config/deploy.rb

@@ -0,0 +1,41 @@
+role :site, 'pocketrails.com'
+role :local, 'localhost'
+
+desktop_path = "/Users/ted/Desktop"
+rails_path = "#{desktop_path}/rails"
+rdoc_path = "#{rails_path}/doc/rdoc"
+remote_path = "~/pocketrails.com"
+zipped_file = "pocketrails.tgz"
+
+desc "Compress the files locally."
+task :gzip, :roles => :local do
+  run "cd #{rdoc_path} && tar cvzf #{zipped_file} *"
+end
+
+desc "Copy the zip file to the server."
+task :scp, :roles => :site do
+  upload "#{rdoc_path}/#{zipped_file}", "#{remote_path}", :via => :scp
+end
+
+desc "Decompress the file remotely."
+task :gunzip, :roles => :site do
+  run "cd #{remote_path} && tar xvzf #{zipped_file}"
+end
+
+task :deploy do
+  gzip
+  scp
+  gunzip
+end
+
+[ 'gzip' ].each do |task| 
+  before "#{task}" do 
+    set :user, 'ted'
+  end 
+end
+
+[ 'scp', 'gunzip' ].each do |task| 
+  before "#{task}" do 
+    set :user, 'teflonted'
+  end 
+end

data/lib/iphone_rdoc_template.rb

@@ -0,0 +1,55 @@
+# Ted's iPhone RDoc template
+require 'erb'
+
+module RDoc
+  module Page
+
+    class << self
+      
+      def read( template )
+        @dir ||= File.join(File.dirname(__FILE__), 'templates')
+        prefix = "#{@dir}/#{template}"
+        [ 'html', 'css', 'xml' ].each do |ext|
+          filename = "#{prefix}.#{ext}"
+          if File.exists?(filename)
+            return ERB.new(File.new(filename).read).result(binding)
+          end
+        end
+        return nil
+      end
+      
+    end
+
+    FONTS = ""
+    XHTML_PREAMBLE = %{<?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">
+}
+    GOOGLE_ANALYTICS = read('analytics')
+    STYLE = read('styles')
+    GOOGLE_ADSENSE = read('adsense')
+    HEADER = read('header') 
+    FILE_PAGE = read('file')
+    CLASS_PAGE = read('class')
+    METHOD_LIST = read('methods')
+    FOOTER = read('footer')
+    BODY = read('body')
+    SRC_PAGE = read('source')
+    FR_INDEX_BODY = <<HTML
+!INCLUDE!
+HTML
+    COMMON_HEADER = <<HTML
+<html>
+  <head>
+    <meta content="width=device-width; initial-scale=1.0; minimum-scale=1.0; maximum-scale=1.0; user-scalable=0;" name="viewport"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="rdoc-style.css" type="text/css" media="screen" />
+HTML
+    GOOGLE_SEARCH_FORM = read('search')
+    FILE_INDEX = read('files')
+    CLASS_INDEX = FILE_INDEX
+    METHOD_INDEX = FILE_INDEX
+    INDEX = read('index')
+  end
+end

data/lib/templates/adsense.html

@@ -0,0 +1,12 @@
+<script type="text/javascript"><!--
+google_ad_client = "pub-3648329338598531";
+/* Pocket Rails */
+google_ad_slot = "9128679516";
+google_ad_width = 234;
+google_ad_height = 60;
+//-->
+</script>
+<script type="text/javascript"
+src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
+</script>
+<hr />

data/lib/templates/analytics.html

@@ -0,0 +1,9 @@
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-1377203-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>

data/lib/templates/body.html

@@ -0,0 +1,6 @@
+<%= HEADER %>
+!INCLUDE! <!-- banner header -->
+<div id="bodyContent">
+  <%= METHOD_LIST %>
+</div>
+<%= FOOTER %>

data/lib/templates/class.html

@@ -0,0 +1,32 @@
+%classmod%
+  <h1>
+    %full_name%
+  </h1>
+  <dl>
+    <dt>
+      Files
+    </dt>
+    <dd>
+      <ul>
+START:infiles
+        <li>
+          HREF:full_path_url:full_path:
+        </li>
+END:infiles
+      </ul>
+    </dd>
+IF:parent
+    <dt>
+      Parent
+    </dt>
+    <dd>
+IF:par_url
+      <a href="%par_url%">
+ENDIF:par_url
+        %parent%
+IF:par_url
+      </a>
+ENDIF:par_url
+ENDIF:parent
+    </dd>
+  </dl>

data/lib/templates/file.html

@@ -0,0 +1,17 @@
+<h1>
+  %short_name%
+</h1>
+<dl>
+  <dt>
+    Path
+  </dt>
+  <dd>
+    %full_path%
+  </dd>
+  <dt>
+    Modified
+  </dt>
+  <dd>
+    %dtm_modified%
+  </dd>
+</dl>

data/lib/templates/files.html

@@ -0,0 +1,18 @@
+<%= XHTML_PREAMBLE %>
+<%= COMMON_HEADER %>
+    <title>
+      %list_title%
+    </title>
+  </head>
+  <body>
+    <h1>
+      %list_title%
+    </h1>
+    <ul>
+START:entries
+      <li>
+        <a href="%href%">%name%</a>
+      </li>
+END:entries
+    </ul>
+<%= FOOTER %>

data/lib/templates/footer.html

@@ -0,0 +1,3 @@
+<%= GOOGLE_ANALYTICS %>
+  </body>
+</html>

data/lib/templates/header.html

@@ -0,0 +1,51 @@
+<%= XHTML_PREAMBLE %>
+<html>
+  <head>
+    <meta content="width=device-width; initial-scale=1.0; minimum-scale=1.0; maximum-scale=1.0; user-scalable=0;" name="viewport"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
+    <title>
+      %title%
+    </title>
+    <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+        function toggleSource( id )
+        {
+          var elem
+          var link
+
+          if( document.getElementById )
+          {
+            elem = document.getElementById( id )
+            link = document.getElementById( "l_" + id )
+          }
+          else if ( document.all )
+          {
+            elem = eval( "document.all." + id )
+            link = eval( "document.all.l_" + id )
+          }
+          else
+            return false;
+
+          if( elem.style.display == "block" )
+          {
+            elem.style.display = "none"
+            link.innerHTML = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
+        }
+      // ]]>
+    </script>
+  </head>
+  <body>
+<%= GOOGLE_ADSENSE %>

data/lib/templates/index.html

@@ -0,0 +1,25 @@
+<%= XHTML_PREAMBLE %>
+<%= COMMON_HEADER %>
+    <title>
+      %title% (formatted for the iPhone)
+    </title>
+  </head>
+  <body>
+    <h1>
+      %title%
+    </h1>
+	(formatted for the iPhone)
+    <ul>
+      <li>
+        <a href="fr_file_index.html">Files</a>
+      </li>
+      <li>
+        <a href="fr_class_index.html">Classes</a>
+      </li>
+      <li>
+        <a href="fr_method_index.html">Methods</a>
+      </li>
+    </ul>
+<%= GOOGLE_SEARCH_FORM %>
+<br/>(doesn't work yet, sorry.)
+<%= FOOTER %>

data/lib/templates/methods.html

@@ -0,0 +1,182 @@
+  <dl>
+IF:diagram
+    <dt>
+      Diagram
+    </dt>
+    <dd>
+      %diagram%
+    </dd>
+ENDIF:diagram
+
+IF:description
+    <dt>
+      Description
+    </dt>
+    <dd>
+      %description%
+    </dd>
+ENDIF:description
+
+IF:requires
+    <dt>
+      Required Files
+    </dt>
+    <dd>
+      <ul>
+START:requires
+        <li>HREF:aref:name:</li>
+END:requires
+      </ul>
+    </dd>
+ENDIF:requires
+
+IF:toc
+    <dt>
+      Contents
+    </dt>
+    <dd>
+      <ul>
+START:toc
+        <li>
+          <a href="#%href%">%secname%</a>
+        </li>
+END:toc
+      </ul>
+    </dd>
+ENDIF:toc
+
+IF:methods
+    <dt>
+      Methods
+    </dt>
+    <dd>
+      <ul>
+START:methods
+        <li>HREF:aref:name:</li>
+END:methods
+      </ul>
+    </dd>
+ENDIF:methods
+
+IF:includes
+    <dt>
+      Included Modules
+    </dt>
+    <dd>
+      <ul>
+START:includes
+        <li>HREF:aref:name:</li>
+END:includes
+      </ul>
+    </dd>
+ENDIF:includes
+
+START:sections
+IF:sectitle
+    <dt>
+      <a name="%secsequence%">%sectitle%</a>
+    </dt>
+IF:seccomment
+    <dd>
+      %seccomment%
+    </dd>
+ENDIF:seccomment
+ENDIF:sectitle
+
+IF:classlist
+    <dt>
+      Classes and Modules
+    </dt>
+    <dd>
+      %classlist%
+    </dd>
+ENDIF:classlist
+
+IF:constants
+    <dt>
+      Constants
+    </dt>
+    <dd>
+      <dl>
+START:constants
+        <dt>
+          %name%
+        </dt>
+        <dd>
+          %value%
+IF:desc
+          <p>
+            %desc%
+          </p>
+ENDIF:desc
+        </dd>
+END:constants
+      </dl>
+    </dd>
+ENDIF:constants
+
+IF:attributes
+    <dt>
+      Attributes
+    </dt>
+    <dd>
+START:attributes
+      <dl>
+IF:rw
+      [%rw%]
+ENDIF:rw
+        <dt>
+          %name%
+        </dt>
+        <dd>
+          %a_desc%
+        </dd>
+END:attributes
+      </dl>
+    </dd>
+ENDIF:attributes
+
+IF:method_list
+START:method_list
+IF:methods
+    <h2>
+      %type% 
+      %category% 
+      methods
+    </h2>
+START:methods
+
+      <h3>
+IF:callseq
+        <a name="%aref%">%callseq%</a>
+ENDIF:callseq
+IFNOT:callseq
+        <a name="%aref%">%name%</a>
+        %params%
+ENDIF:callseq
+      </h3>
+
+IF:m_desc
+      <p>
+        %m_desc%
+      </p>
+ENDIF:m_desc
+
+IF:aka
+      <dt>
+        Alias
+      </dt>
+      <dd>
+START:aka
+        <a href="%aref%">%name%</a>
+END:aka
+      </dd>
+ENDIF:aka
+
+END:methods
+ENDIF:methods
+END:method_list
+ENDIF:method_list
+
+END:sections
+  </dl>

data/lib/templates/search.html

@@ -0,0 +1,5 @@
+<form method="get" action="http://www.google.com/search">
+<input type="text" name="q" size="31" maxlength="255" value="" />
+<input type="submit" value="Google Search" />
+<input type="hidden" name="sitesearch" value="pocketrails.com" />
+</form>

data/lib/templates/source.html

@@ -0,0 +1,29 @@
+<%= XHTML_PREAMBLE %>
+<html>
+  <head>
+    <title>
+      %title%
+    </title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <style type="text/css">
+.ruby-comment    { color: green; font-style: italic }
+.ruby-constant   { color: #4433aa; font-weight: bold; }
+.ruby-identifier { color: #222222;  }
+.ruby-ivar       { color: #2233dd; }
+.ruby-keyword    { color: #3333FF; font-weight: bold }
+.ruby-node       { color: #777777; }
+.ruby-operator   { color: #111111;  }
+.ruby-regexp     { color: #662222; }
+.ruby-value      { color: #662222; font-style: italic }
+  .kw { color: #3333FF; font-weight: bold }
+  .cmt { color: green; font-style: italic }
+  .str { color: #662222; font-style: italic }
+  .re  { color: #662222; }
+    </style>
+  </head>
+  <body>
+    <pre>
+%code%
+    </pre>
+  </body>
+</html>

data/lib/templates/styles.css

@@ -0,0 +1,15 @@
+body {
+	font-family: Helvetica;
+	width: 480px;
+	font-size: x-small;
+}
+ul {
+	list-style: none;
+}
+dt {
+	font-weight: bold;
+}
+pre {
+	overflow-x: auto;
+	white-space: pre-wrap;
+}

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: trak3r-iphone-rdoc-template
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Thomas (Ted) Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-01 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: An RDoc template formatted for the iPhone web browser
+email: ted@pocketrails.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Capfile
+- config/deploy.rb
+- lib/iphone_rdoc_template.rb
+- lib/templates/adsense.html
+- lib/templates/analytics.html
+- lib/templates/body.html
+- lib/templates/class.html
+- lib/templates/file.html
+- lib/templates/files.html
+- lib/templates/footer.html
+- lib/templates/header.html
+- lib/templates/index.html
+- lib/templates/methods.html
+- lib/templates/search.html
+- lib/templates/source.html
+- lib/templates/styles.css
+- LICENSE
+- Manifest
+- Rakefile
+- README.rdoc
+has_rdoc: false
+homepage: http://github.com/trak3r/iphone-rdoc-template
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An RDoc template formatted for the iPhone web browser
+test_files: []
+