rails-settings-cached 2.8.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cdcbd12a2a3eb29491036b8c865a18bd098174324981e85498217bc708d2770
-  data.tar.gz: 6abfb107f6453ad4d221c6accc4a5c04a78da731cdb39cef1a4fc72149d5e63a
+  metadata.gz: 4f2fb5c3b8b6bd86c138a0650c9d0462df1bede6e446600d6fdfe7064c9d1d2c
+  data.tar.gz: ac5d5ab2b3f26bbdc92a3b5dbe7a879d8feb11d5a0bd664ce9e6cae87b79d336
 SHA512:
-  metadata.gz: 4c7acbc5ff62818c2b526301748019926c33611db3ee8b77a7b6d4d14b582874483cd401eadffc9580083f8c4bcf363893851e4a1b6eeb90ddb0266b7b52f2ab
-  data.tar.gz: 5a31aed5bcda620d0540e8c0f90afbdfdfdb4f1504fd1677916f1437d94719fb856cab7159d6ccad20ec4dd871e6c7e21ec66c6de039035ace56492ab9443af3
+  metadata.gz: 91aa31a22a69142164d52ee13792a6622b9a9088cd353ef9dd310919e60bbecf2be4a9c1ecd4a6729684fdd850cc1862988090143e78860ab46574d9573969b9
+  data.tar.gz: a2f5b013f134246ecb8f1a64a2ba0a3a947ae2fb6af1c06ad6b3d8f050d6de4fc05b7526fcc36ef72099095cde3975ef1e80e1fd11232dddfc1e29e5f14b5240

