rails-settings-cached 2.1.1 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f952983987531a930ac0f603d37aed4938648f4e858297182b4039987fc6c975
-  data.tar.gz: ecbfbf363e6c67519ced21e25966ebb0339bc7dae2e3171d95ab2d04675b5b7e
+  metadata.gz: d9fb44e09bad24a4d3c6cf36fda107fe18ce214964b713de318e5f3efc083851
+  data.tar.gz: 75ee5df473cff1fc07b963b6441152f559de8d0a5652267530c5c0f62cac93f9
 SHA512:
-  metadata.gz: d78651e359e244a155e1e743dd391494f0792504b816dc8bd0d3cdbfd1d7103a16c020895f7b751007f5f5b3a04d4d94398e5a7df4cc09ad07ff1166b0d05ed2
-  data.tar.gz: 2320d0950d5a9b9090f5b5df27f42df1b7a74553104e584728146ac5cd41cd567b58e450e9121dc764be4c534209d988b2b1b516b1e948913806f1b4c5850961
+  metadata.gz: 6bf0b841b4b2ee46b7da5f51a54d2e3f17f984f2fe1f72841bc056966efc29fd5ad70ea54b0b5559f4ea493927ef796cbc956302b404e18ec61059c40d620904
+  data.tar.gz: 76a594a2df28a1490c6d67b1fff1a4d776572cc1240c9c07549d6d0349c048a017ee10f828d7c38e41bdf4c7158af9108f9c9181af3ee015af72654cd23831ff

data/README.md

@@ -1,4 +1,4 @@
-## Rails Settings Cached
+# 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,
@@ -6,39 +6,23 @@ that uses simple ActiveRecord like methods for manipulation. Keep track of any g
 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.
 
