rails-settings-cached 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a7bc508cf14fd62288de455806b11c39f5894fc0830ea89523e9a4f9ca3d09b
-  data.tar.gz: 9d4affefb02823cf0a73344c7356f2e416d6cb6fb78dc0e25ad94a21cb4b1646
+  metadata.gz: 603b7101883a17d76bfb33682ce421b7259101bfc7d3b0fea450d02466adcb03
+  data.tar.gz: '088348b905fba8727569b052468ca194c74fcde740976e0d4cfe6b780063144f'
 SHA512:
-  metadata.gz: c023a86676cd5f41c5479e8c671df1946076de4167f8fe40c437e69d69e27d1d46a5d5e5a97ad35f950f6b477a0c14ab6de0c4e4fbd3210df46d0c091ac6c312
-  data.tar.gz: 16ed2df3231c5379847c25c97f3950a8692ce51a36d5b1ffc7e1973a11786de820f8264e628f3f7df5e6689018a91e3849a4749c5757eb7f1b076a5b041f538b
+  metadata.gz: eeaed942036ec6c70fbd0f8a687000032e87cbef17324eca6329c32e1f7b69b6f38a7d295ec00441ec1fd1601f53c8cbe162df33e0f5d4f518658f6cb3236835
+  data.tar.gz: 13f87d6cac9234fcf48b50b3e67723aac4977d4a9e8fb71528bf8d12fd29eb27372d9b5705a496f694550ad988dba613f9dc3bf069fa699a910ebd1f4c5b8506

data/README.md

@@ -126,7 +126,6 @@ irb > Setting.notification_options
 }
 ```
 
-
 ### Get defined fields
 
 > version 2.3+
@@ -151,9 +150,11 @@ Setting.get_field("app_name")
 => { key: "app_name", type: :string, default: "Rails Settings", readonly: false }
 ```
 
-## Readonly field
+## Use Setting in Rails initializing:
 
-Sometimes you may need to use Setting before Rails is initialized, for example `config/devise.rb`
+In `version 2.3+` we allows you to use Setting before Rails is initialized.
+
+For example `config/initializers/devise.rb`
 
 ```rb
 Devise.setup do |config|
@@ -163,17 +164,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
 ```
 
-### Caching flow:
+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:
 
 ```
 Setting.host -> Check Cache -> Exist - Get value of key for cache -> Return
@@ -183,7 +220,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 +245,7 @@ class ActiveSupport::TestCase
 end
 ```
 
------
+---
 
 ## How to manage Settings in the admin interface?
 
@@ -222,19 +259,16 @@ 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
       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
@@ -319,5 +353,4 @@ end
 - [tootsuite/mastodon](https://github.com/tootsuite/mastodon) - 0.6.x
 - [helpyio/helpy](https://github.com/helpyio/helpy) - 0.5.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_store"
 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,7 +23,7 @@ module RailsSettings
 
     class << self
       def clear_cache
-        RequestStore.store[:rails_settings_all_settings] = nil
+        RequestStore.reset
         Rails.cache.delete(cache_key)
       end
 
@@ -121,15 +119,15 @@ module RailsSettings
         when :hash
           value = begin
                     begin
-                                          YAML.load(value).to_h
+                      YAML.load(value).to_h
                     rescue StandardError
                       eval(value).to_h
-                                        end
+                    end
                   rescue StandardError
                     {}
                   end
           value.deep_stringify_keys!
-          value
+          ActiveSupport::HashWithIndifferentAccess.new(value)
         when :integer
           value.to_i
         when :float
@@ -142,19 +140,27 @@ module RailsSettings
       end
 
       def _value_of(var_name)
-        raise "#{table_name} does not exist." 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 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
+        RequestStore.settings ||= begin
           Rails.cache.fetch(cache_key, expires_in: 1.week) do
             vars = unscoped.select("var, value")
             result = {}

data/lib/rails-settings/request_store.rb

@@ -0,0 +1,8 @@
+module RailsSettings
+  # 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 RequestStore < ActiveSupport::CurrentAttributes 
+    attribute :settings
+  end
+end

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.3.1"
+      "2.4.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.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.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:
     - - ">="
@@ -128,6 +128,7 @@ files:
 - lib/rails-settings-cached.rb
 - lib/rails-settings/base.rb
 - lib/rails-settings/railtie.rb
+- lib/rails-settings/request_store.rb
 - lib/rails-settings/version.rb
 homepage: https://github.com/huacnlee/rails-settings-cached
 licenses:
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Settings plugin for Rails that makes managing a table of global keys.