从类对象获取类位置

Question

我有一堆代码要看，现在是调试时间。因为我从来都不是 Ruby 调试器的粉丝，所以我正在寻找一种方法来遍历代码并阅读它。

我要做的是获取定义加载类的文件的位置：

Foo::Bar.create(:param) # how can I know file location in runtime?

对于更小、组织更好的项目，我只会搜索 class Bar 但在这里这是不可能的，因为有许多名为 Bar 的类，而且更糟糕的是，其中一些在同一个命名空间下.我知道，等待发生的麻烦。

注意：我使用的是 Ruby 1.8.7。

Answer 1

坏消息！我猜在运行时没有办法知道在 Ruby 1.8.7 中创建或定义了哪个文件。

如果项目有一些类似rails的结构，你可以猜到。

但在 Ruby 中，多个文件可以为同一个类定义方法 甚至可以在运行时定义类（元编程）。

这意味着定义类的地方可能不止一个。 而且您要查找的内容可以分布在多个文件中。

我猜你必须搜索 Bar 的所有定义，看看它们是否在模块 Foo 中，或者首先找到所有 Foo 定义并检查里面的内容。 如果代码是一团糟，我看不出一个简单的方法，你将不得不按照 spaguetti 形式指向 poi。 一个好的编辑器和多文件搜索可能会有所帮助，但您需要通读代码。

编辑：毕竟是个好消息。在 Ruby 1.9 中有 source_location 并且看起来它有 1.8.7 的反向移植。但是，如果定义是在运行时由 eval 进行的，那么我不确定它是否会起作用。我认为最简单的解决方案是像 Rubymine 这样的优秀编辑器，它通常可以告诉你代码是在哪里定义的。

Answer 2

对于Methods 和Procs Ruby 1.9 有一个名为source_location 的方法：

返回包含此方法的 Ruby 源文件名和行号，如果此方法未在 Ruby 中定义（即本机），则返回 nil

所以你可以请求方法：

m = Foo::Bar.method(:create)

然后求那个方法的source_location：

m.source_location

这将返回一个包含文件名和行号的数组。 例如 ActiveRecord::Base#validates 这返回：

ActiveRecord::Base.method(:validates).source_location
# => ["/Users/laas/.rvm/gems/ruby-1.9.2-p0@arveaurik/gems/activemodel-3.2.2/lib/active_model/validations/validates.rb", 81]

对于类和模块，Ruby 不提供内置支持，但是有一个很好的 Gist，它建立在 source_location 的基础上，如果没有指定方法，则返回给定方法的文件或类的第一个文件：

• ruby where_is module

编辑：对于 Ruby 1.8.7，有一个可以向后移植 source_location 的 gem：

• ruby18_source_location

Answer 3

坦率地说，鉴于您描述的代码组织，我认为 ruby​​-debug 是发现调用站点目的地的简单途径：只需设置断点并介入。如果您真的对调试器过敏，您可以检测使用Kernel#set_trace_func 的呼叫站点。

$max_trace = 10
set_trace_func proc { |event, file, line, id, binding, classname|
  printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
  $max_trace -= 1 
  set_trace_func(nil) unless $max_trace > 0
}

Answer 4

这是一个简单的示例，展示了我如何在代码中跟踪位置。如果我需要知道模块中的位置：

class Foo
  attr_reader :initialize_loc
  def initialize
    @initialize_loc = [__FILE__, __LINE__]
    # do more stuff...
  end
end

如果我需要知道发生了什么事情：

require_relative 't1'

foo = Foo.new
# do lots of stuff until you want to know where something was initialized.
puts 'foo initialized at %s:%s' % foo.initialize_loc

当我运行代码时，我得到：

FooBar:Desktop foobar ruby t2.rb 
foo initilized at /Users/foobar/Desktop/t1.rb:4

如果我不想弄乱模块的源代码，并希望调试器在我需要时跳入，我会让调试器这样做：

require_relative 't1'
require 'ruby-debug'

debugger
foo = Foo.new
# do lots of stuff until you want to know where something was initilized.
puts 'foo initilized at %s:%s' % foo.initialize_loc

执行将停止，我将在紧跟debugger 的那一行进入调试器：

[0, 9] in t2.rb
  1  require_relative 't1'
  2  require 'ruby-debug'
  3  
  4  debugger
=> 5  foo = Foo.new
  6  # do lots of stuff until you want to know where something was initilized.
  7  puts 'foo initilized at %s:%s' % foo.initialize_loc
  8  
t2.rb:5
foo = Foo.new
(rdb:1) 

一个简单的s 将“引导”我进入下一行代码，这将位于Foo 的initialize 块中：

(rdb:1) s
[-1, 8] in /Users/foobar/Desktop/t1.rb
  1  class Foo
  2    attr_reader :initialize_loc
  3    def initialize
=> 4      @initialize_loc = [__FILE__, __LINE__]
  5      # do more stuff...
  6    end
  7  end
  8  
/Users/foobar/Desktop/t1.rb:4
@initialize_loc = [__FILE__, __LINE__]
(rdb:1) 

除此之外，使用像 grep -rn target_to_find path_to_search 这样的工具递归搜索目录并列出与目标匹配的文件名和行号，将大大有助于找到您要查找的内容。

或者，在 Vim 中使用 :vim /target_to_find/ path_to_search 将返回您正在查找的文件。

Answer 5

仅供参考，在 Rails 的控制台或 Rails 应用程序的调试会话中，您可以找到定义该特定类的文件的磁盘位置。喜欢

> show-source Job

这会给你

From: /home/john/projects/iisifix/app/models/job.rb @ line 13:
Class name: Job
Number of monkeypatches: 6. Use the `-a` option to display all available monkeypatches
Number of lines: 66

class Job < ApplicationRecord
  belongs_to :quote_request
  belongs_to :garage

Answer 6

我在更改对象的超类时遇到此错误，解决方法是停止并启动 spring。

Answer 7

Klass.method(Klass.methods.first).source_location

使用source_location 作为方法，我可以搜索类中定义的第一个方法。我想这不是万无一失的，因为元编程和其他黑客。