MethodFinder 使用与技术文档

1. 安装指南

首先，确保您的系统中已安装Ruby。然后，通过Ruby的gem命令安装MethodFinder：

$ gem install methodfinder

2. 项目的使用说明

MethodFinder 是一个类似于Smalltalk的方法查找器，用于Ruby。它可以在 ~/.irbrc 或 ~/.pryrc 文件中使用。

警告

使用此项目时请谨慎，它可能不适用于生产环境，且未在Rails控制台中测试，仅适用于普通的IRB或Pry。

3. 项目API使用文档

以下是一些API的使用说明：

MethodFinder.find

此方法接受一个接收器、期望的结果和可能的参数，然后列出所有在调用接收器时产生给定结果的方法。

MethodFinder.find(10, 1, 3)
#=> ["Fixnum#%", "Fixnum#<=>", "Fixnum#>>", "Fixnum#[]", "Integer#gcd", "Fixnum#modulo", "Numeric#remainder"]

Object#find_method

这个方法提供了与 MethodFinder.find 类似的功能，但它还允许测试除返回值外的其他状态。

%w[a b c].find_method { |a| a.unknown(1) ; a == %w[a c] }
#=> ["Array#delete_at", "Array#slice!"]

Ignorelists

可以通过编辑 MethodFinder::INSTANCE_METHOD_IGNORELIST 和 MethodFinder::CLASS_METHOD_IGNORELIST 两个哈希表来排除某些方法。

MethodFinder::INSTANCE_METHOD_IGNORELIST[:Object] << :shutdown

MethodFinder.find_classes_and_modules

此方法返回所有当前定义的模块和类。

MethodFinder.find_classes_and_modules
#=> [ArgumentError, Array, BasicObject, Bignum ... ZeroDivisionError]

MethodFinder.find_in_class_or_module

在给定的类或模块中搜索指定名称的方法。

MethodFinder.find_in_class_or_module('Array', 'shuff')
#=> [:shuffle, :shuffle!]

4. 项目安装方式

除了使用gem命令安装外，也可以通过以下方式安装：

1. 克隆项目仓库：

   $ git clone https://github.com/citizen428/methodfinder.git
   

2. 进入项目目录，安装依赖：

   $ cd methodfinder
   $ bundle install
   

3. 运行测试以确保安装正确：

   $ rake test
   

4. 如果测试通过，可以使用以下命令将gem安装到本地：

   $ bundle exec rake install
   

以上是关于MethodFinder项目的使用和技术文档。在使用时，请确保遵守项目的许可证协议。