rails-settings-cached/CHANGELOG.md

Visit:

https://github.com/huacnlee/rails-settings-cached/releases

2.6.0

• Allows call key in Setting instance to support use keys in ActionView helpers.
  • Fix #212 not can use f.select with Setting instance method.
• Brake Changes: Limit use var, value as Setting key, now will raise error.

2.5.3

• Improve implement for avoid use eval method.
• Fix #211, support Proc default value for readonly field.

2.5.2

• Avoid allocate string on get value.

2.5.1

• Do validate on directly assignment (#202)

irb> Setting.default_locale = "foo"
ActiveRecord::RecordInvalid: (Validation failed: Default locale is not included in [zh-CN, en, jp])

2.5.0

• Add validates options to special the Rails Validation for fields (#201)

class Setting < RailsSettings::Base
  # cache_prefix { "v1" }
  field :app_name, default: "Rails Settings", validates: { presence: true, length: { in: 2..20 } }
  field :default_locale, default: "zh-CN", validates: { presence: true, inclusion: { in: %w[zh-CN en jp], message: "is not included in [zh-CN, en, jp]" } }
end

2.4.1

• Fix request_cache for backward compatible with Rails 5.0.x;
• No effect for Rails 5.2+;

In Rails 5.0:

# You must add request_store dependency in to you Gemfile
gem "request_store"
gem "rails-settings-cached"

2.4.0

• Use ActiveSupport::CurrentAttributes instead of the request_store for storage request cache.
• Remove request_store dependency.

2.3.5

• Allows to use Setting without database connection, fallback to default value.

This changes is used to avoid startup errors in a database-free environment (such as assets:precompile in Docker build).

2.3.3

• Allows use setting, that if table was not ready (before migrate), print a warning and returns default value.

2.3.2

• Fix hash type with indifferent access.

Setting.smtp_settings = { foo: 1, bar: 2 }
Setting.smtp_settings[:foo]
=> 1
Setting.smtp_settings["foo"]
=> 1

2.3.1

• Add get_field method to get field option.

class Setting
  field :admin_emails, type: :array, default: "huacnlee"
end

Setting.get_field(:admin_emails)
=> { key: "admin_emails", type: :array, default: "huacnlee@gmail.com", readonly: false }

• Add editable_keys to get keys that allow to modify.
• Add readonly_keys to get readonly keys.

2.2.1

• Fix generator module name Settings conflict issue. #172

2.2.0

• Improve setting to support Float and BigDecimal.
• Add Setting.keys methods to get all keys.

2.1.0

• Fix default array separator, remove "space", now only: \n and ,.
• Add separator option for speical the separator for Array type.

For example:

  class Setting < RailsSettings::Base
    field :tips, type: :array, separator: /[\n]+/
    field :keywords, type: :array, separator: ","
  end

2.0.4

• Fix #166 avoid define method to super class.

2.0.0

🚨 BREAK CHANGES WARNING: rails-settings-cached 2.x has redesign the API, the new version will compatible with the stored setting values by older version. But you must read the README.md again, and follow guides to change your Setting model.

• New design release.
• No more scope support (RailsSettings::Extend has removed);
• No more YAML file.
• Requuire Ruby 2.5+, Rails 5.0+
• You must use field method to statement the setting keys before use.

For example:

  class Setting < RailsSettings::Base
    field :host, default: "http://example.com"
    field :readonly_item, type: :integer, default: 100, readonly: true
    field :user_limits, type: :integer, default: 1
    field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
    field :captcha_enable, type: :boolean, default: 1
    field :smtp_settings, type: :hash, default: {
      host: "foo.com",
      username: "foo@bar.com",
      password: "123456"
    }
  end

• One SQL or Cache hit in each request, even you has multiple of keys call in a page.

NOTE: This design will load all settings from db/cache in memory, so I recommend that you do not design a lot of Setting keys (below 1000 keys), and do not store large value。

Changes logs for 0.x

https://github.com/huacnlee/rails-settings-cached/blob/0.x/CHANGELOG.md