rails-settings-cached 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f5d17c59cd0c8b1c7c587169c32a7b7003c9067086a7b43e40d716973c8b104
-  data.tar.gz: 9e4b276543867580abcfa9da999fe3e81303459df28db49c76f2e75bef6679e7
+  metadata.gz: 765057576ddcdb19d9f394f1844950f03e8c70944abd9b104e70824f60f7e0e5
+  data.tar.gz: 0d2a2c4aa7560d96bee3a0c1a0d50f7cb89bffd5c650ae47f2bd6169c0d12b6e
 SHA512:
-  metadata.gz: 4be5e67948d944b2daa60c574586e297b638fc17e828a4923dc010ad691402b69bd8b06c823b228a3eaedafbd00fc2796d43c7986cb34a3bc0e5ae401eae8647
-  data.tar.gz: 7021a6b8d97b31f3f28557f51bef405cf5cfba5ed2194ee50d1b56ce599e1ca1aa288498d39c3ceefadd0618781610bd12344cf468b826ee4b7125fc640ce267
+  metadata.gz: 908f7ae3d8e01710f9df4cb32a77b2302129107bcd34254cb5237fc5f5b98f2e4007fe315751ab3fd7e2212e14a0db133f796f994b0bd6a1cee48768717a01a9
+  data.tar.gz: fe611e7af4ac5ca72a98040c63b0475833878ac6f11b82953fd80458bb6b96311fff7fc174f890171f466f724be809cd334bc184b0cb0c8c7b3ae94f5fbee28f

data/MIT-LICENSE

@@ -1,5 +1,4 @@
-Copyright (c) 2006 Alex Wayne
-Some additional features added 2009 by Georg Ledermann
+Copyright (c) 2019 Jason Lee
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,14 +1,15 @@
 ## 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,
+а 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 dont want to hard code into your rails app. You can store any kind
+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 redesign the API, the new version will compatible with the stored setting values by older version.
-> When you wants to upgrade 2.x, you must read the README again, and follow guides to change your Setting model.
+> 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
 
 ## Status
 
@@ -19,7 +20,7 @@ of object. Strings, numbers, arrays, or any object.
 Edit your Gemfile:
 
 ```ruby
-gem "rails-settings-cached"
+gem "rails-settings-cached", "~> 2.0"
 ```
 
 Generate your settings:
@@ -49,7 +50,10 @@ class Setting < RailsSettings::Base
   field :host, default: "http://example.com"
   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]
+  # 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,
@@ -59,7 +63,7 @@ class Setting < RailsSettings::Base
 end
 ```
 
-You must use `field` method to statement the setting keys, otherwice you can't use it.
+You must use `field` method to statement the setting keys, otherwise you can't use it.
 
 Now just put that migration in the database with:
 
@@ -69,7 +73,7 @@ rake db:migrate
 
 ## Usage
 
-The syntax is easy.  First, lets 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
@@ -132,7 +136,7 @@ irb > Setting.notification_options
 
 ## Readonly field
 
-Some times you may need use Setting before Rails initialize, for example `config/devise.rb`
+Sometimes you may need to use Setting before Rails is initialized, for example `config/devise.rb`
 
 ```rb
 Devise.setup do |config|
@@ -162,9 +166,9 @@ Setting.host -> Check Cache -> Exist - Get value of key for cache -> Return
                 Return default value or nil
 ```
 
-In each Setting keys call, we will load the cache/db and save in Thread.current for avoid hit cache/db.
+In each Setting keys call, we will load the cache/db and save in [RequestStore](https://github.com/steveklabnik/request_store) to avoid hit cache/db.
 
-Each key update will expires the cache, so do not add some frequent update key.
+Each key update will expire the cache, so do not add some frequent update key.
 
 ## Change cache key
 
@@ -189,9 +193,9 @@ end
 
 -----
 
-## How to manage Settings in admin interface?
+## How to manage Settings in the admin interface?
 
-If you want create an admin interface to editing the Settings, you can try methods in follow:
+If you want to create an admin interface to editing the Settings, you can try methods in following:
 
 config/routes.rb
 
@@ -209,18 +213,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,
@@ -256,10 +255,80 @@ 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>
+    </div>
+  </div>
 <% end %>
 ```
 
