rails-settings-cached 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765057576ddcdb19d9f394f1844950f03e8c70944abd9b104e70824f60f7e0e5
-  data.tar.gz: 0d2a2c4aa7560d96bee3a0c1a0d50f7cb89bffd5c650ae47f2bd6169c0d12b6e
+  metadata.gz: 85279c41b179aa65d668a48d4d18e73b5fe886be9cd8235dc2acdb54c3beb5da
+  data.tar.gz: 516991953aa7698cf86511512d863b7903d1ec5ad648a69c386501413a75ac86
 SHA512:
-  metadata.gz: 908f7ae3d8e01710f9df4cb32a77b2302129107bcd34254cb5237fc5f5b98f2e4007fe315751ab3fd7e2212e14a0db133f796f994b0bd6a1cee48768717a01a9
-  data.tar.gz: fe611e7af4ac5ca72a98040c63b0475833878ac6f11b82953fd80458bb6b96311fff7fc174f890171f466f724be809cd334bc184b0cb0c8c7b3ae94f5fbee28f
+  metadata.gz: 742596dc7e47c3d31ea64ecf54d96cae5885938076c2704aebe5f3e94701627631d19a8480f24ef97dc1861a8e1a1cab33c6f3aefd56ff755f88ef47c1380401
+  data.tar.gz: aa7b9a3ba2443a7ac6cb12150c196247bfd543e086b4eea1199f83eca1035ddefc1bcb32ae5d01cf9c3448dcd2f5c651dd9a73c8dab22600d28f202ef7d1f4a6

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,20 +30,26 @@ 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: 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
 ```
 
@@ -68,12 +58,12 @@ 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
@@ -201,7 +191,7 @@ config/routes.rb
 
 ```rb
 namespace :admin do
-  resources :settings
+  resource :settings
 end
 ```
 
@@ -257,78 +247,50 @@ app/views/admin/settings/show.html.erb
       Use YAML format to config the SMTP_html
     </div>
   </div>
-<% 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
-
-@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/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)
+- [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/version.rb

@@ -3,7 +3,7 @@
 module RailsSettings
   class << self
     def version
-      "2.2.0"
+      "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.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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: []