Rails擴展ActiveRecord :: Base

Question

我已經做了一些關於如何擴展ActiveRecord：Base類的閱讀，所以我的模型會有一些特殊的方法。什麼是簡單的方法來擴展它（一步一步的教程）？

Answer 1

有幾種方法：

使用的ActiveSupport ::關注（首選）

閱讀ActiveSupport::Concern文檔瞭解更多信息。

在lib目錄中創建一個名爲active_record_extension.rb的文件。

module ActiveRecordExtension 

    extend ActiveSupport::Concern 

    # add your instance methods here 
    def foo 
    "foo" 
    end 

    # add your static(class) methods here 
    class_methods do 
    #E.g: Order.top_ten   
    def top_ten 
     limit(10) 
    end 
    end 
end 

# include the extension 
ActiveRecord::Base.send(:include, ActiveRecordExtension) 

創建一個名爲extensions.rb的config/initializers目錄中的文件，並將以下行添加到文件：

require "active_record_extension" 

繼承（首選）

參考託比的answer。

猴修補（應儘量避免）

創建一個名爲active_record_monkey_patch.rb的config/initializers目錄中的文件。

class ActiveRecord::Base  
    #instance method, E.g: Order.new.foo  
    def foo 
    "foo" 
    end 

    #class method, E.g: Order.top_ten   
    def self.top_ten 
    limit(10) 
    end 
end 

有關正則表達式的名言被Jamie Zawinski可以被重新利用來說明與猴子修補相關的問題。

Some people, when confronted with a problem, think 「I know, I'll use monkey patching.」 Now they have two problems.

猴子修補很容易和快捷。但是，節省的時間和精力總是會在將來的某個時候提取回 ;與複利。現在我限制猴子修補，以便在軌道控制檯中快速構建原型解決方案。

Answer 2

步驟1

module FooExtension 
    def foo 
    puts "bar :)" 
    end 
end 
ActiveRecord::Base.send :include, FooExtension 

步驟2

# Require the above file in an initializer (in config/initializers) 
require 'lib/foo_extension.rb' 

步驟3

There is no step 3 :) 

Answer 3

您可以只擴展該類並簡單地使用繼承。

class AbstractModel < ActiveRecord::Base 
    self.abstract_class = true 
end 

class Foo < AbstractModel 
end 

class Bar < AbstractModel 
end 

Answer 4

您還可以使用ActiveSupport::Concern和更Rails核心成語，如：

module MyExtension 
    extend ActiveSupport::Concern 

    def foo 
    end 

    module ClassMethods 
    def bar 
    end 
    end 
end 

ActiveRecord::Base.send(:include, MyExtension) 

[編輯]從@daniel

註釋下面然後所有的車型將有包括方法foo作爲實例方法和包含在類方法中的ClassMethods中的方法。例如。在FooBar < ActiveRecord::Base你將有：FooBar.bar和FooBar#foo

http://api.rubyonrails.org/classes/ActiveSupport/Concern.html

Answer 5

只需添加到這個話題，我花了一段時間去解決如何測試這種擴展（我走下ActiveSupport::Concern路線。）

以下是我如何設置測試擴展的模型。

describe ModelExtensions do 
    describe :some_method do 
    it 'should return the value of foo' do 
     ActiveRecord::Migration.create_table :test_models do |t| 
     t.string :foo 
     end 

     test_model_class = Class.new(ActiveRecord::Base) do 
     def self.name 
      'TestModel' 
     end 

     attr_accessible :foo 
     end 

     model = test_model_class.new(:foo => 'bar') 

     model.some_method.should == 'bar' 
    end 
    end 
end 

Answer 6

我

ActiveRecord::Base.extend Foo::Bar 

在初始化

對於像下面

module Foo 
    module Bar 
    end 
end 

Answer 7

使用Rails 4，使用關注的概念模塊化一個模塊並擦乾你的模特一直在亮點。

問題基本上允許您將單個模塊中的類似代碼或多個模型分組，然後在模型中使用此模塊。以下是一個示例：

考慮一篇文章模型，一個事件模型和一個評論模型。一篇文章或一個事件有很多評論。評論屬於文章或事件。

傳統上，模型可能是這樣的：

評論模型：

class Comment < ActiveRecord::Base 
    belongs_to :commentable, polymorphic: true 
end 

文章型號：

class Article < ActiveRecord::Base 
    has_many :comments, as: :commentable 

    def find_first_comment 
    comments.first(created_at DESC) 
    end 

    def self.least_commented 
    #return the article with least number of comments 
    end 
end 

事件模型

class Event < ActiveRecord::Base 
    has_many :comments, as: :commentable 

    def find_first_comment 
    comments.first(created_at DESC) 
    end 

    def self.least_commented 
    #returns the event with least number of comments 
    end 
end 

正如我們可以看到， 那裏 是Event和Article Model共同的重要代碼。使用關注點，我們可以在一個單獨的可評論模塊中提取此通用代碼。

爲此，在app/model/concerns中創建一個commentable.rb文件。

module Commentable 
    extend ActiveSupport::Concern 

    included do 
     has_many :comments, as: :commentable 
    end 

    # for the given article/event returns the first comment 
    def find_first_comment 
     comments.first(created_at DESC) 
    end 

    module ClassMethods  
     def least_commented 
      #returns the article/event which has the least number of comments 
     end 
    end 
end 

，現在你的模型如下圖所示：

評論模型：

class Comment < ActiveRecord::Base 
     belongs_to :commentable, polymorphic: true 
    end 

文章型號：

class Article < ActiveRecord::Base 
    include Commentable 
end 

事件模型

class Event < ActiveRecord::Base  
    include Commentable 
end 

我想強調的一點是，使用Concerns是關注點應該用於「基於域」的分組而不是「技術」分組。例如，域名分組就像'可註釋'，'可標記'等。基於技術的分組將像'FinderMethods'，'ValidationMethods'。

這是一個link to a post，我發現它對於理解模型中的問題非常有用。

希望的書面記錄幫助:)

Answer 8

的Rails 5提供了一個內置的機制，用於擴展ActiveRecord::Base。

這是通過提供附加的層來實現：

# app/models/application_record.rb 
class ApplicationRecord < ActiveRecord::Base 
    self.abstract_class = true 
    # put your extensions here 
end 

和所有模型從一個繼承：

class Post < ApplicationRecord 
end 

參見例如this blogpost。

Answer 9

使用Rails 5，所有模型都從ApplicationRecord &繼承，它提供了很好的方式來包含或擴展其他擴展庫。

# app/models/concerns/special_methods.rb 
module SpecialMethods 
    extend ActiveSupport::Concern 

    scope :this_month, -> { 
    where("date_trunc('month',created_at) = date_trunc('month',now())") 
    } 

    def foo 
    # Code 
    end 
end 

假設特殊方法模塊需要跨所有模型可用，請將其包含在application_record.rb文件中。如果我們想將其應用於特定的一組模型，則將其包含在相應的模型類中。

# app/models/application_record.rb 
class ApplicationRecord < ActiveRecord::Base 
    self.abstract_class = true 
    include SpecialMethods 
end 

# app/models/user.rb 
class User < ApplicationRecord 
    include SpecialMethods 

    # Code 
end 

如果您希望將模塊中定義的方法定義爲類方法，請將模塊擴展到ApplicationRecord。

# app/models/application_record.rb 
class ApplicationRecord < ActiveRecord::Base 
    self.abstract_class = true 
    extend SpecialMethods 
end 

希望它能幫助別人！