rails-settings-cached 0.4.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6bd842dbc504791a77630162468aa6e478a995c2
-  data.tar.gz: 5dcfb862ea79ee47eec0dd6316dfad8b3d1ff811
+SHA256:
+  metadata.gz: 888a069815b6bab14f9f929eafed86726e25ee9a039b8e39fc5f502cf6ee2296
+  data.tar.gz: 483ceb459e33194b5dc530b84ac12e4946b1d572cef3e5809c3304f52c05c7b9
 SHA512:
-  metadata.gz: cd476936667b371251f5fb6b66a3a1dabdf5e99b6808171ecfdd0baa38bca03df6e6ed9475ed7a488626795952076a87d42923b174a13da57e4e1d24bb7c5e95
-  data.tar.gz: 8f093f58bf66a5939d57c6d412a7b9ce742b95f0de4d2f34ea1c0db53fc720df7aa23761964162b0a6d9ff1344630afa405ad9c348bc266a18c0a8ef4008d560
+  metadata.gz: 403951a85e14d29e651fe77bd5d9a1c64ff31dbac0760bca38f0cbc94aceca99a7ff3ba6ea88663d4f116f8216be8930c7311d4d44aae83c9809ca8c3f9ab0f9
+  data.tar.gz: 338908c1df4dc0b0068011881bd4d98206c0e977cf6c1cf5e646559fd06a2d4ddcccafc54be9b53e17eb8267e50f90df0c620f6866f35677277fb4d6a184cd36

data/README.md

@@ -1,179 +1,284 @@
-# Settings Gem
-
-This is improved from 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 you 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. Ported to Rails 3!
-
-## Status
-
-- [![Gem Version](https://badge.fury.io/rb/rails-settings-cached.png)](https://rubygems.org/gems/rails-settings-cached)
-- [![CI Status](https://api.travis-ci.org/huacnlee/rails-settings-cached.png)](http://travis-ci.org/huacnlee/rails-settings-cached)
-
-## Setup
-
-Edit your Gemfile:
-
-```ruby
-# Rails 4.1.x
-gem "rails-settings-cached", "0.4.1"
-# Rails 4+
-gem "rails-settings-cached", "0.3.1"
-# Rails 3.x
-gem "rails-settings-cached", "0.2.4"
-```
-
-Generate your settings:
-
-```bash
-$ rails g settings <settings_name>
-```
-
-Note: If you migrating from gem `rails-settings` then make sure you have it in your model
-
-```ruby
-class Settings < RailsSettings::CachedSettings
-  ...
-end
-```
-
-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
-Setting.get_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 like this:
-
-```ruby
-Setting['preferences.color'] = :blue
-Setting['preferences.size'] = :large
-Setting['license.key'] = 'ABC-DEF'
-Setting.get_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 defualt 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
-user.settings.get_all # { "color" => :red }
-```
-
-I 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)
-```
-
------
-
-## 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
-```
-
-
-That's all there is to it! Enjoy!
+# Rails Settings Cached
+
+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://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
+  source Rails.root.join("config/app.yml")
+  # cache_prefix { "v1" }
+end
+```
+
+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'
+```
+
+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
+Setting.get_all
+```
+
+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 }
+```
+
+## Extend a model
+
+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
+user.settings.get_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)
+```
+
+## Default settings
+
+Sometimes you may want define default settings.
+
+RailsSettings has generate a config YAML file in:
+
+```yml
+# config/app.yml
+defaults: &defaults
+  github_token: "123456"
+  twitter_token: "<%= ENV["TWITTER_TOKEN"] %>"
+  foo:
+    bar: "Foo bar"
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
+
+And you can use by `Setting` model:
+
+```
+Setting.github_token
+=> "123456"
+Setting.github_token = "654321"
+# Save into database.
+Setting.github_token
+# Read from databae / caching.
+=> "654321"
+Setting['foo.bar']
+=> 'Foo bar'
+```
+
+NOTE: YAML setting it also under the cache scope, when you restart Rails application, cache will expire,
+      so when you want change default config, you need restart Rails application server.
+
+### Caching flow:
+
+```
+Setting.foo -> Check Cache -> Exist - Write Cache -> Return
+                   |
+                Check DB -> Exist -> Write Cache -> Return
+                   |
+               Check Default -> Exist -> Write Cache -> Return
+                   |
+               Return nil
+```
+
+## Change cache key
+
+When `config/app.yml` has changed, you may need change the cache prefix to expires caches.
+
+```ruby
+class Setting < RailsSettings::Base
+  cache_prefix { 'you-prefix' }
+  ...
+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:
+
+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 index
+      @settings = Setting.get_all
+    end
+
+    def edit
+    end
+
+    def update
+      if @setting.value != params[:setting][:value]
+        @setting.value = params[:setting][:value]
+        @setting.save
+        redirect_to admin_settings_path, notice: 'Setting has updated.'
+      else
+        redirect_to admin_settings_path
+      end
+    end
+
+    def get_setting
+      @setting = Setting.find_by(var: params[:id]) || Setting.new(var: params[:id])
+    end
+  end
+end
+```
+
+app/views/admin/settings/index.html.erb
+
+```erb
+<table>
+  <tr>
+    <th>Key</th>
+    <th></th>
+  </tr>
+  <% @settings.each_key do |key| %>
+  <tr>
+    <td><%= key %></td>
+    <td><%= link_to 'edit', edit_admin_setting_path(key) %></td>
+  </tr>
+  <% end %>
+</table>
+```
+
+app/views/admin/settings/edit.html.erb
+
+```erb
+<%= form_for(@setting, url: admin_setting_path(@setting.var), method: 'patch') do |f| %>
+  <label><%= @setting.var %></label>
+  <%= f.text_area :value, rows: 10 %>
+  <%= f.submit %>
+<% end %>
+```
+
+Also you may use [rails-settings-ui](https://github.com/accessd/rails-settings-ui) gem
+for building ready to using interface with validations,
+or [activeadmin_settings_cached](https://github.com/artofhuman/activeadmin_settings_cached) gem if you use [activeadmin](https://github.com/activeadmin/activeadmin).
+
+## Use case:
+
+- [ruby-china/ruby-china](https://github.com/ruby-china/ruby-china)

data/lib/generators/settings/install_generator.rb

@@ -0,0 +1,42 @@
+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"
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    @@migrations = false
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        if @@migrations
+          (current_migration_number(dirname) + 1)
+        else
+          @@migrations = true
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+      else
+        format "%.3d", current_migration_number(dirname) + 1
+      end
+    end
+
+    def install_setting
+      template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      template "app.yml", File.join("config", "app.yml")
+      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/app.yml

@@ -0,0 +1,13 @@
+# config/app.yml for rails-settings-cached
+defaults: &defaults
+  foo: "Foo"
+  bar: 123
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

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

@@ -1,14 +1,14 @@
-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, :limit => 30, :null => true
+      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, [ :thing_type, :thing_id, :var ], :unique => true
+
+    add_index :settings, %i(thing_type thing_id var), unique: true
   end
 
   def self.down

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

@@ -1,2 +1,7 @@
-class <%= class_name %> < RailsSettings::CachedSettings
+# RailsSettings Model
+class <%= class_name %> < RailsSettings::Base
+  source Rails.root.join("config/app.yml")
+
+  # When config/app.yml has changed, you need change this prefix to v2, v3 ... to expires caches
+  # cache_prefix { "v1" }
 end

data/lib/rails-settings/base.rb

@@ -0,0 +1,44 @@
+module RailsSettings
+  class Base < Settings
+    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.to_s
+        scope.join("/")
+      end
+
+      def [](key)
+        return super(key) unless rails_initialized?
+        val = Rails.cache.fetch(cache_key(key, @object)) do
+          super(key)
+        end
+        val
+      end
+
+      # set a setting value by [] notation
+      def []=(var_name, value)
+        super
+        Rails.cache.write(cache_key(var_name, @object), value)
+        value
+      end
+    end
+  end
+end

data/lib/rails-settings/default.rb

@@ -0,0 +1,40 @@
+require "digest/md5"
+
+module RailsSettings
+  class Default < ::Hash
+    class MissingKey < StandardError; end
+
+    class << self
+      def enabled?
+        source_path && File.exist?(source_path)
+      end
+
+      def source(value = nil)
+        @source ||= value
+      end
+
+      def source_path
+        @source || Rails.root.join("config/app.yml")
+      end
+
+      def [](key)
+        # foo.bar.dar Nested fetch value
+        return instance[key] if instance.key?(key)
+        keys = key.to_s.split(".")
+        instance.dig(*keys)
+      end
+
+      def instance
+        return @instance if defined? @instance
+        @instance = new
+      end
+    end
+
+    def initialize
+      content = open(self.class.source_path).read
+      hash = content.empty? ? {} : YAML.load(ERB.new(content).result).to_hash
+      hash = hash[Rails.env] || {}
+      replace hash
+    end
+  end
+end

data/lib/rails-settings/extend.rb

@@ -1,37 +1,34 @@
 module RailsSettings
   module Extend
     extend ActiveSupport::Concern
-    
-    included do 
-      scope :with_settings, -> {
-        joins("JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
-                                               settings.thing_type = '#{self.base_class.name}')")
-        .select("DISTINCT #{self.table_name}.*")
-      } 
-                             
 
-      scope :with_settings_for, ->(var) {
-        joins("JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
-              settings.thing_type = '#{self.base_class.name}') AND settings.var = '#{var}'") 
+    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 :without_settings, -> {
-        joins("LEFT JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND settings.thing_type = '#{self.base_class.name}')")
-        .where("settings.id IS NULL")    
-      } 
-                                     
-      scope :without_settings_for, ->(var) {
-        where('settings.id IS NULL')
-        .joins("LEFT JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
-               settings.thing_type = '#{self.base_class.name}') AND settings.var = '#{var}'")
+
+      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/railtie.rb

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

data/lib/rails-settings/scoped_settings.rb

@@ -1,13 +1,12 @@
 module RailsSettings
-  class ScopedSettings < Settings
+  class ScopedSettings < Base
     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)
+      unscoped.where(thing_type: @object.class.base_class.to_s, thing_id: @object.id)
     end
- 
   end
-end
+end

data/lib/rails-settings/settings.rb

@@ -1,118 +1,118 @@
 module RailsSettings
   class Settings < ActiveRecord::Base
-
-    self.table_name = table_name_prefix + 'settings'
+    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
+    # get the value field, YAML decoded
+    def value
+      YAML.load(self[:value]) if self[:value].present?
     end
 
-    #get or set a variable with the variable as the called method
-    def self.method_missing(method, *args)
-      method_name = method.to_s
-      super(method, *args)
-    rescue NoMethodError
-      #set a value for a variable
-      if method_name =~ /=$/
-        var_name = method_name.gsub('=', '')
-        value = args.first
-        self[var_name] = value
-      #retrieve a value
-      else
-        self[method_name]
-      end
+    # set the value field, YAML encoded
+    def value=(new_value)
+      self[:value] = new_value.to_yaml
     end
 
-    #destroy the specified settings record
-    def self.destroy(var_name)
-      var_name = var_name.to_s
-      obj = object(var_name)
-      unless obj.nil?
+    class << self
+      # get or set a variable with the variable as the called method
+      # rubocop:disable Style/MethodMissing
+      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
-      else
-        raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
       end
-    end
 
-    #retrieve all settings as a hash (optionally starting with a given namespace)
-    def self.get_all(starting_with = nil)
-      vars = thing_scoped.select("var,value")
-      if starting_with
-        vars = vars.where("var LIKE '#{starting_with}%'")
+      # 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 { |record| result[record.var] = record.value }
+        result.reverse_merge!(default_settings(starting_with))
+        result.with_indifferent_access
       end
 
-      result = {}
-      vars.each do |record|
-        result[record.var] = record.value
-      end
-      result.with_indifferent_access
-    end
-    
-    def self.where(sql = nil)
-      if sql
-        vars = thing_scoped.where(sql)
+      def where(sql = nil)
+        vars = thing_scoped.where(sql) if sql
+        vars
       end
-      vars
-    end
-    
-    #get a setting value by [] notation
-    def self.[](var_name)
-      if var = object(var_name)
-        var.value
-      elsif @@defaults[var_name.to_s]
-        @@defaults[var_name.to_s]
-      else
-        nil
+
+      # get a setting value by [] notation
+      def [](var_name)
+        val = object(var_name)
+        return val.value if val
+        return Default[var_name] if Default.enabled?
       end
-    end
 
-    #set a setting value by [] notation
-    def self.[]=(var_name, value)
-      var_name = var_name.to_s
+      # 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!
+        record = object(var_name) || thing_scoped.new(var: var_name)
+        record.value = value
+        record.save!
 
-      value
-    end
+        value
+      end
 
-    def self.merge!(var_name, hash_value)
-      raise ArgumentError unless hash_value.is_a?(Hash)
+      def merge!(var_name, hash_value)
+        raise ArgumentError unless hash_value.is_a?(Hash)
 
-      old_value = self[var_name] || {}
-      raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
+        old_value = self[var_name] || {}
+        raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
 
-      new_value = old_value.merge(hash_value)
-      self[var_name] = new_value if new_value != old_value
+        new_value = old_value.merge(hash_value)
+        self[var_name] = new_value if new_value != old_value
 
-      new_value
-    end
+        new_value
+      end
 
-    def self.object(var_name)
-      thing_scoped.where(:var => var_name.to_s).first
-    end
+      def object(var_name)
+        return nil unless table_exists?
+        thing_scoped.where(var: var_name.to_s).first
+      end
 
-    #get the value field, YAML decoded
-    def value
-      YAML::load(self[:value])
-    end
+      def thing_scoped
+        unscoped.where("thing_type is NULL and thing_id is NULL")
+      end
 
-    #set the value field, YAML encoded
-    def value=(new_value)
-      self[:value] = new_value.to_yaml
-    end
+      def source(filename)
+        Default.source(filename)
+      end
 
-    def self.thing_scoped
-      unscoped.where("thing_type is NULL and thing_id is NULL")
-    end
+      def rails_initialized?
+        Rails.application && Rails.application.initialized?
+      end
+
+      private
 
+      def default_settings(starting_with = nil)
+        return {} unless Default.enabled?
+        return Default.instance if starting_with.nil?
+        Default.instance.select { |key, _| key.to_s.start_with?(starting_with) }
+      end
+    end
   end
 end

data/lib/rails-settings/version.rb

@@ -0,0 +1,7 @@
+module RailsSettings
+  class << self
+    def version
+      "0.7.1"
+    end
+  end
+end

data/lib/rails-settings-cached.rb

@@ -1,4 +1,10 @@
-require "rails-settings/settings"
-require "rails-settings/scoped_settings"
-require "rails-settings/cached_settings"
-require "rails-settings/extend"
+require_relative "rails-settings/settings"
+require_relative "rails-settings/base"
+require_relative "rails-settings/scoped_settings"
+require_relative "rails-settings/default"
+require_relative "rails-settings/extend"
+require_relative "rails-settings/railtie"
+require_relative "rails-settings/version"
+
+module RailsSettings
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.7.1
 platform: ruby
 authors:
+- Jason Lee
 - Squeegy
 - Georg Ledermann
 - 100hz
-- Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,29 +19,108 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-description: 
+        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.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.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: rspec
+  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
+  like methods for manipulation.\n\n  Keep track of any global setting that you dont
+  want to hard code into your rails app.\n  You can store any kind of object.  Strings,
+  numbers, arrays, or any object.\n  "
 email: huacnlee@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/generators/settings/settings_generator.rb
+- lib/generators/settings/install_generator.rb
+- lib/generators/settings/templates/app.yml
 - lib/generators/settings/templates/migration.rb
 - lib/generators/settings/templates/model.rb
 - lib/rails-settings-cached.rb
-- lib/rails-settings/cached_settings.rb
+- lib/rails-settings/base.rb
+- lib/rails-settings/default.rb
 - lib/rails-settings/extend.rb
+- lib/rails-settings/railtie.rb
 - lib/rails-settings/scoped_settings.rb
 - lib/rails-settings/settings.rb
+- lib/rails-settings/version.rb
 homepage: https://github.com/huacnlee/rails-settings-cached
 licenses: []
 metadata: {}
@@ -53,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -61,13 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: This is imporved from rails-settings, added caching. Settings is a plugin
-  that makes managing a table of global key, value pairs easy. Think of it like a
-  global Hash stored in you 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. Ported to Rails 3!
+summary: Settings plugin for Rails that makes managing a table of global keys.
 test_files: []

data/lib/generators/settings/settings_generator.rb

@@ -1,30 +0,0 @@
-require 'rails/generators/migration'
-
-    class SettingsGenerator < Rails::Generators::NamedBase
-      include Rails::Generators::Migration
-  
-      argument :name, :type => :string, :default => "my_settings"
-  
-      source_root File.expand_path('../templates', __FILE__)  
-  
-      @@migrations = false
-      
-      def self.next_migration_number(dirname) #:nodoc:
-        if ActiveRecord::Base.timestamped_migrations
-          if @@migrations          
-            (current_migration_number(dirname) + 1)
-          else
-            @@migrations = true
-            Time.now.utc.strftime("%Y%m%d%H%M%S")
-          end
-        else
-          "%.3d" % (current_migration_number(dirname) + 1)
-        end
-      end  
-
-      def settings      
-        #generate(:model, name, "--skip-migration")
-        template "model.rb", File.join("app/models",class_path,"#{file_name}.rb"), :force => true
-        migration_template "migration.rb", "db/migrate/create_settings.rb"
-      end
-    end

data/lib/rails-settings/cached_settings.rb

@@ -1,25 +0,0 @@
-module RailsSettings
-  class CachedSettings < Settings
-    after_update :rewrite_cache    
-    after_create :rewrite_cache
-    def rewrite_cache
-      Rails.cache.write("settings:#{self.var}", self.value)
-    end
-    
-    after_destroy { |record| Rails.cache.delete("settings:#{record.var}") }
-    
-    def self.[](var_name)
-      cache_key = "settings:#{var_name}"
-      obj = Rails.cache.fetch(cache_key) {
-        super(var_name)
-      }
-      obj == nil ? @@defaults[var_name.to_s] : obj
-    end    
-    
-    def self.save_default(key,value)
-      if self.send(key) == nil
-        self.send("#{key}=",value)
-      end
-    end
-  end
-end