rdoc_osx_dictionary 1.3.1 → 2.0.0

data/History.txt

@@ -1,3 +1,13 @@
+=== 2.0.0 / 2011-12-15
+
+* 1 major enhancement:
+
+  * Rewritten to use rdoc 3.11 and the new mostly fancy and sometimes ugly API.
+
+* 1 minor enhancements:
+
+  * Got patches into rdoc and bumped our dependency up
+
 === 1.3.1 / 2010-03-30
 
 * 1 minor enhancement:

data/Rakefile

@@ -4,13 +4,16 @@ require 'rubygems'
 require 'hoe'
 
 Hoe.plugin :seattlerb
+Hoe.plugin :isolate
 
 Hoe.spec 'rdoc_osx_dictionary' do
   developer 'Ryan Davis', 'ryand-ruby@zenspider.com'
 
-  extra_deps << ['rdoc', '~> 2.4.3']
+  dependency 'rdoc', '~> 3.12'
 
   self.rubyforge_name = 'seattlerb'
 end
 
 # vim: syntax=ruby
+
+task :fuck

data/bin/rdoc_osx_dictionary

@@ -1,9 +1,5 @@
 #!/usr/bin/env ruby -ws
 
-$v ||= false
-$f ||= false
-$d ||= false
-
 require 'rubygems'
 require 'rdoc_osx_dictionary'
 

data/lib/rdoc_osx_dictionary.rb

@@ -1,22 +1,22 @@
 #!/usr/bin/ruby -w
 
+gem 'rdoc'
 require 'fileutils'
 require 'rdoc/ri/driver'
 
+$d ||= false
+$f ||= false
 $q ||= false
+$v ||= false
 
 # Forces /bin/tr to ignore badly formatted "unicode". (no clue where from)
 ENV['LANG'] = ""
 ENV['LC_ALL'] = "C"
 
 class RDoc::OSXDictionary
-  VERSION = '1.3.1'
+  VERSION = '2.0.0'
 
   EXCLUDE = {
-    "StringScanner#pre_match"  => true,
-    "StringScanner#post_match" => true,
-    "Gem::Package::TarInput"   => true,
-    "IRB::OutputMethod"        => true,
   }
 
   NAME_MAP = {
@@ -55,6 +55,11 @@ class RDoc::OSXDictionary
                               Regexp.escape(s)
                             }.reverse.join("|"))
 
+  attr_reader :to_html
+
+  def initialize
+    @to_html = RDoc::Markup::ToHtml.new
+  end
 
   def id *args
     args.map { |s| s.gsub(/:/, ',') }.join(",").gsub(/#{NAME_MAP_RE}/) { |x|
@@ -62,80 +67,85 @@ class RDoc::OSXDictionary
     }
   end
 
-  def display_class_info definition
-    name       = definition["name"]
-    fullname   = definition["full_name"]
-    supername  = definition["superclass"]
-    type       = supername ? "class" : "module"
-    title      = supername ? "class #{fullname} < #{supername}" : "module #{fullname}"
-    comment    = Array(definition["comment"]).join("\n")
+  def write_class_info klass, stores, path
+    m_seen = {} # HACK: known issue: on a case insensitive FS we're losing files
 
-    definition["includes"].map!  { |c| c["name"] }
-    definition["constants"].map! { |c| c["name"] }
+    File.open(path, "w") do |f|
+      c_result, m_result = [], []
 
-    return if $q and fullname !~ /^(String|Array|Bignum)/
+      m_seen.clear
+      seen_system = false
 
-    comment = "Improperly formatted" if EXCLUDE[fullname]
+      fullname  = klass
 
-    result = []
+      f.puts <<-"EOD".gsub(/^ {6}/, '')
+        <d:entry id="#{id fullname}" d:title="#{fullname}">
+          <d:index d:value="#{fullname.munge}"/>
+      EOD
 
-    shortname = "<d:index d:value=#{name.munge.inspect}/>" if name != fullname
+      first = true
 
-    result << <<-"EOD".gsub(/^    /, '')
-    <d:entry id="#{id type, fullname}" d:title="#{fullname}">
-      <d:index d:value="#{fullname.munge}"/>
-      #{shortname}
-      <h1>#{title.munge}</h1>
+      stores.each do |store|
+        cdesc     = store.load_class klass
+        type      = store.type
+        from      = store.friendly_path
+        name      = cdesc.name
+        is_class  = ! cdesc.module?
+        supername = cdesc.superclass if is_class
+        comment   = to_html.convert cdesc.comment
+        type      = is_class ? "class" : "module"
+        title     = is_class ? "class #{fullname}" : "module #{fullname}"
 
-      #{comment}
-    EOD
+        title += " < #{supername}" if is_class and supername != "Object"
 
-    extensions = []
+        comment = "Improperly formatted" if EXCLUDE[fullname]
 
-    definition["sources"].shift # remove first one as the original source
-    definition["sources"].each do |path|
-      next if path =~ /^.System/
+        shortname = "<d:index d:value=#{name.munge.inspect}/>" if name != fullname
 
-      gemname   = File.basename(path.sub(%r(/ri/\w+/cdesc-\w+.yaml), ''))
-      extension = YAML.load File.read(path).gsub(/- !.+/, '-')
+        f.puts <<-"EOD".gsub(/^ {8}/, '')
+            #{shortname}
+            <h1>#{title.munge}</h1>
+            <h3>From: #{from}</h3>
 
-      extension["includes"].map!  { |c| c["name"] }
-      extension["constants"].map! { |c| c["name"] }
+            #{comment}
+        EOD
 
-      detail = class_details(name, fullname, extension, 4)
+        level = first ? 2 : 4
+        first = false
 
-      next if detail.empty?
+        f.puts class_details(name, fullname, cdesc, level)
 
-      extensions << "<h3>#{gemname}:</h3>"
-      extensions << detail
-      %w(class_methods instance_methods includes constants).each do |k|
-        definition[k] -= extension[k]
-      end
-    end
+        cdesc.method_list.each do |method|
+          next if m_seen[method.full_name.downcase]
+          method = store.load_method klass, method.full_name
+          m_result << display_method_info(method, from)
+          m_seen[method.full_name.downcase] = true
+        end
+      end # stores.each
 
-    result << class_details(name, fullname, definition)
-    result << "<h2>Extensions:</h2>" unless extensions.empty?
-    result << extensions
+      f.puts <<-"EOD".gsub(/^ {6}/, '')
+        </d:entry>
 
-    result << <<-"EOD".gsub(/^    /, '')
-    </d:entry>
-    EOD
-    result.join("\n")
+      EOD
+
+      f.puts m_result.join("\n\n")
+    end
   end
 
+  # REFACTOR: fold this back in
   def class_details name, fullname, definition, level = 2
-    h = "h#{level}"
-    result     = []
-    includes   = definition["includes"]
-    constants  = definition["constants"]
+    h         = "h#{level}"
+    result    = []
+    includes  = definition.includes.map { |c| c.name }
+    constants = definition.constants.map { |c| c.name }
 
-    classmeths = definition["class_methods"].map { |hash|
-      name = hash["name"]
+    classmeths = definition.singleton_methods.map { |cm|
+      name = cm.name
       "<a href=\"x-dictionary:r:#{id "defs", fullname, name}\">#{name}</a>"
     }
 
-    instmeths  = definition["instance_methods"].map { |hash|
-      name = hash["name"]
+    instmeths = definition.instance_method_list.map { |im|
+      name = im.name
       "<a href=\"x-dictionary:r:#{id "def", fullname, name}\">#{name.munge}</a>"
     }
 
@@ -152,94 +162,73 @@ class RDoc::OSXDictionary
     result
   end
 
-  def display_method_info definition
-    fullname = definition["full_name"]
-    klass = definition["class"]
-    name = definition["name"]
+  def display_method_info definition, from
+    klass     = definition.parent_name
 
-    return if $q and klass !~ /^(String|Array|Bignum)/
+    fullname  = definition.full_name
+    name      = definition.name
+    singleton = definition.singleton
+    params    = definition.arglists
+    comment   = to_html.convert definition.comment
+    type      = singleton ? "defs" : "def"
 
     return if name =~ /_reduce_\d+/
 
-    params = definition["params"]
-    comment = Array(definition["comment"]).join("\n")
     comment = "undocumented" if comment.empty?
-
     comment = "Improperly formatted" if EXCLUDE[fullname]
 
-    type = definition["is_singleton"] ? "defs" : "def"
-
-    # TODO: aliases don't have recv
-    # TODO: some regular methods don't have recv
-
-    result = <<-"EOD".gsub(/^    /, '')
-    <d:entry id="#{id type, klass, name}" d:title="#{fullname.munge}">
-      <d:index d:value="#{fullname.munge}"/>
-      <d:index d:value="#{name.munge}"/>
-      <h1>#{fullname.munge}</h1>
-      <pre class="signatures">
-        #{d_signatures(name, params)}
-      </pre>
+    # HACK to deal with the Dictionary compiler fucking with my whitespace.
+    comment = comment.gsub(/<span[^>]+>/, '').gsub(/<\/span>/, '')
+    comment = comment.gsub(/(<pre[^>]*>)\s*\n/, '\1')
+
+    result = <<-"EOD".gsub(/^ {6}/, '')
+      <d:entry id="#{id type, klass, name}" d:title="#{fullname.munge}">
+        <d:index d:value="#{fullname.munge}"/>
+        <d:index d:value="#{name.munge}"/>
+        <h1>#{fullname.munge}</h1>
+        <h3>From: #{from}</h3>
+        <pre class="signatures">
+          #{d_signatures(name, params)}
+        </pre>
       #{comment}
-    </d:entry>
-  EOD
+      </d:entry>
+    EOD
   end
 
   def d_signatures name, params
     result = " "
+    params ||= ""
     if params.strip =~ /^\(/
       result << "<b>#{name.munge}</b>"
     end
-    result << "<b>#{params.munge.gsub(/\n/, "<br />")}</b>"
+    result << "<b>#{params.munge.gsub(/\n+/, "\n")}</b>"
   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
+    result = <<-"EOD".gsub(/^ {6}/, '')
+      <?xml version="1.0" encoding="UTF-8"?>
+      <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 classes, sources
+    result = <<-"EOD".gsub(/^ {6}/, '')
+      <d:entry id="front_back_matter" d:title="Front/Back Matter">
+        <h1><b>RubyGems Dictionary</b></h1>
+
+        <div>
+          Provides dictionary definitions for ruby core, stdlib, and
+          all known installed ruby gems.
+        </div>
 
-  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
+        <h3>Sources:</h3>
+        <div>#{sources.keys.sort.join ", "}</div>
+
+        <h3>Classes:</h3>
+        <div>#{classes.keys.sort.join ", "}</div>
+      </d:entry>
+      </d:dictionary>
+    EOD
   end
 
   def make
@@ -247,54 +236,64 @@ class RDoc::OSXDictionary
 
     FileUtils.rm_rf base if $d
 
-    seen  = {}
-    ri    = RDoc::RI::Driver.new
+    dir = File.join base, "dict"
+    FileUtils.mkdir_p dir unless File.directory? dir
+
     dirty = false
     force = $f || false
-    dict  = ri.class_cache
+    ri    = RDoc::RI::Driver.new
+    dict  = ri.classes
+
+    l_seen = {}
 
-    dict.sort.each do |klass, definition|
-      path = "#{base}/cache/#{klass}.xml"
+    dict.sort.each do |klass, stores|
+      path = "#{base}/dict/#{klass}.xml"
 
-      next if seen[klass.downcase]
-      seen[klass.downcase] = true
+      next if $q and klass !~ /^(String|Array|Bignum)/
 
       unless File.exist? path then
-        warn "New entries for dictionary. Rebuilding dictionary." unless dirty
+        unless dirty then
+          warn "New entries for dictionary. Rebuilding dictionary."
+          warn "Sing along, kids!"
+        end
         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|
-            v["class"] = klass
-            result << d_entry(k, v)
-          end
+        $stderr.print klass[0,1] unless l_seen[klass[0,1]]
+        l_seen[klass[0,1]] = true
 
-          f.puts result.join("\n")
-        end
+        write_class_info klass, stores, path
       end
     end
 
+    warn "! YAY!! All done!!!" if dirty
+
     return unless dirty unless force
 
     dict_src_path = "#{base}/RubyGemsDictionary.xml"
 
-    seen.clear
+    seen = {}
+
+    classes = {}
+    sources = {}
+    ri.classes.sort.each do |klass, stores|
+      classes[klass] = true
+
+      stores.each do |store|
+        sources[store.friendly_path] = true
+      end
+    end
 
     File.open(dict_src_path, "w") do |xml|
       xml.puts d_header
 
-      dict.sort.each do |klass, definition|
-        next if seen[klass.downcase]
-        seen[klass.downcase] = true
+      dict.sort.each do |klass, stores|
+        next if $q and klass !~ /^(String|Array|Bignum)/
 
-        path = "#{base}/cache/#{klass}.xml"
+        next if seen[klass]
+        seen[klass] = true
+
+        path = "#{base}/dict/#{klass}.xml"
         body = File.read path rescue nil
         if body then
           xml.puts body
@@ -303,7 +302,7 @@ class RDoc::OSXDictionary
         end
       end
 
-      xml.puts d_footer
+      xml.puts d_footer(classes, sources)
     end
 
     dict_name = "RubyAndGems"
@@ -312,6 +311,7 @@ class RDoc::OSXDictionary
 
     Dir.chdir base do
       run("/Developer/Extras/Dictionary Development Kit/bin/build_dict.sh",
+          "-c=0",
           dict_name, dict_src_path,
           "#{data}/RubyGemsDictionary.css",
           "#{data}/RubyGemsInfo.plist")
@@ -360,7 +360,7 @@ class RDoc::OSXDictionary
         @hooked[:uninstall] = true
         require 'fileutils'
         warn "nuking old ri cache to force rebuild"
-        FileUtils.rm_r File.expand_path("~/.ri/cache")
+        FileUtils.rm_r File.expand_path("~/.ri/dict")
         system cmd
       end
     end
@@ -374,42 +374,3 @@ class String
     self.gsub(/&/, '&amp;').gsub(/>/, '&gt;').gsub(/</, '&lt;').gsub(/-/, '&#45;')
   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

metadata

@@ -1,76 +1,101 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc_osx_dictionary
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
-  - 1
-  - 3
-  - 1
-  version: 1.3.1
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Ryan Davis
 autorequire: 
 bindir: bin
-cert_chain: []
+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-03-30 00:00:00 -07:00
-default_executable: 
+date: 2011-12-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
-        - 2
-        - 4
         - 3
-        version: 2.4.3
+        - 12
+        version: "3.12"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: minitest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 2
-        - 0
-        - 4
-        version: 2.0.4
+        - 8
+        version: "2.8"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: hoe
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
-        - 1
-        - 6
-        - 0
-        version: 1.6.0
+        - 2
+        - 12
+        version: "2.12"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rdoc
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
+        - 3
+        - 10
+        version: "3.10"
   type: :development
   version_requirements: *id004
 description: |-
@@ -98,7 +123,7 @@ files:
 - data/RubyGemsInfo.plist
 - lib/rdoc_osx_dictionary.rb
 - lib/rubygems_plugin.rb
-has_rdoc: true
+- .gemtest
 homepage: http://rubyforge.org/projects/seattlerb
 licenses: []
 
@@ -109,23 +134,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: rdoc via Apple's Dictionary.app