rails-settings-cached 2.3.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9fb44e09bad24a4d3c6cf36fda107fe18ce214964b713de318e5f3efc083851
-  data.tar.gz: 75ee5df473cff1fc07b963b6441152f559de8d0a5652267530c5c0f62cac93f9
+  metadata.gz: f37f8d9bad4b40dd60dbf30806e1e530e1d292448ba803db06bdcca5f562c62e
+  data.tar.gz: 2900b13077db46b60b2c22cfa3a21b7af5704b86d874d485672508c8ef866475
 SHA512:
-  metadata.gz: 6bf0b841b4b2ee46b7da5f51a54d2e3f17f984f2fe1f72841bc056966efc29fd5ad70ea54b0b5559f4ea493927ef796cbc956302b404e18ec61059c40d620904
-  data.tar.gz: 76a594a2df28a1490c6d67b1fff1a4d776572cc1240c9c07549d6d0349c048a017ee10f828d7c38e41bdf4c7158af9108f9c9181af3ee015af72654cd23831ff
+  metadata.gz: c696568044b97ce9a9112de42682a7e484e13a8220e0d7b1b52d5977f56358f82109e4bb1dd8b227f89089d060a49454b2bd1c86ac4cc7fbfc2c275bf0a48c55
+  data.tar.gz: c2eb40491e08ce8eefe6d96e6d987fd9a02efbad708e9a1ae0442d98b82e626300ee90eda5664be385aa81178c4be4a19b190d623a2ff8cdb0d8e0f8b53d0649

data/README.md

@@ -1,10 +1,10 @@
 # Rails Settings Cached
 
