rails-settings-cached 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a035f272fc7a299f74e25017cd4d1d453bc5b45c79a4ba0fd68555249087e5
-  data.tar.gz: 91b56df8857355fbd0bcc9178eda065714ab5da4bf9436dde4a8a340bde2809b
+  metadata.gz: 4a7bc508cf14fd62288de455806b11c39f5894fc0830ea89523e9a4f9ca3d09b
+  data.tar.gz: 9d4affefb02823cf0a73344c7356f2e416d6cb6fb78dc0e25ad94a21cb4b1646
 SHA512:
-  metadata.gz: cc1e140b6ec1e2f0ed687de9a699d8bb1a87a41048784928b79b419623c19263c7aecf7d199c752e2ca5d3bfdc9de063e825032d3787ced6b9297ebaa2852275
-  data.tar.gz: 88dafb8efac6cb93566aa6dbded820723afd539a7ab24b96421d51cf5fda7afe268eae3fca10ec4645a571507ce10bcfae2f6ff749f94b2a08e722798e12b021
+  metadata.gz: c023a86676cd5f41c5479e8c671df1946076de4167f8fe40c437e69d69e27d1d46a5d5e5a97ad35f950f6b477a0c14ab6de0c4e4fbd3210df46d0c091ac6c312
+  data.tar.gz: 16ed2df3231c5379847c25c97f3950a8692ce51a36d5b1ffc7e1973a11786de820f8264e628f3f7df5e6689018a91e3849a4749c5757eb7f1b076a5b041f538b

data/README.md

@@ -30,8 +30,8 @@ You will get `app/models/setting.rb`
 ```rb
 class Setting < RailsSettings::Base
   # cache_prefix { "v1" }
-  field :app_name, default: "Rails Settings Cache Demo"
-  field :host, default: "http://example.com"
+  field :app_name, default: "Rails Settings"
+  field :host, default: "http://example.com", readonly: true
   field :default_locale, default: "zh-CN"
   field :readonly_item, type: :integer, default: 100, readonly: true
   field :user_limits, type: :integer, default: 20
@@ -68,9 +68,11 @@ The syntax is easy. First, let's create some settings to keep track of:
 ```ruby
 irb > Setting.host
 "http://example.com"
-irb > Setting.host = "https://your-host.com"
-irb > Setting.host
-"https://your-host.com"
+irb > Setting.app_name
+"Rails Settings"
+irb > Setting.app_name = "Rails Settings Cached"
+irb > Setting.app_name
+"Rails Settings Cached"
 
 irb > Setting.user_limits
 20
@@ -124,6 +126,31 @@ irb > Setting.notification_options
 }
 ```
 
+
+### Get defined fields
+
+> version 2.3+
+
+```rb
+# Get all keys
+Setting.keys
+=> ["app_name", "host", "default_locale", "readonly_item"]
+
+# Get editable keys
+Settng.editable_keys
+=> ["app_name", "default_locale"]
+
+# Get readonly keys
+Setting.readonly_keys
+=> ["host", "readonly_item"]
+
+# Get options of field
+Setting.get_field("host")
+=> { 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 }
+```
+
 ## Readonly field
 
 Sometimes you may need to use Setting before Rails is initialized, for example `config/devise.rb`

data/lib/rails-settings/base.rb

@@ -30,18 +30,13 @@ module RailsSettings
       end
 
       def field(key, **opts)
-        @keys ||= []
-        @readonly_keys ||= []
-        @editable_keys ||= []
-        @keys << key.to_s
-        if opts[:readonly]
-          @readonly_keys << key.to_s
-        else
-          @editable_keys << key.to_s
-        end
         _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly], separator: opts[:separator])
       end
 
+      def get_field(key)
+        @defined_fields.find { |field| field[:key] == key.to_s } || {}
+      end
+
       def cache_prefix(&block)
         @cache_prefix = block
       end
@@ -52,13 +47,29 @@ module RailsSettings
         scope.join("/")
       end
 
-      attr_reader :keys
-      attr_reader :readonly_keys
-      attr_reader :editable_keys
+      def keys
+        @defined_fields.map { |field| field[:key] }
+      end
+
+      def editable_keys
+        @defined_fields.reject { |field| field[:readonly] }.map { |field| field[:key] }
+      end
+
+      def readonly_keys
+        @defined_fields.select { |field| field[:readonly] }.map { |field| field[:key] }
+      end
 
       private
 
       def _define_field(key, default: nil, type: :string, readonly: false, separator: nil)
+        @defined_fields ||= []
+        @defined_fields << {
+          key: key.to_s,
+          default: default,
+          type: type || :string,
+          readonly: readonly.nil? ? false : readonly
+        }
+
         if readonly
           define_singleton_method(key) do
             send(:_convert_string_to_typeof_value, type, default, separator: separator)

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.3.0"
+      "2.3.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Jason Lee