-> 🚨 BREAK CHANGES WARNING:
-> rails-settings-cached 2.x has redesigned the API, the new version will compatible with the stored setting values by an older version.
-> When you want to upgrade 2.x, you must read the README again, and follow guides to change your Setting model.
-> 0.x stable branch: https://github.com/huacnlee/rails-settings-cached/tree/0.x
+[![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)
 
-## Status
-
-[![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) [![Code Climate](https://codeclimate.com/github/huacnlee/rails-settings-cached/badges/gpa.svg)](https://codeclimate.com/github/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)
-
-## Setup
+## Installation
 
 Edit your Gemfile:
 
-```ruby
-gem "rails-settings-cached", "~> 2.0"
-```
-
-Generate your settings:
-
 ```bash
-$ rails g settings:install
+$ bundle add rails-settings-cached
 ```
 
-If you want custom model name:
+Generate your settings:
 
 ```bash
 $ rails g settings:install
-```
 
-Or use a custom name:
-
-```bash
-$ rails g settings:install SiteConfig
+# Or use a custom name:
+$ rails g settings:install AppConfig
 ```
 
 You will get `app/models/setting.rb`
@@ -46,19 +30,26 @@ You will get `app/models/setting.rb`
 ```rb
 class Setting < RailsSettings::Base
   # cache_prefix { "v1" }
-
-  field :host, default: "http://example.com"
+  field :app_name, default: "Rails Settings"
+  field :host, default: "http://example.com", readonly: true
+  field :default_locale, default: "zh-CN"
   field :readonly_item, type: :integer, default: 100, readonly: true
   field :user_limits, type: :integer, default: 20
+  field :exchange_rate, type: :float, default: 0.123
   field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
+  field :captcha_enable, type: :boolean, default: true
+
   # Override array separator, default: /[\n,]/ split with \n or comma.
   field :tips, type: :array, separator: /[\n]+/
-  field :captcha_enable, type: :boolean, default: 1
+
   field :notification_options, type: :hash, default: {
     send_all: true,
     logging: true,
     sender_email: "foo@bar.com"
   }
+
+  # lambda default value
+  field :welcome_message, type: :string, default: -> { "welcome to #{self.app_name}" }
 end
 ```
 
@@ -67,19 +58,21 @@ You must use `field` method to statement the setting keys, otherwise you can't u
 Now just put that migration in the database with:
 
 ```bash
-rake db:migrate
+$ rails db:migrate
 ```
 
 ## Usage
 
-The syntax is easy.  First, let's create some settings to keep track of:
+The syntax is easy. First, let's create some settings to keep track of:
 
 ```ruby
 irb > Setting.host
 "http://example.com"
-irb > Setting.host = "https://your-host.com"
-irb > Setting.host
-"https://your-host.com"
+irb > Setting.app_name
+"Rails Settings"
+irb > Setting.app_name = "Rails Settings Cached"
+irb > Setting.app_name
+"Rails Settings Cached"
 
 irb > Setting.user_limits
 20
@@ -133,6 +126,31 @@ irb > Setting.notification_options
 }
 ```
 
+
+### Get defined fields
+
+> version 2.3+
+
+```rb
+# Get all keys
+Setting.keys
+=> ["app_name", "host", "default_locale", "readonly_item"]
+
+# Get editable keys
+Settng.editable_keys
+=> ["app_name", "default_locale"]
+
+# Get readonly keys
+Setting.readonly_keys
+=> ["host", "readonly_item"]
+
+# Get options of field
+Setting.get_field("host")
+=> { key: "host", type: :string, default: "http://example.com", readonly: true }
+Setting.get_field("app_name")
+=> { key: "app_name", type: :string, default: "Rails Settings", readonly: false }
+```
+
 ## Readonly field
 
 Sometimes you may need to use Setting before Rails is initialized, for example `config/devise.rb`
@@ -200,7 +218,7 @@ config/routes.rb
 
 ```rb
 namespace :admin do
-  resources :settings
+  resource :settings
 end
 ```
 
@@ -212,18 +230,13 @@ module Admin
   class SettingsController < ApplicationController
     before_action :get_setting, only: [:edit, :update]
 
-    def show
-    end
-
     def create
       setting_params.keys.each do |key|
-        next if key.to_s == "site_logo"
         Setting.send("#{key}=", setting_params[key].strip) unless setting_params[key].nil?
       end
-      redirect_to admin_settings_path(notice: "Setting was successfully updated.")
+      redirect_to settings_path, notice: "Setting was successfully updated."
     end
 
-
     private
       def setting_params
         params.require(:setting).permit(:host, :user_limits, :admin_emails,
@@ -259,80 +272,52 @@ app/views/admin/settings/show.html.erb
     <%= f.text_area :notification_options, value: YAML.dump(Setting.notification_options), class: "form-control", style: "height: 180px;"  %>
     <div class="form-text">
       Use YAML format to config the SMTP_html
-    </details>
-<% end %>
-```
-
-##  Backward compatible to support 0.x scoped settings
-
-You may used the scoped setting feature in 0.x version. Before you upgrade rails-settings-cached 2.x, you must follow this guide to backward compatible it.
-
-For example:
-
-```rb
-class User < ApplicationRecord
-  include RailsSettings::Extend
-end
+    </div>
+  </div>
 
-@user.settings.color = "red"
-@user.settings.foo = 123
+  <div>
+    <%= f.submit 'Update Settings' %>
+  </div>
+<% end %>
 ```
 
-create `app/models/concerns/scoped_setting.rb`
+## Scoped Settings
 
-```rb
-module ScopedSetting
-  extend ActiveSupport::Concern
+> 🚨 BREAK CHANGES WARNING:
+> rails-settings-cached 2.x has redesigned the API, the new version will compatible with the stored setting values by an older version.
+> When you want to upgrade 2.x, you must read the README again, and follow guides to change your Setting model.
+> 0.x stable branch: https://github.com/huacnlee/rails-settings-cached/tree/0.x
 
-  included do
-    has_many :settings, as: :thing
-  end
+- [Backward compatible to support 0.x scoped settings](docs/backward-compatible-to-scoped-settings.md)
 
-  class_methods do
-    def scoped_field(name, default: nil)
-      define_method(name) do
-        obj = settings.where(var: name).take || settings.new(var: name, value: default)
-        obj.value
-      end
+For new project / new user of rails-settings-cached. The [ActiveRecord::AttributeMethods::Serialization](https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Serialization/ClassMethods.html#method-i-serialize) is best choice.
 
-      define_method("#{name}=") do |val|
-        record = settings.where(var: name).take || settings.new(var: name)
-        record.value = val
-        record.save!
+> This is reason of why rails-settings-cached 2.x removed **Scoped Settings** feature.
 
-        val
-      end
-    end
-  end
-end
-```
+For example:
 
-Now include it for your model:
+We wants a preferences setting for user.
 
 ```rb
-class User < ApplicationRecord
-  include ScopedSetting
-
-  scoped_field :color, default: ""
-  scoped_field :foo, default: 0
+class User < ActiveRecord::Base
+  serialize :preferences
 end
-```
-
-Now you must to find project with ".setting." for replace with:
 
-Same values will fetch from the `settings` table.
-
-```rb
-@user.color = "red"
-@user.color # => "red"
-@user.foo = 123
-@user.foo # =>
+@user = User.new
+@user.preferences[:receive_emails] = true
+@user.preferences[:public_email] = true
+@user.save
 ```
 
 ## Use cases:
 
-- [ruby-china/ruby-china](https://github.com/ruby-china/ruby-china)
-- [thebluedoc/bluedoc](https://github.com/thebluedoc/bluedoc/blob/master/app/models/setting.rb)
-- [tootsuite/mastodon](https://github.com/tootsuite/mastodon)
-- [helpyio/helpy](https://github.com/helpyio/helpy)
+- [ruby-china/homeland](https://github.com/ruby-china/homeland) - master
+- [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
+- [tootsuite/mastodon](https://github.com/tootsuite/mastodon) - 0.6.x
+- [helpyio/helpy](https://github.com/helpyio/helpy) - 0.5.x
+
 
+And more than [1K repositories](https://github.com/huacnlee/rails-settings-cached/network/dependents) used.

data/lib/generators/settings/install_generator.rb

@@ -3,14 +3,15 @@
 require "rails/generators"
 require "rails/generators/migration"
 
-module Settings
+module RailsSettings
   class InstallGenerator < Rails::Generators::NamedBase
+    namespace "settings:install"
     desc "Generate RailsSettings files."
     include Rails::Generators::Migration
 
     argument :name, type: :string, default: "setting"
 
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path("templates", __dir__)
 
     @@migrations = false
 

data/lib/rails-settings/base.rb

@@ -6,7 +6,7 @@ module RailsSettings
   class Base < ActiveRecord::Base
     class SettingNotFound < RuntimeError; end
 
-    SEPARATOR_REGEXP = /[\n,]+/
+    SEPARATOR_REGEXP = /[\n,;]+/.freeze
     self.table_name = table_name_prefix + "settings"
 
     # get the value field, YAML decoded
@@ -26,13 +26,17 @@ module RailsSettings
     class << self
       def clear_cache
         RequestStore.store[:rails_settings_all_settings] = nil
-        Rails.cache.delete(self.cache_key)
+        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])
       end
 
+      def get_field(key)
+        @defined_fields.find { |field| field[:key] == key.to_s } || {}
+      end
+
       def cache_prefix(&block)
         @cache_prefix = block
       end
@@ -43,88 +47,126 @@ module RailsSettings
         scope.join("/")
       end
 
-      private
-        def _define_field(key, default: nil, type: :string, readonly: false, separator: nil)
-          if readonly
-            define_singleton_method(key) do
-              self.send(:_covert_string_to_typeof_value, type, default, separator: separator)
-            end
-          else
-            define_singleton_method(key) do
-              val = self.send(:_value_of, key)
-              result = nil
-              if !val.nil?
-                result = val
-              else
-                result = default
-                result = default.call if default.is_a?(Proc)
-              end
-
-              result = self.send(:_covert_string_to_typeof_value, type, result, separator: separator)
-
-              result
-            end
+      def keys
+        @defined_fields.map { |field| field[:key] }
+      end
 
-            define_singleton_method("#{key}=") do |value|
-              var_name = key.to_s
+      def editable_keys
+        @defined_fields.reject { |field| field[:readonly] }.map { |field| field[:key] }
+      end
 
-              record = find_by(var: var_name) || new(var: var_name)
-              value = self.send(:_covert_string_to_typeof_value, type, value, separator: separator)
+      def readonly_keys
+        @defined_fields.select { |field| field[:readonly] }.map { |field| field[:key] }
+      end
 
-              record.value = value
-              record.save!
+      private
 
-              value
-            end
+      def _define_field(key, default: nil, type: :string, readonly: false, separator: nil)
+        @defined_fields ||= []
+        @defined_fields << {
+          key: key.to_s,
+          default: default,
+          type: type || :string,
+          readonly: readonly.nil? ? false : readonly
+        }
+
+        if readonly
+          define_singleton_method(key) do
+            send(:_convert_string_to_typeof_value, type, default, separator: separator)
           end
-
-          if type == :boolean
-            define_singleton_method("#{key}?") do
-              self.send(key)
+        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
-        end
 
-        def _covert_string_to_typeof_value(type, value, separator: nil)
-          return value unless value.is_a?(String) || value.is_a?(Integer)
-
-          case type
-          when :boolean
-            return value == "true" || value == "1" || value == 1 || value == true
-          when :array
-            return value.split(separator || SEPARATOR_REGEXP).reject { |str| str.empty? }
-          when :hash
-            value = YAML.load(value).to_hash rescue {}
-            value.deep_stringify_keys!
-            return value
-          when :integer
-            return value.to_i
-          else
+          define_singleton_method("#{key}=") do |value|
+            var_name = key.to_s
+
+            record = find_by(var: var_name) || new(var: var_name)
+            value = send(:_convert_string_to_typeof_value, type, value, separator: separator)
+
+            record.value = value
+            record.save!
+
             value
           end
         end
 
-        def _value_of(var_name)
-          raise "#{self.table_name} does not exist." unless table_exists?
+        if type == :boolean
+          define_singleton_method("#{key}?") do
+            send(key)
+          end
+        end
+      end
 
-          _all_settings[var_name.to_s]
+      def _convert_string_to_typeof_value(type, value, separator: nil)
+        return value unless [String, Integer, Float, BigDecimal].include?(value.class)
+
+        case type
+        when :boolean
+          value == "true" || value == "1" || value == 1 || value == true
+        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
+          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 rails_initialized?
-          Rails.application && Rails.application.initialized?
+      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, `#{name}.#{var_name}` fallback to returns the default value."
+          return nil
         end
 
-        def _all_settings
-          raise "You cannot use settings before Rails initialize." unless rails_initialized?
-          RequestStore.store[:rails_settings_all_settings] ||= begin
-            Rails.cache.fetch(self.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
+        _all_settings[var_name.to_s]
+      end
+
+      def rails_initialized?
+        Rails.application&.initialized?
+      end
+
+      def _all_settings
+        raise "You cannot use settings before Rails initialize." unless rails_initialized?
+
+        RequestStore.store[:rails_settings_all_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
         end
+      end
     end
   end
 end

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.1.1"
+      "2.3.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.3
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -130,9 +130,10 @@ files:
 - lib/rails-settings/railtie.rb
 - lib/rails-settings/version.rb
 homepage: https://github.com/huacnlee/rails-settings-cached
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Settings plugin for Rails that makes managing a table of global keys.
 test_files: []