Как написать миксин Rails, охватывающий модель, контроллер и представление - PullRequest
Новая
       23

Как написать миксин Rails, охватывающий модель, контроллер и представление

5 голосов
/ 16 сентября 2008

Стремясь уменьшить дублирование кода в моем маленьком приложении на Rails, я работаю над тем, чтобы объединить общий код между моими моделями в отдельный модуль, пока что все хорошо.

Модель довольно проста, я просто должен включить модуль в начале, например: 

class Iso < Sale
  include Shared::TracksSerialNumberExtension
  include Shared::OrderLines
  extend  Shared::Filtered
  include Sendable::Model

  validates_presence_of   :customer
  validates_associated    :lines

  owned_by :customer

  def initialize( params = nil )
    super
    self.created_at ||= Time.now.to_date
  end

  def after_initialize
  end

  order_lines             :despatched

  # tracks_serial_numbers   :items
  sendable :customer

  def created_at=( date )
    write_attribute( :created_at, Chronic.parse( date ) )
  end
end

Это работает нормально, но теперь у меня будет некоторый контроллер и просмотр кода, который будет одинаковым для этих моделей, так что пока у меня есть это для моих отправляемых вещей: 

# This is a module that is used for pages/forms that are can be "sent"
# either via fax, email, or printed.
module Sendable
  module Model
    def self.included( klass )
      klass.extend ClassMethods
    end

    module ClassMethods
      def sendable( class_to_send_to )
        attr_accessor :fax_number,
                      :email_address,
                      :to_be_faxed,
                      :to_be_emailed,
                      :to_be_printed

        @_class_sending_to ||= class_to_send_to

        include InstanceMethods
      end

      def class_sending_to
        @_class_sending_to
      end
    end # ClassMethods

    module InstanceMethods
      def after_initialize( )
        super
        self.to_be_faxed    = false
        self.to_be_emailed  = false
        self.to_be_printed  = false

        target_class = self.send( self.class.class_sending_to )
        if !target_class.nil?
          self.fax_number     = target_class.send( :fax_number )
          self.email_address  = target_class.send( :email_address )
        end
      end
    end
  end # Module Model
end # Module Sendable

По сути, я планирую просто включить sendable :: Controller и Sendable :: View (или эквивалент) для контроллера и представления, но есть ли более чистый способ сделать это? Я стараюсь найти общий код между моей моделью, контроллером и представлением.

Редактировать: Просто чтобы прояснить, это просто необходимо распространить на 2 или 3 модели.

Ответы [ 3 ]

7 голосов
/ 16 сентября 2008

Вы можете подключить его (использовать скрипт / создать плагин).

Тогда в вашем init.rb просто сделайте что-то вроде: 

ActiveRecord::Base.send(:include, PluginName::Sendable)
ActionController::Base.send(:include, PluginName::SendableController)

И вместе с самим собой. Это должно работать нормально.

Посмотрите на некоторые из плагинов Act_ *, это довольно распространенный шаблон (http://github.com/technoweenie/acts_as_paranoid/tree/master/init.rb, строка проверки 30)

6 голосов
/ 16 сентября 2008

Если этот код необходимо добавить ко всем моделям и всем контроллерам, вы всегда можете сделать следующее: 

# maybe put this in environment.rb or in your module declaration
class ActiveRecord::Base
  include Iso
end

# application.rb
class ApplicationController
  include Iso
end

Если вам нужны функции из этого модуля, доступные для представлений, вы можете предоставить их по отдельности с помощью объявлений helper_method в application.rb.

1 голос
/ 16 сентября 2008

Если вы идете по плагину, проверьте Rails-Engines , которые предназначены для ясного расширения семантики плагина для контроллеров и представлений.

...