如何在 Rails 中找到方法来自的模块/类？

Question

使用 Rails，我最初是在寻找一种在模型中使用资源路径辅助方法（例如 users_path）的方法，而 this 给了我答案：我可以使用 Rails.application.routes.url_helpers.users_path。

很好，但总的来说，特别是在 Rails 中，如何找到一个方法来自哪个模块/类？阅读源代码或一些官方文档是找到它的唯一方法吗？是不是可以例如直接在调试控制台中签入从users_path获取Rails.application.routes.url_helpers？

Answer 1

我认为您正在寻找的内容类似于此问题How to find where a method is defined at runtime?。

简而言之，在 Ruby 2+ 中，以下（其中之一）将返回文件名和行号的 2 元素数组：

method(:users_path).source_location
my_object.method(:my_method).source_location
# => ["/My/Ruby/Code/some-module.rb", 123]

然后您可以计算出该方法的模块或类名称。

---

[在编辑中添加]

要获取模块名称，您可以改用method(:users_path).owner：参见Answer1 和answer2。

然而，Rails 使用了大量的元编程和动态赋值。问题中的users_path 之类的url-helper 就是其中之一。

引用@spickermann 对该问题的评论

users_path 是由元编程定义的，因此您在代码中根本找不到具有该方法名称的方法定义。

引用@Stefan 对该问题的评论

可能有多个这样的对象。你必须找出与当前自我“最接近”的那个。

具体来说，url_helpers 在 Rails 6.0 的 actionpack-6.*/lib/action_dispatch/routing/route_set.rb 中定义，您会看到 generate_url_helpers 方法负责（动态）生成它。这就是为什么method(:users_path).owner 返回类似#<Module:0x0000000117346e18> 的东西的原因，这并没有真正的帮助。甚至method(:users_path).source_location 也只是指向了

mod.define_method(name) do |*args|

（或类似的东西，取决于 Rails 版本），表示对象是动态生成的。

因此，我怀疑是否有任何简单的方法do-all 从给定的辅助函数（如users_path）派生一个 Rails 对象（类/模块），例如Rails.application.routes.url_helpers .但是使用owner 和source_location 等方法的组合进行分析将非常有助于查明它，并且在某些情况下可能会为您提供您正在寻找的答案。

我注意到，就这个具体案例而言，actionpack-6*.*/lib/abstract_controller/url_for.rb 中写的错误消息会有所帮助——引用：

为了使用#url_for，您必须明确包含路由助手。 例如，include Rails.application.routes.url_helpers。