rdoc_osx_dictionary 1.1.1 → 1.2.0

data/History.txt

@@ -1,3 +1,16 @@
+=== 1.2.0 / 2010-02-03
+
+* 3 minor enhancements:
+
+  * Added -d flag to delete .ri directory to help me debug.
+  * Loudly skip bad files created from rdoc.
+  * Skip _reduce_\d+ methods (generated methods from racc of no value to rdoc).
+
+* 2 bug fixes:
+
+  * Added extra de-duping on xml creation to fix The Bug I Cannot Repro(tm).
+  * OMG I am an idiot. Generating class id string properly now. :/
+
 === 1.1.1 / 2010-02-02
 
 * 1 minor enhancement:

data/bin/rdoc_osx_dictionary

@@ -2,6 +2,7 @@
 
 $v ||= false
 $f ||= false
+$d ||= false
 
 require 'rubygems'
 require 'rdoc_osx_dictionary'

data/lib/rdoc_osx_dictionary.rb

@@ -8,7 +8,7 @@ ENV['LANG'] = ""
 ENV['LC_ALL'] = "C"
 
 class RDoc::OSXDictionary
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 
   exclude = %w[ StringScanner#pre_match
                 StringScanner#post_match
@@ -77,7 +77,7 @@ class RDoc::OSXDictionary
 
     result = []
 
-    shortname = "<d:index d:value="#{name.munge}"/>" if name != fullname
+    shortname = "<d:index d:value=#{name.munge.inspect}/>" if name != fullname
 
     result << <<-"EOD".gsub(/^    /, '')
     <d:entry id="#{id}" d:title="#{fullname}">
@@ -92,10 +92,10 @@ class RDoc::OSXDictionary
 
     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],
+    [["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
@@ -110,8 +110,8 @@ class RDoc::OSXDictionary
     end
 
     %w(name comment superclass includes constants class_methods
-     instance_methods sources display_name full_name).each do |name|
-      definition.delete name
+     instance_methods sources display_name full_name).each do |key|
+      definition.delete key
     end
 
     result << <<-"EOD".gsub(/^    /, '')
@@ -125,6 +125,8 @@ class RDoc::OSXDictionary
     name = definition["name"]
     id = fullname.gsub(/#{NAME_MAP_RE}/) { |x| "_#{NAME_MAP[x]}" }
 
+    return if name =~ /_reduce_\d+/
+
     params = definition["params"]
     comment = Array(definition["comment"]).join("\n")
     comment = "undocumented" if comment.empty?
@@ -194,12 +196,15 @@ class RDoc::OSXDictionary
   end
 
   def make
+    base  = File.expand_path "~/.ri/"
+
+    FileUtils.rm_rf base if $d
+
     seen  = {}
     ri    = RDoc::RI::Driver.new
     dirty = false
     force = $f || false
     dict  = ri.class_cache
-    base  = File.expand_path "~/.ri/"
 
     dict.sort.each do |klass, definition|
       path = "#{base}/cache/#{klass}.xml"
@@ -232,11 +237,22 @@ class RDoc::OSXDictionary
 
     dict_src_path = "#{base}/RubyGemsDictionary.xml"
 
+    seen.clear
+
     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")
+        next if seen[klass.downcase]
+        seen[klass.downcase] = true
+
+        path = "#{base}/cache/#{klass}.xml"
+        body = File.read path rescue nil
+        if body then
+          xml.puts body
+        else
+          warn "Skipping: couldn't read: #{path}"
+        end
       end
 
       xml.puts d_footer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc_osx_dictionary
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -08:00
+date: 2010-02-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency