rails-settings-cached 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bd842dbc504791a77630162468aa6e478a995c2
-  data.tar.gz: 5dcfb862ea79ee47eec0dd6316dfad8b3d1ff811
+  metadata.gz: 4c9f513e434fb39d1cfefa3ff34bac2b079d6aa9
+  data.tar.gz: 9d1c7c9775ab9108d5604bb1617f2bffde890e80
 SHA512:
-  metadata.gz: cd476936667b371251f5fb6b66a3a1dabdf5e99b6808171ecfdd0baa38bca03df6e6ed9475ed7a488626795952076a87d42923b174a13da57e4e1d24bb7c5e95
-  data.tar.gz: 8f093f58bf66a5939d57c6d412a7b9ce742b95f0de4d2f34ea1c0db53fc720df7aa23761964162b0a6d9ff1344630afa405ad9c348bc266a18c0a8ef4008d560
+  metadata.gz: 992cc15c9cadd8298dab78168b42d4ddf60d784a3749ecf66b7e0b1535b18487aa7b763ea89771b0e6e61ff805cb831d1a6d3700a545c51d5ba88b0dc6279f4b
+  data.tar.gz: 310666efc9ba502e62da3e7fd06f3282909c984fcee2518838c6ddd4c13b3045a9bd4dd485b8acd5c5beaeeca09789c04e46ef2b8f6d192a4c573e2d7a186a50

data/README.md

@@ -1,11 +1,11 @@
 # 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!
+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
 
@@ -84,19 +84,24 @@ 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 like this:
+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 }
 ```
 
@@ -137,7 +142,11 @@ Then you can set/get a setting for a given user instance just by doing this:
 user = User.find(123)
 user.settings.color = :red
 user.settings.color # returns :red
-user.settings.get_all # { "color" => :red }
+# Rails 4.1.x
+user.settings.get_all
+# Rails 3.x and 4.0.x
+user.settings.all
+# { "color" => :red }
 ```
 
 I you want to find users having or not having some settings, there are named scopes for this:
@@ -168,7 +177,7 @@ class SettingsController < ApplicationController
     # to get all items for render list
     @settings = Setting.unscoped
   end
-  
+
   def edit
     @setting = Setting.unscoped.find(params[:id])
   end
@@ -176,4 +185,6 @@ end
 ```
 
 
-That's all there is to it! Enjoy!
+Also you may use [rails-settings-ui](https://github.com/accessd/rails-settings-ui) gem
+for building ready to using interface with validations.
+

data/lib/generators/settings/settings_generator.rb

@@ -1,30 +1,30 @@
 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  
+class SettingsGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
 
-      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"
+  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
-    end
+    else
+      format '%.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/generators/settings/templates/migration.rb

@@ -1,14 +1,14 @@
 class CreateSettings < ActiveRecord::Migration
   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,3 @@
+# RailsSettings Model
 class <%= class_name %> < RailsSettings::CachedSettings
 end

data/lib/rails-settings-cached.rb

@@ -1,4 +1,4 @@
-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/scoped_settings'
+require_relative 'rails-settings/cached_settings'
+require_relative 'rails-settings/extend'

data/lib/rails-settings/cached_settings.rb

@@ -1,25 +1,29 @@
 module RailsSettings
   class CachedSettings < Settings
-    after_update :rewrite_cache    
-    after_create :rewrite_cache
+    after_commit :rewrite_cache, on: %i(create update)
     def rewrite_cache
-      Rails.cache.write("settings:#{self.var}", self.value)
+      Rails.cache.write("rails_settings_cached:#{var}", 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)
+
+    after_commit :expire_cache, on: %i(destroy)
+    def expire_cache
+      Rails.cache.delete("rails_settings_cached:#{var}")
+    end
+
+    class << self
+      def [](var_name)
+        cache_key = "rails_settings_cached:#{var_name}"
+        obj = Rails.cache.read(cache_key)
+        obj = super(var_name) if obj.nil?
+
+        return @@defaults[var_name.to_s] if obj.nil?
+        obj
+      end
+
+      def save_default(key, value)
+        return false unless send(key).nil?
+        send("#{key}=", value)
       end
     end
   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) {
+
+      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 = #{self.table_name}.#{self.primary_key} AND
-               settings.thing_type = '#{self.base_class.name}') AND settings.var = '#{var}'")
+          .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

@@ -4,10 +4,9 @@ module RailsSettings
       @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,6 +1,5 @@
 module RailsSettings
   class Settings < ActiveRecord::Base
-
     self.table_name = table_name_prefix + 'settings'
 
     class SettingNotFound < RuntimeError; end
@@ -13,106 +12,95 @@ module RailsSettings
       @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
     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
+    # get the value field, YAML decoded
+    def value
+      YAML.load(self[:value])
     end
 
-    #destroy the specified settings record
-    def self.destroy(var_name)
-      var_name = var_name.to_s
-      obj = object(var_name)
-      unless obj.nil?
-        obj.destroy
-        true
-      else
-        raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
-      end
+    # set the value field, YAML encoded
+    def value=(new_value)
+      self[:value] = new_value.to_yaml
     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}%'")
+    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
 
-      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)
+      # 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
-      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
+
+      # 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
+        result.with_indifferent_access
       end
-    end
 
-    #set a setting value by [] notation
-    def self.[]=(var_name, value)
-      var_name = var_name.to_s
+      def where(sql = nil)
+        vars = thing_scoped.where(sql) if sql
+        vars
+      end
 
-      record = object(var_name) || thing_scoped.new(:var => var_name)
-      record.value = value
-      record.save!
+      # get a setting value by [] notation
+      def [](var_name)
+        object(var_name).try(:value) || @@defaults[var_name.to_s]
+      end
 
-      value
-    end
+      # set a setting value by [] notation
+      def []=(var_name, value)
+        var_name = var_name.to_s
 
-    def self.merge!(var_name, hash_value)
-      raise ArgumentError unless hash_value.is_a?(Hash)
+        record = object(var_name) || thing_scoped.new(var: var_name)
+        record.value = value
+        record.save!
 
-      old_value = self[var_name] || {}
-      raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
+        value
+      end
 
-      new_value = old_value.merge(hash_value)
-      self[var_name] = new_value if new_value != old_value
+      def merge!(var_name, hash_value)
+        raise ArgumentError unless hash_value.is_a?(Hash)
 
-      new_value
-    end
+        old_value = self[var_name] || {}
+        raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
 
-    def self.object(var_name)
-      thing_scoped.where(:var => var_name.to_s).first
-    end
+        new_value = old_value.merge(hash_value)
+        self[var_name] = new_value if new_value != old_value
 
-    #get the value field, YAML decoded
-    def value
-      YAML::load(self[:value])
-    end
+        new_value
+      end
 
-    #set the value field, YAML encoded
-    def value=(new_value)
-      self[:value] = new_value.to_yaml
-    end
+      def object(var_name)
+        thing_scoped.where(var: var_name.to_s).first
+      end
 
-    def self.thing_scoped
-      unscoped.where("thing_type is NULL and thing_id is NULL")
+      def thing_scoped
+        unscoped.where('thing_type is NULL and thing_id is NULL')
+      end
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Squeegy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,14 +19,56 @@ 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
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
 description: 
 email: huacnlee@gmail.com
 executables: []
@@ -61,13 +103,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
-summary: This is imporved from rails-settings, added caching. Settings is a plugin
+summary: This is improved 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!
 test_files: []
+has_rdoc: