ruby元編程之建立自己的動態方法_ruby專題

method_missing是Ruby元編程（metaprogramming）常用的手法。基本思想是通過實現調用不存在的方法，以便進行回調。典型的例子是：ActiveRecord的動態尋找（dynamic finder）。例如：我們有email屬性那麼就可以調用User.find_by_email('joe@example.com')，雖然， ActiveRecord::Base並沒有一個叫做find_by_email的方法。

respond_to? 並不如method_missing出名，常用在當需要確認一個回饋對象需要確認，以便不會因為沒有反饋對象，而導致後面的調用出現錯誤。

下面是一個應用這兩者的例子：

樣本

我們有類Legislator class，現在，想要給它加一個find_by_first_name('John')的動態調用。實現find(:first_name => 'John')的功能。

複製代碼 代碼如下:

class Legislator
  #假設這是一個真實的實現
  def find(conditions = {})
  end
 
  #在本身定義畢竟這是他的方法
  def self.method_missing(method_sym, *arguments, &block)
    # the first argument is a Symbol, so you need to_s it if you want to pattern match
    if method_sym.to_s =~ /^find_by_(.*)$/
      find($1.to_sym => arguments.first)
    else
      super
    end
  end
end

那麼這個時候調用

複製代碼 代碼如下:

Legislator.respond_to?(:find_by_first_name) 

將會提示錯誤，那麼繼續

複製代碼 代碼如下:

class Legislator
  # 省略
 
  # It's important to know Object defines respond_to to take two parameters: the method to check, and whether to include private methods
  # http://www.ruby-doc.org/core/classes/Object.html#M000333
  def self.respond_to?(method_sym, include_private = false)
    if method_sym.to_s =~ /^find_by_(.*)$/
      true
    else
      super
    end
  end
end

正如代碼注釋所述respond_to?需要兩個參數，如果，你沒有提供將會產生ArgumentError。

相關反射 DRY

如果我們注意到了這裡有重複的代碼。我們可以參考ActiveRecord的實現封裝在ActiveRecord::DynamicFinderMatch，以便避免在method_missing和respond_to?中重複。

複製代碼 代碼如下:

class LegislatorDynamicFinderMatch
  attr_accessor :attribute
  def initialize(method_sym)
    if method_sym.to_s =~ /^find_by_(.*)$/
      @attribute = $1.to_sym
    end
  end
 
  def match?
    @attribute != nil
  end
end

class Legislator
  def self.method_missing(method_sym, *arguments, &block)
    match = LegislatorDynamicFinderMatch.new(method_sym)
    if match.match?
      find(match.attribute => arguments.first)
    else
      super
    end
  end

  def self.respond_to?(method_sym, include_private = false)
    if LegislatorDynamicFinderMatch.new(method_sym).match?
      true
    else
      super
    end
  end
end

緩衝 method_missing

重複多次的method_missing可以考慮緩衝。

另外一個我們可以向ActiveRecord 學習的是，當定義method_missing的時候，發送 now-defined方法。如下：

複製代碼 代碼如下:

class Legislator   
  def self.method_missing(method_sym, *arguments, &block)
    match = LegislatorDynamicFinderMatch.new(method_sym)
    if match.match?
      define_dynamic_finder(method_sym, match.attribute)
      send(method_sym, arguments.first)
    else
      super
    end
  end
 
  protected
 
  def self.define_dynamic_finder(finder, attribute)
    class_eval <<-RUBY
      def self.#{finder}(#{attribute})        # def self.find_by_first_name(first_name)
        find(:#{attribute} => #{attribute})   #   find(:first_name => first_name)
      end                                     # end
    RUBY
  end
end

測試

測試部分如下：

複製代碼 代碼如下:

describe LegislatorDynamicFinderMatch do
  describe 'find_by_first_name' do
    before do
      @match = LegislatorDynamicFinderMatch.new(:find_by_first_name)
    end
     
    it 'should have attribute :first_name' do
      @match.attribute.should == :first_name
    end
   
    it 'should be a match' do
      @match.should be_a_match
    end
  end
 
  describe 'zomg' do
    before do
      @match = LegislatorDynamicFinderMatch(:zomg)
    end
   
    it 'should have nil attribute' do
      @match.attribute.should be_nil
    end
   
    it 'should not be a match' do
      @match.should_not be_a_match
    end
  end
end

下面是 RSpec 例子:

複製代碼 代碼如下:

describe Legislator, 'dynamic find_by_first_name' do 
  it 'should call find(:first_name => first_name)' do 
    Legislator.should_receive(:find).with(:first_name => 'John') 
     
    Legislator.find_by_first_name('John') 
  end 
end