rails-settings-cached 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11dbf6161605ff3aed324a9ac29600d47918cd5fad1b8a5abfadaeddd9636c57
-  data.tar.gz: 8056da8c1b7441dd6fc78117013b06c0d67b53bfb06497d1e2343b1417503b95
+  metadata.gz: f37f8d9bad4b40dd60dbf30806e1e530e1d292448ba803db06bdcca5f562c62e
+  data.tar.gz: 2900b13077db46b60b2c22cfa3a21b7af5704b86d874d485672508c8ef866475
 SHA512:
-  metadata.gz: 61579ae6068bdd643c4741ac07855c0802220f11be06709910efae5f653dc69db7d7b039cb265bc4229a5121aef90ee9de92d6da700aea87cec33bfb9c4800f3
-  data.tar.gz: 2fbd8d62d15ac420abc0ac96ca2aea53eb6d78c9072a1f19fa942f86fd89a8253e829ec827251909dc2cd8f2082e65e890737ba7588d4cf960ebad85fdc76269
+  metadata.gz: c696568044b97ce9a9112de42682a7e484e13a8220e0d7b1b52d5977f56358f82109e4bb1dd8b227f89089d060a49454b2bd1c86ac4cc7fbfc2c275bf0a48c55
+  data.tar.gz: c2eb40491e08ce8eefe6d96e6d987fd9a02efbad708e9a1ae0442d98b82e626300ee90eda5664be385aa81178c4be4a19b190d623a2ff8cdb0d8e0f8b53d0649

data/README.md

@@ -30,9 +30,9 @@ You will get `app/models/setting.rb`
 ```rb
 class Setting < RailsSettings::Base
   # cache_prefix { "v1" }
-  field :app_name, default: "Rails Settings"
+  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"
+  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
@@ -49,7 +49,7 @@ class Setting < RailsSettings::Base
   }
 
   # lambda default value
-  field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }
+  field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }, validates: { length: { maximum: 255 } }
 end
 ```
 
@@ -150,6 +150,39 @@ Setting.get_field("app_name")
 => { key: "app_name", type: :string, default: "Rails Settings", readonly: false }
 ```
 
+## Validations
+
+You can use `validates` options to special the [Rails Validation](https://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates) for fields.
+
+```rb
+class Setting < RailsSettings::Base
+  # cache_prefix { "v1" }
+  field :app_name, default: "Rails Settings", validates: { presence: true, length: { in: 2..20 } }
+  field :default_locale, default: "zh-CN", validates: { presence: true, inclusion: { in: %w[zh-CN en jp], message: "is not included in [zh-CN, en, jp]" } }
+end
+```
+
+Now validate will work on record save.
+
+```rb
+setting = Setting.find_or_initialize_by(var: :app_name)
+setting.value = ""
+setting.valid?
+# => false
+setting.errors.full_messages
+# => ["App name can't be blank", "App name too short (minimum is 2 characters)"]
+
+setting = Setting.find_or_initialize_by(var: :default_locale)
+setting.value = "zh-TW"
+setting.save
+# => false
+setting.errors.full_messages
+# => ["Default locale is not included in [zh-CN, en, jp]"]
+setting.value = "en"
+setting.valid?
+# => true
+```
+
 ## Use Setting in Rails initializing:
 
 In `version 2.3+` you can use Setting before Rails is initialized.
@@ -265,9 +298,25 @@ app/controllers/admin/settings_controller.rb
 module Admin
   class SettingsController < ApplicationController
     def create
+      @errors = ActiveModel::Errors.new
+      setting_params.keys.each do |key|
+        next if setting_params[key].nil?
+
+        setting = Setting.new(var: key)
+        setting.value = setting_params[key].strip
+        unless setting.valid?
+          @errors.merge!(setting.errors)
+        end
+      end
+
+      if @errors.any?
+        render :new
+      end
+
       setting_params.keys.each do |key|
         Setting.send("#{key}=", setting_params[key].strip) unless setting_params[key].nil?
       end
+
       redirect_to admin_settings_path, notice: "Setting was successfully updated."
     end
 
@@ -284,6 +333,16 @@ app/views/admin/settings/show.html.erb
 
 ```erb
 <%= form_for(Setting.new, url: admin_settings_path) do |f| %>
+  <% if @errors.any? %>
+    <div class="alert alert-block alert-danger">
+      <ul>
+        <% @errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
   <div class="form-group">
     <label class="control-label">Host</label>
     <%= f.text_field :host, value: Setting.host, class: "form-control", placeholder: "http://localhost"  %>

data/lib/rails-settings/base.rb

@@ -28,7 +28,7 @@ module RailsSettings
       end
 
       def field(key, **opts)
-        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly], separator: opts[:separator])
+        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly], separator: opts[:separator], validates: opts[:validates])
       end
 
       def get_field(key)
@@ -59,7 +59,7 @@ module RailsSettings
 
       private
 
-      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil)
+      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil, validates: nil)
         @defined_fields ||= []
         @defined_fields << {
           key: key.to_s,
@@ -95,10 +95,19 @@ module RailsSettings
             value = send(:_convert_string_to_typeof_value, type, value, separator: separator)
 
             record.value = value
-            record.save!
+            record.save(validate: false)
 
             value
           end
+
+          if validates
+            validates[:if] = Proc.new { |item| item.var.to_s == key.to_s }
+            send(:validates, key, **validates)
+
+            define_method(:read_attribute_for_validation) do |_key|
+              self.value
+            end
+          end
         end
 
         if type == :boolean

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.4.1"
+      "2.5.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Jason Lee
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: The best solution for store global settings in Rails applications.