Bagaimana saya bisa menetapkan nilai default di ActiveRecord?

Saya melihat posting dari Pratik yang menggambarkan potongan kode yang jelek dan rumit: http://m.onkey.org/2007/7/24/how-to-set-default-values-in-your-model

class Item < ActiveRecord::Base  
  def initialize_with_defaults(attrs = nil, &block)
    initialize_without_defaults(attrs) do
      setter = lambda { |key, value| self.send("#{key.to_s}=", value) unless
        !attrs.nil? && attrs.keys.map(&:to_s).include?(key.to_s) }
      setter.call('scheduler_type', 'hotseat')
      yield self if block_given?
    end
  end
  alias_method_chain :initialize, :defaults
end

Saya telah melihat contoh-contoh berikut di Google:

  def initialize 
    super
    self.status = ACTIVE unless self.status
  end

dan

  def after_initialize 
    return unless new_record?
    self.status = ACTIVE
  end

Saya juga melihat orang memasukkannya ke dalam migrasi, tetapi saya lebih suka melihatnya didefinisikan dalam kode model.

Apakah ada cara kanonik untuk menetapkan nilai default untuk bidang dalam model ActiveRecord?

Ada beberapa masalah dengan masing-masing metode yang tersedia, tetapi saya percaya bahwa mendefinisikan after_initializepanggilan balik adalah cara untuk pergi karena alasan berikut:

1. default_scopeakan menginisialisasi nilai untuk model baru, tetapi kemudian itu akan menjadi ruang lingkup di mana Anda menemukan model. Jika Anda hanya ingin menginisialisasi beberapa angka ke 0 maka ini bukan yang Anda inginkan.
2. Menentukan default dalam migrasi Anda juga berfungsi sebagian waktu ... Seperti yang telah disebutkan ini tidak akan berfungsi ketika Anda baru saja memanggil Model.new.
3. Mengganti initializebisa berhasil, tapi jangan lupa menelepon super!
4. Menggunakan plugin seperti phusion menjadi sedikit konyol. Ini ruby, apakah kita benar-benar membutuhkan plugin hanya untuk menginisialisasi beberapa nilai default?
5. Overriding after_initialize sudah tidak digunakan lagi pada Rails 3. Ketika saya menimpa after_initializedi rails 3.0.3 saya mendapatkan peringatan berikut di konsol:

PERINGATAN DEPRECASI: Base # after_initialize telah ditinggalkan, silakan gunakan Base.after_initialize: metode sebagai gantinya. (dipanggil dari / Users / me / myapp / app / models / my_model: 15)

Karena itu saya akan mengatakan menulis after_initializepanggilan balik, yang memungkinkan Anda atribut default selain membiarkan Anda menetapkan default pada asosiasi seperti:

  class Person < ActiveRecord::Base
    has_one :address
    after_initialize :init

    def init
      self.number  ||= 0.0           #will set the default value only if it's nil
      self.address ||= build_address #let's you set a default association
    end
  end    

Sekarang Anda hanya memiliki satu tempat untuk mencari inisialisasi model Anda. Saya menggunakan metode ini sampai seseorang menemukan yang lebih baik.

Peringatan:

1. Untuk bidang boolean lakukan:

   self.bool_field = true if self.bool_field.nil?

   Lihat komentar Paul Russell tentang jawaban ini untuk lebih jelasnya

2. Jika Anda hanya memilih subset kolom untuk model (yaitu; menggunakan selectdalam query seperti Person.select(:firstname, :lastname).all) Anda akan mendapatkan MissingAttributeErrorjika initmetode Anda mengakses kolom yang belum dimasukkan dalam selectklausa. Anda dapat menjaga terhadap kasus ini seperti:

   self.number ||= 0.0 if self.has_attribute? :number

   dan untuk kolom boolean ...

   self.bool_field = true if (self.has_attribute? :bool_value) && self.bool_field.nil?

   Perhatikan juga bahwa sintaksnya berbeda sebelum Rails 3.2 (lihat komentar Cliff Darling di bawah)

Rails 5+

Anda dapat menggunakan metode atribut dalam model Anda, misalnya .:

class Account < ApplicationRecord
  attribute :locale, :string, default: 'en'
end

Anda juga dapat meneruskan lambda ke defaultparameter. Contoh:

attribute :uuid, UuidType.new, default: -> { SecureRandom.uuid }

Kami menempatkan nilai-nilai default di database melalui migrasi (dengan menentukan :defaultopsi pada setiap definisi kolom) dan membiarkan Rekaman Aktif menggunakan nilai-nilai ini untuk mengatur default untuk setiap atribut.

IMHO, pendekatan ini selaras dengan prinsip-prinsip AR: konvensi atas konfigurasi, KERING, definisi tabel menggerakkan model, bukan sebaliknya.

Perhatikan bahwa default masih dalam kode aplikasi (Ruby), meskipun tidak dalam model tetapi dalam migrasi.

Beberapa kasus sederhana dapat ditangani dengan mendefinisikan default dalam skema database tetapi itu tidak menangani sejumlah kasus rumit termasuk nilai yang dihitung dan kunci dari model lain. Untuk kasus ini saya melakukan ini:

after_initialize :defaults

def defaults
   unless persisted?
    self.extras||={}
    self.other_stuff||="This stuff"
    self.assoc = [OtherModel.find_by_name('special')]
  end
end

Saya telah memutuskan untuk menggunakan after_initialize tetapi saya tidak ingin itu diterapkan ke objek yang hanya ditemukan yang baru atau dibuat. Saya pikir itu hampir mengejutkan bahwa panggilan balik after_new tidak disediakan untuk kasus penggunaan yang jelas ini tetapi saya lakukan dengan mengkonfirmasi apakah objek sudah bertahan yang menunjukkan bahwa itu bukan barang baru.

Setelah melihat jawaban Brad Murray ini bahkan lebih bersih jika kondisinya dipindahkan ke permintaan callback:

after_initialize :defaults, unless: :persisted?
              # ":if => :new_record?" is equivalent in this context

def defaults
  self.extras||={}
  self.other_stuff||="This stuff"
  self.assoc = [OtherModel.find_by_name('special')]
end

Pola panggilan balik after_initialize dapat ditingkatkan dengan hanya melakukan hal berikut

after_initialize :some_method_goes_here, :if => :new_record?

Ini memiliki manfaat non-sepele jika kode init Anda perlu berurusan dengan asosiasi, karena kode berikut ini memicu n + 1 yang halus jika Anda membaca catatan awal tanpa menyertakan yang terkait.

class Account

  has_one :config
  after_initialize :init_config

  def init_config
    self.config ||= build_config
  end

end

Orang-orang Phusion punya beberapa plugin yang bagus untuk ini.

Cara potensial yang lebih baik / lebih bersih daripada jawaban yang diajukan adalah menimpa accessor, seperti ini:

def status
  self['status'] || ACTIVE
end

Lihat "Menimpa aksesor default" di ActiveRecord :: dokumentasi Base dan lainnya dari StackOverflow tentang penggunaan mandiri .

Saya menggunakan attribute-defaultspermata

Dari dokumentasi: jalankan sudo gem install attribute-defaultsdan tambahkan require 'attribute_defaults'ke aplikasi Anda.

class Foo < ActiveRecord::Base
  attr_default :age, 18
  attr_default :last_seen do
    Time.now
  end
end

Foo.new()           # => age: 18, last_seen => "2014-10-17 09:44:27"
Foo.new(:age => 25) # => age: 25, last_seen => "2014-10-17 09:44:28"

Pertanyaan serupa, tetapi semua memiliki konteks yang sedikit berbeda: - Bagaimana cara membuat nilai default untuk atribut dalam model Rails activerecord?

Jawaban Terbaik: Tergantung pada Apa yang Anda Inginkan!

Jika Anda ingin setiap objek memulai dengan sebuah nilai: gunakanafter_initialize :init

Anda ingin new.htmlformulir memiliki nilai default saat membuka halaman? gunakan https://stackoverflow.com/a/5127684/1536309

class Person < ActiveRecord::Base
  has_one :address
  after_initialize :init

  def init
    self.number  ||= 0.0           #will set the default value only if it's nil
    self.address ||= build_address #let's you set a default association
  end
  ...
end 

Jika Anda ingin setiap objek memiliki nilai yang dihitung dari input pengguna: gunakanbefore_save :default_values Anda ingin pengguna memasukkanXlaluY = X+'foo'? menggunakan:

class Task < ActiveRecord::Base
  before_save :default_values
  def default_values
    self.status ||= 'P'
  end
end

Inilah gunanya konstruktor! Ganti metode model initialize.

Gunakan after_initializemetodenya.

Sup kawan, saya akhirnya melakukan hal berikut:

def after_initialize 
 self.extras||={}
 self.other_stuff||="This stuff"
end

Bekerja seperti pesona!

Ini telah dijawab sejak lama, tetapi saya sering membutuhkan nilai default dan memilih untuk tidak memasukkannya ke dalam basis data. Saya membuat DefaultValueskeprihatinan:

module DefaultValues
  extend ActiveSupport::Concern

  class_methods do
    def defaults(attr, to: nil, on: :initialize)
      method_name = "set_default_#{attr}"
      send "after_#{on}", method_name.to_sym

      define_method(method_name) do
        if send(attr)
          send(attr)
        else
          value = to.is_a?(Proc) ? to.call : to
          send("#{attr}=", value)
        end
      end

      private method_name
    end
  end
end

Dan kemudian menggunakannya dalam model saya seperti ini:

class Widget < ApplicationRecord
  include DefaultValues

  defaults :category, to: 'uncategorized'
  defaults :token, to: -> { SecureRandom.uuid }
end

Saya juga melihat orang memasukkannya ke dalam migrasi, tetapi saya lebih suka melihatnya didefinisikan dalam kode model.

Apakah ada cara kanonik untuk menetapkan nilai default untuk bidang dalam model ActiveRecord?

Cara kanonik Rails, sebelum Rails 5, sebenarnya untuk mengaturnya dalam migrasi, dan lihat saja db/schema.rbuntuk setiap kali ingin melihat apa nilai-nilai default yang ditetapkan oleh DB untuk model apa pun.

Bertentangan dengan apa yang dijawab oleh @Jeff Perrin (yang agak lama), pendekatan migrasi bahkan akan menerapkan default saat menggunakan Model.new, karena beberapa sihir Rails. Diverifikasi bekerja di Rails 4.1.16.

Yang paling sederhana seringkali yang terbaik. Kurang pengetahuan hutang dan potensi titik kebingungan dalam basis kode. Dan itu 'hanya berfungsi'.

class AddStatusToItem < ActiveRecord::Migration
  def change
    add_column :items, :scheduler_type, :string, { null: false, default: "hotseat" }
  end
end

Atau, untuk perubahan kolom tanpa membuat yang baru, maka lakukan:

class AddStatusToItem < ActiveRecord::Migration
  def change
    change_column_default :items, :scheduler_type, "hotseat"
  end
end

Atau mungkin lebih baik:

class AddStatusToItem < ActiveRecord::Migration
  def change
    change_column :items, :scheduler_type, :string, default: "hotseat"
  end
end

Periksa panduan RoR resmi untuk opsi dalam metode penggantian kolom.

Tidak null: falsediizinkan nilai NULL dalam DB, dan, sebagai manfaat tambahan, itu juga memperbarui sehingga semua catatan DB yang sudah ada sebelumnya yang sebelumnya nol ditetapkan dengan nilai default untuk bidang ini juga. Anda dapat mengecualikan parameter ini dalam migrasi jika Anda mau, tetapi saya merasa sangat berguna!

Cara kanonik di Rails 5+ adalah, seperti yang dikatakan @Lucas Caton:

class Item < ActiveRecord::Base
  attribute :scheduler_type, :string, default: 'hotseat'
end

Masalah dengan solusi after_initialize adalah Anda harus menambahkan after_initialize ke setiap objek yang Anda cari dari DB, terlepas dari apakah Anda mengakses atribut ini atau tidak. Saya menyarankan pendekatan yang malas.

