如何记录每个在Ruby程序中调用的方法？

Question

我已经继承了大量的Ruby代码，坦率地说，对于像我这样的凡人来说，几乎无法理解。它实际上是Rspec单元测试代码，但是它的结构“很不寻常”可以很好地表达出来。

想我能够做的就是运行代码，并已经某处记录以下信息：

• 每一个被调用，包括定义该方法的类的名称的方法，和已定义调用方法的文件名（也就是说，我们已经在多个不同文件中定义了相同的类/方法，并且很难知道哪个被调用）
• （可选）传递给每个方法的参数被调用

With那我可以开始尝试重构它。没有它，由于代码库的大小（20k +单元测试用例），将它变成一个非常困难的任务。

我不能进入并对正在运行的代码执行批量编辑，因为当您甚至使用粗糙的语言（即频繁）时它会中断。相反，我需要能够在现有状态下对代码进行测试，或者对现有的代码进行最小限度的更改。

有没有一种方法可以记录此级别的细节而不对代码库进行大规模更改？我看了一下Ruby探查器，看看它是否有帮助，可能会;我很好奇，如果有更好的方法（尤其是记录包含被调用方法的文件名）。

在此先感谢

Answer 1

这绝对是可能的 - 事实上，甚至有一种方法！

set_trace_func proc { |event, file, line, id, binding, classname| 
    printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname 
} 

你想要的秘密武器来自Kernel#set_trace_func，正如上面所指出的：就在你的代码要开始记录的东西点之前添加这个地方

• set_trace_func（ PROC）=> PROC
• set_trace_func（无）=>无

将proc设置为跟踪处理程序，如果参数为nil，则禁用跟踪。 proc最多需要六个参数：事件名称，文件名，行号，对象ID，绑定和类名称。每当发生事件时都会调用proc。事件是：c-call（调用C语言例程），c-return（从C语言例程返回），call（调用Ruby方法），class（启动类或模块定义），end（完成类或模块定义），line（在新行上执行代码），raise（引发异常）和return（从Ruby方法返回）。跟踪在proc的上下文中被禁用。

这里有一个简便的事例：

class Test 
    def test 
    a = 1 
    b = 2 
    end 
end 

set_trace_func proc { |event, file, line, id, binding, classname| 
    printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname 
} 

t = Test.new 
t.test 

（注意：除非你想文本的一个巨大的滚动屏幕不要尝试这种在irb）输出结果是：

line test.rb:11    false 
    c-call test.rb:11  new Class 
    c-call test.rb:11 initialize Object 
c-return test.rb:11 initialize Object 
c-return test.rb:11  new Class 
    line test.rb:12    false 
    call test.rb:2  test  Test 
    line test.rb:3  test  Test 
    line test.rb:4  test  Test 
    return test.rb:4  test  Test 

你可以使用上面的格式化字符串来获得你想要记录的结果（例如，听起来你只对call事件感兴趣）。希望有所帮助，并祝你能够在所有单元测试中排序！

Answer 2

我想包括秒，过去一分钟的情况下，在happend以及多久每个功能

start = DateTime.now.strftime('%Q').to_i/1000.0 
set_trace_func proc { |event, file, line, id, binding, classname| 
    now_ms = DateTime.now.strftime('%Q').to_i/1000.0 
    duration = '%.3f' % (now_ms - start) 
    start = DateTime.now.strftime('%Q').to_i/1000.0 
    printf "%s %s %8s %s:%-2d %10s %8s\n", DateTime.now.strftime("%S.%L"), duration, event, file, line, id, classname 
} 

AdminUser.create(password: "password", password_confirmation: "password", email: email) 

set_trace_func nil 

我试图调试为什么花了这么长时间来创建用户花在并登录到ActiveAdmin。

05.761 0.000 c-return /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:51  to_s String 
05.761 0.000 c-call /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:51 __bc_crypt BCrypt::Engine 
09.736 63.975 c-return /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:51 __bc_crypt BCrypt::Engine 
09.736 0.000 return /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:59 hash_secret BCrypt::Engine 
09.736 0.000 c-call /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/password.rb:46  new Class 

从那我知道Ruby花了一分多钟在__bc_crypt。

Answer 3

近日，set_trace_func已被否决：

注：此方法已过时，请使用跟踪点来代替。

我们可以利用跟踪点，它备份set_trace_func，而不是：

trace = TracePoint.new(:call) do |tp| 
    puts "#{tp.defined_class}##{tp.method_id} got called (#{tp.path}:#{tp.lineno})" 
end 

trace.enable 
# do stuff here 
trace.disable 

其实，这甚至比set_trace_func更强大，因为您可以启用和在您方便的禁用。你可以有选择地挂接到以下事件：:line, :class, :end, :call, :return, :c_call, :c_return, :raise, :b_call, :b_return, :thread_begin, :thread_end

下面一个完整的例子：

class MyClass 
    def initialize 
    end 
    def y 
    z 
    end 
    def z 
    1 + 1 
    end 
end 

trace = TracePoint.new(:call) do |tp| 
    puts "#{tp.defined_class}##{tp.method_id} got called (#{tp.path}:#{tp.lineno})" 
end 

trace.enable # note 
MyClass.new.y 
trace.disable 
    # MyClass#initialize got called (./trace.rb:4) 
    # MyClass#y got called (./trace.rb:7) 
    # MyClass#z got called (./trace.rb:10)