version 2.9.0

huacnlee · May 29, 2023 · 8dc786f · 8dc786f
1 parent bbb7a67
commit 8dc786f
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 9 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-settings-cached (2.8.3)
+    rails-settings-cached (2.9.0)
       activerecord (>= 5.0.0)
       railties (>= 5.0.0)
 
@@ -48,8 +48,6 @@ GEM
     nokogiri (1.13.10)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.10-x86_64-darwin)
-      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
@@ -89,7 +87,6 @@ GEM
     ruby-progressbar (1.11.0)
     sqlite3 (1.5.4)
       mini_portile2 (~> 2.8.0)
-    sqlite3 (1.5.4-x86_64-darwin)
     thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)

diff --git a/README.md b/README.md
@@ -161,6 +161,55 @@ Setting.get_field("default_locale")[:options]
 => { option_values: %w[en zh-CN jp], help_text: "Bla bla ..." }
 ```
 
+### Custom type for setting
+
+> Since: 2.9.0
+
+You can write your custom field type by under `RailsSettings::Fields` module.
+
+#### For example
+
+```rb
+module RailsSettings
+  module Fields
+    class YesNo < ::RailsSettings::Fields::Base
+      def serialize(value)
+        case value
+        when true then "YES"
+        when false then "NO"
+        else raise StandardError, 'invalid value'
+        end
+      end
+
+      def deserialize(value)
+        case value
+        when "YES" then true
+        when "NO" then false
+        else nil
+        end
+      end
+    end
+  end
+end
+```
+
+Now you can use `yes_no` type in you setting:
+
+```rb
+class Setting
+  field :custom_item, type: :yes_no, default: 'YES'
+end
+```
+
+```rb
+irb> Setting.custom_item = 'YES'
+irb> Setting.custom_item
+true
+irb> Setting.custom_item = 'NO'
+irb> Setting.custom_item
+false
+```
+
 #### Get All defined fields
 
 > version 2.7.0+

diff --git a/lib/rails-settings/base.rb b/lib/rails-settings/base.rb
@@ -96,10 +96,9 @@ def _define_field(key, default: nil, type: :string, readonly: false, separator:
         @defined_fields ||= []
         @defined_fields << field
 
-        if readonly
-          define_singleton_method(key) { field.read }
-        else
-          define_singleton_method(key) { field.read }
+        define_singleton_method(key) { field.read }
+
+        unless readonly
           define_singleton_method("#{key}=") { |value| field.save!(value: value) }
 
           if validates

diff --git a/lib/rails-settings/version.rb b/lib/rails-settings/version.rb
@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.8.3"
+      "2.9.0"
     end
   end
 end