Ruby on Rails: Di mana mendefinisikan konstanta global?

Saya baru memulai dengan aplikasi web Ruby on Rails pertama saya. Saya punya banyak model, tampilan, pengontrol, dan sebagainya yang berbeda.

Saya ingin menemukan tempat yang baik untuk tetap definisi konstan konstanta global, yang berlaku di seluruh aplikasi saya. Secara khusus, mereka berlaku baik dalam logika model saya, dan dalam keputusan yang diambil dalam pandangan saya. Saya tidak dapat menemukan tempat KERING untuk meletakkan definisi ini di mana mereka tersedia baik untuk semua model saya dan juga dalam semua pandangan saya.

Untuk mengambil contoh spesifik, saya ingin sebuah konstanta COLOURS = ['white', 'blue', 'black', 'red', 'green']. Ini digunakan di semua tempat, baik dalam model maupun tampilan. Di mana saya dapat mendefinisikannya hanya di satu tempat sehingga dapat diakses?

Apa yang saya coba:

• Variabel kelas konstan dalam file model.rb yang paling sering dikaitkan dengan mereka, seperti @@COLOURS = [...]. Tapi saya tidak bisa menemukan cara yang waras untuk mendefinisikannya sehingga saya bisa menulis dalam pandangan saya Card.COLOURSdaripada sesuatu yang suka kludgy Card.first.COLOURS.
• Metode pada model, sesuatu seperti def colours ['white',...] end- masalah yang sama.
• Metode di application_helper.rb - inilah yang saya lakukan sejauh ini, tetapi pembantu hanya dapat diakses dalam tampilan, bukan dalam model
• Saya pikir saya mungkin telah mencoba sesuatu di application.rb atau environment.rb, tetapi itu sepertinya tidak benar (dan mereka juga tidak berfungsi)

Apakah tidak ada cara untuk mendefinisikan sesuatu yang dapat diakses baik dari model maupun dari tampilan? Maksud saya, saya tahu model dan tampilan harus terpisah, tetapi pasti di beberapa domain akan ada saatnya mereka perlu merujuk ke pengetahuan khusus domain yang sama?

Jika model Anda benar-benar "bertanggung jawab" untuk konstanta, Anda harus menempelkannya di sana. Anda bisa membuat metode kelas untuk mengaksesnya tanpa membuat instance objek baru:

class Card < ActiveRecord::Base
  def self.colours
    ['white', 'blue']
  end
end

# accessible like this
Card.colours

Atau, Anda bisa membuat variabel kelas dan accessor. Namun ini tidak dianjurkan karena variabel kelas mungkin bertindak agak mengejutkan dengan pewarisan dan dalam lingkungan multi-utas.

class Card < ActiveRecord::Base
  @@colours = ['white', 'blue']
  cattr_reader :colours
end

# accessible the same as above

Dua opsi di atas memungkinkan Anda untuk mengubah array yang dikembalikan pada setiap pemanggilan metode accessor jika diperlukan. Jika Anda memiliki konstanta yang benar-benar tidak dapat diubah, Anda juga dapat mendefinisikannya pada kelas model:

class Card < ActiveRecord::Base
  COLOURS = ['white', 'blue'].freeze
end

# accessible as
Card::COLOURS

Anda juga bisa membuat konstanta global yang dapat diakses dari mana saja di penginisialisasi seperti pada contoh berikut. Ini mungkin tempat terbaik, jika warna Anda benar-benar global dan digunakan dalam lebih dari satu konteks model.

# put this into config/initializers/my_constants.rb
COLOURS = ['white', 'blue'].freeze

Catatan: ketika kita mendefinisikan konstanta di atas, seringkali kita ingin freezearray. Itu mencegah kode lain dari nanti (secara tidak sengaja) memodifikasi array dengan misalnya menambahkan elemen baru. Setelah suatu objek dibekukan, itu tidak dapat diubah lagi.

Beberapa opsi:

Menggunakan konstanta:

class Card
  COLOURS = ['white', 'blue', 'black', 'red', 'green', 'yellow'].freeze
end

Malas dimuat menggunakan variabel instance kelas:

class Card
  def self.colours
    @colours ||= ['white', 'blue', 'black', 'red', 'green', 'yellow'].freeze
  end
end

Jika itu adalah konstanta yang benar-benar global ( hindari konstanta global seperti ini ), Anda juga dapat mempertimbangkan untuk memasukkan konstanta tingkat config/initializers/my_constants.rbatas sebagai contoh.

Pada Rails 4.2, Anda dapat menggunakan config.xproperti:

# config/application.rb (or config/custom.rb if you prefer)
config.x.colours.options = %w[white blue black red green]
config.x.colours.default = 'white'

Yang akan tersedia sebagai:

Rails.configuration.x.colours.options
# => ["white", "blue", "black", "red", "green"]
Rails.configuration.x.colours.default
# => "white"

Metode lain pemuatan konfigurasi khusus:

# config/colours.yml
default: &default
  options:
    - white
    - blue
    - black
    - red
    - green
  default: white
development:
  *default
production:
  *default

# config/application.rb
config.colours = config_for(:colours)

Rails.configuration.colours
# => {"options"=>["white", "blue", "black", "red", "green"], "default"=>"white"}
Rails.configuration.colours['default']
# => "white"

Dalam Rails 5 & 6 , Anda dapat menggunakan configurationobjek langsung untuk konfigurasi kustom, selain config.x. Namun, itu hanya dapat digunakan untuk konfigurasi non-bersarang:

# config/application.rb
config.colours = %w[white blue black red green]

Ini akan tersedia sebagai:

Rails.configuration.colours
# => ["white", "blue", "black", "red", "green"]

Jika sebuah konstanta diperlukan di lebih dari satu kelas, saya memasukkannya ke config / initializers / contant.rb selalu dalam semua huruf besar (daftar negara di bawah ini terpotong).

STATES = ['AK', 'AL', ... 'WI', 'WV', 'WY']

Mereka tersedia di seluruh aplikasi kecuali dalam kode model seperti:

    <%= form.label :states, %>
    <%= form.select :states, STATES, {} %>

Untuk menggunakan konstanta dalam model, gunakan attr_accessor untuk membuat konstanta tersedia.

class Customer < ActiveRecord::Base
    attr_accessor :STATES

    validates :state, inclusion: {in: STATES, message: "-- choose a State from the drop down list."}
end

Untuk pengaturan di seluruh aplikasi dan untuk konstanta global, saya sarankan untuk menggunakan Settingslogic . Pengaturan ini disimpan dalam file YML dan dapat diakses dari model, tampilan, dan pengontrol. Selain itu, Anda dapat membuat pengaturan berbeda untuk semua lingkungan Anda:

  # app/config/application.yml
  defaults: &defaults
    cool:
      sweet: nested settings
    neat_setting: 24
    awesome_setting: <%= "Did you know 5 + 5 = #{5 + 5}?" %>

    colors: "white blue black red green"

  development:
    <<: *defaults
    neat_setting: 800

  test:
    <<: *defaults

  production:
    <<: *defaults

Di suatu tempat dalam pandangan (saya lebih suka metode pembantu untuk hal-hal semacam itu) atau dalam model Anda bisa mendapatkan, misalnya, berbagai warna Settings.colors.split(/\s/). Ini sangat fleksibel. Dan Anda tidak perlu menciptakan sepeda.

Gunakan metode kelas:

def self.colours
  ['white', 'red', 'black']
end

Kemudian Model.coloursakan mengembalikan array itu. Atau, buat penginisialisasi dan bungkus konstanta dalam modul untuk menghindari konflik namespace.

Cobalah untuk menjaga semua konstan di satu tempat, Dalam aplikasi saya, saya telah membuat folder konstanta di dalam inisialisasi sebagai berikut:

dan saya biasanya menjaga semua konstan dalam file ini.

Dalam kasus Anda, Anda dapat membuat file di bawah folder konstanta sebagai colors_constant.rb

colors_constant.rb

Jangan lupa me-restart server

Opsi lain, jika Anda ingin mendefinisikan konstanta di satu tempat:

module DSL
  module Constants
    MY_CONSTANT = 1
  end
end

Tetapi tetap membuatnya terlihat secara global tanpa harus mengaksesnya dengan cara yang sepenuhnya memenuhi syarat:

DSL::Constants::MY_CONSTANT # => 1
MY_CONSTANT # => NameError: uninitialized constant MY_CONSTANT
Object.instance_eval { include DSL::Constants }
MY_CONSTANT # => 1

Tempat umum untuk meletakkan konstanta global aplikasi-lebar ada di dalamnya config/application.

module MyApp
  FOO ||= ENV.fetch('FOO', nil)
  BAR ||= %w(one two three)

  class Application < Rails::Application
    config.foo_bar = :baz
  end
end

Saya biasanya memiliki model / tabel 'pencarian' dalam program rel saya dan menggunakannya untuk konstanta. Ini sangat berguna jika konstanta akan berbeda untuk lingkungan yang berbeda. Selain itu, jika Anda memiliki rencana untuk memperpanjangnya, katakan Anda ingin menambahkan 'kuning' di kemudian hari, Anda bisa menambahkan baris baru ke tabel pencarian dan selesai dengan itu.

Jika Anda memberikan izin admin untuk memodifikasi tabel ini, mereka tidak akan datang kepada Anda untuk pemeliharaan. :) KERING.

Begini tampilannya kode migrasi saya:

class CreateLookups < ActiveRecord::Migration
  def change
    create_table :lookups do |t|
      t.string :group_key
      t.string :lookup_key
      t.string :lookup_value
      t.timestamps
    end
  end
end

Saya menggunakan seed.rb untuk mengisinya terlebih dahulu.

Lookup.find_or_create_by_group_key_and_lookup_key_and_lookup_value!(group_key: 'development_COLORS', lookup_key: 'color1', lookup_value: 'red');

Variabel global harus dinyatakan dalam config/initializersdirektori

COLOURS = %w(white blue black red green)

Menurut kondisi Anda, Anda juga dapat mendefinisikan beberapa variabel lingkungan, dan mengambilnya melalui ENV['some-var']kode ruby, solusi ini mungkin tidak cocok untuk Anda, tetapi saya harap ini dapat membantu orang lain.

Contoh: Anda dapat membuat file yang berbeda .development_env, .production_env, .test_envdan beban itu sesuai lingkungan aplikasi Anda, periksa ini gen dotenv-rel yang mengotomatisasi ini untuk Anda.