ri_for 0.5.1 → 0.6.0

data/ChangeLog

@@ -0,0 +1 @@
+0.6.0: jruby support, add File.method(:delete).ri_for

data/README

@@ -1,13 +1,12 @@
-TODO note my_methods
+the ri_for gem:
 
-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.
+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.
 
 Examples:
 
+given this class
+
 >> class A; 
     def go(a); end; 
    end
@@ -18,35 +17,41 @@ def go(a)
   # do nothing
 end
 Parameters: go(a)
-Searching ri for sig: A#go arity 1 ...
+Searching ri for
+sig: A#go arity 1
+...
+Nothing known about A
 (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)
+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
-ri for File.delete
+
+sig: File.delete arity -1
+appears to be a c method
+Searching ri for
+sig: File.delete arity -1
+...
 ----------------------------------------------------------- File::delete
      File.delete(file_name, ...)  => integer
      File.unlink(file_name, ...)  => integer
 
-     From Ruby 1.9.1
 ------------------------------------------------------------------------
      Deletes the named files, returning the number of names passed as
      arguments. Raises an exception on any error. See also +Dir::rmdir+.
 
 (end ri)
-#<Method: File.delete>     arity: -1
-appears to be a c method
-#parameters signature: delete( [[:rest]] )
+=> "sig: File.delete arity -1"
 
-Or (my favorite) a debug session:
 
-(rdb:1) l=
-...
+Or (my favorite) use it within debug session:
+
  74       assert(assigns['order'].order_line_items.map(:unit_price).min >= -5)
-...
-(rdb:1) desc_method :assert
+ 
+(rdb:1) ri_for :assert
 #<Method: StoreControllerTest(Test::Unit::Assertions)#assert>      arity: -2
 ri for Test::Unit::Assertions#assert
 ------------------------------------------ Test::Unit::Assertions#assert
@@ -71,37 +76,36 @@ def assert(boolean, message = nil)
 end
 Parameters: assert(boolean, message = nil)
 
-Thus, you can look at methods' source/rdocs without having to step into them.  Deftly convenient.
+Thus, you can look at methods' source/rdocs without having to run the methods and step into them.  Deftly convenient.
+
+=========Installation=====
 
-========= How to Install=====
-$ gem install rogerdpack-desc_method
-or
-$ gem install rogerdpack-desc_method --source http://gems.github.com 
-if you don't have gems.github.com as a gem source.
+$ gem install ri_for
 
 Usage:
->> require 'desc_method'
->> Class.desc_method :method_name # class or instance method name
-...
->> some_instance.desc_method :method_name
+>> require 'ri_for'
+>> ClassName.ri_for :method_name # class or instance method name
+
+>> some_instance.ri_for :method_name
 
 Other goodies included:
 
-Class#desc_class method
+Object#my_methods (stolen from a website somewhere)
 
 An example:
->> Object.desc_class
-# outputs descriptive info about that class--RI, method list, etc.
->> Object.desc_class :verbose => true
-# outputs RI, method lists including inherited methods, ancestors, all constants etc.
+>> class A; def go; end; end
+>> A.new.my_methods
+=> {:first, :second, :third]}
+
+Object#methods2 (like #methods, but inserts a marker after my_methods are shown)
+
+>> A.new.methods2
+=> ["go", :"inherited methods after this point >>", "to_yaml_style", "inspect", "methods_old", "clone", "public_methods", "display", "instance_variable_defined?", "equal?", "freeze", "to_yaml_properties", "methods"...]
 
-Kernel#methods has been monkey patched to output a "separator" between its inherited and non inherited methods--i.e.
->> instance.methods
-=> [:first, :second, :after_this_are_inherited>>>>>, :some_inherited_method, :another_inherited_method] # adds in that separator
+=== Attributions ===
 
-I'll probably remove that in a future release since it turns out you can just run Kernel#methods(false) for about much.
+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!
 
-=== Thanks ===
-This gem wraps for convenience the functionality of Method#source_location, ruby2ruby, et al, and also contains some code inspiration from manvenu, SourceRef (MBARI), and Python's Method#desc.  It also wouldn't be useful without irb and the ruby-debug folks. Thanks!
+Comments/suggestions welcome rogerdpack on gmail or rdp on github
 
-Comments/suggestions welcome rogerdpack on gmail or github
+github.com/rdp/ri_for

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/ri_for/kernel_new_methods_list.rb

