methodfinder 2.2.1 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc5f10019d05bf88ecadc9ef8f753c8fb24bae5b964e15823eb6235c50ca96f6
-  data.tar.gz: bd20ac80dfa26324d3041ad3d0dfca0b2cc15a632f7fff37a285c1fa3663698d
+  metadata.gz: 60a53dfb0ed92260ece6d823b14bf913ce8c1ccc5cedaca06a4d657959e17c7f
+  data.tar.gz: de867f859a3131529bb476f79edb0a2fd613279575f2f6218f0d02102d277137
 SHA512:
-  metadata.gz: d1c21e4002be10b889ea23d70d16dde3db53e73bf42926f71882fa740a51f0391339eb8e43d42c44c7e692fd8faddb339bb3f07ad2100ef397bd0f4399887775
-  data.tar.gz: 599bf95909d58aeb601dc45bd8d3a2ba316a041c550fe2f20aacabe544189d27e35bafe93c10daebcaf37e385cb7e8f561d61ac06f12e699535128f39a452cf1
+  metadata.gz: 45c69e28874c5fe6eb8d20a442f74b44b5d91f1605f54bbcb930b0073fbf2a16942a708d57a11e15837c6c0eb2573bf7c7744a72743281ebbcd6219a254b29d8
+  data.tar.gz: 36907469a0fc84a5b6688642dd78d70b1f2c397f3b5693df2c63aa4579fc86fcf3c74119b873a536d30dc7514dcbfb873b4b98dd23bc0f02cdce846bb5fd785b

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

@@ -1,35 +1,76 @@
 # MethodFinder
 
