rails-settings-cached 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f433f1f67e2ad2493d2ea5569115ee4af86f7d37a6e2abf033f3f780697fbc5f
-  data.tar.gz: 76593d4f3d843df0dbae34aaf0fbcce0ac9b89423dffef310c9de73c23e4e744
+  metadata.gz: '08c5252dd50adb752c5f4271a8e8c6f9a33ed99688d1df97de143430aa8a3010'
+  data.tar.gz: 95cec20166fcf229ffe6f7b6bb70477e5139b297012b685a7ace320ff956639d
 SHA512:
-  metadata.gz: 34f9a5afcdfb90d4524f69b121accf15011a770296a585d720e85e97b3500d226bb674cf2b28da68d3c619b7c8cd1c93ffa398a0142a5e2937fa0e04fb67621a
-  data.tar.gz: e21096b92f58e31bd8db19bb09694ee236188d2b57ec1a35dc74bf853d591eaab84c50915715d5d08639086010b72e496c013a2d1548c48b8904e947f274d753
+  metadata.gz: 01d00c7d1681bdf3e3510a8397b5c7e3569672783260be3ef5fe835e5b51b7fb7fe15e9d328bcd92816100b23c4d8441e47602aa9ef3e56b2d77594df269375a
+  data.tar.gz: eec0ac9dfe44f09abdf800c2c968a6c15bb29be0dfb98176fda26c277ec82b4a6753a024069064bbfe8845d5768b121f30b3f024b44e045229e375e43c1c0b27

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:
@@ -59,7 +60,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 +70,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 +133,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 +163,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 `Thread.current` 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 +190,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
 
@@ -260,6 +261,76 @@ app/views/admin/settings/show.html.erb
 <% 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)
+- [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/rails-settings/base.rb

@@ -46,11 +46,11 @@ module RailsSettings
       private
         def _define_field(key, default: nil, type: :string, readonly: false)
           if readonly
-            self.class.define_method(key) do
+            define_singleton_method(key) do
               self.send(:_covert_string_to_typeof_value, type, default)
             end
           else
-            self.class.define_method(key) do
+            define_singleton_method(key) do
               val = self.send(:_value_of, key)
               result = nil
               if !val.nil?
@@ -65,7 +65,7 @@ module RailsSettings
               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)
@@ -79,7 +79,7 @@ module RailsSettings
           end
 
           if type == :boolean
-            self.class.define_method("#{key}?") do
+            define_singleton_method("#{key}?") do
               self.send(key)
             end
           end
@@ -115,7 +115,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.0.4"
     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.0.4
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-26 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -147,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.