@@ -1,8 +1,9 @@
 =begin rdoc
  add method methods2 so that it returns lists that are split into two kind of [adds a marker where the inherited methods begin].
 =end
+
 module Kernel
-  alias :methods_old :methods
+  #alias :methods_old :methods
   def methods2 all = true
     if all
       # give some marker designating when the inherited methods start
@@ -13,7 +14,7 @@ module Kernel
   end
 end
 
-class Object
+class Object  # TODO add to sane [?]
  def my_methods(_super=false)
    _methods = (_super) ? self.class.superclass.new.methods : Object.methods
    (self.methods - _methods).sort

data/lib/ri_for/method_ri.rb

@@ -1,8 +1,11 @@
+
 if RUBY_VERSION < '1.9'
-  require 'ruby2ruby'
-  require 'parse_tree'
-  gem 'rdp-arguments' # TODO why is this necessary?
-  require 'arguments' # rogerdpack-arguments
+  unless RUBY_PLATFORM =~ /java/
+    require 'ruby2ruby'
+    require 'parse_tree'
+    gem 'rdp-arguments' # TODO why is this necessary?
+    require 'arguments' # rdp-arguments
+  end
 end
 
 class Object
@@ -65,32 +68,36 @@ module SourceLocationDesc
 
     if !(respond_to? :source_location)
       # pull out names for 1.8
-      begin
-        klass = eval(class_name)
-        # we don't call to_ruby to overcome ruby2ruby bug http://rubyforge.org/tracker/index.php?func=detail&aid=26891&group_id=1513&atid=5921
-        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) # singleton_class
+      unless RUBY_PLATFORM =~ /java/
+        begin
+          klass = eval(class_name)
+          # we don't call to_ruby to overcome ruby2ruby bug http://rubyforge.org/tracker/index.php?func=detail&aid=26891&group_id=1513&atid=5921
+          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) # singleton_class
+          end
+          doc << Ruby2Ruby.new.process(ParseTree.new.process(raw_code))
+  
+          args = Arguments.names(klass, method_name, false) rescue Arguments.names(klass.singleton_class, method_name, false)
+          out = []
+          args.each{|arg_pair|
+            out << arg_pair.join(' = ')
+          } if args
+          out = out.join(', ')
+          return out if want_just_summary
+  
+          param_string = "Parameters: #{method_name}(" + out + ")"
+          doc << param_string unless want_the_description_returned
+        rescue Exception => e
+          doc << "appears to be a c method"
+          puts "fail to parse tree: #{class_name} #{e} #{e.backtrace}" if $DEBUG
         end
-        doc << Ruby2Ruby.new.process(ParseTree.new.process(raw_code))
-
-        args = Arguments.names(klass, method_name, false) rescue Arguments.names(klass.singleton_class, method_name, false)
-        out = []
-        args.each{|arg_pair|
-          out << arg_pair.join(' = ')
-        } if args
-        out = out.join(', ')
-        return out if want_just_summary
-
-        param_string = "Parameters: #{method_name}(" + out + ")"
-        doc << param_string unless want_the_description_returned
-      rescue Exception => e
-        doc << "appears to be a c method"
-        puts "fail to parse tree: #{class_name} #{e} #{e.backtrace}" if $DEBUG
+      else
+        doc << "jruby does not allow introspection of method parameter names in 1.8.x AFAIK"
       end
     else
-      # 1.9.x
+      # 1.9.x or REE
       file, line = source_location
       param_string = to_s
       if file
@@ -157,9 +164,6 @@ module SourceLocationDesc
   
 end
 
-class Method; include SourceLocationDesc; end
-class UnboundMethod; include SourceLocationDesc; end
-
 # TODO mixin from a separate module
 
 class Object
@@ -181,3 +185,13 @@ class Object
     end
   end
 end
+
+class Method; 
+  include SourceLocationDesc
+  alias ri_for ri # allow for File.method(:delete).ri_for as well
+end
+
+class UnboundMethod
+  include SourceLocationDesc
+  alias ri_for ri
+end

data/test/rubydoctest.method.rb

@@ -1,124 +1,133 @@
-require 'rubygems'
-require 'ffi'
-require 'os'
-
-class A
- # a suh-weet rdoc
- def go(a=5)
-  a = 33
- end
-
- def self.go22(b=5)
-   b = 3
- end
-end
-
-=begin
-doctest_require: '../lib/ri_for'
->> output = A.ri_for(:go, :want_the_description_returned => true).join(' ')
->> output.include? 'a = 33'
-=> true
->> RUBY_VERSION < '1.9' || output.include?('suh-weet')
-=> true
-
->> output = A.new.ri_for(:go, :want_the_description_returned => true).join(' ')
->> output.include? 'a = 33'
-=> true
->> RUBY_VERSION < '1.9' || output.include?('suh-weet')
-=> true
-
->> output = A.ri_for(:go22, :want_the_description_returned => true).join(' ')
->> puts output
->> output.include? 'b = 3'
-=> true
-
-it should return you something useful
-
->> A.ri_for(:go22) == nil
-=> false
->> A.ri_for(:go) == nil
-=> false
-
-it should work with Module
->> FFI::Library.ri_for(:attach_function, :want_the_description_returned => true).nil?
-=> false
-
-it should say c method for c
->> output = String.ri_for(:strip, :want_the_description_returned => true).join(' ')
->> output.include?('c method')
-=> true
->> output = String.ri_for(:strip)
->> output.nil?
-=> false
-
-=end
-
-
-=begin
-doctest:
-
-it should return true if you run it against a "real" class
->> String.desc_class(:want_output => true).length > 1
-=> true
->> class A; end
->> A.desc_class(:want_output => true).length > 1
-=>  true
-
-it shouldn't report itself as an ancestor of itself
->> A.desc_class(:want_output => true).grep(/ancestors/).include? '[A]'
-=> false
-
-also lists constants
->> A.desc_class(:want_output => true, :verbose => true).grep(/constants/i)
-=> [] # should be none since we didn't add any constants to A
->> class A; B = 3; end
->> A.desc_class(:want_output => true, :verbose => true).grep(/constants/i).length
-=> 1 # should be none since we didn't add any constants to A
-
-should work with sub methods
->> String.ri_for(:strip)
-
-doctest_require: '../lib/ri_for'
-=end
-
-=begin 
-doctest:
->> require 'pathname'
-
-it should display the name
-
->> Pathname.instance_method(:children).desc(:want_the_description_returned => true).grep(/children/).size > 0
-=>  true # ["#<UnboundMethod: Pathname#children>"]
-
->> Pathname.instance_method(:children).desc(:want_the_description_returned => true).grep(/Dir.foreach/).size > 0
-=> true  # the code itself
-
-and arity
->> Pathname.instance_method(:children).desc(:want_the_description_returned => true).grep(/arity/)
-=> ["sig: Pathname#children arity -1"]
-
-it should not duplicate arity
->> A.ri_for(:go, :want_the_description_returned => true).join(' ').scan(/arity/).length
-=> 1
-
-wurx with class methods
->> class A; def self.go(a = 3); a=5; end; end
->> class A; def go2(a=4) a =7; end; end
->> A.ri_for(:go)
->> A.ri_for(:go2)
-
-# 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
-
-# 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
-
+require 'rubygems'
+require 'ffi'
+require 'os'
+
+class A
+ # a suh-weet rdoc
+ def go(a=5)
+  a = 33
+ end
+
+ def self.go22(b=5)
+   b = 3
+ end
+end
+
+=begin
+doctest_require: '../lib/ri_for'
+>> output = A.ri_for(:go, :want_the_description_returned => true).join(' ')
+>> output.include? 'a = 33'
+=> true
+>> RUBY_VERSION < '1.9' || output.include?('suh-weet')
+=> true
+
+>> output = A.new.ri_for(:go, :want_the_description_returned => true).join(' ')
+>> output.include? 'a = 33'
+=> true
+>> RUBY_VERSION < '1.9' || output.include?('suh-weet')
+=> true
+
+>> output = A.ri_for(:go22, :want_the_description_returned => true).join(' ')
+>> puts output
+>> output.include? 'b = 3'
+=> true
+
+it should return you something useful
+
+>> A.ri_for(:go22) == nil
+=> false
+>> A.ri_for(:go) == nil
+=> false
+
+it should work with Module
+>> FFI::Library.ri_for(:attach_function, :want_the_description_returned => true).nil?
+=> false
+
+it should say c method for c
+>> output = String.ri_for(:strip, :want_the_description_returned => true).join(' ')
+>> output.include?('c method')
+=> true
+>> output = String.ri_for(:strip)
+>> output.nil?
+=> false
+
+=end
+
+
+=begin
+doctest:
+
+it should return true if you run it against a "real" class
+>> String.desc_class(:want_output => true).length > 1
+=> true
+>> class A; end
+>> A.desc_class(:want_output => true).length > 1
+=>  true
+
+it shouldn't report itself as an ancestor of itself
+>> A.desc_class(:want_output => true).grep(/ancestors/).include? '[A]'
+=> false
+
+also lists constants
+>> A.desc_class(:want_output => true, :verbose => true).grep(/constants/i)
+=> [] # should be none since we didn't add any constants to A
+>> class A; B = 3; end
+>> A.desc_class(:want_output => true, :verbose => true).grep(/constants/i).length
+=> 1 # should be none since we didn't add any constants to A
+
+should work with sub methods
+>> String.ri_for(:strip)
+
+doctest_require: '../lib/ri_for'
+=end
+
+=begin 
+doctest:
+>> require 'pathname'
+
+it should display the name
+
+>> Pathname.instance_method(:children).desc(:want_the_description_returned => true).grep(/children/).size > 0
+=>  true # ["#<UnboundMethod: Pathname#children>"]
+
+>> Pathname.instance_method(:children).desc(:want_the_description_returned => true).grep(/Dir.foreach/).size > 0
+=> true  # the code itself
+
+and arity
+>> Pathname.instance_method(:children).desc(:want_the_description_returned => true).grep(/arity/)
+=> ["sig: Pathname#children arity -1"]
+
+it should not duplicate arity
+>> A.ri_for(:go, :want_the_description_returned => true).join(' ').scan(/arity/).length
+=> 1
+
+wurx with class methods
+>> class A; def self.go(a = 3); a=5; end; end
+>> class A; def go2(a=4) a =7; end; end
+>> A.ri_for(:go)
+>> A.ri_for(:go2)
+
+# 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
+
+# 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
+
+=begin
+doctest: it should work with method objects themselves
+>> b = File.method(:delete)
+>> b.ri_for
+=> "sig: File.delete arity -1"
+
+# TODO
+
 =end