data/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+
@@ -454,7 +503,7 @@ end
 - [getzealot/zealot](https://github.com/getzealot/zealot) - 2.x
 - [kaishuu0123/rebacklogs](https://github.com/kaishuu0123/rebacklogs) - 2.x
 - [texterify/texterify](https://github.com/texterify/texterify) - 2.x
-- [tootsuite/mastodon](https://github.com/tootsuite/mastodon) - 0.6.x
+- [mastodon/mastodon](https://github.com/mastodon/mastodon) - 0.6.x
 - [helpyio/helpy](https://github.com/helpyio/helpy) - 0.5.x
 - [daqing/rabel](https://github.com/daqing/rabel) - 0.4.x
 

data/lib/rails-settings/base.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 module RailsSettings
-  class ProcetedKeyError < RuntimeError
+  class ProtectedKeyError < 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"
 
@@ -55,7 +54,7 @@ module RailsSettings
       end
 
       def get_field(key)
-        @defined_fields.find { |field| field[:key] == key.to_s } || {}
+        @defined_fields.find { |field| field.key == key.to_s }.to_h || {}
       end
 
       def cache_prefix(&block)
@@ -69,15 +68,15 @@ module RailsSettings
       end
 
       def keys
-        @defined_fields.map { |field| field[:key] }
+        @defined_fields.map(&:key)
       end
 
       def editable_keys
-        @defined_fields.reject { |field| field[:readonly] }.map { |field| field[:key] }
+        @defined_fields.reject(&:readonly).map(&:key)
       end
 
       def readonly_keys
-        @defined_fields.select { |field| field[:readonly] }.map { |field| field[:key] }
+        @defined_fields.select(&:readonly).map(&:key)
       end
 
       attr_reader :defined_fields
@@ -87,58 +86,25 @@ module RailsSettings
       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)
+        raise ProtectedKeyError.new(key) if PROTECTED_KEYS.include?(key)
 
+        field = ::RailsSettings::Fields::Base.generate(
+          scope: @scope, key: key, default: default,
+          type: type, readonly: readonly, options: opts,
+          separator: separator, parent: self
+        )
         @defined_fields ||= []
-        @defined_fields << {
-          scope: @scope,
-          key: key,
-          default: default,
-          type: type || :string,
-          readonly: readonly.nil? ? false : readonly,
-          options: opts
-        }
-
-        if readonly
-          define_singleton_method(key) do
-            result = default.is_a?(Proc) ? default.call : default
-            send(:_convert_string_to_typeof_value, type, result, separator: separator)
-          end
-        else
-          define_singleton_method(key) do
-            val = send(:_value_of, key)
-            result = nil
-            if !val.nil?
-              result = val
-            else
-              result = default
-              result = default.call if default.is_a?(Proc)
-            end
-
-            result = send(:_convert_string_to_typeof_value, type, result, separator: separator)
-
-            result
-          end
-
-          define_singleton_method("#{key}=") do |value|
-            var_name = key
-
-            record = find_by(var: var_name) || new(var: var_name)
-            value = send(:_convert_string_to_typeof_value, type, value, separator: separator)
+        @defined_fields << field
 
-            record.value = value
-            record.save!
+        define_singleton_method(key) { field.read }
 
-            value
-          end
+        unless readonly
+          define_singleton_method("#{key}=") { |value| field.save!(value: value) }
 
           if validates
             validates[:if] = proc { |item| item.var.to_s == key }
             send(:validates, key, **validates)
-
-            define_method(:read_attribute_for_validation) do |_key|
-              self.value
-            end
+            define_method(:read_attribute_for_validation) { |_key| self.value }
           end
         end
 
@@ -156,49 +122,6 @@ module RailsSettings
         end
       end
 
-      def _convert_string_to_typeof_value(type, value, separator: nil)
-        return value unless [String, Integer, Float, BigDecimal].include?(value.class)
-
-        case type
-        when :boolean
-          ["true", "1", 1, true].include?(value)
-        when :array
-          value.split(separator || SEPARATOR_REGEXP).reject { |str| str.empty? }.map(&:strip)
-        when :hash
-          value = begin
-            YAML.safe_load(value).to_h
-          rescue
-            {}
-          end
-          value.deep_stringify_keys!
-          ActiveSupport::HashWithIndifferentAccess.new(value)
-        when :integer
-          value.to_i
-        when :float
-          value.to_f
-        when :big_decimal
-          value.to_d
-        else
-          value
-        end
-      end
-
-      def _value_of(var_name)
-        unless _table_exists?
-          # Fallback to default value if table was not ready (before migrate)
-          puts "WARNING: table: \"#{table_name}\" does not exist or not database connection, `#{name}.#{var_name}` fallback to returns the default value."
-          return nil
-        end
-
-        _all_settings[var_name]
-      end
-
-      def _table_exists?
-        table_exists?
-      rescue
-        false
-      end
-
       def rails_initialized?
         Rails.application&.initialized?
       end

data/lib/rails-settings/fields/array.rb

@@ -0,0 +1,15 @@
+module RailsSettings
+  module Fields
+    class Array < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        return value unless value.is_a?(::String)
+
+        value.split(separator).reject(&:empty?).map(&:strip)
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/base.rb

@@ -0,0 +1,71 @@
+module RailsSettings
+  module Fields
+    class Base < Struct.new(:scope, :key, :default, :parent, :readonly, :separator, :type, :options, keyword_init: true)
+      SEPARATOR_REGEXP = /[\n,;]+/
+
+      def initialize(scope:, key:, default:, parent:, readonly:, separator:, type:, options:)
+        super
+        self.readonly = !!readonly
+        self.type ||= :string
+        self.separator ||= SEPARATOR_REGEXP
+      end
+
+      def save!(value:)
+        serialized_value = serialize(value)
+        parent_record = parent.find_by(var: key) || parent.new(var: key)
+        parent_record.value = serialized_value
+        parent_record.save!
+        parent_record.value
+      end
+
+      def saved_value
+        return parent.send(:_all_settings)[key] if table_exists?
+
+        # Fallback to default value if table was not ready (before migrate)
+        puts "WARNING: table: \"#{parent.table_name}\" does not exist or not database connection, `#{parent.name}.#{key}` fallback to returns the default value."
+        nil        
+      end
+
+      def default_value
+        default.is_a?(Proc) ? default.call : default
+      end
+
+      def read
+        return deserialize(default_value) if readonly || saved_value.nil?
+
+        deserialize(saved_value)
+      end
+
+      def deserialize(value)
+        raise NotImplementedError
+      end
+
+      def serialize(value)
+        raise NotImplementedError
+      end
+
+      def to_h
+        super.slice(:scope, :key, :default, :type, :readonly, :options)
+      end
+
+      def table_exists?
+        parent.table_exists?
+      rescue StandardError
+        false
+      end
+
+      class << self
+        def generate(**args)
+          fetch_field_class(args[:type]).new(**args)
+        end
+
+        private
+
+        def fetch_field_class(type)
+          field_class_name = type.to_s.split('_').map(&:capitalize).join('')
+          const_get("::RailsSettings::Fields::#{field_class_name}")
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/big_decimal.rb

@@ -0,0 +1,13 @@
+module RailsSettings
+  module Fields
+    class BigDecimal < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        value.to_d
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/boolean.rb

@@ -0,0 +1,13 @@
+module RailsSettings
+  module Fields
+    class Boolean < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        ["true", "1", 1, true].include?(value)
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/float.rb

@@ -0,0 +1,13 @@
+module RailsSettings
+  module Fields
+    class Float < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        value.to_f
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/hash.rb

@@ -0,0 +1,21 @@
+module RailsSettings
+  module Fields
+    class Hash < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        return value unless value.is_a?(::String)
+
+        load_value(value).deep_stringify_keys.with_indifferent_access
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+
+      def load_value(value)
+        YAML.safe_load(value).to_h
+      rescue StandardError
+        {}
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/integer.rb

@@ -0,0 +1,13 @@
+module RailsSettings
+  module Fields
+    class Integer < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        value.to_i
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+    end
+  end
+end

data/lib/rails-settings/fields/string.rb

@@ -0,0 +1,13 @@
+module RailsSettings
+  module Fields
+    class String < ::RailsSettings::Fields::Base
+      def deserialize(value)
+        value
+      end
+
+      def serialize(value)
+        deserialize(value)
+      end
+    end
+  end
+end

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.8.2"
+      "2.9.0"
     end
   end
 end

data/lib/rails-settings-cached.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
+require_relative "rails-settings/fields/base"
+require_relative "rails-settings/fields/array"
+require_relative "rails-settings/fields/big_decimal"
+require_relative "rails-settings/fields/boolean"
+require_relative "rails-settings/fields/float"
+require_relative "rails-settings/fields/hash"
+require_relative "rails-settings/fields/integer"
+require_relative "rails-settings/fields/string"
+
 require_relative "rails-settings/base"
 require_relative "rails-settings/request_cache"
 require_relative "rails-settings/middleware"
@@ -7,4 +16,6 @@ require_relative "rails-settings/railtie"
 require_relative "rails-settings/version"
 
 module RailsSettings
+  module Fields
+  end
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +127,14 @@ files:
 - lib/generators/settings/templates/model.rb
 - lib/rails-settings-cached.rb
 - lib/rails-settings/base.rb
+- lib/rails-settings/fields/array.rb
+- lib/rails-settings/fields/base.rb
+- lib/rails-settings/fields/big_decimal.rb
+- lib/rails-settings/fields/boolean.rb
+- lib/rails-settings/fields/float.rb
+- lib/rails-settings/fields/hash.rb
+- lib/rails-settings/fields/integer.rb
+- lib/rails-settings/fields/string.rb
 - lib/rails-settings/middleware.rb
 - lib/rails-settings/railtie.rb
 - lib/rails-settings/request_cache.rb
@@ -122,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: The best solution for store global settings in Rails applications.