methodfinder 1.2.5 → 2.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6956d01fde38cb630cad9346d877e060fff4920c7163016ff8b97cf20020ef27
+  data.tar.gz: 695b0fd1fa89f26ab09dc6f30bda1b650d2ce6d0e9617c0ac5a8207f402ec575
+SHA512:
+  metadata.gz: 24d990971ab3dbdfbc3a7568b7145637dc8b222897200ee01d03364528248edcb1d7acd57db8b4afaab2949cb4b7dfa31ef3dfd5778ac1f6d4360afc9b2f0619
+  data.tar.gz: 894bdbb10df681feae1dbd03892d436ce2faec0009414fa50cafab92dba1079dfb52e722bb9a763b21af6971cca007081b9bcff6c111718e349d7c97e92dd07a

data/CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+## [Unreleased](https://github.com/citizen428/methodfinder/tree/HEAD)
+
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v2.2.1...HEAD)
+
+**Implemented enhancements:**
+
+- Add a changelog [\#19](https://github.com/citizen428/methodfinder/pull/19) ([chocolateboy](https://github.com/chocolateboy))
+- Cast the METHOD\_FINDER\_DEBUG environment variable to a boolean [\#17](https://github.com/citizen428/methodfinder/pull/17) ([chocolateboy](https://github.com/chocolateboy))
+- Switch to Bundler gem structure [\#16](https://github.com/citizen428/methodfinder/pull/16) ([citizen428](https://github.com/citizen428))
+
+**Merged pull requests:**
+
+- Documentation tweaks [\#22](https://github.com/citizen428/methodfinder/pull/22) ([chocolateboy](https://github.com/chocolateboy))
+- Bump activesupport from 5.2.0 to 6.0.3.1 [\#21](https://github.com/citizen428/methodfinder/pull/21) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update rake requirement from ~\> 10.0 to ~\> 13.0 [\#20](https://github.com/citizen428/methodfinder/pull/20) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v2.2.1](https://github.com/citizen428/methodfinder/tree/v2.2.1) (2018-05-02)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v2.2.0...v2.2.1)
+
+## [v2.2.0](https://github.com/citizen428/methodfinder/tree/v2.2.0) (2018-05-02)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v2.1.0...v2.2.0)
+
+**Implemented enhancements:**
+
+- README.md tweaks [\#14](https://github.com/citizen428/methodfinder/pull/14) ([chocolateboy](https://github.com/chocolateboy))
+
+**Fixed bugs:**
+
+- It's not possible to pass a hash as the last argument [\#10](https://github.com/citizen428/methodfinder/issues/10)
+- Fix failing Travis builds [\#15](https://github.com/citizen428/methodfinder/pull/15) ([chocolateboy](https://github.com/chocolateboy))
+- Propagate keywords \(i.e. :debug\) from find\_method to find [\#11](https://github.com/citizen428/methodfinder/pull/11) ([chocolateboy](https://github.com/chocolateboy))
+
+## [v2.1.0](https://github.com/citizen428/methodfinder/tree/v2.1.0) (2017-02-05)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v2.0.0...v2.1.0)
+
+**Implemented enhancements:**
+
+- Allow tested method names to be dumped to STDERR via an environment variable [\#9](https://github.com/citizen428/methodfinder/pull/9) ([chocolateboy](https://github.com/chocolateboy))
+- Compatibility updates, fixes and workarounds [\#8](https://github.com/citizen428/methodfinder/pull/8) ([chocolateboy](https://github.com/chocolateboy))
+
+## [v2.0.0](https://github.com/citizen428/methodfinder/tree/v2.0.0) (2013-10-30)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.2.5...v2.0.0)
+
+## [v1.2.5](https://github.com/citizen428/methodfinder/tree/v1.2.5) (2011-12-18)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.2.4...v1.2.5)
+
+## [v1.2.4](https://github.com/citizen428/methodfinder/tree/v1.2.4) (2011-10-26)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.2.2...v1.2.4)
+
+**Implemented enhancements:**
+
+- Make methodfinder play nice with Pry [\#7](https://github.com/citizen428/methodfinder/pull/7) ([skanev](https://github.com/skanev))
+- Instance syntax and fix tests [\#6](https://github.com/citizen428/methodfinder/pull/6) ([BMorearty](https://github.com/BMorearty))
+
+## [v1.2.2](https://github.com/citizen428/methodfinder/tree/v1.2.2) (2011-04-23)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.2.1...v1.2.2)
+
+## [v1.2.1](https://github.com/citizen428/methodfinder/tree/v1.2.1) (2011-04-16)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.2.0...v1.2.1)
+
+**Implemented enhancements:**
+
+- Add a method blacklist [\#4](https://github.com/citizen428/methodfinder/pull/4) ([janlelis](https://github.com/janlelis))
+
+## [v1.2.0](https://github.com/citizen428/methodfinder/tree/v1.2.0) (2011-04-08)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.1.1...v1.2.0)
+
+## [v1.1.1](https://github.com/citizen428/methodfinder/tree/v1.1.1) (2011-04-05)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.1.0...v1.1.1)
+
+**Implemented enhancements:**
+
+- Alternative block interface [\#3](https://github.com/citizen428/methodfinder/issues/3)
+
+## [v1.1.0](https://github.com/citizen428/methodfinder/tree/v1.1.0) (2011-03-31)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.0.1...v1.1.0)
+
+**Closed issues:**
+
+- Small typo in the readme [\#2](https://github.com/citizen428/methodfinder/issues/2)
+
+## [v1.0.1](https://github.com/citizen428/methodfinder/tree/v1.0.1) (2011-03-11)
+[Full Changelog](https://github.com/citizen428/methodfinder/compare/v1.0.0...v1.0.1)
+
+## [v1.0.0](https://github.com/citizen428/methodfinder/tree/v1.0.0) (2011-02-10)

data/{LICENSE → LICENSE.txt}

@@ -17,4 +17,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-

data/README.md

@@ -0,0 +1,219 @@
+# MethodFinder
+
+![Build](https://github.com/citizen428/methodfinder/workflows/Build/badge.svg)
+[![Gem Version](https://img.shields.io/gem/v/methodfinder.svg)](https://rubygems.org/gems/methodfinder)
+
+<!-- toc -->
+
+- [NAME](#name)
+- [INSTALLATION](#installation)
+- [SYNOPSIS](#synopsis)
+- [DESCRIPTION](#description)
+  - [Warning](#warning)
+- [API](#api)
+  - [MethodFinder.find](#methodfinderfind)
+  - [Object#find_method](#objectfind_method)
+    - [Ignorelists](#ignorelists)
+  - [MethodFinder.find_classes_and_modules](#methodfinderfind_classes_and_modules)
+  - [MethodFinder.find_in_class_or_module](#methodfinderfind_in_class_or_module)
+- [TROUBLESHOOTING](#troubleshooting)
+- [DEVELOPMENT](#development)
+- [CONTRIBUTING](#contributing)
+- [SEE ALSO](#see-also)
+  - [Gems](#gems)
+  - [Misc](#misc)
+- [VERSION](#version)
+- [AUTHOR](#author)
+- [LICENSE](#license)
+
+<!-- tocstop -->
+
+## NAME
+
+MethodFinder - a Smalltalk-like Method Finder for Ruby
+
+## INSTALLATION
+
+    $ gem install methodfinder
+
+## SYNOPSIS
+
+```ruby
+Welcome to IRB. # or Pry
+
+>> 'Hello, world!'.find_method('HELLO, WORLD!')
+#=> ["String#upcase", "String#upcase!"]
+
+>> %w[a b c].find_method('c')
+#=> ["Array#last", "Array#max", "Array#pop"]
+
+>> %w[a b c].find_method { |it| it.unknown(2); it == %w[c] }
+#=> ["Array#shift"]
+```
+
+## DESCRIPTION
+
+A Smalltalk-like Method Finder for Ruby for use in your `~/.irbrc` or
+`~/.pryrc`.
+
+This project was originally inspired by Smalltalk's Method
+Finder, but additional features have been added over time.
+
+### Warning
+
+Common sense not included!
+
+While this gem should generally be safe to use, it's still better to be safe
+than sorry, so use this with caution and maybe not on production data.
+
+This was initially written for the students of the core Ruby course on
+[RubyLearning](http://web.archive.org/web/20151218180403/http://rubylearning.org/classes/),
+so it's generally not tested in a Rails console, just plain IRB/Pry.
+
+## API
+
+### MethodFinder.find
+
+Provided with a receiver, the desired result and possibly some arguments,
+`MethodFinder.find` will list all methods that produce the given result when
+called on the receiver with the provided arguments.
+
+```ruby
+MethodFinder.find(10, 1, 3)
+#=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
+MethodFinder.find("abc", "ABC")
+#=> ["String#swapcase", "String#swapcase!", "String#upcase", "String#upcase!"]
+MethodFinder.find(10, 100, 2)
+#=> ["Fixnum#**"]
+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!"]
+```
+
+### Object#find_method
+
+This gem also adds `Object#find_method`, which besides offering an alternative
+interface to pretty much the same functionality as `MethodFinder.find`, also
+allows you to test for state other than the return value of the method.
+
+```ruby
+%w[a b c].find_method { |a| a.unknown(1) ; a == %w[a c] }
+#=> ["Array#delete_at", "Array#slice!"]
+10.find_method { |n| n.unknown(3) == 1 }
+#=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
+```
+
+Inside `find_method`'s block, the receiver is available as block argument and
+the special method `unknown` is used as a placeholder for the desired method.
+
+You can also call `find_method` without passing a block. This is the same as
+calling `MethodFinder.find`.
+
+```ruby
+10.find_method(1, 3)
+#=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
+```
+
+#### Ignorelists
+
+You can exclude methods from being tried by editing the hashes
+`MethodFinder::INSTANCE_METHOD_IGNORELIST` and
+`MethodFinder::CLASS_METHOD_IGNORELIST`. Both use the class/module as key and
+an array of method names as values (note that class, module and method names
+have to be symbols).
+
+For example, to ignore the instance method `shutdown` of `Object`, you would do
+
+```ruby
+MethodFinder::INSTANCE_METHOD_IGNORELIST[:Object] << :shutdown
+```
+
+This might come in handy when using `MethodFinder` together with other gems as
+such as `interactive_editor`.
+
+### MethodFinder.find_classes_and_modules
+
+A simple method to return all currently defined modules and classes.
+
+```ruby
+MethodFinder.find_classes_and_modules
+#=> [ArgumentError, Array, BasicObject, Bignum ... ZeroDivisionError]
+```
+
+### MethodFinder.find_in_class_or_module
+
+Searches for a given name within a class. The first parameter can either be a
+class object, a symbol or a string whereas the optional second parameter can
+be a string or a regular expression:
+
+```ruby
+MethodFinder.find_in_class_or_module('Array', 'shuff')
+#=> [:shuffle, :shuffle!]
+MethodFinder.find_in_class_or_module(Float, /^to/)
+#=> [:to_f, :to_i, :to_int, :to_r, :to_s]
+```
+
+If the second parameter is omitted, all methods of the class or module will be
+returned.
+
+```ruby
+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 consequently ignore) misbehaving methods.
+
+It can be set on the command line e.g.:
+
+```
+$ METHOD_FINDER_DEBUG=1 irb
+```
+
+Or you can toggle it inside IRB/Pry:
+
+```ruby
+>> MethodFinder.toggle_debug!
+```
+
+## DEVELOPMENT
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## CONTRIBUTING
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/citizen428/methodfinder.
+
+## SEE ALSO
+
+### Gems
+
+- [irbtools](https://github.com/janlelis/irbtools) - improvements for Ruby's IRB console (includes methodfinder)
+
+### Misc
+
+- [Other Implementations](https://github.com/citizen428/methodfinder/wiki/Other-Implementations) - a list of related projects in Ruby and other languages
+
+## VERSION
+
+2.2.1
+
+## AUTHOR
+
+- [Michael Kohl](https://github.com/citizen428)
+
+## LICENSE
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/lib/methodfinder.rb

@@ -1,91 +1,173 @@
+# frozen_string_literal: true
+
+require 'methodfinder/version'
 require 'stringio'
 
 class Object
+  # An alternative interface to the functionality of
+  # <tt>MethodFinder.find</tt>. Also allows to test for state other
+  # than the return value of the method.
+  #
+  #    %w[a b c].find_method { |a| a.unknown(1) ; a == %w[a c] }
+  #    #=> ["Array#delete_at", "Array#slice!"]
+  #    10.find_method { |n| n.unknown(3) == 1 }
+  #    #=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", ...]
+  #
+  # Inside <tt>find_method</tt>'s block, the receiver is available as
+  # block argument and the special method <tt>unknown</tt> is used as
+  # a placeholder for the desired method.
+  #
+  # <tt>find_method</tt> can be called without passing a block. This
+  # is the same as calling <tt>MethodFinder.find</tt>.
+  #
+  #    10.find_method(1, 3)
+  #    #=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", ...]
   def find_method(*args, &block)
-    if block_given?
-      mets = MethodFinder.methods_to_try(self).select do |met|
-        self.class.class_eval %{ alias :unknown #{met} }
-        obj = self.dup rescue self
-        yield obj rescue nil
-      end
-      mets.map { |m| [self.method(m).owner, m].join("#") }
-    else
-      MethodFinder.find(self, *args)
-    end
+    return MethodFinder.find(self, *args) unless block_given?
+    MethodFinder.find_unknown(self, &block)
   end
 end
 
-class MethodFinder
+module MethodFinder
+  # Default arguments for methods
+  # :nodoc:
   ARGS = {
-    :cycle => [1] # prevent cycling forever
-  }
+    cycle: [1] # prevent cycling forever
+  }.freeze
 
-  # Blacklisting methods, e.g. { :Object => [:ri, :vim] }
-  INSTANCE_METHOD_BLACKLIST = Hash.new { |h, k| h[k] = [] }
-  CLASS_METHOD_BLACKLIST = Hash.new { |h, k| h[k] = [] }
+  # Ignoring methods, e.g. { :Object => [:ri, :vim] }
+  INSTANCE_METHOD_IGNORELIST = Hash.new { |h, k| h[k] = [] }
+  # Ignoring class methods
+  CLASS_METHOD_IGNORELIST = Hash.new { |h, k| h[k] = [] }
 
-  INSTANCE_METHOD_BLACKLIST[:Object] << :find_method # prevent stack overflow
-  INSTANCE_METHOD_BLACKLIST[:Object] << :gem # funny testing stuff w/ Bundler
+  INSTANCE_METHOD_IGNORELIST[:Object] << :find_method # prevent stack overflow
+  INSTANCE_METHOD_IGNORELIST[:Object] << :gem # funny testing stuff w/ Bundler
 
-  if defined? Pry
-    INSTANCE_METHOD_BLACKLIST[:Object] << :pry
-    CLASS_METHOD_BLACKLIST[:Object] << :pry
+  if defined?(Pry)
+    INSTANCE_METHOD_IGNORELIST[:Object] << :pry
+    CLASS_METHOD_IGNORELIST[:Object] << :pry
   end
 
-  class << self
-    def find(obj, res, *args, &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
-          a = args.empty? && ARGS.has_key?(met) ? ARGS[met] : args
-          m.call(*a, &block) == res rescue nil
-        end
-      end
-      mets.map { |m| [obj.method(m).owner, m].join("#") }
-    ensure
-      restore_streams
-    end
+  # true if METHOD_FINDER_DEBUG is truthy, false otherwise e.g.:
+  #
+  #   $ METHOD_FINDER_DEBUG=1     irb # true
+  #   $ METHOD_FINDER_DEBUG=0     irb # false
+  #   $ METHOD_FINDER_DEBUG=false irb # false
+  #   $ METHOD_FINDER_DEBUG=      irb # false
+  @debug = !ENV.fetch('METHOD_FINDER_DEBUG', '').match(/\A(0|false)?\z/i)
 
-    # Added by Jan Lelis
-    def methods_to_try(obj)
-      ret = obj.methods.map(&:intern)
-      blacklist = obj.is_a?(Module) ? CLASS_METHOD_BLACKLIST : INSTANCE_METHOD_BLACKLIST
-      klass = obj.is_a?(Module) ? obj : obj.class
+  # Checks whether or not debugging is currently enabled
+  # :doc:
+  def self.debug?
+    @debug
+  end
 
-      klass.ancestors.each { |ancestor| ret -= blacklist[ancestor.to_s.intern] }
+  # Toggles the debug mode
+  def self.toggle_debug!
+    @debug = !@debug
+  end
 
-      # 1.8.7 lacks Symbol#<=>
-      ret.sort_by(&:to_s)
+  # 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
+  # provided arguments.
+  #
+  #    MethodFinder.find(10, 1, 3)
+  #    #=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", ...]
+  #    MethodFinder.find("abc","ABC")
+  #    #=> ["String#swapcase", "String#swapcase!", "String#upcase", ...]
+  #    MethodFinder.find(10, 100, 2)
+  #    #=> ["Fixnum#**"]
+  #    MethodFinder.find(['a','b','c'], ['A','B','C']) { |x| x.upcase }
+  #    #=> ["Array#collect", "Array#collect!", "Enumerable#collect_concat", ...]
+  def self.find(obj, res, *args, &block)
+    find_methods(obj) do |met|
+      o = obj.dup rescue obj
+      m = o.method(met)
+      next unless m.arity <= args.size
+      STDERR.puts(met) if debug?
+      a = args.empty? && ARGS.key?(met) ? ARGS[met] : args
+      m.call(*a, &block) == res rescue nil
     end
+  end
 
-    def find_classes_and_modules
+  # Returns all currently defined modules and classes.
+  def self.find_classes_and_modules
+    with_redirected_streams do
       constants = Object.constants.sort.map { |c| Object.const_get(c) }
-      constants.select { |c| c.class == Class || c.class == Module}
+      constants.select { |c| c.class == Class || c.class == Module }
     end
+  end
 
-    def 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)
-      all_methods = class_methods + instance_methods
-      all_methods.grep(/#{pattern}/).sort
-    end
+  # Searches for a given name within a class. The first parameter
+  # can either be a class object, a symbol or a string whereas the
+  # optional second parameter can be a string or a regular
+  # expression:
+  #
+  #    MethodFinder.find_in_class_or_module('Array', 'shuff')
+  #    #=> [:shuffle, :shuffle!]
+  #    MethodFinder.find_in_class_or_module(Float, /^to/)
+  #    #=> [:to_f, :to_i, :to_int, :to_r, :to_s]
+  #
+  # If the second parameter is omitted, all methods of the class or
+  # module will be returned.
+  #
+  #    MethodFinder.find_in_class_or_module(Math)
+  #    #=> [:acos, :acosh, :asin ... :tanh]
+  # :doc:
+  def self.find_in_class_or_module(klass, pattern = /./)
+    klasses = Object.const_get(klass.to_s)
+    class_methods = klasses.methods(false) rescue []
+    instance_methods = klasses.instance_methods(false)
+    all_methods = class_methods + instance_methods
+    all_methods.grep(/#{pattern}/).sort
+  end
+
+  # Returns a list of candidate methods for a given object. Added by Jan Lelis.
+  def self.methods_to_try(obj)
+    ret = obj.methods
+    ignorelist = select_ignorelist(obj)
+    klass = obj.is_a?(Module) ? obj : obj.class
 
-    def redirect_streams
-      @orig_stdout = $stdout
-      @orig_stderr = $stderr
-      $stdout = StringIO.new
-      $stderr = StringIO.new
+    klass.ancestors.each { |ancestor| ret -= ignorelist[ancestor.to_s.intern] }
+    ret.sort
+  end
+  private_class_method :methods_to_try
+
+  # Used by Object.find_method
+  # :nodoc:
+  def self.find_unknown(obj, &block)
+    find_methods(obj) do |met|
+      STDERR.puts(met) if debug?
+      obj.class.class_eval("alias :unknown #{met}", __FILE__, __LINE__)
+      subject = obj.dup rescue obj # dup doesn't work for immutable types
+      block.call(subject) rescue nil
     end
+  end
 
-    def restore_streams
-      $stdout = @orig_stdout
-      $stderr = @orig_stderr
+  def self.find_methods(obj)
+    with_redirected_streams do
+      found = methods_to_try(obj).select { |met| yield(met) }
+      found.map { |m| "#{obj.method(m).owner}##{m}" }
     end
   end
-  private_class_method :redirect_streams, :restore_streams
-end
+  private_class_method :find_methods
+
+  def self.with_redirected_streams
+    orig_stdout = $stdout
+    orig_stderr = $stderr
+    $stdout = StringIO.new
+    $stderr = StringIO.new
 
+    yield
+  ensure
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end
+  private_class_method :with_redirected_streams
+
+  def self.select_ignorelist(object)
+    object.is_a?(Module) ? CLASS_METHOD_IGNORELIST : INSTANCE_METHOD_IGNORELIST
+  end
+  private_class_method :select_ignorelist
+end

data/lib/methodfinder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MethodFinder
+  VERSION = '2.2.2'
+end

metadata

@@ -1,47 +1,121 @@
 --- !ruby/object:Gem::Specification
 name: methodfinder
 version: !ruby/object:Gem::Version
-  version: 1.2.5
-  prerelease: 
+  version: 2.2.2
 platform: ruby
 authors:
 - Michael Kohl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-18 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: citizen428@gmail.com
+date: 2021-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A Smalltalk-like Method Finder for Ruby with some extra features
+email:
+- citizen428@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - lib/methodfinder.rb
-- ./LICENSE
-- ./README.markdown
-homepage: https://github.com/citizen428/MethodFinder
-licenses: []
+- lib/methodfinder/version.rb
+homepage: http://citizen428.github.com/methodfinder/
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/citizen428/methodfinder/issues
+  source_code_uri: https://github.com/citizen428/methodfinder
+  changelog_uri: https://github.com/citizen428/methodfinder/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 3.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Smalltalk-like Method Finder for Ruby
 test_files: []

data/README.markdown

@@ -1,138 +0,0 @@
-[![Build Status](https://secure.travis-ci.org/citizen428/methodfinder.png)](http://travis-ci.org/citizen428/methodfinder)
-
-(tested with MRI 1.8.7 and newer)
-
-Description
----
-
-This project was originally inspired by Smalltalk's Method Finder, but
-additonal features were added over time.
-
-Usage
----
-
-### MethodFinder.find
-
-Provided with a receiver, the desired result and possibly some
-arguments, `MethodFinder.find` will list all methods that produce the
-given result when called on the receiver with the provided arguments.
-
-    >> MethodFinder.find(10,1,3)
-    => ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
-    >> MethodFinder.find("abc","ABC")
-    => ["String#swapcase", "String#swapcase!", "String#upcase", "String#upcase!"]
-    >> MethodFinder.find(10,100,2)
-    => ["Fixnum#**"]
-    >> 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!"]
-
-### Object#find_method
-
-This gem also adds `Object#find_method`, which besides offering an
-alternate interface to pretty much the same functionality as
-`MethodFinder.find`, also allows you to test for state other than
-the return value of the method.
-
-    >> %w[a b c].find_method { |a| a.unknown(1) ; a == %w[a c] }
-    => ["Array#delete_at", "Array#slice!"]
-    >> 10.find_method { |n| n.unknown(3) == 1 }
-    => ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
-
-Inside `find_method`'s block, the receiver is available as block
-argument and the special method `unknown` is used as a placeholder for
-the desired method.
-
-You can also call `find_method` without passing a block. This is the
-same as calling `MethodFinder.find`.
-
-    >> 10.find_method(1,3)
-    => ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
-
-#### Blacklists
-
-You can exclude methods from being tried by editing the hashes
-`MethodFinder::INSTANCE_METHOD_BLACKLIST` and
-`MethodFinder::CLASS_METHOD_BLACKLIST`. Both use the class/module
-as key and an array of method names as values (note that class, module
-and method names have to be symbols).
-
-For example, to blacklist the instance method `shutdown` of `Object`,
-you would do
-
-    MethodFinder::INSTANCE_METHOD_BLACKLIST[:Object] << :shutdown
-
-This might come in handy when using `MethodFinder` together with other
-gems as such as `interactive_editor`.
-
-### MethodFinder.find\_classes\_and_modules
-
-A simple method to return all currently defined modules and classes.
-
-    >> MethodFinder.find_classes_and_modules
-    => [ArgumentError, Array, BasicObject, Bignum ... ZeroDivisionError]
-
-### MethodFinder.find\_in\_class\_or_module
-
-Searches for a given name within a class. The first parameter can
-either be a class object, a symbol or a string whereas the optional
-second parameter can be a string or a regular expression:
-
-    >> MethodFinder.find_in_class_or_module('Array', 'shuff')
-    => [:shuffle, :shuffle!]
-    >> MethodFinder.find_in_class_or_module(Float, /^to/)
-    => [:to_f, :to_i, :to_int, :to_r, :to_s]
-
-If the second parameter is omitted, all methods of the class or module
-will be returned.
-
-    >> MethodFinder.find_in_class_or_module(Math)
-    => [:acos, :acosh, :asin ... :tanh]
-
-Warning
----
-
-Common sense not included!
-
-While I never had any problems with this, it's still better to be
-safe than sorry, so use this with caution and maybe not on production
-data.
-
-I initially wrote this for the students of the core Ruby course on
-[RubyLearning](http://rubylearning.org), so Rails is not of interest
-to me (not saying it doesn't work there, just that I test in plain
-IRB, not with `script/console`).
-
-Thanks
----
-
-* Matthew Lucas for [first packaging this as a gem](https://github.com/citizen428/methodfinder/pull/1).
-* Ryan Bates for
-[suggesting](https://github.com/citizen428/methodfinder/issues/closed#issue/3)
-what eventually became `Object#find_method`.
-* 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 `Object#find_method`.
-* Stefan Kanev for [adding Pry support](https://github.com/citizen428/methodfinder/pull/7).
-License
----
-
-Copyright (c) 2011 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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.