-## Use case:
+##  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
+
+@user.settings.color = "red"
+@user.settings.foo = 123
+```
+
+create `app/models/concerns/scoped_setting.rb`
+
+```rb
+module ScopedSetting
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :settings, as: :thing
+  end
+
+  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
+
+      define_method("#{name}=") do |val|
+        record = settings.where(var: name).take || settings.new(var: name)
+        record.value = val
+        record.save!
+
+        val
+      end
+    end
+  end
+end
+```
+
+Now include it for your model:
+
+```rb
+class User < ApplicationRecord
+  include ScopedSetting
+
+  scoped_field :color, default: ""
+  scoped_field :foo, default: 0
+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 # =>
+```
+
+## Use cases:
 
-- [ruby-china/ruby-china](https://github.com/ruby-china/ruby-china)
+- [ruby-china/homeland](https://github.com/ruby-china/homeland)
+- [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)

data/lib/generators/settings/install_generator.rb

@@ -32,12 +32,16 @@ module Settings
       migration_template "migration.rb", "db/migrate/create_settings.rb", migration_version: migration_version
     end
 
-    def rails5?
-      Rails.version.start_with? "5"
+    def rails_version_major
+      Rails::VERSION::MAJOR
+    end
+
+    def rails_version_minor
+      Rails::VERSION::MINOR
     end
 
     def migration_version
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5?
+      "[#{rails_version_major}.#{rails_version_minor}]" if rails_version_major >= 5
     end
   end
 end

data/lib/rails-settings/base.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require "request_store"
+
 module RailsSettings
   class Base < ActiveRecord::Base
     class SettingNotFound < RuntimeError; end
 
-    SEPARATOR_REGEXP = /[\s,]/
+    SEPARATOR_REGEXP = /[\n,;]+/
     self.table_name = table_name_prefix + "settings"
 
     # get the value field, YAML decoded
@@ -23,12 +25,14 @@ module RailsSettings
 
     class << self
       def clear_cache
-        Thread.current[:rails_settings_all_settings] = nil
+        RequestStore.store[:rails_settings_all_settings] = nil
         Rails.cache.delete(self.cache_key)
       end
 
       def field(key, **opts)
-        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly])
+        @keys ||= []
+        @keys << key.to_s
+        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly], separator: opts[:separator])
       end
 
       def cache_prefix(&block)
@@ -41,14 +45,19 @@ module RailsSettings
         scope.join("/")
       end
 
+      def keys
+        @keys
+      end
+
       private
-        def _define_field(key, default: nil, type: :string, readonly: false)
+
+        def _define_field(key, default: nil, type: :string, readonly: false, separator: nil)
           if readonly
-            self.class.define_method(key) do
-              self.send(:_covert_string_to_typeof_value, type, default)
+            define_singleton_method(key) do
+              self.send(:_convert_string_to_typeof_value, type, default, separator: separator)
             end
           else
-            self.class.define_method(key) do
+            define_singleton_method(key) do
               val = self.send(:_value_of, key)
               result = nil
               if !val.nil?
@@ -58,16 +67,16 @@ module RailsSettings
                 result = default.call if default.is_a?(Proc)
               end
 
-              result = self.send(:_covert_string_to_typeof_value, type, result)
+              result = self.send(:_convert_string_to_typeof_value, type, result, separator: separator)
 
               result
             end
 
-            self.class.define_method("#{key}=") do |value|
+            define_singleton_method("#{key}=") do |value|
               var_name = key.to_s
 
               record = find_by(var: var_name) || new(var: var_name)
-              value = self.send(:_covert_string_to_typeof_value, type, value)
+              value = self.send(:_convert_string_to_typeof_value, type, value, separator: separator)
 
               record.value = value
               record.save!
@@ -77,26 +86,30 @@ module RailsSettings
           end
 
           if type == :boolean
-            self.class.define_method("#{key}?") do
+            define_singleton_method("#{key}?") do
               self.send(key)
             end
           end
         end
 
-        def _covert_string_to_typeof_value(type, value)
-          return value unless value.is_a?(String) || value.is_a?(Integer)
+        def _convert_string_to_typeof_value(type, value, separator: nil)
+          return value unless [String, Integer, Float, BigDecimal].include?(value.class)
 
           case type
           when :boolean
-            return value == "true" || value == "1" || value == 1 || value == true
+            value == "true" || value == "1" || value == 1 || value == true
           when :array
-            return value.split(SEPARATOR_REGEXP).reject { |str| str.empty? }
+            value.split(separator || SEPARATOR_REGEXP).reject { |str| str.empty? }.map(&:strip)
           when :hash
-            value = YAML.load(value).to_hash rescue {}
+            value = YAML.load(value).to_h rescue eval(value).to_h rescue {}
             value.deep_stringify_keys!
-            return value
+            value
           when :integer
-            return value.to_i
+            value.to_i
+          when :float
+            value.to_f
+          when :big_decimal
+            value.to_d
           else
             value
           end
@@ -113,8 +126,8 @@ module RailsSettings
         end
 
         def _all_settings
-          raise "You can use settings before Rails initialize." unless rails_initialized?
-          Thread.current[:rails_settings_all_settings] ||= begin
+          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 = {}

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.0.2"
+      "2.2.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-26 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -133,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Settings plugin for Rails that makes managing a table of global keys.