-This a plugin that makes managing a table of
-а global key, value pairs easy. Think of it like a global Hash stored in your database,
-that uses simple ActiveRecord like methods for manipulation. Keep track of any global
-setting that you don't want to hard code into your rails app. You can store any kind
-of object. Strings, numbers, arrays, or any object.
+The best solution for store global settings in Rails applications.
+
+This gem will managing a table of а global key, value pairs easy. Think of it like a global Hash stored in your database, that uses simple ActiveRecord like methods for manipulation. Keep track of any global setting that you don't want to hard code into your rails app.
+
+You can store any kind of object. Strings, numbers, arrays, booleans, or any object.
 
 [![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![CI Status](https://travis-ci.org/huacnlee/rails-settings-cached.svg)](http://travis-ci.org/huacnlee/rails-settings-cached) [![codecov.io](https://codecov.io/github/huacnlee/rails-settings-cached/coverage.svg?branch=master)](https://codecov.io/github/huacnlee/rails-settings-cached?branch=master)
 
@@ -30,9 +30,9 @@ You will get `app/models/setting.rb`
 ```rb
 class Setting < RailsSettings::Base
   # cache_prefix { "v1" }
-  field :app_name, default: "Rails Settings"
+  field :app_name, default: "Rails Settings", validates: { presence: true, length: { in: 2..20 } }
   field :host, default: "http://example.com", readonly: true
-  field :default_locale, default: "zh-CN"
+  field :default_locale, default: "zh-CN", validates: { presence: true, inclusion: { in: %w[zh-CN en jp] } }
   field :readonly_item, type: :integer, default: 100, readonly: true
   field :user_limits, type: :integer, default: 20
   field :exchange_rate, type: :float, default: 0.123
@@ -49,11 +49,11 @@ class Setting < RailsSettings::Base
   }
 
   # lambda default value
-  field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }
+  field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }, validates: { length: { maximum: 255 } }
 end
 ```
 
-You must use `field` method to statement the setting keys, otherwise you can't use it.
+You must use the `field` method to statement the setting keys, otherwise you can't use it.
 
 Now just put that migration in the database with:
 
@@ -126,7 +126,6 @@ irb > Setting.notification_options
 }
 ```
 
-
 ### Get defined fields
 
 > version 2.3+
@@ -151,9 +150,44 @@ Setting.get_field("app_name")
 => { key: "app_name", type: :string, default: "Rails Settings", readonly: false }
 ```
 
-## Readonly field
+## Validations
 
-Sometimes you may need to use Setting before Rails is initialized, for example `config/devise.rb`
+You can use `validates` options to special the [Rails Validation](https://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates) for fields.
+
+```rb
+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
+```
+
+Now validate will work on record save.
+
+```rb
+setting = Setting.find_or_initialize_by(var: :app_name)
+setting.value = ""
+setting.valid?
+# => false
+setting.errors.full_messages
+# => ["App name can't be blank", "App name too short (minimum is 2 characters)"]
+
+setting = Setting.find_or_initialize_by(var: :default_locale)
+setting.value = "zh-TW"
+setting.save
+# => false
+setting.errors.full_messages
+# => ["Default locale is not included in [zh-CN, en, jp]"]
+setting.value = "en"
+setting.valid?
+# => true
+```
+
+## Use Setting in Rails initializing:
+
+In `version 2.3+` you can use Setting before Rails is initialized.
+
+For example `config/initializers/devise.rb`
 
 ```rb
 Devise.setup do |config|
@@ -163,17 +197,53 @@ Devise.setup do |config|
 end
 ```
 
-In this case, you must define the `readonly` field:
+```rb
+class Setting < RailsSettings::Base
+  field :omniauth_google_client_id, default: ENV["OMNIAUTH_GOOGLE_CLIENT_ID"]
+  field :omniauth_google_client_secret, default: ENV["OMNIAUTH_GOOGLE_CLIENT_SECRET"]
+end
+```
+
+## Readonly field
+
+You may also want use Setting before Rails initialize:
+
+```
+config/environments/*.rb
+```
+
+If you want do that do that, the setting field must has `readonly: true`.
+
+For example:
 
 ```rb
 class Setting < RailsSettings::Base
-  # cache_prefix { "v1" }
-  field :omniauth_google_client_id, default: ENV["OMNIAUTH_GOOGLE_CLIENT_ID"], readonly: true
-  field :omniauth_google_client_secret, default: ENV["OMNIAUTH_GOOGLE_CLIENT_SECRET"], readonly: true
+  field :mailer_provider, default: (ENV["mailer_provider"] || "smtp"), readonly: true
+  field :mailer_options, type: :hash, readonly: true, default: {
+    address: ENV["mailer_options.address"],
+    port: ENV["mailer_options.port"],
+    domain: ENV["mailer_options.domain"],
+    user_name: ENV["mailer_options.user_name"],
+    password: ENV["mailer_options.password"],
+    authentication: ENV["mailer_options.authentication"] || "login",
+    enable_starttls_auto: ENV["mailer_options.enable_starttls_auto"]
+  }
+end
+```
+
+config/environments/production.rb
+
+```rb
+# You must require_relative directly in Rails 6.1+ in config/environments/production.rb
+require_relative "../../app/models/setting"
+
+Rails.application.configure do
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = Setting.mailer_options.deep_symbolize_keys
 end
 ```
 
-### Caching flow:
+## Caching flow:
 
 ```
 Setting.host -> Check Cache -> Exist - Get value of key for cache -> Return
@@ -183,7 +253,7 @@ Setting.host -> Check Cache -> Exist - Get value of key for cache -> Return
                 Return default value or nil
 ```
 
-In each Setting keys call, we will load the cache/db and save in [RequestStore](https://github.com/steveklabnik/request_store) to avoid hit cache/db.
+In each Setting keys call, we will load the cache/db and save in [ActiveSupport::CurrentAttributes](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) to avoid hit cache/db.
 
 Each key update will expire the cache, so do not add some frequent update key.
 
@@ -208,7 +278,7 @@ class ActiveSupport::TestCase
 end
 ```
 
------
+---
 
 ## How to manage Settings in the admin interface?
 
@@ -222,19 +292,32 @@ namespace :admin do
 end
 ```
 
-
 app/controllers/admin/settings_controller.rb
 
 ```rb
 module Admin
   class SettingsController < ApplicationController
-    before_action :get_setting, only: [:edit, :update]
-
     def create
+      @errors = ActiveModel::Errors.new
+      setting_params.keys.each do |key|
+        next if setting_params[key].nil?
+
+        setting = Setting.new(var: key)
+        setting.value = setting_params[key].strip
+        unless setting.valid?
+          @errors.merge!(setting.errors)
+        end
+      end
+
+      if @errors.any?
+        render :new
+      end
+
       setting_params.keys.each do |key|
         Setting.send("#{key}=", setting_params[key].strip) unless setting_params[key].nil?
       end
-      redirect_to settings_path, notice: "Setting was successfully updated."
+
+      redirect_to admin_settings_path, notice: "Setting was successfully updated."
     end
 
     private
@@ -250,6 +333,16 @@ app/views/admin/settings/show.html.erb
 
 ```erb
 <%= form_for(Setting.new, url: admin_settings_path) do |f| %>
+  <% if @errors.any? %>
+    <div class="alert alert-block alert-danger">
+      <ul>
+        <% @errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
   <div class="form-group">
     <label class="control-label">Host</label>
     <%= f.text_field :host, value: Setting.host, class: "form-control", placeholder: "http://localhost"  %>
@@ -315,9 +408,11 @@ end
 - [forem/forem](https://github.com/forem/forem) - 2.x
 - [siwapp/siwapp](https://github.com/siwapp/siwapp) - 2.x
 - [aidewoode/black_candy](https://github.com/aidewoode/black_candy) - 2.x
-- [thebluedoc/bluedoc](https://github.com/thebluedoc/bluedoc/blob/master/app/models/setting.rb) - 2.x
+- [huacnlee/bluedoc](https://github.com/huacnlee/bluedoc) - 2.x
+- [getzealot/zealot](https://github.com/getzealot/zealot) - 2.x
+- [kaishuu0123/rebacklogs](https://github.com/kaishuu0123/rebacklogs) - 2.x
 - [tootsuite/mastodon](https://github.com/tootsuite/mastodon) - 0.6.x
 - [helpyio/helpy](https://github.com/helpyio/helpy) - 0.5.x
-
+- [daqing/rabel](https://github.com/daqing/rabel) - 0.4.x
 
 And more than [1K repositories](https://github.com/huacnlee/rails-settings-cached/network/dependents) used.

data/lib/rails-settings-cached.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "rails-settings/base"
+require_relative "rails-settings/request_cache"
 require_relative "rails-settings/railtie"
 require_relative "rails-settings/version"
 

data/lib/rails-settings/base.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "request_store"
-
 module RailsSettings
   class Base < ActiveRecord::Base
     class SettingNotFound < RuntimeError; end
@@ -25,12 +23,12 @@ module RailsSettings
 
     class << self
       def clear_cache
-        RequestStore.store[:rails_settings_all_settings] = nil
+        RequestCache.reset
         Rails.cache.delete(cache_key)
       end
 
       def field(key, **opts)
-        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly], separator: opts[:separator])
+        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly], separator: opts[:separator], validates: opts[:validates])
       end
 
       def get_field(key)
@@ -61,7 +59,7 @@ module RailsSettings
 
       private
 
-      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil)
+      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil, validates: nil)
         @defined_fields ||= []
         @defined_fields << {
           key: key.to_s,
@@ -97,10 +95,19 @@ module RailsSettings
             value = send(:_convert_string_to_typeof_value, type, value, separator: separator)
 
             record.value = value
-            record.save!
+            record.save(validate: false)
 
             value
           end
+
+          if validates
+            validates[:if] = Proc.new { |item| item.var.to_s == key.to_s }
+            send(:validates, key, **validates)
+
+            define_method(:read_attribute_for_validation) do |_key|
+              self.value
+            end
+          end
         end
 
         if type == :boolean
@@ -142,23 +149,27 @@ module RailsSettings
       end
 
       def _value_of(var_name)
-        unless table_exists?
+        unless _table_exists?
           # Fallback to default value if table was not ready (before migrate)
-          puts "WARNING: table: \"#{table_name}\" does not exist, `#{name}.#{var_name}` fallback to returns the default value."
+          puts "WARNING: table: \"#{table_name}\" does not exist or not database connection, `#{name}.#{var_name}` fallback to returns the default value."
           return nil
         end
 
         _all_settings[var_name.to_s]
       end
 
+      def _table_exists?
+        table_exists?
+      rescue => e
+        false
+      end
+
       def rails_initialized?
         Rails.application&.initialized?
       end
 
       def _all_settings
-        raise "You cannot use settings before Rails initialize." unless rails_initialized?
-
-        RequestStore.store[:rails_settings_all_settings] ||= begin
+        RequestCache.settings ||= begin
           Rails.cache.fetch(cache_key, expires_in: 1.week) do
             vars = unscoped.select("var, value")
             result = {}

data/lib/rails-settings/request_cache.rb

@@ -0,0 +1,30 @@
+module RailsSettings
+  if defined? ActiveSupport::CurrentAttributes 
+    # For storage all settings in Current, it will reset after per request completed.
+    # Base on ActiveSupport::CurrentAttributes
+    # https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html
+    class RequestCache < ActiveSupport::CurrentAttributes 
+      attribute :settings
+    end
+  else
+    # https://github.com/steveklabnik/request_store
+    # For Rails 5.0
+    require "request_store"
+
+    class RequestCache
+      class << self
+        def reset
+          self.settings = nil
+        end
+
+        def settings
+          RequestStore.store[:rails_settings_all_settings]
+        end
+
+        def settings=(val)
+          RequestStore.store[:rails_settings_all_settings]
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.3.3"
+      "2.5.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,22 +16,22 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,11 +108,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n  This is improved from rails-settings, added caching.\n  Settings
-  plugin for Rails that makes managing a table of global key,\n  value pairs easy.
-  Think of it like a global Hash stored in you database,\n  that uses simple ActiveRecord
-  like methods for manipulation.\n\n  Keep track of any global setting that you dont
-  want to hard code into your rails app.\n  You can store any kind of object.  Strings,
+description: "\n  The best solution for store global settings in Rails applications.\n\n
+  \ This gem will managing a table of а global key, value pairs easy. Think of it
+  like a \n  global Hash stored in your database, that uses simple ActiveRecord like
+  methods for manipulation.\n\n  Keep track of any global setting that you dont want
+  to hard code into your rails app.\n  You can store any kind of object.  Strings,
   numbers, arrays, or any object.\n  "
 email: huacnlee@gmail.com
 executables: []
@@ -128,6 +128,7 @@ files:
 - lib/rails-settings-cached.rb
 - lib/rails-settings/base.rb
 - lib/rails-settings/railtie.rb
+- lib/rails-settings/request_cache.rb
 - lib/rails-settings/version.rb
 homepage: https://github.com/huacnlee/rails-settings-cached
 licenses:
@@ -148,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
-summary: Settings plugin for Rails that makes managing a table of global keys.
+summary: The best solution for store global settings in Rails applications.
 test_files: []