rdoc_osx_dictionary 1.0.0

data/History.txt

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

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/rdoc_osx_dictionary
+data/RubyGemsDictionary.css
+data/RubyGemsInfo.plist
+lib/rdoc_osx_dictionary.rb
+lib/rubygems_plugin.rb

data/README.txt

@@ -0,0 +1,48 @@
+= rdoc_osx_dictionary
+
+* http://rubyforge.org/projects/seattlerb
+
+== DESCRIPTION:
+
+rdoc via Apple's Dictionary.app. Automatically builds and installs an
+Apple Dictionary with all rdoc nicely formatted.
+
+== FEATURES/PROBLEMS:
+
+* Automatically builds and installs an Apple Dictionary with all rdoc
+  nicely formatted.
+
+== REQUIREMENTS:
+
+* rdoc gem
+* rubygems
+* Mac OS X w/ Developer Tools
+
+== INSTALL:
+
+* sudo gem install rdoc_osx_dictionary
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) Ryan Davis, seattle.rb
+
+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.plugin :seattlerb
+
+Hoe.spec 'rdoc_osx_dictionary' do
+  developer 'Ryan Davis', 'ryand-ruby@zenspider.com'
+
+  self.rubyforge_name = 'seattlerb'
+end
+
+# vim: syntax=ruby

data/bin/rdoc_osx_dictionary

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -ws
+
+$v ||= false
+
+require 'rubygems'
+require 'rdoc_osx_dictionary'
+
+dict = RDoc::OSXDictionary.new
+dict.make

data/data/RubyGemsDictionary.css

