Come si aggiunge un'opzione di configurazione specifica del modello a un problema di rotaie?

Question

Sono in procinto di scrivere una preoccupazione Importabile per il mio progetto di rotaie. Questa preoccupazione fornirà un modo generico per importare un file CSV in qualsiasi modello che includa Importabile.

Ho bisogno di un modo per ciascun modello per specificare quale campo deve essere utilizzato dal codice di importazione per trovare i record esistenti. Esistono modi consigliati per aggiungere questo tipo di configurazione a un problema?

Answer 1

Piuttosto che includere la preoccupazione in ogni modello, io suggerirei di creare un ActiveRecord modulo e estendo ActiveRecord::Base con esso, e quindi aggiungere un metodo che modulo (diciamo include_importable) che fa il compreso. È quindi possibile passare il nome del campo come argomento a tale metodo e nel metodo definire una variabile di istanza e un accessorio (ad esempio, ad esempio importable_field) per salvare il nome del campo come riferimento nei metodi di classe e istanza Importable.

Quindi qualcosa di simile:

module Importable 
    extend ActiveSupport::Concern 

    module ActiveRecord 
    def include_importable(field_name) 

     # create a reader on the class to access the field name 
     class << self; attr_reader :importable_field; end 
     @importable_field = field_name.to_s 

     include Importable 

     # do any other setup 
    end 
    end 

    module ClassMethods 
    # reference field name as self.importable_field 
    end 

    module InstanceMethods 
    # reference field name as self.class.importable_field 
    end 

end 

Sarai quindi necessario estendere ActiveRecord con questo modulo, dicono mettendo questa linea in un inizializzatore (config/initializers/active_record.rb):

ActiveRecord::Base.extend(Importable::ActiveRecord) 

(Se il preoccupazione è nel tuo config.autoload_paths quindi non dovrebbe essere necessario richiedere qui, vedere i commenti qui sotto.)

Quindi nei tuoi modelli, yo u dovrebbe includere Importable come questo:

class MyModel 
    include_importable 'some_field' 
end 

E il lettore imported_field restituirà il nome del campo:

MyModel.imported_field 
#=> 'some_field' 

Nella tua InstanceMethods, è possibile impostare il valore del campo importato nel vostro caso metodi passando il nome del campo per write_attribute, e di ottenere il valore utilizzando read_attribute:

m = MyModel.new 
m.write_attribute(m.class.imported_field, "some value") 
m.some_field 
#=> "some value" 
m.read_attribute(m.class.importable_field) 
#=> "some value" 

Spero che questo aiuti. Questa è solo la mia opinione personale su questo, però, ci sono altri modi per farlo (e sarei interessato a sentir parlare anche di loro).

Answer 2

Una soluzione leggermente più "vanilla-look", lo facciamo (per coincidenza, per l'esatto problema di importazione di csv) per evitare la necessità di passare argomenti alla Concern. Sono sicuro che ci sono pro e contro nel metodo astratto che genera errori, ma mantiene tutto il codice nella cartella dell'app e nei modelli in cui prevedi di trovarlo.

Nel modulo "preoccupazione", solo le basi:

module CsvImportable 
    extend ActiveSupport::Concern 

    # concern methods, perhaps one that calls 
    # some_method_that_differs_by_target_class() ... 

    def some_method_that_differs_by_target_class() 
    raise 'you must implement this in the target class' 
    end 

end 

E nel modello avere la preoccupazione:

class Exemption < ActiveRecord::Base 
    include CsvImportable 

    # ... 

private 
    def some_method_that_differs_by_target_class 
    # real implementation here 
    end 
end