Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/citizen428/methodfinder
A Smalltalk like Method Finder for Ruby. This is a mirror of the main repository on Sourcehut.
https://github.com/citizen428/methodfinder
introspection ruby
Last synced: 5 days ago
JSON representation
A Smalltalk like Method Finder for Ruby. This is a mirror of the main repository on Sourcehut.
- Host: GitHub
- URL: https://github.com/citizen428/methodfinder
- Owner: citizen428
- License: mit
- Created: 2011-02-10T09:24:18.000Z (almost 14 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T08:51:17.000Z (2 months ago)
- Last Synced: 2024-12-16T03:35:29.279Z (12 days ago)
- Topics: introspection, ruby
- Language: Ruby
- Homepage: https://sr.ht/~citizen428/methodfinder/
- Size: 113 KB
- Stars: 270
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MethodFinder
[](https://builds.sr.ht/~citizen428/methodfinder?)
[](https://rubygems.org/gems/methodfinder)
- [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)
## 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
Development happens primarily on [Sourcehut](https://sr.ht/~citizen428/methodfinder/) where you can
[file bugs](https://sr.ht/~citizen428/methodfinder/trackers), [discuss on the mailing list](https://sr.ht/~citizen428/methodfinder/lists) or [send patches](https://git.sr.ht/~citizen428/methodfinder/send-email).
If you really have to you can also contribute via https://github.com/citizen428/methodfinder, but I really prefer Sourcehut.
## SEE ALSO
### Gems
- [irbtools](https://github.com/janlelis/irbtools) - improvements for Ruby's IRB console (includes methodfinder)
### Misc
- [Other Implementations](https://man.sr.ht/~citizen428/MethodFinder/) - a list of related projects in Ruby and other languages
## VERSION
2.2.4
## AUTHOR
- [Michael Kohl](https://citizen428.net/)
## LICENSE
The gem is available as open source under the terms of the [MIT
License](https://opensource.org/licenses/MIT).