@@ -0,0 +1,52 @@
+@charset "UTF-8";
+@namespace d url(http://www.apple.com/DTDs/DictionaryService-1.0.rng);
+
+d|entry {
+}
+
+h1, h2, h3 {
+	font-family: 'Helvetica Neue', Helvetica, sans-serif;
+	text-shadow: 0px 0px 0px #000;
+}
+
+h1	{
+	font-size: 150%;
+}
+
+h2	{
+	font-size: 125%;
+}
+
+h3	{
+	font-size: 100%;
+}
+
+pre {
+  margin: 0.5em;
+  padding: 0.5em;
+  font-family: Monaco;
+  font-size: 12px;
+  background-color: #efefef;
+  border: 1px solid #333;
+}
+
+p.signatures {
+  font-family: Monaco;
+  font-size: 12px;
+  padding: 0 1em;
+}
+
+a {
+  color: #000;
+  text-decoration: none;
+}
+
+span.column {
+	display: block;
+	border: solid 2px #c0c0c0;
+	margin-left: 2em;
+	margin-right: 2em;
+	margin-top: 0.5em;
+	margin-bottom: 0.5em;
+	padding: 0.5em;
+}

data/data/RubyGemsInfo.plist

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.apple.dictionary.RubyGems</string>
+	<key>CFBundleName</key>
+	<string>Ruby + Gems</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>DCSDictionaryCopyright</key>
+	<string>Copyright © 2007 Apple Inc.</string>
+	<key>DCSDictionaryManufacturerName</key>
+	<string>Apple Inc.</string>
+	<key>DCSDictionaryFrontMatterReferenceID</key>
+	<string>front_back_matter</string>
+	<key>DCSDictionaryPrefsHTML</key>
+	<string>RubyGemsDictionary_prefs.html</string>
+	<key>DCSDictionaryXSL</key>
+	<string>RubyGemsDictionary.xsl</string>
+	<key>DCSDictionaryDefaultPrefs</key>
+	<dict>
+		<key>pronunciation</key>
+		<string>0</string>
+		<key>display-column</key>
+		<string>1</string>
+		<key>display-picture</key>
+		<string>1</string>
+		<key>version</key>
+		<string>1</string>
+	</dict>
+</dict>
+</plist>

data/lib/rdoc_osx_dictionary.rb

@@ -0,0 +1,329 @@
+#!/usr/bin/ruby -w
+
+require 'fileutils'
+require 'rdoc/ri/driver'
+
+class RDoc::OSXDictionary
+  VERSION = '1.0.0'
+
+  exclude = [] # nothing to exclude currently
+  EXCLUDE = Hash[*exclude.map { |k| [k, true] }.flatten]
+
+  NAME_MAP = {
+    '!'   => 'bang',
+    '%'   => 'percent',
+    '&'   => 'and',
+    '*'   => 'times',
+    '**'  => 'times2',
+    '+'   => 'plus',
+    '-'   => 'minus',
+    '/'   => 'div',
+    '<'   => 'lt',
+    '<='  => 'lte',
+    '<=>' => 'spaceship',
+    "<\<" => 'lt2',
+    '=='  => 'equals2',
+    '===' => 'equals3',
+    '=~'  => 'equalstilde',
+    '>'   => 'gt',
+    '>='  => 'ge',
+    '>>'  => 'gt2',
+    '+@'  => 'unary_plus',
+    '-@'  => 'unary_minus',
+    '[]'  => 'idx',
+    '[]=' => 'idx_equals',
+    '^'   => 'carat',
+    '|'   => 'or',
+    '~'   => 'tilde',
+    '='   => 'eq',
+    '?'   => 'eh',
+    '`'   => 'backtick',
+  }
+
+  NAME_MAP_RE = Regexp.new(NAME_MAP.keys.sort_by { |k| k.length }.map {|s|
+                              Regexp.escape(s)
+                            }.reverse.join("|"))
+
+
+  def display_class_info definition
+    name       = definition["name"]
+    fullname   = definition["full_name"]
+    supername  = definition["superclass"]
+    includes   = (definition["includes"]||[]).join(", ")
+    classmeths = definition["class_methods"].map { |hash| hash["name"] }
+    instmeths  = definition["instance_methods"].map { |hash| hash["name"] }
+    type       = supername ? "class" : "module"
+    title      = supername ? "class #{fullname} < #{supername}" : "module #{fullname}"
+    comment    = Array(definition["comment"]).join("\n")
+    constants  = Array(definition["constants"])
+    sources    = definition["sources"].map { |path|
+      next if path =~ /^.System/
+      path.sub(%r%^.*?1\.[89]/doc/([^/]+).*%, '\1')
+    }.compact
+
+    comment = "Improperly formatted" if EXCLUDE[fullname]
+
+    id = "#{type}_#{fullname}".munge.gsub(/[\s:.#]/, '_')
+
+    result = []
+
+    result << <<-"EOD".gsub(/^    /, '')
+    <d:entry id="#{id}" d:title="#{fullname}">
+      <d:index d:value="#{fullname.munge}"/>
+      <d:index d:value="#{name.munge}"/>
+      <h1>#{title.munge}</h1>
+
+      #{comment}
+  EOD
+
+    constants.map! { |c| c["name"] }
+
+    ext, ext_type = sources.size == 1 ? ["From", :str] : ["Extensions", :list]
+
+    [["Includes", includes.munge, :str],
+     ["Constants", constants.join(", "), :str],
+     ["Class Methods", classmeths.join(", ").munge, :str],
+     ["Instance Methods", instmeths.join(", ").munge, :str],
+     [ext, sources, ext_type]].each do |n, s, t|
+      next if s.empty?
+      case t
+      when :str then
+        result << "<h3>#{n}:</h3><p>#{s}</p>"
+      when :list then
+        items = s.map { |o| "<li>#{o}</li>" }.join("\n")
+        result << "<h3>#{n}:</h3><ul>#{items}</ul>"
+      else
+        raise "unknown type #{t.inspect}"
+      end
+    end
+
+    %w(name comment superclass includes constants class_methods
+     instance_methods sources display_name full_name).each do |name|
+      definition.delete name
+    end
+
+    result << <<-"EOD".gsub(/^    /, '')
+    </d:entry>
+  EOD
+    result.join("\n")
+  end
+
+  def display_method_info definition
+    fullname = definition["full_name"]
+    name = definition["name"]
+    id = fullname.gsub(/:|#/, '_').gsub(/#{NAME_MAP_RE}/) { |x| "_"+NAME_MAP[x] }
+
+    params = definition["params"]
+    comment = Array(definition["comment"]).join("\n")
+    comment = "undocumented" if comment.empty?
+
+    comment = "Improperly formatted" if EXCLUDE[fullname]
+
+    result = <<-"EOD".gsub(/^    /, '')
+    <d:entry id="def_#{id}" d:title="#{id}">
+      <d:index d:value="#{fullname.munge}"/>
+      <d:index d:value="#{name.munge}"/>
+      <h1>#{fullname.munge}</h1>
+      <p class="signatures">
+        <b>#{name.munge}#{params.munge}</b>
+      </p>
+      #{comment}
+    </d:entry>
+  EOD
+  end
+
+  def d_header
+    result = <<-"EOD"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  This is a sample dictionary source file.
+  It can be built using Dictionary Development Kit.
+-->
+<d:dictionary xmlns="http://www.w3.org/1999/xhtml" xmlns:d="http://www.apple.com/DTDs/DictionaryService-1.0.rng">
+  EOD
+  end
+
+  def d_entry fullname, definition, klass = false
+    if klass then
+      display_class_info definition
+    else
+      display_method_info definition
+    end
+  end
+
+  def d_footer
+    result = <<-"EOD"
+<d:entry id="front_back_matter" d:title="Front/Back Matter">
+  <h1><b>RubyGems Dictionary</b></h1>
+  <h2>Front/Back Matter</h2>
+  <div>
+    Provides dictionary definitions for all known installed ruby gems.<br/><br/>
+  </div>
+  <div>
+    <b>To see</b> this page,
+    <ol>
+      <li>Open "Go" menu.</li>
+      <li>Choose "Front/Back Matter" menu item.
+      If it has sub-menu items, choose one of them.</li>
+    </ol>
+  </div>
+  <div>
+    <b>To prepare</b> the menu item, do the followings.
+    <ol>
+      <li>Prepare this page source as an entry.</li>
+      <li>Add "DCSDictionaryFrontMatterReferenceID" key and its value to the plist of the dictionary.
+      The value should be the string of this page entry id. </li>
+    </ol>
+  </div>
+  <br/>
+</d:entry>
+</d:dictionary>
+  EOD
+  end
+
+  def make
+    seen  = {}
+    ri    = RDoc::RI::Driver.new
+    dirty = false
+    dict  = ri.class_cache
+    base  = File.expand_path "~/.ri/"
+
+    dict.sort.each do |klass, definition|
+      path = "#{base}/cache/#{klass}.xml"
+
+      next if seen[klass.downcase]
+      seen[klass.downcase] = true
+
+      unless File.exist? path then
+        warn "New entries for dictionary. Rebuilding dictionary." unless dirty
+        dirty = true
+
+        warn klass if $v
+
+        File.open(path, "w") do |f|
+          methods = ri.load_cache_for(klass)
+          next if methods.nil? || methods.empty?
+          result = []
+          result << d_entry(klass, dict[klass], true)
+
+          methods.each do |k,v|
+            result << d_entry(k, v)
+          end
+          result = result.join("\n")
+          f.puts result
+        end
+      end
+    end
+
+    return unless dirty
+
+    dict_src_path = "#{base}/RubyGemsDictionary.xml"
+
+    File.open(dict_src_path, "w") do |xml|
+      xml.puts d_header
+
+      dict.sort.each do |klass, definition|
+        xml.puts File.read("#{base}/cache/#{klass}.xml")
+      end
+
+      xml.puts d_footer
+    end
+
+    dict_name = "RubyAndGems"
+    data      = File.expand_path("#{__FILE__}/../../data")
+    dict_path = File.expand_path "~/Library/Dictionaries"
+
+    Dir.chdir base do
+      system("/Developer/Extras/Dictionary Development Kit/bin/build_dict.sh",
+             dict_name, dict_src_path,
+             "#{data}/RubyGemsDictionary.css",
+             "#{data}/RubyGemsInfo.plist")
+    end
+
+    warn "installing"
+
+    FileUtils.mkdir_p dict_path
+
+    system("rsync", "-r",
+           "#{base}/objects/#{dict_name}.dictionary",
+           "#{dict_path}/#{dict_name}.dictionary")
+
+    FileUtils.touch dict_path
+
+    warn "installed"
+    warn "Run Dictionary.app to use the new dictionary. (activate in prefs!)"
+  end
+
+  @hooked = false
+
+  def self.install_gem_hooks
+    return if @hooked
+
+    cmd = File.expand_path File.join(__FILE__, "../../bin/rdoc_osx_dictionary")
+
+    # post_install isn't actually fully post-install... so I must
+    # force via at_exit :(
+    Gem.post_install do |i|
+      at_exit do
+        warn "updating OSX ruby + gem dictionary, if necessary"
+        system cmd
+      end
+    end
+
+    Gem.post_uninstall do |i|
+      at_exit do
+        require 'fileutils'
+        warn "nuking old ri cache to force rebuild"
+        FileUtils.rm_r File.expand_path("~/.ri")
+        system cmd
+      end
+    end
+
+    @hooked = true
+  end
+end
+
+class String
+  def munge
+    self.gsub(/&/, '&amp;').gsub(/>/, '&gt;').gsub(/</, '&lt;')
+  end
+end
+
+class RDoc::Markup::Flow::LIST # ARG!
+  def to_s
+    pre, post = { :NUMBER => ['<ol>', '</ol>'] }[self.type] || ['<ul>', '</ul>']
+
+    raise "no: #{self.type}" unless pre
+
+    "#{pre}#{contents.join("\n")}#{post}"
+  end
+end
+
+class Struct
+  alias :old_to_s :to_s
+
+  MARKUP = {
+    "RULE" => [nil, nil],
+    "H"    => ["<h2>", "</h2>"],
+    "P"    => ["<p>", "</p>"],
+    "VERB" => ["<pre>", "</pre>"],
+    "LI"   => ['<li>', '</li>'],
+  }
+
+  def body
+    self.text
+  end
+
+  def to_s
+    name = self.class.name
+    if name =~ /Flow/ then
+      short = name.split(/::/).last
+      raise short unless MARKUP.has_key? short
+      pre, post = MARKUP[short]
+      return "" unless pre
+      "#{pre}#{self.body}#{post}"
+    else
+      old_to_s
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,4 @@
+require 'rubygems/command_manager'
+require 'rdoc_osx_dictionary'
+
+RDoc::OSXDictionary.install_gem_hooks

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: rdoc_osx_dictionary
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Davis
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
+  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
+  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
+  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
+  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
+  FBHgymkyj/AOSqKRIpXPhjC6
+  -----END CERTIFICATE-----
+
+date: 2010-01-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: |-
+  rdoc via Apple's Dictionary.app. Automatically builds and installs an
+  Apple Dictionary with all rdoc nicely formatted.
+email: 
+- ryand-ruby@zenspider.com
+executables: 
+- rdoc_osx_dictionary
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/rdoc_osx_dictionary
+- data/RubyGemsDictionary.css
+- data/RubyGemsInfo.plist
+- lib/rdoc_osx_dictionary.rb
+- lib/rubygems_plugin.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/seattlerb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: seattlerb
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: rdoc via Apple's Dictionary.app
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,2 @@
+��������K����'x��X�����h�醦�&wGH�2^�jUUF�7�4!�9<>R�R�S�T�F�����/�M>���̛����,��K=&¸�{:f�c��a)Z�V@@�4�����)��"ԍdV�z�F�W��|<���鎐�]���[����vh6����}O�������`nPCq#�0�p�1qF�E�[�'a[>խ|��	��Z
+��|��[����Y��ϗ��6'D��C6��NWdǿ�K