rails-settings-cached 2.5.3 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc604a3e9ea5a7ed498250820ca7e93ec44e38adb88380b24b0f7b2d5dc164b8
-  data.tar.gz: 9e62d3f49c59e981655a22924d2c32d346ba4618a6c98b4b8b1a0dfb6fd6db24
+  metadata.gz: 5f078f79f76ec1145cb095d269ea6a4772e8959b0eeaedec1ed607a23189fc5b
+  data.tar.gz: bd0105aebf763f4bce9041c459f6464f827ce1459ed3b83614342f1f285bfe7d
 SHA512:
-  metadata.gz: 7bfc23cb9fadddad15c1f3c341973bae5571cdb324ebb7d71f8c075c3877912d7f40b2792cbeaa582a79f22bcde166def831506c95d90444cd7193077492d4a7
-  data.tar.gz: dc55136872ad58751d08f745d93a7707e3e815f6ffc99adcc5d63b19e980594a7874c11484976b7342932ca511ace408c8d48bdd5de5666854b544d908345678
+  metadata.gz: 964dad7734883af92b76ed7e4b6729e7381f15b3e2149df7fc98e07dbf869baef1460e0f0dea6de6eb0689255a4e249d55e2afdd7fdf5f3d18b0028ac407caa3
+  data.tar.gz: a1bc23575e4790b2c707bc644fb5d522c95338320120cb1bab1b047310c868ec7922e29853d138dc137726f75bce25f518f95a5b71a146d3e4da8b613807cb5a

data/README.md

@@ -30,17 +30,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 +55,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 +151,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 +283,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

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 module RailsSettings
-  class Base < ActiveRecord::Base
-    class SettingNotFound < RuntimeError; end
+  class ProcetedKeyError < RuntimeError
+    def initialize(key)
+      super("Can't use #{key} as setting key.")
+    end
+  end
 
+  class Base < ActiveRecord::Base
     SEPARATOR_REGEXP = /[\n,;]+/
+    PROTECTED_KEYS = %w[var value]
     self.table_name = table_name_prefix + "settings"
 
     # get the value field, YAML decoded
@@ -29,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)
@@ -42,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
@@ -59,17 +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
@@ -120,6 +143,13 @@ module RailsSettings
             send(key)
           end
         end
+
+        # delegate instance get method to class for support:
+        # setting = Setting.new
+        # setting.admin_emails
+        define_method(key) do
+          self.class.public_send(key)
+        end
       end
 
       def _convert_string_to_typeof_value(type, value, separator: nil)
@@ -170,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

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.5.3"
+      "2.8.0"
     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.5.3
+  version: 2.8.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-09-14 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.