Ruby on Rails: Де визначити глобальні константи?

Я тільки починаю свій перший Ruby on Rails webapp. У мене є купа різних моделей, поглядів, контролерів тощо.

Я хочу знайти гарне місце, щоб дотримуватися визначень справді глобальних констант, які застосовуються у всьому моєму додатку. Зокрема, вони застосовуються як у логіці моїх моделей, так і в рішеннях, прийнятих на мою думку. Я не можу знайти жодного місця, де можна поставити ці визначення, де вони доступні як для всіх моїх моделей, так і для всіх моїх поглядів.

Щоб взяти конкретний приклад, я хочу константу COLOURS = ['white', 'blue', 'black', 'red', 'green']. Це використовується повсюдно, як у моделях, так і у видах. Де я можу визначити його лише в одному місці, щоб воно було доступним?

Що я спробував:

• Постійні змінні класу у файлі model.rb, з якими вони найбільше пов'язані, наприклад @@COLOURS = [...]. Але я не міг знайти розумного способу визначити це, щоб я міг писати в своїх поглядах, Card.COLOURSа не щось подібне Card.first.COLOURS.
• Метод на моделі, щось на зразок def colours ['white',...] end- та сама проблема.
• Метод у application_helper.rb - це те, що я зараз роблю, але помічники доступні лише в представленнях, а не в моделях
• Я думаю, що, можливо, я щось спробував у application.rb або environment.rb, але це насправді не здається правильним (і, здається, не працює)

Чи просто немає способу визначити доступне як для моделей, так і для видань? Я маю на увазі, я знаю, що моделі та погляди повинні бути окремими, але, безумовно, в деяких областях буде час, коли вони повинні звернутися до тих же знань, що стосуються конкретного домену?

Якщо ваша модель справді "відповідає" за константи, слід вставити їх туди. Ви можете створити методи класу для доступу до них без створення нового примірника об'єкта:

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

# accessible like this
Card.colours

Крім того, ви можете створити змінні класу та аксесуар. Це, однак, не перешкоджає тому, що змінні класу можуть спричинити дивовижне наслідування і в багатопотокових середовищах.

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

# accessible the same as above

Два вищезазначені параметри дозволяють змінювати повернутий масив на кожному виклику методу accessor, якщо потрібно. Якщо у вас справді незмінна константа, ви також можете визначити її в класі моделі:

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

# accessible as
Card::COLOURS

Ви також можете створити глобальні константи, доступні з будь-якого місця в ініціалізаторі, як у наступному прикладі. Це, мабуть, найкраще місце, якщо ваші кольори справді глобальні та використовуються в більш ніж одному модельному контексті.

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

Примітка. Коли ми визначаємо константи вище, часто ми хочемо до freezeмасиву. Це заважає іншому коду пізніше (ненавмисно) змінювати масив, наприклад, додаючи новий елемент. Щойно об’єкт заморожений, його більше неможливо змінити.

Деякі варіанти:

Використання константи:

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

Ледачий завантажений за допомогою змінної примірника класу:

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

Якщо це дійсно глобальна константа ( однак уникайте глобальних констант подібного характеру ), ви також можете розглянути можливість прикладання константи верхнього рівня config/initializers/my_constants.rb.

З Rails 4.2 ви можете скористатись config.xвластивістю:

# 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'

Які будуть доступні як:

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

Ще один спосіб завантаження користувальницької конфігурації:

# 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"

У Rails 5 і 6 ви можете використовувати configurationоб'єкт безпосередньо для спеціальної конфігурації, на додаток до config.x. Однак його можна використовувати лише для вкладеної конфігурації:

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

Він буде доступний як:

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

Якщо константа потрібна для більш ніж одного класу, я розміщую її у config / inicijalizers / contant.rb завжди у всіх кришках (список станів нижче урізаний).

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

Вони доступні через додаток, за винятком типового коду моделі:

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

Щоб використовувати константу в моделі, використовуйте attr_accessor, щоб зробити константу доступною.

class Customer < ActiveRecord::Base
    attr_accessor :STATES

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

Для налаштувань для загальної програми та глобальних констант рекомендую використовувати Settingslogic . Ці параметри зберігаються у файлі YML і до них можна отримати доступ із моделей, представлень даних та контролерів. Крім того, ви можете створити різні налаштування для всіх середовищ:

  # 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

Десь у полі зору (я віддаю перевагу допоміжним методам для подібних матеріалів) або в моделі, яку ви можете отримати, наприклад, масив кольорів Settings.colors.split(/\s/). Це дуже гнучко. І не потрібно вигадувати велосипед.

Використовуйте метод класу:

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

Потім Model.coloursповерне цей масив. Крім того, створіть ініціалізатор і загортайте константи в модуль, щоб уникнути конфліктів у просторі імен.

Постарайтеся зберегти все постійне в одному місці. У своїй програмі я створив папку констант всередині ініціалізаторів:

і зазвичай я постійно зберігаю все в цих файлах.

У вашому випадку ви можете створити файл у папці констант як colors_constant.rb

color_constant.rb

Не забудьте перезапустити сервер

Ще один варіант, якщо ви хочете визначити свої константи в одному місці:

module DSL
  module Constants
    MY_CONSTANT = 1
  end
end

Але все-таки зробіть їх глобально видимими без необхідності доступу до них:

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

Загальне місце для розміщення глобальних констант, що мають широке застосування, знаходиться всередині config/application.

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

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

У моїй програмі рейок я зазвичай маю модель "пошуку" і використовую її для констант. Це дуже корисно, якщо константи будуть різними для різних середовищ. Крім того, якщо у вас є план їх розширення, скажімо, ви хочете додати "жовтий" пізніше, ви можете просто додати новий рядок до таблиці пошуку і зробити це з ним.

Якщо ви дасте адміністратору дозволи на зміни цієї таблиці, вони не прийдуть до вас для обслуговування. :) СУХА.

Ось як виглядає міграційний код:

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

Я використовую seed.rb для попереднього заселення.

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

Глобальна змінна повинна бути оголошена в config/initializersкаталозі

COLOURS = %w(white blue black red green)

Відповідно до вашої умови, ви також можете визначити деякі змінні середовища та отримати їх за допомогою ENV['some-var']рубінового коду, це рішення може не підійти вам, але я сподіваюся, що може допомогти іншим.

Приклад: ви можете створювати різні файли .development_env, .production_env, .test_envі завантажити його в відповідно ваші середовища додатків, перевірити це генераторну dotenv-рейки , які автоматизують це для вашого.