rails-settings-cached 2.4.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11dbf6161605ff3aed324a9ac29600d47918cd5fad1b8a5abfadaeddd9636c57
-  data.tar.gz: 8056da8c1b7441dd6fc78117013b06c0d67b53bfb06497d1e2343b1417503b95
+  metadata.gz: 659ee746f1a087bb3ee48bba9f72a3dfd6af920830c6b003fd3bd909dce0a3c9
+  data.tar.gz: bb07a004ae0bbe413df58a0e2fd72fa7940cf5c55661c30214161745ebc5accc
 SHA512:
-  metadata.gz: 61579ae6068bdd643c4741ac07855c0802220f11be06709910efae5f653dc69db7d7b039cb265bc4229a5121aef90ee9de92d6da700aea87cec33bfb9c4800f3
-  data.tar.gz: 2fbd8d62d15ac420abc0ac96ca2aea53eb6d78c9072a1f19fa942f86fd89a8253e829ec827251909dc2cd8f2082e65e890737ba7588d4cf960ebad85fdc76269
+  metadata.gz: 2cbd53148b2110e12e8280a34691e9c08fb1e0805d2cc3ce8a4d25bbb477339e0116d508bac3bfb988bd96ffd3c173838475b5c85bb4659644b275585870198f
+  data.tar.gz: afe704c8920d76f70795ad55ac17a5ccbfa9807abe9903090fa797b1eb9a7ac4c5564b0a817ccca329b57704eebd3d688ad347c1f6afce58b4fbb58e20a029a1

data/README.md

@@ -2,11 +2,11 @@
 
 The best solution for store global settings in Rails applications.
 
-This gem will managing a table of а global key, value pairs easy. Think of it like a global Hash stored in your database, that uses simple ActiveRecord like methods for manipulation. Keep track of any global setting that you don't want to hard code into your rails app.
+This gem will make managing a table of а global key, value pairs easy. Think of it like a global Hash stored in your database, that uses simple ActiveRecord like methods for manipulation. Keep track of any global setting that you don't want to hard code into your rails app.
 
 You can store any kind of object. Strings, numbers, arrays, booleans, or any object.
 