-[![Build Status](https://travis-ci.org/citizen428/methodfinder.svg)](https://travis-ci.org/citizen428/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)
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<!-- toc -->
 
-- [Requirements](#requirements)
-- [Usage](#usage)
+- [NAME](#name)
+- [INSTALLATION](#installation)
+- [SYNOPSIS](#synopsis)
+- [DESCRIPTION](#description)
+  - [Warning](#warning)
+- [API](#api)
   - [MethodFinder.find](#methodfinderfind)
   - [Object#find_method](#objectfind_method)
-    - [Blacklists](#blacklists)
+    - [Ignorelists](#ignorelists)
   - [MethodFinder.find_classes_and_modules](#methodfinderfind_classes_and_modules)
   - [MethodFinder.find_in_class_or_module](#methodfinderfind_in_class_or_module)
-- [Troubleshooting](#troubleshooting)
-- [Warning](#warning)
-- [Thanks](#thanks)
-- [License](#license)
+- [TROUBLESHOOTING](#troubleshooting)
+- [DEVELOPMENT](#development)
+- [CONTRIBUTING](#contributing)
+- [SEE ALSO](#see-also)
+  - [Gems](#gems)
+  - [Misc](#misc)
+- [VERSION](#version)
+- [AUTHOR](#author)
+- [LICENSE](#license)
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- tocstop -->
 
-This project was originally inspired by Smalltalk's Method Finder, but
-additional features were added over time.
+## NAME
 
-## Requirements
+MethodFinder - a Smalltalk-like Method Finder for Ruby
 
-Ruby 1.9.3+ (also works with Rubinius in 1.9 mode). Versions of `MethodFinder`
-up to 1.2.5 will also work with Ruby 1.8.7. Note: CI only runs newer versions
-of Ruby.
+## INSTALLATION
 
-## Usage
+    $ 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
 
@@ -72,19 +113,18 @@ calling `MethodFinder.find`.
 #=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]
 ```
 
-#### Blacklists
+#### Ignorelists
 
 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
+`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 blacklist the instance method `shutdown` of `Object`, you
-would do
+For example, to ignore the instance method `shutdown` of `Object`, you would do
 
 ```ruby
-MethodFinder::INSTANCE_METHOD_BLACKLIST[:Object] << :shutdown
+MethodFinder::INSTANCE_METHOD_IGNORELIST[:Object] << :shutdown
 ```
 
 This might come in handy when using `MethodFinder` together with other gems as
@@ -120,11 +160,11 @@ MethodFinder.find_in_class_or_module(Math)
 #=> [:acos, :acosh, :asin ... :tanh]
 ```
 
-## Troubleshooting
+## 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.
+to identify (and consequently ignore) misbehaving methods.
 
 It can be set on the command line e.g.:
 
@@ -138,49 +178,42 @@ Or you can toggle it inside IRB/Pry:
 >> MethodFinder.toggle_debug!
 ```
 
-## Warning
+## DEVELOPMENT
 
-Common sense not included!
+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.4
+
+## AUTHOR
+
+- [Michael Kohl](https://github.com/citizen428)
+
+## LICENSE
 
-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/Pry and not with
-the Rails console.
-
-## Thanks
-
-* [Matthew Lucas](https://github.com/lucas-matt) for [first packaging this as a gem](https://github.com/citizen428/methodfinder/pull/1).
-* [Ryan Bates](https://github.com/ryanb) for [suggesting](https://github.com/citizen428/methodfinder/issues/closed#issue/3)
-  what eventually became `Object#find_method`.
-* [Jan Lelis](https://github.com/janlelis) for [implementing blacklists](https://github.com/citizen428/methodfinder/issues/closed#issue/4).
-* [Brian Morearty](https://github.com/BMorearty) 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](https://github.com/skanev) for [adding Pry support](https://github.com/citizen428/methodfinder/pull/7).
-* [chocolateboy](https://github.com/chocolateboy) for [compatibility fixes and updates](https://github.com/citizen428/methodfinder/pull/8),
-  [the initial debug implementation](https://github.com/citizen428/methodfinder/pull/9), and [many smaller fixes](https://github.com/citizen428/methodfinder/pulls?utf8=✓&q=is%3Apr+author%3Achocolateboy).
-
-## License
-
-Copyright (c) 2011-2018 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.
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/lib/methodfinder/version.rb

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

data/lib/methodfinder.rb

@@ -24,6 +24,7 @@ class Object
   #    #=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", ...]
   def find_method(*args, &block)
     return MethodFinder.find(self, *args) unless block_given?
+
     MethodFinder.find_unknown(self, &block)
   end
 end
@@ -32,28 +33,41 @@ module MethodFinder
   # Default arguments for methods
   # :nodoc:
   ARGS = {
-    cycle: [1] # prevent cycling forever
+    cycle: [1], # prevent cycling forever
+    tally: [],  # Since Ruby 3.1 Enumberable tally takes an optional hash
   }.freeze
 
-  # Blacklisting methods, e.g. { :Object => [:ri, :vim] }
-  INSTANCE_METHOD_BLACKLIST = Hash.new { |h, k| h[k] = [] }
-  # Blacklisting class methods
-  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] = [] }
+  # IGNORING classes
+  CLASS_IGNORELIST = []
+
+  if RUBY_VERSION.start_with?('3')
+    CLASS_IGNORELIST << :SortedSet # this moved to a gem
+  end
 
-  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
+    INSTANCE_METHOD_IGNORELIST[:Object] << :pry
+    CLASS_METHOD_IGNORELIST[:Object] << :pry
   end
 
-  @debug = ENV['METHOD_FINDER_DEBUG']
+  # 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)
 
-  # Checkes whether or not debugging is currently enabled
+  # Checks whether or not debugging is currently enabled
   # :doc:
   def self.debug?
-    !!(@debug)
+    @debug
   end
 
   # Toggles the debug mode
@@ -76,20 +90,32 @@ module MethodFinder
   #    #=> ["Array#collect", "Array#collect!", "Enumerable#collect_concat", ...]
   def self.find(obj, res, *args, &block)
     find_methods(obj) do |met|
-      o = obj.dup rescue obj
+      o = begin
+        obj.dup
+      rescue StandardError
+        obj
+      end
       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
+
+      warn(met) if debug?
+      a = ARGS.key?(met) ? ARGS[met] : args
+      begin
+        m.call(*a, &block) == res
+      rescue StandardError
+        nil
+      end
     end
   end
 
   # 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 }
+      candidates = Object.constants - CLASS_IGNORELIST
+      constants = candidates.sort.map { |c| Object.const_get(c) }
+      constants.select do |c|
+        c.instance_of?(Class) || c.instance_of?(Module)
+      end
     end
   end
 
@@ -111,7 +137,11 @@ module MethodFinder
   # :doc:
   def self.find_in_class_or_module(klass, pattern = /./)
     klasses = Object.const_get(klass.to_s)
-    class_methods = klasses.methods(false) rescue []
+    class_methods = begin
+      klasses.methods(false)
+    rescue StandardError
+      []
+    end
     instance_methods = klasses.instance_methods(false)
     all_methods = class_methods + instance_methods
     all_methods.grep(/#{pattern}/).sort
@@ -120,10 +150,10 @@ module MethodFinder
   # Returns a list of candidate methods for a given object. Added by Jan Lelis.
   def self.methods_to_try(obj)
     ret = obj.methods
-    blacklist = select_blacklist(obj)
+    ignorelist = select_ignorelist(obj)
     klass = obj.is_a?(Module) ? obj : obj.class
 
-    klass.ancestors.each { |ancestor| ret -= blacklist[ancestor.to_s.intern] }
+    klass.ancestors.each { |ancestor| ret -= ignorelist[ancestor.to_s.intern] }
     ret.sort
   end
   private_class_method :methods_to_try
@@ -132,16 +162,24 @@ module MethodFinder
   # :nodoc:
   def self.find_unknown(obj, &block)
     find_methods(obj) do |met|
-      STDERR.puts(met) if debug?
+      warn(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
+      subject = begin
+        obj.dup
+      rescue StandardError # dup doesn't work for immutable types
+        obj
+      end
+      begin
+        block.call(subject)
+      rescue StandardError
+        nil
+      end
     end
   end
 
-  def self.find_methods(obj)
+  def self.find_methods(obj, &block)
     with_redirected_streams do
-      found = methods_to_try(obj).select { |met| yield(met) }
+      found = methods_to_try(obj).select(&block)
       found.map { |m| "#{obj.method(m).owner}##{m}" }
     end
   end
@@ -150,8 +188,11 @@ module MethodFinder
   def self.with_redirected_streams
     orig_stdout = $stdout
     orig_stderr = $stderr
-    $stdout = StringIO.new
-    $stderr = StringIO.new
+
+    unless debug?
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+    end
 
     yield
   ensure
@@ -160,8 +201,8 @@ module MethodFinder
   end
   private_class_method :with_redirected_streams
 
-  def self.select_blacklist(object)
-    object.is_a?(Module) ? CLASS_METHOD_BLACKLIST : INSTANCE_METHOD_BLACKLIST
+  def self.select_ignorelist(object)
+    object.is_a?(Module) ? CLASS_METHOD_IGNORELIST : INSTANCE_METHOD_IGNORELIST
   end
-  private_class_method :select_blacklist
+  private_class_method :select_ignorelist
 end

metadata

@@ -1,30 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: methodfinder
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.4
 platform: ruby
 authors:
 - Michael Kohl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
-dependencies: []
+date: 2022-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
 description: A Smalltalk-like Method Finder for Ruby with some extra features
-email: citizen428@gmail.com
+email:
+- citizen428@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- "./LICENSE"
-- "./README.md"
+- LICENSE.txt
+- README.md
 - lib/methodfinder.rb
 - lib/methodfinder/version.rb
 homepage: http://citizen428.github.com/methodfinder/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/citizen428/methodfinder/issues
+  source_code_uri: https://github.com/citizen428/methodfinder
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -32,16 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A Smalltalk-like Method Finder for Ruby
 test_files: []