methodfinder 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f711364eaf7e9772fcdba37d1080618579f7e6f
-  data.tar.gz: b9bdf0bbdd9c32b299a778fbc80747b9b157adc7
+  metadata.gz: 6a9a69705744aeafd4eb6e25c3909a44cdd6e650
+  data.tar.gz: a5b5f61da2e85b791b95e954fa9355d6f545ffe6
 SHA512:
-  metadata.gz: 55acd3f55bb995667eca8053582cfb34f82a2f83c6a5bbd510ba473c5df15c08d0525ed6027b6d3cae433ac1b6b72912ac59e655055415dfa5656249d5a0ed4b
-  data.tar.gz: 0f445f405f1d393e8ad8e0338b46997faf89635e78fe3ad85c9a2630e2676956f0d9dbbc0d96542c18d1ec090f63184773b25276928f4ceada1016cf934989d3
+  metadata.gz: 0a743f6b177ed4adf72fade44e5a84e8b68ae0f813e6410d70333d83fffb6c641881f6b0127dc5e7ac77a4dec979b972e1148a610e46bfcab98af4dabcd0f453
+  data.tar.gz: 7d6463f11b889aa7728d4c595567fb804ee19f1f5ee06ad5a00a03b2666c30fa174ce01e8d4b98c8be14113a3bba6c2b9e51969a0584bb5d2b4dbf553123df49

data/README.rdoc

@@ -68,6 +68,33 @@ If the second parameter is omitted, all methods of the class or module will be r
     MethodFinder.find_in_class_or_module(Math)
     #=> [:acos, :acosh, :asin ... :tanh]
 
+== Troubleshooting
+
+If the +METHOD_FINDER_DEBUG+ environment variable is set, the name of each candidate method is printed to stderr before it is invoked. This can be useful to identify (and blacklist) misbehaving methods.
+
+It can be set on the command line e.g.:
+
+    $ METHOD_FINDER_DEBUG=1 irb
+
+Or inside IRB/Pry:
+
+    >> ENV['METHOD_FINDER_DEBUG'] = '1'
+
+Alternatively both <tt>Object#find_method</tt> and <tt>MethodFinder.find</tt> support an optional keyword argument +debug+ to toggle the behavior on a per-call basis (this argument defaults to the value of the environment variable described above):
+
+    >> 'a'.find_method(debug: true) { |n| n.unknown == 'A' }
+    !
+    !=
+    [output shortened]
+    yellowish
+    #=> ["String#capitalize", "String#capitalize!", "String#swapcase", "String#swapcase!", "String#upcase", "String#upcase!"]
+    >> MethodFinder.find('a', 'A', debug: true)
+    !
+    !=
+    [output shortened]
+    yellowish
+    #=> ["String#capitalize", "String#capitalize!", "String#swapcase", "String#swapcase!", "String#upcase", "String#upcase!"]
+
 == Warning
 
 Common sense not included!
