paddle 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-04-11
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,16 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/images/ruby.png
+lib/paddle.rb
+lib/rdoc/discover.rb
+lib/rdoc/generator/paddle.rb
+lib/templates/classfile.html.erb
+lib/templates/container.xml
+lib/templates/content.opf.erb
+lib/templates/cover.html.erb
+lib/templates/title.html.erb
+lib/templates/toc.ncx.erb
+test/test_paddle.rb

data/README.rdoc

@@ -0,0 +1,62 @@
+= paddle
+
+* http://tenderlovemaking.com
+
+== DESCRIPTION:
+
+Paddle is an RDoc plugin that emits documentation suitable for use as an epub
+book.  The epub book can then be imported to iBooks for reading on iPad!
+
+== FEATURES/PROBLEMS:
+
+* Converts RDoc to epub format
+* Sometimes it doesn't escape everything properly
+* Links aren't working yet
+* The tests are poor.  *Very* poor.
+
+== SYNOPSIS:
+
+First, make sure to have the latest RDoc.  Install paddle, then rdoc your code
+like this:
+
+  $ rdoc -o epub -f paddle -t 'My Documentation' lib
+
+Next, convert the documentation to an epub file:
+
+  $ cd epub
+  $ zip -Xr9D mydocs.epub mimetype *
+
+Then drag "mydocs.epub" to iTunes, and sync up your iPad.
+
+== REQUIREMENTS:
+
+* RDoc
+
+== INSTALL:
+
+* sudo gem install rdoc
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Aaron Patterson
+
+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/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'paddle' do
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
+  self.readme_file   = 'README.rdoc'
+  self.history_file  = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files  = FileList['*.rdoc']
+  self.extra_deps       << ['rdoc', '>= 2.5.3']
+end
+
+# vim: syntax=ruby

data/lib/paddle.rb

@@ -0,0 +1,8 @@
+###
+# Paddle is an RDoc template that will emit iPad compatible books!
+module Paddle
+  # Test Attribute
+  attr_accessor :foo
+
+  VERSION = '1.0.0'
+end

data/lib/rdoc/discover.rb

@@ -0,0 +1 @@
+require 'rdoc/generator/paddle'

data/lib/rdoc/generator/paddle.rb

@@ -0,0 +1,144 @@
+require 'rdoc/generator'
+require 'rdoc/rdoc'
+require 'paddle'
+require 'erb'
+require 'md5'
+require 'fileutils'
+
+class RDoc::Generator::Paddle
+  RDoc::RDoc.add_generator self
+
+  TEMPLATE_DIR = File.expand_path(
+    File.join(File.dirname(__FILE__), '..', '..', 'templates'))
+  IMAGE_DIR = File.expand_path(
+    File.join(File.dirname(__FILE__), '..', '..', 'images'))
+
+  class << self
+    alias :for :new
+  end
+
+  def initialize options
+    @options   = options
+    @class_dir = nil
+    @file_dir  = nil
+    @odir      = Pathname.new(options.op_dir).expand_path(Pathname.pwd)
+    @fh        = nil
+    @files     = nil
+  end
+
+  def generate top_levels
+    @files   = top_levels
+    @classes = RDoc::TopLevel.all_classes_and_modules.reject { |x|
+      x.name =~ /[<>]/
+    }
+
+    FileUtils.mkdir_p(File.join(@odir, class_dir))
+
+    emit_mimetype
+    emit_meta_inf
+    emit_cover
+    emit_title
+    emit_opf
+    emit_toc
+    emit_classfiles
+    copy_images
+  end
+
+  def class_dir
+    '/doc'
+  end
+
+  def title
+    @options.title
+  end
+
+  def identifier
+    MD5.hexdigest title
+  end
+
+  private
+  def h string
+    string.strip.gsub(/<pre>\s*<\/pre>/, '').gsub(/&/, '&amp;').gsub(/<</, '&lt;&lt;')
+  end
+
+  def copy_images
+    imgs = File.join @odir, 'images'
+    FileUtils.mkdir_p imgs
+
+    FileUtils.cp File.join(IMAGE_DIR, 'ruby.png'), imgs
+  end
+
+  def emit_meta_inf
+    meta_inf = File.join @odir, 'META-INF'
+    FileUtils.mkdir_p meta_inf
+
+    FileUtils.cp File.join(TEMPLATE_DIR, 'container.xml'), meta_inf
+  end
+
+  def emit_mimetype
+    File.open(File.join(@odir, 'mimetype'), 'wb') do |f|
+      f.write 'application/epub+zip'
+    end
+  end
+
+  def emit_cover
+    template = ERB.new File.read(File.join(TEMPLATE_DIR, 'cover.html.erb')),
+      nil, '<>'
+
+    File.open(File.join(@odir, class_dir, 'cover.html'), 'wb') do |f|
+      f.write template.result binding
+    end
+  end
+
+  def emit_title
+    template = ERB.new File.read(File.join(TEMPLATE_DIR, 'title.html.erb')),
+      nil, '<>'
+
+    File.open(File.join(@odir, class_dir, 'title.html'), 'wb') do |f|
+      f.write template.result binding
+    end
+  end
+
+  def emit_classfiles
+    @classes.each do |klass|
+      klass_methods    = []
+      instance_methods = []
+
+      klass.method_list.each do |method|
+        next if 'private' == method.visibility.to_s
+        if method.type == 'class'
+          klass_methods << method
+        else
+          instance_methods << method
+        end
+      end
+
+      template = ERB.new File.read(File.join(TEMPLATE_DIR, 'classfile.html.erb')),
+        nil, '<>'
+
+      FileUtils.mkdir_p(File.dirname(File.join(@odir, klass.path)))
+
+      File.open(File.join(@odir, klass.path), 'wb') do |f|
+        f.write template.result binding
+      end
+    end
+  end
+
+  def emit_opf
+    template = ERB.new File.read(File.join(TEMPLATE_DIR, 'content.opf.erb')),
+      nil, '<>'
+
+    File.open(File.join(@odir, 'content.opf'), 'wb') do |f|
+      f.write template.result binding
+    end
+  end
+
+  def emit_toc
+    template = ERB.new File.read(File.join(TEMPLATE_DIR, 'toc.ncx.erb')),
+      nil, '<>'
+
+    File.open(File.join(@odir, 'toc.ncx'), 'wb') do |f|
+      f.write template.result binding
+    end
+  end
+end