-[![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![CI Status](https://travis-ci.org/huacnlee/rails-settings-cached.svg)](http://travis-ci.org/huacnlee/rails-settings-cached) [![codecov.io](https://codecov.io/github/huacnlee/rails-settings-cached/coverage.svg?branch=master)](https://codecov.io/github/huacnlee/rails-settings-cached?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![build](https://github.com/huacnlee/rails-settings-cached/workflows/build/badge.svg)](https://github.com/huacnlee/rails-settings-cached/actions?query=workflow%3Abuild) [![codecov.io](https://codecov.io/github/huacnlee/rails-settings-cached/coverage.svg?branch=master)](https://codecov.io/github/huacnlee/rails-settings-cached?branch=master)
 
 ## Installation
 
@@ -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,53 @@ 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
+irb> Setting.app_name = ""
+ActiveRecord::RecordInvalid: (Validation failed: App name can't be blank)
+irb> Setting.app_name = "Rails Settings"
+"Rails Settings"
+irb> Setting.default_locale = "zh-TW"
+ActiveRecord::RecordInvalid: (Validation failed: Default locale is not included in [zh-CN, en, jp])
+irb> Setting.default_locale = "en"
+"en"
+```
+
+Validate by `save` / `valid?` method:
+
+```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 +312,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 +347,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"  %>
@@ -352,6 +425,7 @@ end
 - [huacnlee/bluedoc](https://github.com/huacnlee/bluedoc) - 2.x
 - [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
 - [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,20 @@
 # frozen_string_literal: true
 
 module RailsSettings
-  class Base < ActiveRecord::Base
-    class SettingNotFound < RuntimeError; end
+  class ProcetedKeyError < RuntimeError
+    def initialize(key)
+      super("Can't use #{key} as setting key.")
+    end
+  end
 
-    SEPARATOR_REGEXP = /[\n,;]+/.freeze
+  class Base < ActiveRecord::Base
+    SEPARATOR_REGEXP = /[\n,;]+/
+    PROTECTED_KEYS = %w[var value]
     self.table_name = table_name_prefix + "settings"
 
     # get the value field, YAML decoded
     def value
+      # rubocop:disable Security/YAMLLoad
       YAML.load(self[:value]) if self[:value].present?
     end
 
@@ -28,7 +34,8 @@ 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,10 +66,14 @@ 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)
+        key = key.to_s
+
+        raise ProcetedKeyError.new(key) if PROTECTED_KEYS.include?(key)
+
         @defined_fields ||= []
         @defined_fields << {
-          key: key.to_s,
+          key: key,
           default: default,
           type: type || :string,
           readonly: readonly.nil? ? false : readonly
@@ -70,7 +81,8 @@ module RailsSettings
 
         if readonly
           define_singleton_method(key) do
-            send(:_convert_string_to_typeof_value, type, default, separator: separator)
+            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
@@ -89,7 +101,7 @@ module RailsSettings
           end
 
           define_singleton_method("#{key}=") do |value|
-            var_name = key.to_s
+            var_name = key
 
             record = find_by(var: var_name) || new(var: var_name)
             value = send(:_convert_string_to_typeof_value, type, value, separator: separator)
@@ -99,6 +111,15 @@ module RailsSettings
 
             value
           end
+
+          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
+          end
         end
 
         if type == :boolean
@@ -106,6 +127,13 @@ module RailsSettings
             send(key)
           end
         end
+
+        # delegate instance get method to class for support:
+        # setting = Setting.new
+        # setting.admin_emails
+        define_method(key) do
+          self.class.public_send(key)
+        end
       end
 
       def _convert_string_to_typeof_value(type, value, separator: nil)
@@ -113,19 +141,15 @@ module RailsSettings
 
         case type
         when :boolean
-          value == "true" || value == "1" || value == 1 || value == true
+          ["true", "1", 1, true].include?(value)
         when :array
           value.split(separator || SEPARATOR_REGEXP).reject { |str| str.empty? }.map(&:strip)
         when :hash
           value = begin
-                    begin
-                      YAML.load(value).to_h
-                    rescue StandardError
-                      eval(value).to_h
-                    end
-                  rescue StandardError
-                    {}
-                  end
+            YAML.safe_load(value).to_h
+          rescue
+            {}
+          end
           value.deep_stringify_keys!
           ActiveSupport::HashWithIndifferentAccess.new(value)
         when :integer
@@ -146,12 +170,12 @@ module RailsSettings
           return nil
         end
 
-        _all_settings[var_name.to_s]
+        _all_settings[var_name]
       end
 
       def _table_exists?
         table_exists?
-      rescue => e
+      rescue
         false
       end
 
@@ -160,13 +184,11 @@ module RailsSettings
       end
 
       def _all_settings
-        RequestCache.settings ||= begin
-          Rails.cache.fetch(cache_key, expires_in: 1.week) do
-            vars = unscoped.select("var, value")
-            result = {}
-            vars.each { |record| result[record.var] = record.value }
-            result.with_indifferent_access
-          end
+        RequestCache.settings ||= Rails.cache.fetch(cache_key, expires_in: 1.week) do
+          vars = unscoped.select("var, value")
+          result = {}
+          vars.each { |record| result[record.var] = record.value }
+          result.with_indifferent_access
         end
       end
     end

data/lib/rails-settings/railtie.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class Railtie < Rails::Railtie
     initializer "rails_settings.active_record.initialization" do
-      RailsSettings::Base.after_commit :clear_cache, on: %i(create update destroy)
+      RailsSettings::Base.after_commit :clear_cache, on: %i[create update destroy]
     end
   end
 end

data/lib/rails-settings/request_cache.rb

@@ -1,9 +1,9 @@
 module RailsSettings
-  if defined? ActiveSupport::CurrentAttributes 
+  if defined? ActiveSupport::CurrentAttributes
     # For storage all settings in Current, it will reset after per request completed.
     # Base on ActiveSupport::CurrentAttributes
     # https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html
-    class RequestCache < ActiveSupport::CurrentAttributes 
+    class RequestCache < ActiveSupport::CurrentAttributes
       attribute :settings
     end
   else
@@ -27,4 +27,4 @@ module RailsSettings
       end
     end
   end
-end
+end

data/lib/rails-settings/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Jason Lee
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
 description: "\n  The best solution for store global settings in Rails applications.\n\n
   \ This gem will managing a table of а global key, value pairs easy. Think of it
-  like a \n  global Hash stored in your database, that uses simple ActiveRecord like
+  like a\n  global Hash stored in your database, that uses simple ActiveRecord like
   methods for manipulation.\n\n  Keep track of any global setting that you dont want
   to hard code into your rails app.\n  You can store any kind of object.  Strings,
   numbers, arrays, or any object.\n  "
@@ -134,7 +134,7 @@ homepage: https://github.com/huacnlee/rails-settings-cached
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: The best solution for store global settings in Rails applications.
 test_files: []