data/test/test_ri.rb

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

metadata

@@ -1,140 +1,146 @@
 --- !ruby/object:Gem::Specification 
 name: ri_for
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors: 
-- Roger Pack
+  - Roger Pack
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 -07:00
-default_executable: 
+date: 2011-09-01 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rdoc
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.3"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rdp-arguments
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.4
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: ParseTree
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: ruby2ruby
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: sane
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.20.1
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rubydoctest
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !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: 
+  - !ruby/object:Gem::Dependency 
+    name: rdoc
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "2.3"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rdp-arguments
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.6.4
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: ParseTree
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: ruby2ruby
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: sane
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.20.1
+    type: :development
+    version_requirements: *id005
+  - !ruby/object:Gem::Dependency 
+    name: rubydoctest
+    prerelease: false
+    requirement: &id006 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id006
+  - !ruby/object:Gem::Dependency 
+    name: ffi
+    prerelease: false
+    requirement: &id007 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            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.
 email: 
-- rogerdpack@gmail.comm
+  - rogerdpack@gmail.comm
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
-- TODO
+  - ChangeLog
+  - README
+  - TODO
 files: 
-- README
-- Rakefile
-- VERSION
-- lib/ri_for.rb
-- lib/ri_for/class_desc.rb
-- lib/ri_for/kernel_new_methods_list.rb
-- lib/ri_for/method_ri.rb
-- test/rubydoctest.big.rb
-- test/rubydoctest.method.rb
-- test/test_ri.rb
-- todo
-- TODO
-has_rdoc: true
+  - ChangeLog
+  - README
+  - Rakefile
+  - VERSION
+  - lib/ri_for.rb
+  - lib/ri_for/class_desc.rb
+  - lib/ri_for/kernel_new_methods_list.rb
+  - lib/ri_for/method_ri.rb
+  - test/rubydoctest.big.rb
+  - test/rubydoctest.method.rb
+  - test/test_ri.rb
+  - test/test_ri_rb_used_internally
+  - todo
+  - TODO
 homepage: http://github.com/rogerdpack/ri_for
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.9
 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/bad.rb
-- test/rubydoctest.big.rb
-- test/rubydoctest.method.rb
-- test/test_ri.rb
+test_files: []
+

data/test/bad.rb

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