rails-settings-cached 2.6.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659ee746f1a087bb3ee48bba9f72a3dfd6af920830c6b003fd3bd909dce0a3c9
-  data.tar.gz: bb07a004ae0bbe413df58a0e2fd72fa7940cf5c55661c30214161745ebc5accc
+  metadata.gz: 0405e5cfca63f64b56ba7e95817c52803184afc191c837ef312df41e368dd9e4
+  data.tar.gz: 54a968cf325c616142394892943ffdd6a9893234acc98c381122f878696e1547
 SHA512:
-  metadata.gz: 2cbd53148b2110e12e8280a34691e9c08fb1e0805d2cc3ce8a4d25bbb477339e0116d508bac3bfb988bd96ffd3c173838475b5c85bb4659644b275585870198f
-  data.tar.gz: afe704c8920d76f70795ad55ac17a5ccbfa9807abe9903090fa797b1eb9a7ac4c5564b0a817ccca329b57704eebd3d688ad347c1f6afce58b4fbb58e20a029a1
+  metadata.gz: 171e47f07b71053d5b1218118992b3e5723f3118abe5a2b31a7b799f05354fac3e4ec28734ddf33790dead573948f2b59ff811cc0edec18ee688dedbd3d724f0
+  data.tar.gz: 5f8aa09f8980dfb7b100aaa1ac2c5fdb65185511c7fb21e96343e29b4d63280fc5e2ef1ce5a930e69dcd543ce5bd0c4bb0fb15185db72ca3c7276b09ee27bf1e

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
 
@@ -30,17 +28,24 @@ You will get `app/models/setting.rb`
 ```rb
 class Setting < RailsSettings::Base
   # cache_prefix { "v1" }
-  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] } }
-  field :readonly_item, type: :integer, default: 100, readonly: true
-  field :user_limits, type: :integer, default: 20
-  field :exchange_rate, type: :float, default: 0.123
-  field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
-  field :captcha_enable, type: :boolean, default: true
 
-  # Override array separator, default: /[\n,]/ split with \n or comma.
-  field :tips, type: :array, separator: /[\n]+/
+  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 jp], help_text: "Bla bla ..."
+    field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
+
+    # lambda default value
+    field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }, validates: { length: { maximum: 255 } }
+    # Override array separator, default: /[\n,]/ split with \n or comma.
+    field :tips, type: :array, separator: /[\n]+/
+  end
+
+  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
+  end
 
   field :notification_options, type: :hash, default: {
     send_all: true,
@@ -48,13 +53,14 @@ class Setting < RailsSettings::Base
     sender_email: "foo@bar.com"
   }
 
-  # lambda default value
-  field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }, validates: { length: { maximum: 255 } }
+  field :readonly_item, type: :integer, default: 100, readonly: true
 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
@@ -143,11 +149,29 @@ Settng.editable_keys
 Setting.readonly_keys
 => ["host", "readonly_item"]
 
-# Get options of field
+# Get field
 Setting.get_field("host")
-=> { key: "host", type: :string, default: "http://example.com", readonly: true }
+=> { scope: :application, key: "host", type: :string, default: "http://example.com", readonly: true }
 Setting.get_field("app_name")
-=> { key: "app_name", type: :string, default: "Rails Settings", readonly: false }
+=> { 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
+
+> version 2.7.0+
+
+You can use `defined_fields` method to get all defined fields in Setting.
+
+```rb
+# Get editable fields and group by scope
+editable_fields = Setting.defined_fields
+  .select { |field| !field[:readonly] }
+  .group_by { |field| field[:scope] }
 ```
 
 ## Validations
@@ -257,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

@@ -34,8 +34,20 @@ module RailsSettings
       end
 
       def field(key, **opts)
-        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly],
-                           separator: opts[:separator], validates: opts[:validates])
+        _define_field(key, **opts)
+      end
+
+      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 block
+        @scope = nil
       end
 
       def get_field(key)
@@ -47,9 +59,9 @@ module RailsSettings
       end
 
       def cache_key
-        scope = ["rails-settings-cached"]
-        scope << @cache_prefix.call if @cache_prefix
-        scope.join("/")
+        key_parts = ["rails-settings-cached"]
+        key_parts << @cache_prefix.call if @cache_prefix
+        key_parts.join("/")
       end
 
       def keys
@@ -64,19 +76,23 @@ module RailsSettings
         @defined_fields.select { |field| field[:readonly] }.map { |field| field[:key] }
       end
 
+      attr_reader :defined_fields
+
       private
 
-      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil, validates: nil)
+      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil, validates: nil, **opts)
         key = key.to_s
 
         raise ProcetedKeyError.new(key) if PROTECTED_KEYS.include?(key)
 
         @defined_fields ||= []
         @defined_fields << {
+          scope: @scope,
           key: key,
           default: default,
           type: type || :string,
-          readonly: readonly.nil? ? false : readonly
+          readonly: readonly.nil? ? false : readonly,
+          options: opts
         }
 
         if readonly
@@ -184,7 +200,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.6.0"
+      "2.8.1"
     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.6.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-09-24 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
@@ -149,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The best solution for store global settings in Rails applications.