如何获取Ruby中使用的方法的列表?

时间:2019-05-03 13:00:09

标签: ruby module metaprogramming

嘿,我希望我的方法logify将每个方法及其参数以及类A的返回值放入。例如,我编写了一个简单的类A,其中包含两个方法add和sub,输出应如下所示:

Output:
Method add(1, 2) called 
return value 3
Method sub(1, 2) called
return value -1

我知道我可以使用self.instance_methods(false)获得每种方法,但是有人可以进一步帮助我吗?

require_relative "log"

class A
    extend Log

    def add(a, b)
      a + b
    end

    def sub(a, b)
      a - b
    end
    logify
  end

    a = A.new
    a.add(2,1)
    a.sub(2,1)
module Log 
   def logify 
   puts self.instance_methods(false)
   end
end

2 个答案:

答案 0 :(得分:5)

您可以使用Module#prependModule#prepended来帮助您,如下所示:

module Log 
  def self.prepended(base)
    base.instance_methods(false).each do |m|
      define_method(m) do |*args, &block| 
        puts "Method #{m}(#{args.join(',')}) called"
        val = super(*args, &block)
        puts "return value #{val}"
        val
      end
    end
  end
end

class A
  def add(a, b)
    a + b
  end

  def sub(a, b)
    a - b
  end
end

A.prepend(Log)

它的作用是在前置模块中定义一个与原始名称相同的方法,然后在中间(super)的基础上构建输出并修改为原始方法,以获取返回值。

示例

a = A.new
a.add(2,1)
# Method add(2,1) called
# return value 3
#=> 3
a.sub(2,1)
# Method sub(2,1) called
# return value 1
#=> 1

注意:仅显示提供的参数,不会在方法签名中输出默认参数

答案 1 :(得分:2)

ruby​​核心库包括类TracePoint,该类可用于跟踪几乎所有内容-从定义,调用的方法或引发的异常等...

这里是一个示例用法,它将执行您想要的跟踪:

class A
  def add(a, b)
    a + b
  end

  def sub(a, b)
    a - b
  end
end

TracePoint.trace(:call, :return) do |tp|
  next unless tp.defined_class == A
  case tp.event
  when :call
    params = tp.parameters.map { |arg| eval(arg[1].to_s, tp.binding) }
    puts "Method #{tp.method_id}(#{params.join(', ')}) called"
  when :return
    puts "return value #{tp.return_value}"
  end
end

# The trace has been enabled! Any time one of those events occurs, the block is evaluated.
a = A.new
a.add(2,1)
a.sub(2,1)

输出:

  

方法add(2,1)称为

     

返回值3

     

方法sub(2,1)称为

     

返回值1

如您所见,获取params数据有点麻烦。 TracePoint可以访问方法 signature ,但是您需要利用跟踪的绑定来查看实际使用的值。