Metode atribut (getter) tentu saja merupakan metode itu sendiri, sehingga Anda dapat menimpanya dan memberikan default. Sesuatu seperti:

Class Foo < ActiveRecord::Base
  # has a DB column/field atttribute called 'status'
  def status
    (val = read_attribute(:status)).nil? ? 'ACTIVE' : val
  end
end

Kecuali, seperti yang ditunjukkan seseorang, Anda perlu melakukan Foo.find_by_status ('ACTIVE'). Dalam hal ini saya pikir Anda benar-benar harus menetapkan default di kendala database Anda, jika DB mendukungnya.

Saya mengalami masalah dengan after_initializememberikan ActiveModel::MissingAttributeErrorkesalahan saat melakukan penemuan kompleks:

misalnya:

@bottles = Bottle.includes(:supplier, :substance).where(search).order("suppliers.name ASC").paginate(:page => page_no)

"search" di .wherehash of conditions

Jadi saya akhirnya melakukannya dengan mengganti inisialisasi dengan cara ini:

def initialize
  super
  default_values
end

private
 def default_values
     self.date_received ||= Date.current
 end

The superpanggilan diperlukan untuk memastikan objek menginisialisasi dengan benar dari ActiveRecord::Basesebelum melakukan kode customize saya, yaitu: default_values

class Item < ActiveRecord::Base
  def status
    self[:status] or ACTIVE
  end

  before_save{ self.status ||= ACTIVE }
end

Meskipun melakukan itu untuk menetapkan nilai default membingungkan dan canggung dalam kebanyakan kasus, Anda dapat menggunakannya :default_scopejuga. Lihat komentar squil di sini .

Metode after_initialize sudah usang, gunakan panggilan balik sebagai gantinya.

after_initialize :defaults

def defaults
  self.extras||={}
  self.other_stuff||="This stuff"
end

namun, menggunakan : default dalam migrasi Anda masih merupakan cara terbersih.

Saya telah menemukan bahwa menggunakan metode validasi memberikan banyak kontrol terhadap pengaturan default. Anda bahkan dapat mengatur default (atau gagal validasi) untuk pembaruan. Anda bahkan menetapkan nilai default yang berbeda untuk insert vs update jika Anda benar-benar menginginkannya. Perhatikan bahwa default tidak akan ditetapkan hingga #valid? disebut.

class MyModel
  validate :init_defaults

  private
  def init_defaults
    if new_record?
      self.some_int ||= 1
    elsif some_int.nil?
      errors.add(:some_int, "can't be blank on update")
    end
  end
end

Mengenai mendefinisikan metode after_initialize, mungkin ada masalah kinerja karena after_initialize juga dipanggil oleh setiap objek yang dikembalikan oleh: find: http://guides.rubyonrails.org/active_record_validations_callbacks.html#after_initialize-and-after_find

Jika kolom tersebut adalah kolom tipe 'status', dan model Anda cocok untuk penggunaan mesin negara, pertimbangkan untuk menggunakan permata aasm , setelah itu Anda cukup melakukan

  aasm column: "status" do
    state :available, initial: true
    state :used
    # transitions
  end

Itu masih tidak menginisialisasi nilai untuk catatan yang belum disimpan, tetapi itu sedikit lebih bersih daripada menggulung sendiri dengan initatau apa pun, dan Anda menuai manfaat lain dari aasm seperti cakupan untuk semua status Anda.

https://github.com/keithrowell/rails_default_value

class Task < ActiveRecord::Base
  default :status => 'active'
end

Saya sangat menyarankan menggunakan permata "default_value_for": https://github.com/FooBarWidget/default_value_for

Ada beberapa skenario rumit yang cukup banyak mengharuskan mengganti metode inisialisasi, yang permata itu lakukan.

Contoh:

Default db Anda adalah NULL, model Anda / default yang ditentukan ruby ​​adalah "some string", tetapi Anda sebenarnya ingin mengatur nilai menjadi nil karena alasan apa pun:MyModel.new(my_attr: nil)

Sebagian besar solusi di sini akan gagal untuk mengatur nilai ke nol, dan sebagai gantinya akan menetapkannya ke default.

