ri_for 0.5.0 → 0.5.1

data/README

@@ -1,6 +1,10 @@
-A "run time RI for ruby methods", this gem allows you to query for information about objects' methods at runtime--for example within irb or ruby-debug.  It reveals everything known about the method.  This includes source, ri, arity, rdoc comments (1.9 only), etc.
+TODO note my_methods
 
-For me it has proved quite useful, and I wouldn't do a ruby-debug session without it--you might really like it.
+ri_for gem:
+
+A "run time RI for existing methods", this gem allows you to grab a method's docu at runtime--for example within a irb.  It display the method's source code/comments, ri (if available), arity, parameters, etc.
+
+It has proved quite useful, and I wouldn't do a ruby-debug session without it--you might really like it.
 
 Examples:
 
@@ -8,17 +12,19 @@ Examples:
     def go(a); end; 
    end
 
->> A.desc_method :go
-#<UnboundMethod: A#go>      arity: 1
-ri for A#go
-Nothing known about A
-(end ri)
+>> 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 ...
+(end ri)
+=> "Parameters: go(a)"
+
+(or you could do A.ri_for :go -- it falls back to show the instance method if it can't find the class method)
 
->> File.desc_method :delete
+>> File.ri_for :delete
 ri for File.delete
 ----------------------------------------------------------- File::delete
      File.delete(file_name, ...)  => integer

data/Rakefile

@@ -4,13 +4,13 @@ Jeweler::Tasks.new do |s|
   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.email = ["rogerdpack@gmail.comm"]
-
-  s.homepage = %q{http://github.com/rogerdpack/method_describer}
-  s.add_dependency(%q<rdoc>, [">= 2.3"]) # for sane ri lookup times
+  s.homepage = %q{http://github.com/rogerdpack/ri_for}
+  s.add_dependency(%q<rdoc>, [">= 2.3"]) # for quick ri lookup times
   s.add_dependency(%q<rdp-arguments>, [">= 0.6.4"])
-  s.add_dependency(%q<sane>, ['>= 0.20.1'])
   s.add_dependency(%q<ParseTree>) # these next two for 1.8 only...
   s.add_dependency(%q<ruby2ruby>)
+  s.add_development_dependency(%q<sane>, ['>= 0.20.1'])
   s.add_development_dependency("rubydoctest")
+  s.add_development_dependency("ffi")
 end
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/ri_for.rb

@@ -1,4 +1,3 @@
-require 'sane'
-for file in Dir[__dir__ + '/ri_for/*.rb'] do
+for file in Dir[File.dirname(__FILE__) + '/ri_for/*.rb'] do
 	 require file
 end

data/lib/ri_for/class_desc.rb

@@ -1,5 +1,3 @@
-require_relative 'method_ri'
-
 class Class
   # just runs ri against the class, outputs a big
   def desc_class options = {}

data/lib/ri_for/method_ri.rb

@@ -1,13 +1,16 @@
-require 'sane'
-
 if RUBY_VERSION < '1.9'
-  require 'rubygems'
   require 'ruby2ruby'
   require 'parse_tree'
   gem 'rdp-arguments' # TODO why is this necessary?
   require 'arguments' # rogerdpack-arguments
 end
 
+class Object
+  def singleton_class
+    class << self; self; end
+  end
+end
+
 module SourceLocationDesc
 
   # add a Method#desc which spits out all it knows about that method
@@ -53,7 +56,8 @@ module SourceLocationDesc
     string =~ /Method: .*([#\.])(.*)>/ # include the # or .
     joiner = $1
     method_name = $2
-    sig = "sig: #{class_name}#{joiner}#{method_name} arity #{arity}"
+    full_name = class_name + joiner + method_name
+    sig = "sig: #{full_name} arity #{arity}"
     doc << sig
     param_string = sig
 
@@ -67,7 +71,7 @@ module SourceLocationDesc
         if joiner == '#'
           raw_code = ParseTree.new.parse_tree_for_method(klass, method_name)
         else
-          raw_code = ParseTree.new.parse_tree_for_method(klass.singleton_class, method_name)
+          raw_code = ParseTree.new.parse_tree_for_method(klass.singleton_class, method_name) # singleton_class
         end
         doc << Ruby2Ruby.new.process(ParseTree.new.process(raw_code))
 
@@ -84,7 +88,6 @@ module SourceLocationDesc
       rescue Exception => e
         doc << "appears to be a c method"
         puts "fail to parse tree: #{class_name} #{e} #{e.backtrace}" if $DEBUG
-        doc << "appears to be a c method"
       end
     else
       # 1.9.x
@@ -133,7 +136,7 @@ module SourceLocationDesc
 
       # show default RI for it
       begin
-        pps 'Searching ri for', sig, '...'
+        puts 'Searching ri for', sig, '...'
         RDoc::RI::Driver.run [full_name, '--no-pager']
       rescue *[StandardError, SystemExit]
         # not found
@@ -167,7 +170,11 @@ class Object
       begin
         instance_method(name).ri(options)
       rescue NameError => e #allow for Class.instance_method_name, Module.instance_method_name
-        method(name).ri(options)
+        begin
+          method(name).ri(options)
+        rescue NameError
+          raise NameError.new("appears that this object #{self} does not have this method #{name}")
+        end
       end
     else
       method(name).desc(options)

data/test/bad.rb

@@ -0,0 +1,5 @@
+require 'rubydoctest.method.rb'
+require '../lib/ri_for'
+#require '_dbg'
+output = A.ri_for(:go22, :want_the_description_returned => true).join(' ')
+puts output.inspect

data/test/{test_method.rb → rubydoctest.method.rb}

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'ffi'
+require 'os'
 
 class A
  # a suh-weet rdoc
@@ -27,6 +28,7 @@ doctest_require: '../lib/ri_for'
 => true
 
 >> output = A.ri_for(:go22, :want_the_description_returned => true).join(' ')
+>> puts output
 >> output.include? 'b = 3'
 => true
 
@@ -105,6 +107,18 @@ wurx with class methods
 >> A.ri_for(:go)
 >> A.ri_for(:go2)
 
->> File.ri_for :delete
+# shouldn't duplicate "appear to be"
+doctest: fail
+>> a = File.ri_for(:delete, :want_the_description_returned => true).join(' ').scan(/appears to be/).length
+=> 1
 
-=end
+# should throw our own style exceptions
+>> e = nil;begin; File.ri_for(:unknown); rescue NameError => e; end
+>> e.to_s.include? "appears that"
+=> true
+
+>> a = `#{OS.ruby_bin} test_ri.rb`
+>> a.include? "File.delete(file_name"
+=> true
+
+=end

data/test/test_ri.rb

@@ -0,0 +1,2 @@
+require '../lib/ri_for'
+File.ri_for :delete

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ri_for
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Roger Pack
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 -07:00
+date: 2010-01-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,17 +33,17 @@ dependencies:
         version: 0.6.4
     version: 
 - !ruby/object:Gem::Dependency 
-  name: sane
+  name: ParseTree
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.20.1
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: ParseTree
+  name: ruby2ruby
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -53,14 +53,14 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: ruby2ruby
-  type: :runtime
+  name: sane
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.20.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: rubydoctest
@@ -72,6 +72,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: ruby method describer to make it possible to inspect methods [rdoc, signature, etc.] at runtime, for example while debugging.
 email: 
 - rogerdpack@gmail.comm
@@ -90,12 +100,13 @@ files:
 - lib/ri_for/class_desc.rb
 - lib/ri_for/kernel_new_methods_list.rb
 - lib/ri_for/method_ri.rb
-- test/test_big_name.rb
-- test/test_method.rb
+- test/rubydoctest.big.rb
+- test/rubydoctest.method.rb
+- test/test_ri.rb
 - todo
 - TODO
 has_rdoc: true
-homepage: http://github.com/rogerdpack/method_describer
+homepage: http://github.com/rogerdpack/ri_for
 licenses: []
 
 post_install_message: 
@@ -123,5 +134,7 @@ 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.
 test_files: 
-- test/test_big_name.rb
-- test/test_method.rb
+- test/bad.rb
+- test/rubydoctest.big.rb
+- test/rubydoctest.method.rb
+- test/test_ri.rb