rdoc_osx_dictionary 1.0.1 → 1.1.0

data/History.txt

@@ -1,3 +1,15 @@
+=== 1.1.0 / 2010-02-01
+
+* 2 minor enhancements:
+
+  * Added -f to force rebuild.
+  * Refactored system calls to a handler so failures are uniformly handled.
+
+* 2 bug fixes:
+
+  * Fixed dictionary entry id munging to avoid errant duplicates.
+  * Setting $LC_ALL to C to fix unicode errors discovered in iTerm.
+
 === 1.0.1 / 2010-01-28
 
 * 4 bug fixes:

data/bin/rdoc_osx_dictionary

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby -ws
 
 $v ||= false
+$f ||= false
 
 require 'rubygems'
 require 'rdoc_osx_dictionary'

data/lib/rdoc_osx_dictionary.rb

@@ -5,9 +5,10 @@ require 'rdoc/ri/driver'
 
 # Forces /bin/tr to ignore badly formatted "unicode". (no clue where from)
 ENV['LANG'] = ""
+ENV['LC_ALL'] = "C"
 
 class RDoc::OSXDictionary
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
   exclude = %w[ StringScanner#pre_match
                 StringScanner#post_match
@@ -46,6 +47,7 @@ class RDoc::OSXDictionary
     '='   => 'eq',
     '?'   => 'eh',
     '`'   => 'backtick',
+    '::'  => '__',
   }
 
   NAME_MAP_RE = Regexp.new(NAME_MAP.keys.sort_by { |k| k.length }.map {|s|
@@ -119,7 +121,7 @@ class RDoc::OSXDictionary
   def display_method_info definition
     fullname = definition["full_name"]
     name = definition["name"]
-    id = fullname.gsub(/:|#/, '_').gsub(/#{NAME_MAP_RE}/) { |x| "_"+NAME_MAP[x] }
+    id = fullname.gsub(/#{NAME_MAP_RE}/) { |x| "_#{NAME_MAP[x]}" }
 
     params = definition["params"]
     comment = Array(definition["comment"]).join("\n")
@@ -193,6 +195,7 @@ class RDoc::OSXDictionary
     seen  = {}
     ri    = RDoc::RI::Driver.new
     dirty = false
+    force = $f || false
     dict  = ri.class_cache
     base  = File.expand_path "~/.ri/"
 
@@ -217,13 +220,13 @@ class RDoc::OSXDictionary
           methods.each do |k,v|
             result << d_entry(k, v)
           end
-          result = result.join("\n")
-          f.puts result
+
+          f.puts result.join("\n")
         end
       end
     end
 
-    return unless dirty
+    return unless dirty unless force
 
     dict_src_path = "#{base}/RubyGemsDictionary.xml"
 
@@ -242,17 +245,17 @@ class RDoc::OSXDictionary
     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")
+      run("/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
+    run "rsync", "-r", "#{base}/objects/#{dict_name}.dictionary", dict_path
 
     FileUtils.touch dict_path
 
@@ -260,6 +263,11 @@ class RDoc::OSXDictionary
     warn "Run Dictionary.app to use the new dictionary. (activate in prefs!)"
   end
 
+  def run(*cmd)
+    warn "running: " + cmd.map { |s| s.inspect }.join(" ") if $v
+    abort "command failed" unless system(*cmd)
+  end
+
   @hooked = false
 
   def self.install_gem_hooks

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc_osx_dictionary
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -30,7 +30,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2010-01-28 00:00:00 -08:00
+date: 2010-02-01 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency