rails-settings-cached 0.5.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b57a0a5ecf132300eb30437cecef1d72ac4a6850
-  data.tar.gz: 0819f21de6cb043141b20ff39ddd4c212aabd758
+SHA256:
+  metadata.gz: e89d0b87824703140e5d9182ade7936b22045bde791ba86d805dfbde9614f7b7
+  data.tar.gz: 2a3643dd2c6b3b837c3a4b1361651ca0a5b468336e038a38d1aaaa3bc659e151
 SHA512:
-  metadata.gz: b26625a6a49cc7413f18201e454374a6de07523705efd6eedd7d889aa464f2f07a057a541a277eba1fcfc1ad6cc791c4221ce6e84b35c2004cb37d86fdb661ad
-  data.tar.gz: d2c7146010da954ef4b8010b5a3fe7bd92a9c6c100c389a8db3c834fd90429c64a648387f6d5885c414f13b407f4cde974b382d13c6a089cc5dc0373780ef7d2
+  metadata.gz: e6b9209c170d1b5d34b62496533936c4e8598bc963fb5bd1fbb3a8c5b86424e6c7986fb300eb4aebc89ce7e13f86d083588bef06e93c5c6927b18ccf2465e5e6
+  data.tar.gz: 7b7b05d0794663008292b3630c99c160f8fc54cc0b9e8b958d46052cb63ce94f9eff4d012d06b2676551cfc805502d890e5313a887d3611bfb6fdbd0ffb2d3d9

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006 Alex Wayne
+Some additional features added 2009 by Georg Ledermann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,202 +1,233 @@
-# Settings Gem
-
-This is improved from [rails-settings](https://github.com/ledermann/rails-settings),
-added caching for all settings. Settings is a plugin that makes managing a table of
-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
-of object. Strings, numbers, arrays, or any object.
-
-## Status
-
-[![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![CI Status](https://api.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
-
-Edit your Gemfile:
-
-```ruby
-gem 'rails-settings-cached', "~> 0.5.6"
-```
-
-Older Rails versions:
-
-```rb
-# 4.1.x
-gem "rails-settings-cached", "~> 0.4.0"
-# 4.0.x
-gem "rails-settings-cached", "0.3.1"
-# 3.x
-gem "rails-settings-cached", "0.2.4"
-```
-
-Generate your settings:
-
-```bash
-$ rails g settings:install
-```
-
-If you want custom model name:
-
-```bash
-$ rails g settings:install MySetting
-```
-
-Now just put that migration in the database with:
-
-```bash
-rake db:migrate
-```
-
-## Usage
-
-The syntax is easy.  First, lets create some settings to keep track of:
-
-```ruby
-Setting.admin_password = 'supersecret'
-Setting.date_format    = '%m %d, %Y'
-Setting.cocktails      = ['Martini', 'Screwdriver', 'White Russian']
-Setting.foo            = 123
-Setting.credentials    = { :username => 'tom', :password => 'secret' }
-```
-
-Now lets read them back:
-
-```ruby
-Setting.foo            # returns 123
-```
-
-Changing an existing setting is the same as creating a new setting:
-
-```ruby
-Setting.foo = 'super duper bar'
-```
-
-For changing an existing setting which is a Hash, you can merge new values with existing ones:
-
-```ruby
-Setting.merge!(:credentials, :password => 'topsecret')
-Setting.credentials    # returns { :username => 'tom', :password => 'topsecret' }
-```
-
-Decide you dont want to track a particular setting anymore?
-
-```ruby
-Setting.destroy :foo
-Setting.foo            # returns nil
-```
-
-Want a list of all the settings?
-```ruby
-# Rails 4.1.x
-Setting.get_all
-# Rails 3.x and 4.0.x
-Setting.all
-# returns {'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y'}
-```
-
-You need name spaces and want a list of settings for a give name space? Just choose your prefered named space delimiter and use `Setting.get_all` (`Settings.all` for # Rails 3.x and 4.0.x) like this:
-
-```ruby
-Setting['preferences.color'] = :blue
-Setting['preferences.size'] = :large
-Setting['license.key'] = 'ABC-DEF'
-# Rails 4.1.x
-Setting.get_all('preferences.')
-# Rails 3.x and 4.0.x
-Setting.all('preferences.')
-# returns { 'preferences.color' => :blue, 'preferences.size' => :large }
-```
-
-Set defaults for certain settings of your app.  This will cause the defined settings to return with the
-Specified value even if they are **not in the database**.  Make a new file in `config/initializers/default_settings.rb`
-with the following:
-
-```ruby
-Setting.defaults[:some_setting] = 'footastic'
-Setting.where(:var => "some_setting").count
-=> 0
-Setting.some_setting
-=> "footastic"
-```
-
-Init default value in database, this has indifferent with `Setting.defaults[:some_setting]`, this will **save the value into database**:
-
-```ruby
-Setting.save_default(:some_key, "123")
-Setting.where(:var => "some_key").count
-=> 1
-Setting.some_key
-=> "123"
-```
-
-Settings may be bound to any existing ActiveRecord object. Define this association like this:
-Notice! is not do caching in this version.
-
-```ruby
-class User < ActiveRecord::Base
-  include RailsSettings::Extend
-end
-```
-
-Then you can set/get a setting for a given user instance just by doing this:
-
-```ruby
-user = User.find(123)
-user.settings.color = :red
-user.settings.color # returns :red
-# Rails 4.1.x
-user.settings.get_all
-# Rails 3.x and 4.0.x
-user.settings.all
-# { "color" => :red }
-```
-
-If you want to find users having or not having some settings, there are named scopes for this:
-
-```ruby
-User.with_settings
-# => returns a scope of users having any setting
-
-User.with_settings_for('color')
-# => returns a scope of users having a 'color' setting
-
-User.without_settings
-# returns a scope of users having no setting at all (means user.settings.get_all == {})
-
-User.without_settings('color')
-# returns a scope of users having no 'color' setting (means user.settings.color == nil)
-```
-
-Settings maybe dynamically scoped. For example, if you're using [apartment gem](https://github.com/influitive/apartment) for multitenancy, you may not want tenants to share settings:
-
-```ruby
-class Settings < RailsSettings::CachedSettings
-  cache_prefix { Apartment::Tenant.current }
-  ...
-end
-```
-
------
-
-## How to create a list, form to manage Settings?
-
-If you want create an admin interface to editing the Settings, you can try methods in follow:
-
-```ruby
-class SettingsController < ApplicationController
-  def index
-    # to get all items for render list
-    @settings = Setting.unscoped
-  end
-
-  def edit
-    @setting = Setting.unscoped.find(params[:id])
-  end
-end
-```
-
-
-Also you may use [rails-settings-ui](https://github.com/accessd/rails-settings-ui) gem
-for building ready to using interface with validations.
-
+# 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,
+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
+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)
+
+## Setup
+
+Edit your Gemfile:
+
+```ruby
+gem "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
+```
+
+You will get `app/models/setting.rb`
+
+```rb
+class Setting < RailsSettings::Base
+  # cache_prefix { "v1" }
+
+  field :host, default: "http://example.com"
+  field :readonly_item, type: :integer, default: 100, readonly: true
+  field :user_limits, type: :integer, default: 20
+  field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
+  field :captcha_enable, type: :boolean, default: 1
+  field :notification_options, type: :hash, default: {
+    send_all: true,
+    logging: true,
+    sender_email: "foo@bar.com"
+  }
+end
+```
+
+You must use `field` method to statement the setting keys, otherwice you can't use it.
+
+Now just put that migration in the database with:
+
+```bash
+rake db:migrate
+```
+
+## Usage
+
+The syntax is easy.  First, lets 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.user_limits
+20
+irb > Setting.user_limits = "30"
+irb > Setting.user_limits
+30
+irb > Setting.user_limits = 45
+irb > Setting.user_limits
+45
+
+irb > Setting.captcha_enable
+1
+irb > Setting.captcha_enable?
+true
+irb > Setting.captcha_enable = "0"
+irb > Setting.captcha_enable
+false
+irb > Setting.captcha_enable = "1"
+irb > Setting.captcha_enable
+true
+irb > Setting.captcha_enable = "false"
+irb > Setting.captcha_enable
+false
+irb > Setting.captcha_enable = "true"
+irb > Setting.captcha_enable
+true
+irb > Setting.captcha_enable?
+true
+
+irb > Setting.admin_emails
+["admin@rubyonrails.org"]
+irb > Setting.admin_emails = %w[foo@bar.com bar@dar.com]
+irb > Setting.admin_emails
+["foo@bar.com", "bar@dar.com"]
+irb > Setting.admin_emails = "huacnlee@gmail.com,admin@admin.com\nadmin@rubyonrails.org"
+irb > Setting.admin_emails
+["huacnlee@gmail.com", "admin@admin.com", "admin@rubyonrails.org"]
+
+irb > Setting.notification_options
+{
+  send_all: true,
+  logging: true,
+  sender_email: "foo@bar.com"
+}
+irb > Setting.notification_options = {
+  sender_email: "notice@rubyonrails.org"
+}
+irb > Setting.notification_options
+{
+  sender_email: "notice@rubyonrails.org"
+}
+```
+
+### Caching flow:
+
+```
+Setting.host -> Check Cache -> Exist - Get value of key for cache -> Return
+                   |
+                Fetch all key and values from DB -> Write Cache -> 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.
+
+Each key update will expires the cache, so do not add some frequent update key.
+
+## Change cache key
+
+Some times you may need to force update cache, now you can use `cache_prefix`
+
+```ruby
+class Setting < RailsSettings::Base
+  cache_prefix { "you-prefix" }
+  ...
+end
+```
+
+-----
+
+## How to manage Settings in admin interface?
+
+If you want create an admin interface to editing the Settings, you can try methods in follow:
+
+config/routes.rb
+
+```rb
+namespace :admin do
+  resources :settings
+end
+```
+
+
+app/controllers/admin/settings_controller.rb
+
+```rb
+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.")
+    end
+
+
+    private
+      def setting_params
+        params.require(:setting).permit(:host, :user_limits, :admin_emails,
+          :captcha_enable, :notification_options)
+      end
+  end
+end
+```
+
+app/views/admin/settings/show.html.erb
+
+```erb
+<%= form_for(Setting.new, url: admin_settings_path) do |f| %>
+  <div class="form-group">
+    <label class="control-label">Host</label>
+    <%= f.text_field :host, value: Setting.host, class: "form-control", placeholder: "http://localhost"  %>
+  </div>
+
+  <div class="form-group form-checkbox">
+    <label>
+      <%= f.check_box :captcha_enable, checked: Setting.captcha_enable? %>
+      Enable/Disable Captcha
+    </label>
+  </div>
+
+  <div class="form-group">
+    <label class="control-label">Admin Emails</label>
+    <%= f.text_area :admin_emails, value: Setting.admin_emails.join("\n"), class: "form-control" %>
+  </div>
+
+  <div class="form-group">
+    <label class="control-label">Notification options</label>
+    <%= 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 %>
+```
+
+## Use case:
+
+- [ruby-china/ruby-china](https://github.com/ruby-china/ruby-china)

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Rails Settings Cached"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/lib/generators/settings/install_generator.rb

@@ -1,14 +1,16 @@
-require 'rails/generators'
-require 'rails/generators/migration'
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
 
 module Settings
   class InstallGenerator < Rails::Generators::NamedBase
     desc "Generate RailsSettings files."
     include Rails::Generators::Migration
 
-    argument :name, type: :string, default: 'setting'
+    argument :name, type: :string, default: "setting"
 
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path("../templates", __FILE__)
 
     @@migrations = false
 
@@ -18,16 +20,24 @@ module Settings
           (current_migration_number(dirname) + 1)
         else
           @@migrations = true
-          Time.now.utc.strftime('%Y%m%d%H%M%S')
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
         end
       else
-        format '%.3d', current_migration_number(dirname) + 1
+        format "%.3d", current_migration_number(dirname) + 1
       end
     end
 
     def install_setting
-      template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb"), force: true
-      migration_template 'migration.rb', 'db/migrate/create_settings.rb'
+      template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      migration_template "migration.rb", "db/migrate/create_settings.rb", migration_version: migration_version
+    end
+
+    def rails5?
+      Rails.version.start_with? "5"
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5?
     end
   end
 end

data/lib/generators/settings/templates/migration.rb

@@ -1,14 +1,12 @@
-class CreateSettings < ActiveRecord::Migration
+class CreateSettings < ActiveRecord::Migration<%= migration_version %>
   def self.up
     create_table :settings do |t|
       t.string  :var,        null: false
       t.text    :value,      null: true
-      t.integer :thing_id,   null: true
-      t.string  :thing_type, null: true, limit: 30
       t.timestamps
     end
 
-    add_index :settings, %i(thing_type thing_id var), unique: true
+    add_index :settings, %i(var), unique: true
   end
 
   def self.down

data/lib/generators/settings/templates/model.rb

@@ -1,3 +1,10 @@
 # RailsSettings Model
-class <%= class_name %> < RailsSettings::CachedSettings
+class <%= class_name %> < RailsSettings::Base
+  cache_prefix { "v1" }
+
+  # Define your fields
+  # field :host, type: :string, default: "http://localhost:3000"
+  # field :default_locale, default: "en", type: :string
+  # field :confirmable_enable, default: "0", type: :boolean
+  # field :admin_emails, default: "admin@rubyonrails.org", type: :array
 end

data/lib/rails-settings/base.rb

@@ -1,18 +1,11 @@
+# frozen_string_literal: true
+
 module RailsSettings
   class Base < ActiveRecord::Base
-    self.table_name = table_name_prefix + 'settings'
-
     class SettingNotFound < RuntimeError; end
 
-    cattr_accessor :defaults
-    @@defaults = {}.with_indifferent_access
-
-    belongs_to :thing, polymorphic: true
-
-    # Support old plugin
-    if defined?(SettingsDefaults::DEFAULTS)
-      @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
-    end
+    SEPARATOR_REGEXP = /[\s,]/
+    self.table_name = table_name_prefix + "settings"
 
     # get the value field, YAML decoded
     def value
@@ -24,89 +17,105 @@ module RailsSettings
       self[:value] = new_value.to_yaml
     end
 
-    class << self
-      # get or set a variable with the variable as the called method
-      def method_missing(method, *args)
-        method_name = method.to_s
-        super(method, *args)
-      rescue NoMethodError
-        # set a value for a variable
-        if method_name[-1] == '='
-          var_name = method_name.sub('=', '')
-          value = args.first
-          self[var_name] = value
-        else
-          # retrieve a value
-          self[method_name]
-        end
-      end
-
-      # destroy the specified settings record
-      def destroy(var_name)
-        var_name = var_name.to_s
-        obj = object(var_name)
-        raise SettingNotFound, "Setting variable \"#{var_name}\" not found" if obj.nil?
-
-        obj.destroy
-        true
-      end
-
-      # retrieve all settings as a hash (optionally starting with a given namespace)
-      def get_all(starting_with = nil)
-        vars = thing_scoped.select('var, value')
-        vars = vars.where("var LIKE '#{starting_with}%'") if starting_with
-
-        result = {}
-        vars.each do |record|
-          result[record.var] = record.value
-        end
-        default_keys = @@defaults.keys
-        default_keys = default_keys.select {|k| k.start_with? starting_with } if starting_with
-        result.merge! @@defaults.slice(*(default_keys - result.keys))
-
-        result.with_indifferent_access
-      end
+    def expire_cache
+      Thread.current[:rails_settings_all_settings] = nil
+      Rails.cache.delete(self.class.cache_key)
+    end
 
-      def where(sql = nil)
-        vars = thing_scoped.where(sql) if sql
-        vars
+    class << self
+      def field(key, **opts)
+        _define_field(key, default: opts[:default], type: opts[:type], readonly: opts[:readonly])
       end
 
-      # get a setting value by [] notation
-      def [](var_name)
-        object(var_name).try(:value) || @@defaults[var_name.to_s]
+      def cache_prefix(&block)
+        @cache_prefix = block
       end
 
-      # set a setting value by [] notation
-      def []=(var_name, value)
-        var_name = var_name.to_s
-
-        record = object(var_name) || thing_scoped.new(var: var_name)
-        record.value = value
-        record.save!
-
-        value
+      def cache_key
+        scope = ["rails-settings-cached"]
+        scope << @cache_prefix.call if @cache_prefix
+        scope.join("/")
       end
 
-      def merge!(var_name, hash_value)
-        raise ArgumentError unless hash_value.is_a?(Hash)
+      private
+        def _define_field(key, default: nil, type: :string, readonly: false)
+          self.class.define_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)
+
+            result
+          end
+
+          unless readonly
+            self.class.define_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)
+
+              record.value = value
+              record.save!
+
+              value
+            end
+          end
+
+          if type == :boolean
+            self.class.define_method("#{key}?") do
+              val = self.send(:_value_of, key)
+              val == "true" || val == "1"
+            end
+          end
+        end
 
-        old_value = self[var_name] || {}
-        raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
+        def _covert_string_to_typeof_value(type, value)
+          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_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
+            value
+          end
+        end
 
-        new_value = old_value.merge(hash_value)
-        self[var_name] = new_value if new_value != old_value
+        def _value_of(var_name)
+          raise "#{self.table_name} does not exist." unless table_exists?
 
-        new_value
-      end
+          _all_settings[var_name.to_s]
+        end
 
-      def object(var_name)
-        thing_scoped.where(var: var_name.to_s).first
-      end
+        def rails_initialized?
+          Rails.application && Rails.application.initialized?
+        end
 
-      def thing_scoped
-        unscoped.where('thing_type is NULL and thing_id is NULL')
-      end
+        def _all_settings
+          raise "You can use settings before Rails initialize." unless rails_initialized?
+          Thread.current[: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
+          end
+        end
     end
   end
 end

data/lib/rails-settings/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RailsSettings
+  class Railtie < Rails::Railtie
+    initializer "rails_settings.active_record.initialization" do
+      RailsSettings::Base.after_commit :expire_cache, on: %i(create update destroy)
+    end
+  end
+end

data/lib/rails-settings/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module RailsSettings
   class << self
     def version
-      "0.5.6"
+      "2.0.0"
     end
   end
 end

data/lib/rails-settings-cached.rb

@@ -1,15 +1,8 @@
-require_relative 'rails-settings/base'
-require_relative 'rails-settings/settings'
-require_relative 'rails-settings/cached_settings'
-require_relative 'rails-settings/scoped_settings'
-require_relative 'rails-settings/extend'
-require_relative 'rails-settings/version'
+# frozen_string_literal: true
+
+require_relative "rails-settings/base"
+require_relative "rails-settings/railtie"
+require_relative "rails-settings/version"
 
 module RailsSettings
-  class Railtie < Rails::Railtie
-    initializer "rails_settings.active_record.initialization" do
-      RailsSettings::CachedSettings.after_commit :rewrite_cache, on: %i(create update)
-      RailsSettings::CachedSettings.after_commit :expire_cache, on: %i(destroy)
-    end
-  end
 end

metadata

@@ -1,17 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Lee
-- Squeegy
-- Georg Ledermann
-- 100hz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2019-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,6 +24,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "\n  This is improved from rails-settings, added caching.\n  Settings
   plugin for Rails that makes managing a table of global key,\n  value pairs easy.
   Think of it like a global Hash stored in you database,\n  that uses simple ActiveRecord
@@ -38,16 +105,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
+- Rakefile
 - lib/generators/settings/install_generator.rb
 - lib/generators/settings/templates/migration.rb
 - lib/generators/settings/templates/model.rb
 - lib/rails-settings-cached.rb
 - lib/rails-settings/base.rb
-- lib/rails-settings/cached_settings.rb
-- lib/rails-settings/extend.rb
-- lib/rails-settings/scoped_settings.rb
-- lib/rails-settings/settings.rb
+- lib/rails-settings/railtie.rb
 - lib/rails-settings/version.rb
 homepage: https://github.com/huacnlee/rails-settings-cached
 licenses: []
@@ -60,15 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Settings plugin for Rails that makes managing a table of global keys.

data/lib/rails-settings/cached_settings.rb

@@ -1,54 +0,0 @@
-module RailsSettings
-  class CachedSettings < Base
-    def rewrite_cache
-      Rails.cache.write(cache_key, value)
-    end
-
-    def expire_cache
-      Rails.cache.delete(cache_key)
-    end
-
-    def cache_key
-      self.class.cache_key(var, thing)
-    end
-
-    class << self
-      def cache_prefix(&block)
-        @cache_prefix = block
-      end
-
-      def cache_key(var_name, scope_object)
-        scope = "rails_settings_cached:"
-        scope << "#{@cache_prefix.call}:" if @cache_prefix
-        scope << "#{scope_object.class.name}-#{scope_object.id}:" if scope_object
-        scope << "#{var_name}"
-      end
-
-      def [](var_name)
-        value = Rails.cache.fetch(cache_key(var_name, @object)) do
-          super(var_name)
-        end
-
-        if value.nil?
-          @@defaults[var_name.to_s] if value.nil?
-        else
-          value
-        end
-      end
-
-      # set a setting value by [] notation
-      def []=(var_name, value)
-        super
-
-        Rails.cache.write(cache_key(var_name, @object),value)
-
-        value
-      end
-
-      def save_default(key, value)
-        return false unless self[key].nil?
-        self[key] = value
-      end
-    end
-  end
-end

data/lib/rails-settings/extend.rb

@@ -1,34 +0,0 @@
-module RailsSettings
-  module Extend
-    extend ActiveSupport::Concern
-
-    included do
-      scope :with_settings, lambda {
-        joins("JOIN settings ON (settings.thing_id = #{table_name}.#{primary_key} AND
-                                 settings.thing_type = '#{base_class.name}')")
-          .select("DISTINCT #{table_name}.*")
-      }
-
-      scope :with_settings_for, lambda  { |var|
-        joins("JOIN settings ON (settings.thing_id = #{table_name}.#{primary_key} AND
-                                 settings.thing_type = '#{base_class.name}') AND settings.var = '#{var}'")
-      }
-
-      scope :without_settings, lambda {
-        joins("LEFT JOIN settings ON (settings.thing_id = #{table_name}.#{primary_key} AND
-                                      settings.thing_type = '#{base_class.name}')")
-          .where('settings.id IS NULL')
-      }
-
-      scope :without_settings_for, lambda  { |var|
-        where('settings.id IS NULL')
-          .joins("LEFT JOIN settings ON (settings.thing_id = #{table_name}.#{primary_key} AND
-                                       settings.thing_type = '#{base_class.name}') AND settings.var = '#{var}'")
-      }
-    end
-
-    def settings
-      ScopedSettings.for_thing(self)
-    end
-  end
-end

data/lib/rails-settings/scoped_settings.rb

@@ -1,12 +0,0 @@
-module RailsSettings
-  class ScopedSettings < CachedSettings
-    def self.for_thing(object)
-      @object = object
-      self
-    end
-
-    def self.thing_scoped
-      unscoped.where(thing_type: @object.class.base_class.to_s, thing_id: @object.id)
-    end
-  end
-end

data/lib/rails-settings/settings.rb

@@ -1,9 +0,0 @@
-module RailsSettings
-  class Settings < Base
-    def self.inherited(subclass)
-      Kernel.warn 'DEPRECATION WARNING: RailsSettings::Settings is deprecated and it will removed in 0.6.0. ' <<
-                  'Please use RailsSettings::Base instead.'
-      super(subclass)
-    end
-  end
-end