rails-settings-cached 2.7.0 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d45081eacc51de459cd0bc48469430474cd561386e924b40996bd5f66c1299e5
-  data.tar.gz: 485e2df525a6d3b66dfed0c0b5935aa8134b13ae0b0528d1fae536e5b19e4ae2
+  metadata.gz: 2cdcbd12a2a3eb29491036b8c865a18bd098174324981e85498217bc708d2770
+  data.tar.gz: 6abfb107f6453ad4d221c6accc4a5c04a78da731cdb39cef1a4fc72149d5e63a
 SHA512:
-  metadata.gz: 6651da35fec5737f76192ec01f0980ea45a85c69efb768c22edbce29b490f29dfa2498798b5af6d45a126955a3fe72bf2fa1ae76bd249237b83f408f7bba72c4
-  data.tar.gz: b96670e501b9c5aff237b02fd2da2560b654dd2835322b2e64e28679e3edf646ee940f2f2ffe69bfa7d851732ac4844bb47b01e292f4ef4b5f04e587977f8c21
+  metadata.gz: 4c7acbc5ff62818c2b526301748019926c33611db3ee8b77a7b6d4d14b582874483cd401eadffc9580083f8c4bcf363893851e4a1b6eeb90ddb0266b7b52f2ab
+  data.tar.gz: 5a31aed5bcda620d0540e8c0f90afbdfdfdb4f1504fd1677916f1437d94719fb856cab7159d6ccad20ec4dd871e6c7e21ec66c6de039035ace56492ab9443af3

data/README.md

@@ -2,11 +2,9 @@
 
 The best solution for store global settings in Rails applications.
 
-This gem will make 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.
+This gem will make 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 application.
 
-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) [![build](https://github.com/huacnlee/rails-settings-cached/workflows/build/badge.svg)](https://github.com/huacnlee/rails-settings-cached/actions?query=workflow%3Abuild) [![codecov.io](https://codecov.io/github/huacnlee/rails-settings-cached/coverage.svg?branch=master)](https://codecov.io/github/huacnlee/rails-settings-cached?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![build](https://github.com/huacnlee/rails-settings-cached/workflows/build/badge.svg)](https://github.com/huacnlee/rails-settings-cached/actions?query=workflow%3Abuild)
 
 ## Installation
 
@@ -34,7 +32,7 @@ class Setting < RailsSettings::Base
   scope :application do
     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", validates: { presence: true, inclusion: { in: %w[zh-CN en jp] } }, option_values: %w[en zh-CN]
+    field :default_locale, default: "zh-CN", validates: { presence: true, inclusion: { in: %w[zh-CN en jp] } }, option_values: %w[en zh-CN jp], help_text: "Bla bla ..."
     field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
 
     # lambda default value
@@ -46,14 +44,14 @@ class Setting < RailsSettings::Base
   scope :limits do
     field :user_limits, type: :integer, default: 20
     field :exchange_rate, type: :float, default: 0.123
-    field :captcha_enable, type: :boolean, default: true, group: :limits
+    field :captcha_enable, type: :boolean, default: true
   end
 
   field :notification_options, type: :hash, default: {
     send_all: true,
     logging: true,
     sender_email: "foo@bar.com"
-  }, group: :advanced
+  }
 
   field :readonly_item, type: :integer, default: 100, readonly: true
 end
@@ -61,6 +59,8 @@ end
 
 You must use the `field` method to statement the setting keys, otherwise you can't use it.
 
+The `scope` method allows you to group the keys for admin UI.
+
 Now just put that migration in the database with:
 
 ```bash
@@ -142,20 +142,23 @@ Setting.keys
 => ["app_name", "host", "default_locale", "readonly_item"]
 
 # Get editable keys
-Settng.editable_keys
+Setting.editable_keys
 => ["app_name", "default_locale"]
 
 # Get readonly keys
 Setting.readonly_keys
 => ["host", "readonly_item"]
 
-# Get options of field
+# Get field
 Setting.get_field("host")
 => { scope: :application, key: "host", type: :string, default: "http://example.com", readonly: true }
 Setting.get_field("app_name")
 => { scope: :application, key: "app_name", type: :string, default: "Rails Settings", readonly: false }
 Setting.get_field(:user_limits)
 => { scope: :limits, key: "user_limits", type: :integer, default: 20, readonly: false }
+# Get field options
+Setting.get_field("default_locale")[:options]
+=> { option_values: %w[en zh-CN jp], help_text: "Bla bla ..." }
 ```
 
 #### Get All defined fields
@@ -278,6 +281,10 @@ Rails.application.configure do
 end
 ```
 
+TIP: You also can follow this file to rewrite ActionMailer's `mail` method for configuration Mail options from Setting after Rails booted.
+
+https://github.com/ruby-china/homeland/blob/main/app/mailers/application_mailer.rb#L19
+
 ## Caching flow:
 
 ```

data/lib/rails-settings/base.rb

@@ -15,7 +15,11 @@ module RailsSettings
     # get the value field, YAML decoded
     def value
       # rubocop:disable Security/YAMLLoad
-      YAML.load(self[:value]) if self[:value].present?
+      payload = self[:value]
+
+      if payload.present?
+        YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(payload) : YAML.load(payload)
+      end
     end
 
     # set the value field, YAML encoded
@@ -37,9 +41,16 @@ module RailsSettings
         _define_field(key, **opts)
       end
 
-      def scope(name)
+      alias_method :_rails_scope, :scope
+      def scope(*args, &block)
+        name = args.shift
+        body = args.shift
+        if body.respond_to?(:call)
+          return _rails_scope(name, body, &block)
+        end
+
         @scope = name.to_sym
-        yield
+        yield block
         @scope = nil
       end
 
@@ -193,7 +204,7 @@ module RailsSettings
       end
 
       def _all_settings
-        RequestCache.settings ||= Rails.cache.fetch(cache_key, expires_in: 1.week) do
+        RequestCache.all_settings ||= Rails.cache.fetch(cache_key, expires_in: 1.week) do
           vars = unscoped.select("var, value")
           result = {}
           vars.each { |record| result[record.var] = record.value }

data/lib/rails-settings/middleware.rb

@@ -0,0 +1,14 @@
+module RailsSettings
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      RailsSettings::RequestCache.enable!
+      result = @app.call(env)
+      RailsSettings::RequestCache.disable!
+      result
+    end
+  end
+end

data/lib/rails-settings/railtie.rb

@@ -5,5 +5,9 @@ module RailsSettings
     initializer "rails_settings.active_record.initialization" do
       RailsSettings::Base.after_commit :clear_cache, on: %i[create update destroy]
     end
+
+    initializer "rails_settings.configure_rails_initialization" do |app|
+      app.middleware.use RailsSettings::Middleware
+    end
   end
 end

data/lib/rails-settings/request_cache.rb

@@ -1,9 +1,36 @@
 module RailsSettings
+  module RequestCacheGetter
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def enable!
+        Thread.current[:rails_settings_request_cache_enable] = true
+      end
+
+      def disable!
+        Thread.current[:rails_settings_request_cache_enable] = nil
+      end
+
+      def enabled?
+        Thread.current[:rails_settings_request_cache_enable]
+      end
+
+      def all_settings
+        enabled? ? settings : nil
+      end
+
+      def all_settings=(val)
+        self.settings = val
+      end
+    end
+  end
+
   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
+      include RequestCacheGetter
       attribute :settings
     end
   else
@@ -12,6 +39,8 @@ module RailsSettings
     require "request_store"
 
     class RequestCache
+      include RequestCacheGetter
+
       class << self
         def reset
           self.settings = nil
@@ -22,7 +51,7 @@ module RailsSettings
         end
 
         def settings=(val)
-          RequestStore.store[:rails_settings_all_settings]
+          RequestStore.store[:rails_settings_all_settings] = val
         end
       end
     end

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.7.0"
+      "2.8.2"
     end
   end
 end

data/lib/rails-settings-cached.rb

@@ -2,6 +2,7 @@
 
 require_relative "rails-settings/base"
 require_relative "rails-settings/request_cache"
+require_relative "rails-settings/middleware"
 require_relative "rails-settings/railtie"
 require_relative "rails-settings/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.2
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +99,7 @@ files:
 - lib/generators/settings/templates/model.rb
 - lib/rails-settings-cached.rb
 - lib/rails-settings/base.rb
+- lib/rails-settings/middleware.rb
 - lib/rails-settings/railtie.rb
 - lib/rails-settings/request_cache.rb
 - lib/rails-settings/version.rb
@@ -134,7 +107,7 @@ homepage: https://github.com/huacnlee/rails-settings-cached
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: The best solution for store global settings in Rails applications.
 test_files: []