rails-settings-cached 2.0.3 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f433f1f67e2ad2493d2ea5569115ee4af86f7d37a6e2abf033f3f780697fbc5f
-  data.tar.gz: 76593d4f3d843df0dbae34aaf0fbcce0ac9b89423dffef310c9de73c23e4e744
+  metadata.gz: 85279c41b179aa65d668a48d4d18e73b5fe886be9cd8235dc2acdb54c3beb5da
+  data.tar.gz: 516991953aa7698cf86511512d863b7903d1ec5ad648a69c386501413a75ac86
 SHA512:
-  metadata.gz: 34f9a5afcdfb90d4524f69b121accf15011a770296a585d720e85e97b3500d226bb674cf2b28da68d3c619b7c8cd1c93ffa398a0142a5e2937fa0e04fb67621a
-  data.tar.gz: e21096b92f58e31bd8db19bb09694ee236188d2b57ec1a35dc74bf853d591eaab84c50915715d5d08639086010b72e496c013a2d1548c48b8904e947f274d753
+  metadata.gz: 742596dc7e47c3d31ea64ecf54d96cae5885938076c2704aebe5f3e94701627631d19a8480f24ef97dc1861a8e1a1cab33c6f3aefd56ff755f88ef47c1380401
+  data.tar.gz: aa7b9a3ba2443a7ac6cb12150c196247bfd543e086b4eea1199f83eca1035ddefc1bcb32ae5d01cf9c3448dcd2f5c651dd9a73c8dab22600d28f202ef7d1f4a6

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,43 +1,28 @@
-## 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,
+а 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.
-
-## 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)
+[![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)
 
-## Setup
+## Installation
 
 Edit your Gemfile:
 
-```ruby
-gem "rails-settings-cached"
+```bash
+$ bundle add rails-settings-cached
 ```
 
 Generate your settings:
 
 ```bash
 $ rails g settings:install
-```
-
-If you want custom model name:
 
-```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`
@@ -45,31 +30,40 @@ You will get `app/models/setting.rb`
 ```rb
 class Setting < RailsSettings::Base
   # cache_prefix { "v1" }
-
+  field :app_name, default: "Rails Settings Cache Demo"
   field :host, default: "http://example.com"
+  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: 1
+  field :captcha_enable, type: :boolean, default: true
+
+  # Override array separator, default: /[\n,]/ split with \n or comma.
+  field :tips, type: :array, separator: /[\n]+/
+
   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
 ```
 
-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:
 
 ```bash
-rake db:migrate
+$ rails 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 +126,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 +156,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,15 +183,15 @@ 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
 
 ```rb
 namespace :admin do
-  resources :settings
+  resource :settings
 end
 ```
 
@@ -209,18 +203,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 +245,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>
+    </div>
+  </div>
+
+  <div>
+    <%= f.submit 'Update Settings' %>
+  </div>
 <% end %>
 ```
 
-## Use case:
+## Scoped Settings
+
+> 🚨 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
+
+- [Backward compatible to support 0.x scoped settings](docs/backward-compatible-to-scoped-settings.md)
+
+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.
+
+> This is reason of why rails-settings-cached 2.x removed **Scoped Settings** feature.
+
+For example:
+
+We wants a preferences setting for user.
+
+```rb
+class User < ActiveRecord::Base
+  serialize :preferences
+end
+
+@user = User.new
+@user.preferences[:receive_emails] = true
+@user.preferences[:public_email] = true
+@user.save
+```
+
+## Use cases:
+
+- [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
+
 
-- [ruby-china/ruby-china](https://github.com/ruby-china/ruby-china)
+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
 
@@ -32,12 +33,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

@@ -6,7 +6,7 @@ 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
@@ -30,7 +30,9 @@ module RailsSettings
       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)
@@ -43,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?
@@ -60,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!
@@ -79,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
@@ -115,7 +126,7 @@ module RailsSettings
         end
 
         def _all_settings
-          raise "You can use settings before Rails initialize." unless rails_initialized?
+          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")

data/lib/rails-settings/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.0.3"
+      "2.2.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.2.1
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-26 00:00:00.000000000 Z
+date: 2020-10-14 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
@@ -147,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Settings plugin for Rails that makes managing a table of global keys.
 test_files: []