ri_for 0.6.0 → 0.6.1

data/README

@@ -1,32 +1,11 @@
-the ri_for gem:
+The ri_for gem allows "runtime documentation lookup", it show a method's source code/comments, ri (if available), arity, parameters, 
+etc. all at runtime (for example within an irb session).
 
-A "run time documentation lookup gem", this gem allows you to grab a method's docu at runtime--for example within an irb session.  
-It display the method's source code/comments, ri (if available), arity, parameters, etc.
+Don't know what a method does? Look it up!
+It has proven quite useful, and I wouldn't do a ruby-debug session without it--you might like it.
 
 Examples:
 
-given this class
-
->> class A; 
-    def go(a); end; 
-   end
-
->> A.new.ri_for :go
-sig: A#go arity 1
-def go(a)
-  # do nothing
-end
-Parameters: go(a)
-Searching ri for
-sig: A#go arity 1
-...
-Nothing known about A
-(end ri)
-=> "Parameters: go(a)"
-
-It has proven quite useful, and I wouldn't do a ruby-debug session without it--try it--you might like it.
-
-more examples:
 
 >> File.ri_for :delete
 
@@ -46,10 +25,31 @@ sig: File.delete arity -1
 (end ri)
 => "sig: File.delete arity -1"
 
+(or alternatively use >> File.method(:delete).ri_for)
+
+or, given this dynamically generated class, it can still show runtime parameter information:
+
+>> class A; 
+    def go(a); end; 
+   end
+
+>> A.new.ri_for :go
+
+sig: A#go arity 1
+def go(a)
+  # do nothing
+end
+Parameters: go(a)
+Searching ri for
+sig: A#go arity 1
+...
+Nothing known about A
+(end ri)
+=> "Parameters: go(a)"
 
 Or (my favorite) use it within debug session:
 
- 74       assert(assigns['order'].order_line_items.map(:unit_price).min >= -5)
+ 74       assert(true == false)
  
 (rdb:1) ri_for :assert
 #<Method: StoreControllerTest(Test::Unit::Assertions)#assert>      arity: -2
@@ -106,6 +106,18 @@ Object#methods2 (like #methods, but inserts a marker after my_methods are shown)
 
 This gem wraps for convenience the functionality of Method#source_location, ruby2ruby, et al, and was inspired by a snippet from manvenu, SourceRef (MBARI), and Python's Method#desc.  It also wouldn't be useful without irb and the ruby-debug folks. Thanks!
 
+=== Related ===
+
+https://github.com/dadooda/ori (just lists ri, not method bodies and parameters, like mine does).
+also irb has a "help" command for obtaining (just lists ri) but it's pretty obscure nobody knows about it.
+>> help "Array"
+>> help "Array#[]" (just displays ri)
+
+There are quite a few "#methods" helper utilties out there, too.  
+irbtools also lists a lot of other irb helpers.
+
+=== Feedback ===
+
 Comments/suggestions welcome rogerdpack on gmail or rdp on github
 
 github.com/rdp/ri_for

data/Rakefile

@@ -2,10 +2,10 @@ require 'jeweler'
 Jeweler::Tasks.new do |s|
   s.name = %q{ri_for}
   s.authors = ["Roger Pack"]
-  s.description = s.summary = %q{ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging.}
+  s.description = s.summary = %q{ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging or in irb.}
   s.email = ["rogerdpack@gmail.comm"]
-  s.homepage = %q{http://github.com/rogerdpack/ri_for}
-  s.add_dependency(%q<rdoc>, [">= 2.3"]) # for quick ri lookup times
+  s.homepage = %q{http://github.com/rdp/ri_for}
+  s.add_dependency(%q<rdoc>, [">= 2.3"]) # higher version for quick ri lookup times
   s.add_dependency(%q<rdp-arguments>, [">= 0.6.4"])
   s.add_dependency(%q<ParseTree>) # these next two for 1.8 only...
   s.add_dependency(%q<ruby2ruby>)

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

metadata

@@ -2,7 +2,7 @@
 name: ri_for
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
   - Roger Pack
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-01 00:00:00 Z
+date: 2012-01-04 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: rdoc
@@ -89,7 +89,7 @@ dependencies:
             version: "0"
     type: :development
     version_requirements: *id007
-description: ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging.
+description: ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging or in irb.
 email: 
   - rogerdpack@gmail.comm
 executables: []
@@ -115,7 +115,7 @@ files:
   - test/test_ri_rb_used_internally
   - todo
   - TODO
-homepage: http://github.com/rogerdpack/ri_for
+homepage: http://github.com/rdp/ri_for
 licenses: []
 
 post_install_message: 
@@ -138,9 +138,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
-summary: ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging.
+summary: ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging or in irb.
 test_files: []