ruby_core_ri 0.3.0 → 0.4.0

data/README

@@ -1,20 +1,14 @@
-ruby_core_ri
+ruby_core_ri gem
 
-Installs the ri for Ruby's core docs for your current version, even if they didn't come with your distro.
-
-This utility is for those of us whose ruby distros are lacking in core RI.  For example.
+This utility is for those whose ruby distros are lacking the core RI (ex: mingw).  For example, if you get this:
 
 $ ri File
 Nothing known about File
 
-$
 
-now becomes
+After installing this gem, you will get the following:
 
 $ ri File
-
-
-
 --------------------------------------------------- Class: File < Object
 
 FTOOLS.RB: EXTRA TOOLS FOR THE FILE CLASS
@@ -23,18 +17,36 @@ FTOOLS.RB: EXTRA TOOLS FOR THE FILE CLASS
      Author:        WATANABE, Hirofumi
 
      Documentation: Zachary Landau
-...
-
-$
+... [etc.]
 
+The gem downloads the source for your current Ruby version, then does a gem --ri 
+against your version, thus installing the ri for Ruby's core docs locally.
 
-This is quite helpful for those of us who want to use ri for core classes.  For me, at least, ri is quite useless without it.
+This is quite helpful for those of us who want to use ri for core classes.
 
 == Installation (takes a little while) ==
 
-$ gem install ruby_core_ri --source=http://gemcutter.org
-$ install_ruby_core_ri # download core's source, ri's it locally for you
+* For all versions:
+
+$ gem install ruby_core_ri
+$ ruby_core_ri # download your distro's sources, ri's them locally
+
+* Note: for 1.9 users you have to install rdoc > 2.4.3 for it to work.  To do so (until it is released):
+
+    $ gem install specific_install
+    $ gem specific_install -l http://github.com/downloads/rdp/ruby_core_ri/rdoc-2.4.9a.gem
+
+    Also for windows 1.9 users, you may have to manually go into your install and delete the file "test/ruby/test_sprintf.rb"
+      ex: C:\Ruby19\lib\ruby\gems\1.9.1\gems\ruby_core_ri-0.4.0\lib\downloaded_full_source>rm test/ruby/test_sprintf.rb (and then clear your cache--see below)
+    
+== Trouble Shooting ==
+
+With gems v 1.3.6, it "refuses to regenerate" ri and rdoc (even on failed installs of the same).
 
+So if you do an install and "nothing happens":
+$ gem rdoc --no-rdoc --ri ruby_core_ri
+
+$ # note lack of output, above
+Then you may have to uninstall the gem, or remove your C:\Ruby19\lib\ruby\gems\1.9.1\doc\ruby_core_ri-0.4.0 directory before running ruby_core_ri again.
 
-== Known issues ==
-You may need to uninstall the mislav-hanna gem first, if installed.
+You may also need to uninstall the mislav-hanna gem first, if you have it installed (which is probably rare).

data/Rakefile

@@ -8,4 +8,14 @@
     s.add_development_dependency 'rspec'
     s.add_development_dependency 'sane'
     s.add_dependency 'backports'
+    s.add_dependency 'archive-tar-minitar'
+    # hopefully a warning is enough... 
+    s.add_dependency 'rdoc', '>=2.4.3' # 1.9 needs > ... see README
+    s.post_install_message  = "Please run 
+    
+    $ ruby_core_ri
+    
+    To install the docs locally.
+    "
+    
   end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bin/ruby_core_ri

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'ruby_core_ri/ruby_core_source'
+require 'ruby_core_ri/ruby_core_ri'
 
 # sanity check
 myself = Gem.source_index.find_name('ruby_core_ri')
@@ -10,9 +10,9 @@ myself = myself[0]
 # put it in a generic dir, until I can figure out how to get gem rdoc to accept it from elsewhere
 to_dir = myself.full_gem_path + "/lib/downloaded_full_source"
 puts "installing your full source (for rdoc/ri purposes) to #{to_dir}"
-Ruby_core_source.download_headers nil, to_dir, false
+Ruby_core_source.download_headers nil, to_dir, false # my call
 
-command = "gem rdoc --no-rdoc --ri ruby_core_ri"
-puts "downloading--extracting out the ri via " + command
+command = "gem rdoc --no-rdoc --ri ruby_core_ri" # note -- if this does nothing, it means "rubygems is cacheing your failed output" [I think]
+puts "downloaded--extracting out the ri via [" + command + "]"
 
-system command
+system command

data/lib/ruby_core_ri/{ruby_core_source.rb → ruby_core_ri.rb}

@@ -46,8 +46,9 @@ def download_headers hdrs, dest_dir = nil, just_headers = true, existing_pre_unp
 
   ruby_dir = ""
   ruby_version = RUBY_VERSION[0..-3]
+  
   if RUBY_VERSION >= '1.9'
-    ruby_version = '1.8' # for the latest 1.8.7 patch, for now [see below]
+    puts "Warning: if this fails, you may need to install rdoc > 2.4.3 see http://github.com/rdp/ruby_core_ri"    
   end
 
   if RUBY_PATCHLEVEL < 0
@@ -63,13 +64,7 @@ def download_headers hdrs, dest_dir = nil, just_headers = true, existing_pre_unp
   else
 
     version = RUBY_VERSION.to_s
-    patch_level = RUBY_PATCHLEVEL.to_s
-    if RUBY_VERSION >= '1.9'
-      $stderr.puts 'WARNING: installing the 1.8.7 source, since ri doesn\'t work on 1.9 core source quite yet'
-      version = '1.8.7'
-      patch_level = '160'
-    end
-      
+    patch_level = RUBY_PATCHLEVEL.to_s      
     ruby_dir = "ruby-" + version + "-p" + patch_level
   end
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_core_ri
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Roger Pack
@@ -9,39 +14,71 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-16 00:00:00 -07:00
+date: 2010-03-29 00:00:00 -06:00
 default_executable: ruby_core_ri
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: sane
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: backports
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 3
+        version: 2.4.3
+  type: :runtime
+  version_requirements: *id005
 description: 
 email: rogerdpack@gmail.com
 executables: 
@@ -55,14 +92,15 @@ files:
 - Rakefile
 - VERSION
 - bin/ruby_core_ri
+- lib/ruby_core_ri.rb
 - lib/ruby_core_ri/contrib/progressbar.rb
 - lib/ruby_core_ri/contrib/uri_ext.rb
-- lib/ruby_core_ri/ruby_core_source.rb
+- lib/ruby_core_ri/ruby_core_ri.rb
 has_rdoc: true
 homepage: http://github.com/rdp/ruby_core_ri
 licenses: []
 
-post_install_message: 
+post_install_message: "Please run \n    \n    $ ruby_core_ri\n    \n    To install the docs locally.\n    "
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -71,18 +109,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A gem to make it possible to have the core ri/rdoc (especially useful if your distro didn't include it)