data/lib/templates/classfile.html.erb

@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
+    <title>
+      <%= klass.name %>
+    </title>
+    <style>
+      dt, dd {
+        margin: 0;
+      }
+      dt.name {
+        float: left;
+      }
+      dd.explanation {
+        clear: both;
+        margin-bottom: 0.5em;
+        margin-left: 1.5em;
+      }
+      dt.name {
+        font-weight: bold;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>
+      <% if klass.type == 'class' %>
+        <span class="class">
+          <%= klass.type.capitalize %>
+          <a href="<%= klass.path %>">
+            <%= klass.full_name %>
+          </a>
+          <% if klass.superclass %>
+            inherits from
+          <% end %>
+          <% unless String === klass.superclass %>
+            <a href="<%= klass.superclass.path %>">
+              <%= klass.superclass.name %>
+            </a>
+          <% else %>
+            <%= klass.superclass %>
+          <% end %>
+        </span>
+      <% else %>
+        <span class="module">
+          <%= klass.type.capitalize %>
+          <a href="<%= klass.path %>">
+            <%= klass.name %>
+          </a>
+        </span>
+      <% end %>
+    </h1>
+    <% if klass.description && !klass.description.empty? %>
+      <div id="description" class="alt">
+        <%= h klass.description %>
+      </div>
+    <% end %>
+
+    <!-- Constants -->
+    <% unless klass.constants.empty? %>
+      <h3>Constants</h3>
+      <% klass.constants.sort_by { |x| x.name }.each do |const| %>
+        <dl>
+          <dt class="name">
+            <%= h const.name %>
+          </dt>
+          <dd class="explanation"><%= h const.description %></dd>
+        </dl>
+      <% end %>
+    <% end %>
+
+    <!-- Attributes -->
+    <% unless klass.attributes.empty? %>
+      <h3>Attributes</h3>
+      <% klass.attributes.sort_by { |x| x.name }.each do |attr| %>
+        <dl>
+          <dt class="name">
+            <%= h attr.name %>
+            <span class="optional"><%= attr.rw %></span>
+          </dt>
+          <dd class="explanation"><%= h attr.description %></dd>
+        </dl>
+      <% end %>
+    <% end %>
+
+    <!-- Class Methods -->
+    <% unless klass_methods.empty? %>
+      <h3>Public Class Methods</h3>
+      <% klass_methods.each do |method| %>
+        <dl class="method">
+          <dt class="name">
+          <a name="<%= method.aref %>" ></a>
+          <%= h method.name %><%= h method.params %>
+          </dt>
+          <dd class="explanation"><%= h method.description %></dd>
+        </dl>
+      <% end %>
+    <% end %>
+
+    <!-- Instance Methods -->
+    <% unless instance_methods.empty? %>
+      <h3>Public Instance Methods</h3>
+      <% instance_methods.each do |method| %>
+        <dl class="method">
+          <dt class="name">
+          <a name="<%= method.aref %>" ></a>
+          <%= h method.name %><%= h method.params %>
+          </dt>
+          <dd class="explanation"><%= h method.description %></dd>
+        </dl>
+      <% end %>
+    <% end %>
+
+  </body>
+</html>

data/lib/templates/container.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+  <rootfiles>
+    <rootfile full-path="content.opf" media-type="application/oebps-package+xml"/>
+  </rootfiles>
+</container>
+

data/lib/templates/content.opf.erb

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf"
+         version="2.0"
+         unique-identifier="internet">
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/"
+            xmlns:dcterms="http://purl.org/dc/terms/"
+            xmlns:opf="http://www.idpf.org/2007/opf"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <dc:title><%= title %></dc:title>
+    <dc:language xsi:type="dcterms:RFC3066">en</dc:language>
+    <dc:identifier id="dcidid" opf:scheme="URI">
+      <%= identifier %>
+    </dc:identifier>
+  </metadata>
+  <manifest>
+    <item id="ncx" href="toc.ncx" media-type="text/xml"/>
+    <item id="cover" href="doc/cover.html" media-type="application/xhtml+xml"/>
+    <item id="title" href="doc/title.html" media-type="application/xhtml+xml"/>
+    <item id="ruby" href="images/ruby.png" media-type="image/png"/>
+    <% @classes.each do |klass| %>
+      <item id="<%= MD5.hexdigest(klass.full_name) %>" href="<%= klass.path %>" media-type="application/xhtml+xml"/>
+    <% end %>
+  </manifest>
+  <spine toc="ncx">
+    <itemref idref="cover"/>
+    <itemref idref="title"/>
+    <% @classes.sort_by { |x| x.full_name }.each do |klass| %>
+      <itemref idref="<%= MD5.hexdigest(klass.full_name) %>"/>
+    <% end %>
+  </spine>
+  <guide>
+    <reference type="cover" title="Cover" href="doc/cover.html" />
+  </guide>
+</package>

data/lib/templates/cover.html.erb

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
+    <title>
+      <%= title %>
+    </title>
+    <style>
+      h1 {
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <h1><%= title %></h1>
+    <img src="/images/ruby.png" />
+  </body>
+</html>

data/lib/templates/title.html.erb

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
+    <title>
+      <%= title %>
+    </title>
+    <style>
+      h1 {
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <h1><%= title %></h1>
+    <img src="/images/ruby.png" />
+  </body>
+</html>

data/lib/templates/toc.ncx.erb

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN" 
+   "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" xml:lang="en">
+  <head>
+    <meta name="dtb:uid" content="<%= identifier %>"/>
+    <meta name="dtb:depth" content="2"/>
+    <meta name="dtb:totalPageCount" content="0"/>
+    <meta name="dtb:maxPageNumber" content="0"/>
+  </head>
+  <docTitle>
+    <text><%= title %></text>
+  </docTitle>
+  <navMap>
+    <navPoint id="navPoint-1" playOrder="1">
+      <navLabel>
+        <text>Cover</text>
+      </navLabel>
+      <content src="doc/cover.html"/>
+    </navPoint>
+    <navPoint id="navPoint-2" playOrder="2">
+      <navLabel>
+        <text>Title</text>
+      </navLabel>
+      <content src="doc/title.html"/>
+    </navPoint>
+    <% @classes.sort_by { |x| x.full_name }.each_with_index do |klass, i| %>
+      <navPoint id="navPoint-<%= i + 3 %>" playOrder="<%= i + 3 %>">
+        <navLabel>
+          <text><%= klass.full_name %></text>
+        </navLabel>
+        <content src="<%= klass.path %>"/>
+      </navPoint>
+    <% end %>
+  </navMap>
+</ncx>

data/test/test_paddle.rb

@@ -0,0 +1,13 @@
+require "test/unit"
+require 'rdoc/generator/paddle'
+require 'tempfile'
+require 'fileutils'
+
+class TestPaddle < Test::Unit::TestCase
+  def setup
+    @dirname = File.join(Dir.tmpdir, Time.now.to_i.to_s)
+    p @dirname
+    rdoc = RDoc::RDoc.new
+    rdoc.document ['--op', @dirname, '-q', '-f', 'paddle']
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: paddle
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 3
+        version: 2.5.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 3
+        version: 2.0.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id004
+description: |-
+  Paddle is an RDoc plugin that emits documentation suitable for use as an epub
+  book.  The epub book can then be imported to iBooks for reading on iPad!
+email: 
+- aaron@tenderlovemaking.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/images/ruby.png
+- lib/paddle.rb
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/paddle.rb
+- lib/templates/classfile.html.erb
+- lib/templates/container.xml
+- lib/templates/content.opf.erb
+- lib/templates/cover.html.erb
+- lib/templates/title.html.erb
+- lib/templates/toc.ncx.erb
+- test/test_paddle.rb
+has_rdoc: true
+homepage: http://tenderlovemaking.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: paddle
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Paddle is an RDoc plugin that emits documentation suitable for use as an epub book
+test_files: 
+- test/test_paddle.rb