OK, jadi alih-alih mengambil ||=pendekatan, Anda beralih ke my_attr_changed?...

TAPI sekarang bayangkan standar db Anda adalah "beberapa string", model Anda / default yang ditentukan ruby ​​adalah "beberapa string lain", tetapi di bawah skenario tertentu, Anda ingin mengatur nilai ke "beberapa string" (default db):MyModel.new(my_attr: 'some_string')

Hal ini akan mengakibatkan my_attr_changed?menjadi palsu karena nilai sesuai dengan standar db, yang pada gilirannya akan api kode default ruby-didefinisikan Anda dan mengatur nilai untuk "beberapa string lain" - lagi, bukan apa yang Anda inginkan.

Untuk alasan itu saya tidak berpikir ini bisa diselesaikan dengan baik hanya dengan kait after_initialize.

Sekali lagi, saya pikir permata "default_value_for" mengambil pendekatan yang tepat: https://github.com/FooBarWidget/default_value_for

Inilah solusi yang saya gunakan sehingga saya sedikit terkejut belum ditambahkan.

Ada dua bagian untuk itu. Bagian pertama adalah pengaturan default dalam migrasi aktual, dan bagian kedua adalah menambahkan validasi dalam model memastikan bahwa kehadiran itu benar.

add_column :teams, :new_team_signature, :string, default: 'Welcome to the Team'

Jadi, Anda akan melihat di sini bahwa default sudah ditetapkan. Sekarang dalam validasi Anda ingin memastikan bahwa selalu ada nilai untuk string, jadi lakukan saja

 validates :new_team_signature, presence: true

Apa yang akan dilakukan adalah menetapkan nilai default untuk Anda. (bagi saya, saya memiliki "Selamat Datang di Tim"), dan kemudian akan selangkah lebih maju memastikan bahwa selalu ada nilai hadiah untuk objek itu.

Semoga itu bisa membantu!

# db/schema.rb
create_table :store_listings, force: true do |t|
  t.string :my_string, default: "original default"
end

StoreListing.new.my_string # => "original default"

# app/models/store_listing.rb
class StoreListing < ActiveRecord::Base
  attribute :my_string, :string, default: "new default"
end

StoreListing.new.my_string # => "new default"

class Product < ActiveRecord::Base
  attribute :my_default_proc, :datetime, default: -> { Time.now }
end

Product.new.my_default_proc # => 2015-05-30 11:04:48 -0600
sleep 1
Product.new.my_default_proc # => 2015-05-30 11:04:49 -0600

gunakan default_scope di rails 3

api doc

ActiveRecord mengaburkan perbedaan antara default yang didefinisikan dalam database (skema) dan default yang dilakukan dalam aplikasi (model). Selama inisialisasi, ini mem-parsing skema database dan mencatat nilai-nilai default yang ditentukan di sana. Kemudian, ketika membuat objek, itu menetapkan nilai-nilai default yang ditentukan skema tanpa menyentuh database.

diskusi

Dari api docs http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html Gunakan before_validationmetode dalam model Anda, ini memberi Anda pilihan untuk membuat inisialisasi spesifik untuk membuat dan memperbarui panggilan misalnya dalam contoh ini (kode lagi diambil dari contoh api docs) bidang angka diinisialisasi untuk kartu kredit. Anda dapat dengan mudah mengadaptasi ini untuk menetapkan nilai apa pun yang Anda inginkan

class CreditCard < ActiveRecord::Base
  # Strip everything but digits, so the user can specify "555 234 34" or
  # "5552-3434" or both will mean "55523434"
  before_validation(:on => :create) do
    self.number = number.gsub(%r[^0-9]/, "") if attribute_present?("number")
  end
end

class Subscription < ActiveRecord::Base
  before_create :record_signup

  private
    def record_signup
      self.signed_up_on = Date.today
    end
end

class Firm < ActiveRecord::Base
  # Destroys the associated clients and people when the firm is destroyed
  before_destroy { |record| Person.destroy_all "firm_id = #{record.id}"   }
  before_destroy { |record| Client.destroy_all "client_of = #{record.id}" }
end

Terkejut bahwa itu belum disarankan di sini