ruby-on-rails - Rails 扩展 ActiveRecord::Base

Question

我已经阅读了一些关于如何扩展 ActiveRecord:Base 类的内容，这样我的模型就会有一些特殊的方法。扩展它的简单方法是什么（分步教程）？

Answer 1

有几种方法：

使用 ActiveSupport::Concern（首选）

阅读ActiveSupport::Concern文档以获取更多详细信息。

active_record_extension.rb在目录中创建一个名为的lib文件。

require 'active_support/concern'

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)

config/initializers在名为的目录中创建一个文件，extensions.rb并将以下行添加到文件中：

require "active_record_extension"

继承（首选）

参考托比的回答。

猴子补丁（应该避免）

在目录中创建一个config/initializers名为active_record_monkey_patch.rb.

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关于正则表达式的名言可以重新用于说明与猴子修补相关的问题。

有些人在遇到问题时会想“我知道，我会使用猴子补丁”。现在他们有两个问题。

猴子修补简单快捷。但是，节省的时间和精力总是在将来的某个时候提取回来；复利。这些天来，我限制猴子修补以在 Rails 控制台中快速原型化解决方案。

Answer 2

您可以扩展类并简单地使用继承。

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

class Foo < AbstractModel
end

class Bar < AbstractModel
end

Answer 3

您还可以使用ActiveSupport::ConcernRails 核心惯用语，例如：

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 4

在 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

在使用关注点时，我想强调的一点是关注点应该用于“基于域”的分组而不是“技术”分组。例如，域分组类似于“Commentable”、“Taggable”等。基于技术的分组类似于“FinderMethods”、“ValidationMethods”。

这是一个帖子的链接，我发现它对于理解模型中的关注点非常有用。

希望这篇文章有帮助:)

Answer 5

第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 6

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

参见例如这篇博文。

Answer 7

在 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

希望它可以帮助别人！

Answer 8

只是为了补充这个话题，我花了一段时间研究如何测试这样的扩展（我走了这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 9

我有

ActiveRecord::Base.extend Foo::Bar

在初始化器中

对于像下面这样的模块

module Foo
  module Bar
  end
end