ruby_core_ri 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
data/README CHANGED
@@ -1,12 +1,15 @@
1
- ruby_core_ri gem
1
+ == ruby_core_ri gem ==
2
2
 
3
- This utility is for those whose ruby distros are lacking the core RI (ex: mingw). For example, if you get this:
3
+ This gem installs a local copy of the trunk RI, which is useful for those ruby distros that are lacking the core RI (ex: rubyinstaller).
4
+
5
+ For example, if you get this:
4
6
 
5
7
  $ ri File
6
8
  Nothing known about File
7
9
 
10
+ $
8
11
 
9
- After installing this gem, you will get the following:
12
+ Then after installing this gem, you will get the following (the ri is there now):
10
13
 
11
14
  $ ri File
12
15
  --------------------------------------------------- Class: File < Object
@@ -19,34 +22,32 @@ FTOOLS.RB: EXTRA TOOLS FOR THE FILE CLASS
19
22
  Documentation: Zachary Landau
20
23
  ... [etc.]
21
24
 
22
- The gem downloads the source for your current Ruby version, then does a gem --ri
23
- against your version, thus installing the ri for Ruby's core docs locally.
24
-
25
- This is quite helpful for those of us who want to use ri for core classes.
26
25
 
27
- == Installation (takes a little while) ==
26
+ The gem downloads the source for your current Ruby version, then does a gem --ri, thus installing the ri for Ruby's core docs locally, though really as a gem.
28
27
 
29
- * For all versions:
28
+ == Installation (takes a little while--it's worth it if you want to use ri for core classes, though) ==
30
29
 
31
30
  $ gem install ruby_core_ri
32
- $ ruby_core_ri # download your distro's sources, ri's them locally
33
31
 
34
- * Note: for 1.9 users you have to install rdoc > 2.4.3 for it to work. To do so (until it is released):
32
+ $ ruby_core_ri # downloads your distro's sources, ri's them
35
33
 
36
- $ gem install specific_install
37
- $ gem specific_install -l http://github.com/downloads/rdp/ruby_core_ri/rdoc-2.4.9a.gem
34
+ * Note: for 1.9 users you have to install rdoc > 2.4.3 for it to work (possibly even > 2.5.0).
35
+ To do so (until bugs are fixed in rdoc trunk):
38
36
 
39
- Also for windows 1.9 users, you may have to manually go into your install and delete the file "test/ruby/test_sprintf.rb"
40
- 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)
37
+ $ gem install specific_install # install this gem plugin
38
+ $ gem specific_install -l http://github.com/downloads/rdp/ruby_core_ri/rdoc-2.4.3.1.gem # install a slightly fixed version that actually works with trunk
41
39
 
40
+ Or install that gem version by hand.
41
+
42
42
  == Trouble Shooting ==
43
43
 
44
- With gems v 1.3.6, it "refuses to regenerate" ri and rdoc (even on failed installs of the same).
44
+ With gems v 1.3.6, gems now always "doesn't re-generate" ri and rdoc (even on failed attempts of the same).
45
+
46
+ So if you attempt an install and "nothing happens" ex:
45
47
 
46
- So if you do an install and "nothing happens":
47
48
  $ gem rdoc --no-rdoc --ri ruby_core_ri
48
49
 
49
- $ # note lack of output, above
50
- 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.
50
+ $ # note lack of output
51
51
 
52
- You may also need to uninstall the mislav-hanna gem first, if you have it installed (which is probably rare).
52
+ Then you may have to uninstall the gem, or remove your equivalent of C:\Ruby19\lib\ruby\gems\1.9.1\doc\ruby_core_ri-0.4.0 before running ruby_core_ri again (then it will work).
53
+ You may also need to uninstall the mislav-hanna gem first, if you have it installed.
data/Rakefile CHANGED
@@ -15,7 +15,7 @@
15
15
 
16
16
  $ ruby_core_ri
17
17
 
18
- To install the docs locally.
18
+ To install the docs locally. 1.9 users please see the README.
19
19
  "
20
20
 
21
21
  end
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.4.0
1
+ 0.5.0
@@ -47,10 +47,6 @@ def download_headers hdrs, dest_dir = nil, just_headers = true, existing_pre_unp
47
47
  ruby_dir = ""
48
48
  ruby_version = RUBY_VERSION[0..-3]
49
49
 
50
- if RUBY_VERSION >= '1.9'
51
- puts "Warning: if this fails, you may need to install rdoc > 2.4.3 see http://github.com/rdp/ruby_core_ri"
52
- end
53
-
54
50
  if RUBY_PATCHLEVEL < 0
55
51
  # some type of svn checkout
56
52
  # try to use mark's lookup
@@ -96,6 +92,14 @@ def download_headers hdrs, dest_dir = nil, just_headers = true, existing_pre_unp
96
92
 
97
93
  }
98
94
  }
95
+ if RUBY_VERSION >= '1.9'
96
+ puts "Warning: if this fails, you may need to install rdoc > 2.4.3 see http://github.com/rdp/ruby_core_ri"
97
+ Dir[dest_dir + '/**/test_sprintf.rb'].each{ |file|
98
+ FileUtils.rm file # this file breaks rdoc on doze <sniff>
99
+ }
100
+ end
101
+
102
+
99
103
  dest_dir
100
104
  end
101
105
 
data/lib/ruby_core_ri.rb CHANGED
@@ -0,0 +1 @@
1
+ # put here just for convenience in being able to find where the gem was installed via gem which ruby_core_ri
metadata CHANGED
@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
4
4
  prerelease: false
5
5
  segments:
6
6
  - 0
7
- - 4
7
+ - 5
8
8
  - 0
9
- version: 0.4.0
9
+ version: 0.5.0
10
10
  platform: ruby
11
11
  authors:
12
12
  - Roger Pack
@@ -14,7 +14,7 @@ autorequire:
14
14
  bindir: bin
15
15
  cert_chain: []
16
16
 
17
- date: 2010-03-29 00:00:00 -06:00
17
+ date: 2010-03-30 00:00:00 -06:00
18
18
  default_executable: ruby_core_ri
19
19
  dependencies:
20
20
  - !ruby/object:Gem::Dependency
@@ -100,7 +100,7 @@ has_rdoc: true
100
100
  homepage: http://github.com/rdp/ruby_core_ri
101
101
  licenses: []
102
102
 
103
- post_install_message: "Please run \n \n $ ruby_core_ri\n \n To install the docs locally.\n "
103
+ post_install_message: "Please run \n \n $ ruby_core_ri\n \n To install the docs locally. 1.9 users please see the README.\n "
104
104
  rdoc_options:
105
105
  - --charset=UTF-8
106
106
  require_paths: