Como escrever um mixin Rails que abrange modelo, controlador e visualização
-
09-06-2019 - |
Pergunta
Em um esforço para reduzir a duplicação de código em meu pequeno aplicativo Rails, tenho trabalhado para obter código comum entre meus modelos em seu próprio módulo separado, até agora tudo bem.
O material do modelo é bastante fácil, só preciso incluir o módulo no início, por exemplo:
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
Isso está funcionando bem, mas agora terei algum controlador e código de visualização que também será comum entre esses modelos, até agora tenho isso para minhas coisas enviáveis:
# 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
Basicamente, estou planejando apenas incluir Sendable::Controller e Sendable::View (ou equivalente) para o controlador e a visualização, mas existe uma maneira mais limpa de fazer isso?Estou procurando uma maneira legal de ter um monte de código comum entre meu modelo, controlador e visualização.
Editar:Só para esclarecer, isso só precisa ser compartilhado entre 2 ou 3 modelos.
Solução
Você pode pluginizá-lo (usar script/gerar plugin).
Então no seu init.rb faça algo como:
ActiveRecord::Base.send(:include, PluginName::Sendable)
ActionController::Base.send(:include, PluginName::SendableController)
E junto com você mesmo, incluído, isso deve funcionar perfeitamente.
Confira alguns dos plugins act_*, é um padrão bastante comum (http://github.com/technoweenie/acts_as_paranoid/tree/master/init.rb, verifique a linha 30)
Outras dicas
Se esse código precisar ser adicionado a todos os modelos e controladores, você sempre poderá fazer o seguinte:
# maybe put this in environment.rb or in your module declaration
class ActiveRecord::Base
include Iso
end
# application.rb
class ApplicationController
include Iso
end
Se você precisasse de funções deste módulo disponíveis para as visualizações, você poderia expô-las individualmente com helper_method
declarações em application.rb.
Se você seguir o caminho do plugin, dê uma olhada Motores-trilhos, que têm como objetivo estender a semântica do plugin para Controllers e Views de forma clara.