Рельсы, расширяющие ActiveRecord :: Base

Question

Я читал о том, как расширить ActiveRecord: базовый класс, чтобы у моих моделей были специальные методы. Каков простой способ его расширения (пошаговое руководство)?

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::Concern и быть более похожим на Rails core:

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 концепция использования проблем для модульности и сушки ваших моделей была в центре внимания.

Проблемы, в основном, позволяют группировать сходный код модели или нескольких моделей в одном модуле, а затем использовать этот модуль в моделях. Вот пример:

Рассмотрим модель Article, модель Event и модель Comment. Статья или событие имеет много комментариев. Комментарий относится либо к статье, либо к событию.

Традиционно модели могут выглядеть так:

Комментарий модели:

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. Используя проблемы, мы можем извлечь этот общий код в отдельный модуль Commentable.

Для этого создайте файл commentable.rb в app / model / Concers.

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

Одна вещь, которую я хотел бы подчеркнуть при использовании проблем, заключается в том, что Проблемы должны использоваться для групповой группировки, а не для технической группировки. «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 все модели наследуются от 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 7

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