rails-settings-cached 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659ee746f1a087bb3ee48bba9f72a3dfd6af920830c6b003fd3bd909dce0a3c9
-  data.tar.gz: bb07a004ae0bbe413df58a0e2fd72fa7940cf5c55661c30214161745ebc5accc
+  metadata.gz: d45081eacc51de459cd0bc48469430474cd561386e924b40996bd5f66c1299e5
+  data.tar.gz: 485e2df525a6d3b66dfed0c0b5935aa8134b13ae0b0528d1fae536e5b19e4ae2
 SHA512:
-  metadata.gz: 2cbd53148b2110e12e8280a34691e9c08fb1e0805d2cc3ce8a4d25bbb477339e0116d508bac3bfb988bd96ffd3c173838475b5c85bb4659644b275585870198f
-  data.tar.gz: afe704c8920d76f70795ad55ac17a5ccbfa9807abe9903090fa797b1eb9a7ac4c5564b0a817ccca329b57704eebd3d688ad347c1f6afce58b4fbb58e20a029a1
+  metadata.gz: 6651da35fec5737f76192ec01f0980ea45a85c69efb768c22edbce29b490f29dfa2498798b5af6d45a126955a3fe72bf2fa1ae76bd249237b83f408f7bba72c4
+  data.tar.gz: b96670e501b9c5aff237b02fd2da2560b654dd2835322b2e64e28679e3edf646ee940f2f2ffe69bfa7d851732ac4844bb47b01e292f4ef4b5f04e587977f8c21

data/README.md

@@ -30,26 +30,32 @@ 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]
+    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, group: :limits
+  end
 
   field :notification_options, type: :hash, default: {
     send_all: true,
     logging: true,
     sender_email: "foo@bar.com"
-  }
+  }, group: :advanced
 
-  # 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
 ```
 
@@ -145,9 +151,24 @@ Setting.readonly_keys
 
 # Get options of 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 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

data/lib/rails-settings/base.rb

@@ -34,8 +34,13 @@ 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
+
+      def scope(name)
+        @scope = name.to_sym
+        yield
+        @scope = nil
       end
 
       def get_field(key)
@@ -47,9 +52,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 +69,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

data/lib/rails-settings/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails