rails-settings-cached 2.4.0 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 603b7101883a17d76bfb33682ce421b7259101bfc7d3b0fea450d02466adcb03
-  data.tar.gz: '088348b905fba8727569b052468ca194c74fcde740976e0d4cfe6b780063144f'
+  metadata.gz: fc604a3e9ea5a7ed498250820ca7e93ec44e38adb88380b24b0f7b2d5dc164b8
+  data.tar.gz: 9e62d3f49c59e981655a22924d2c32d346ba4618a6c98b4b8b1a0dfb6fd6db24
 SHA512:
-  metadata.gz: eeaed942036ec6c70fbd0f8a687000032e87cbef17324eca6329c32e1f7b69b6f38a7d295ec00441ec1fd1601f53c8cbe162df33e0f5d4f518658f6cb3236835
-  data.tar.gz: 13f87d6cac9234fcf48b50b3e67723aac4977d4a9e8fb71528bf8d12fd29eb27372d9b5705a496f694550ad988dba613f9dc3bf069fa699a910ebd1f4c5b8506
+  metadata.gz: 7bfc23cb9fadddad15c1f3c341973bae5571cdb324ebb7d71f8c075c3877912d7f40b2792cbeaa582a79f22bcde166def831506c95d90444cd7193077492d4a7
+  data.tar.gz: dc55136872ad58751d08f745d93a7707e3e815f6ffc99adcc5d63b19e980594a7874c11484976b7342932ca511ace408c8d48bdd5de5666854b544d908345678

data/README.md

@@ -1,12 +1,12 @@
 # Rails Settings Cached
 
-This a plugin that makes 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, or any object.
+The best solution for store global settings in Rails applications.
 
-[![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)
+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) [![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,11 +49,11 @@ 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
 ```
 
-You must use `field` method to statement the setting keys, otherwise you can't use it.
+You must use the `field` method to statement the setting keys, otherwise you can't use it.
 
 Now just put that migration in the database with:
 
@@ -150,9 +150,56 @@ 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+` we allows you to use Setting before Rails is initialized.
+In `version 2.3+` you can use Setting before Rails is initialized.
 
 For example `config/initializers/devise.rb`
 
@@ -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"  %>
@@ -349,8 +422,12 @@ end
 - [forem/forem](https://github.com/forem/forem) - 2.x
 - [siwapp/siwapp](https://github.com/siwapp/siwapp) - 2.x
 - [aidewoode/black_candy](https://github.com/aidewoode/black_candy) - 2.x
-- [thebluedoc/bluedoc](https://github.com/thebluedoc/bluedoc/blob/master/app/models/setting.rb) - 2.x
+- [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
 
 And more than [1K repositories](https://github.com/huacnlee/rails-settings-cached/network/dependents) used.

data/lib/rails-settings-cached.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "rails-settings/base"
-require_relative "rails-settings/request_store"
+require_relative "rails-settings/request_cache"
 require_relative "rails-settings/railtie"
 require_relative "rails-settings/version"
 

data/lib/rails-settings/base.rb

@@ -4,11 +4,12 @@ module RailsSettings
   class Base < ActiveRecord::Base
     class SettingNotFound < RuntimeError; end
 
-    SEPARATOR_REGEXP = /[\n,;]+/.freeze
+    SEPARATOR_REGEXP = /[\n,;]+/
     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
 
@@ -23,12 +24,13 @@ module RailsSettings
 
     class << self
       def clear_cache
-        RequestStore.reset
+        RequestCache.reset
         Rails.cache.delete(cache_key)
       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 +61,12 @@ 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
+
         @defined_fields ||= []
         @defined_fields << {
-          key: key.to_s,
+          key: key,
           default: default,
           type: type || :string,
           readonly: readonly.nil? ? false : readonly
@@ -70,7 +74,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 +94,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 +104,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
@@ -113,19 +127,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 +156,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 +170,11 @@ module RailsSettings
       end
 
       def _all_settings
-        RequestStore.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

@@ -0,0 +1,30 @@
+module RailsSettings
+  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
+      attribute :settings
+    end
+  else
+    # https://github.com/steveklabnik/request_store
+    # For Rails 5.0
+    require "request_store"
+
+    class RequestCache
+      class << self
+        def reset
+          self.settings = nil
+        end
+
+        def settings
+          RequestStore.store[:rails_settings_all_settings]
+        end
+
+        def settings=(val)
+          RequestStore.store[:rails_settings_all_settings]
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.4.0"
+      "2.5.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.3
 platform: ruby
 authors:
 - Jason Lee
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -108,11 +108,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n  This is improved from rails-settings, added caching.\n  Settings
-  plugin for Rails that makes managing a table of global key,\n  value pairs easy.
-  Think of it like a global Hash stored in you database,\n  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,
+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
+  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  "
 email: huacnlee@gmail.com
 executables: []
@@ -128,13 +128,13 @@ files:
 - lib/rails-settings-cached.rb
 - lib/rails-settings/base.rb
 - lib/rails-settings/railtie.rb
-- lib/rails-settings/request_store.rb
+- lib/rails-settings/request_cache.rb
 - lib/rails-settings/version.rb
 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: Settings plugin for Rails that makes managing a table of global keys.
+summary: The best solution for store global settings in Rails applications.
 test_files: []

data/lib/rails-settings/request_store.rb

@@ -1,8 +0,0 @@
-module RailsSettings
-  # 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 RequestStore < ActiveSupport::CurrentAttributes 
-    attribute :settings
-  end
-end