@@ -83,10 +110,11 @@ I initially wrote this for the students of the core Ruby course on {RubyLearning
 * Jan Lelis for {implementing blacklists}[https://github.com/citizen428/methodfinder/issues/closed#issue/4].
 * Brian Morearty for pointing out an {incompatibility with Ruby 1.8.7}[https://github.com/citizen428/methodfinder/pull/5] and adding the {blockless version}[https://github.com/citizen428/methodfinder/pull/6] of <tt>Object#find_method</tt>.
 * Stefan Kanev for {adding Pry support}[https://github.com/citizen428/methodfinder/pull/7].
+* chocolateboy for {compatibility fixes and updates}[https://github.com/citizen428/methodfinder/pull/8] as well as {the intitial debug implementation}[https://github.com/citizen428/methodfinder/pull/9].
 
 == License
 
-Copyright (c) 2011 Michael Kohl
+Copyright (c) 2011-2017 Michael Kohl
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/methodfinder.rb

@@ -20,9 +20,10 @@ class Object
   #    10.find_method(1,3)
   #    #=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
 
-  def find_method(*args, &block)
+  def find_method(*args, debug: ENV['METHOD_FINDER_DEBUG'], &block)
     if block
       mets = MethodFinder.methods_to_try(self).select do |met|
+        STDERR.puts met if debug
         self.class.class_eval("alias :unknown #{met}")
         obj = self.dup rescue self # dup doesn't work for immutable types
         block.call(obj) rescue nil
@@ -52,7 +53,6 @@ module MethodFinder
     CLASS_METHOD_BLACKLIST[:Object] << :pry
   end
 
-  class << self
     # Provided with a receiver, the desired result and possibly some
     # arguments, <tt>MethodFinder.find</tt> will list all methods that
     # produce the given result when called on the receiver with the
@@ -67,13 +67,14 @@ module MethodFinder
     #    MethodFinder.find(['a','b','c'], ['A','B','C']) { |x| x.upcase }
     #    #=> ["Array#collect", "Array#collect!", "Enumerable#collect_concat", "Enumerable#flat_map", "Array#map", "Array#map!"]
 
-    def find(obj, res, *args, &block)
+    def self.find(obj, res, *args, debug: ENV['METHOD_FINDER_DEBUG'], &block)
       redirect_streams
 
       mets = methods_to_try(obj).select do |met|
         o = obj.dup rescue obj
         m = o.method(met)
         if m.arity <= args.size
+          STDERR.puts met if debug
           a = args.empty? && ARGS.has_key?(met) ? ARGS[met] : args
           m.call(*a, &block) == res rescue nil
         end
@@ -84,7 +85,7 @@ module MethodFinder
     end
 
     # Returns all currently defined modules and classes.
-    def find_classes_and_modules
+    def self.find_classes_and_modules
       constants = Object.constants.sort.map { |c| Object.const_get(c) }
       constants.select { |c| c.class == Class || c.class == Module}
     end
@@ -105,7 +106,7 @@ module MethodFinder
     #    MethodFinder.find_in_class_or_module(Math)
     #    #=> [:acos, :acosh, :asin ... :tanh]
 
-    def find_in_class_or_module(c, pattern=/./)
+    def self.find_in_class_or_module(c, pattern=/./)
       cs = Object.const_get(c.to_s)
       class_methods = cs.methods(false) rescue []
       instance_methods = cs.instance_methods(false)
@@ -114,7 +115,7 @@ module MethodFinder
     end
 
     # Returns a list of candidate methods for a given object. Added by Jan Lelis.
-    def methods_to_try(obj)
+    def self.methods_to_try(obj)
       ret = obj.methods
       blacklist = obj.is_a?(Module) ? CLASS_METHOD_BLACKLIST : INSTANCE_METHOD_BLACKLIST
       klass = obj.is_a?(Module) ? obj : obj.class
@@ -125,17 +126,16 @@ module MethodFinder
     end
 
     # :nodoc:
-    def redirect_streams
+    def self.redirect_streams
       @orig_stdout = $stdout
       @orig_stderr = $stderr
       $stdout = StringIO.new
       $stderr = StringIO.new
     end
 
-    def restore_streams
+    def self.restore_streams
       $stdout = @orig_stdout
       $stderr = @orig_stderr
     end
-  end
   private_class_method :redirect_streams, :restore_streams
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: methodfinder
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michael Kohl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies: []
 description: A Smalltalk-like Method Finder for Ruby with some extra features
 email: citizen428@gmail.com
@@ -16,9 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- "./LICENSE"
+- "./README.rdoc"
 - lib/methodfinder.rb
-- ./LICENSE
-- ./README.rdoc
 homepage: http://citizen428.github.com/methodfinder/
 licenses:
 - MIT
@@ -29,19 +29,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Smalltalk-like Method Finder for Ruby
 test_files: []
-has_rdoc: