ledermann-rails-settings 1.0.1 → 1.1.0

data/.travis.yml

@@ -1,9 +1,9 @@
+language: ruby
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - rbx-2.0
 gemfile:
   - ci/Gemfile.rails-2.3.x
-  - ci/Gemfile.rails-3.0.x
+#  - ci/Gemfile.rails-3.0.x
   - ci/Gemfile.rails-3.1.x
+  - ci/Gemfile.rails-3.2.x

data/Changelog.md

@@ -0,0 +1,13 @@
+Version 1.1.0 (2012-06-01)
+
+- Added caching (thanks to Matthew McEachen)
+
+Version 1.0.1 (2011-11-05)
+
+- Gemspec: Fixed missing dependency
+
+Version 1.0.0 (2011-11-05)
+
+- Conversion from Plugin to Gem
+- Destroying false values (thanks to @Pavling)
+- Testing with Travis

data/MIT-LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2006 Alex Wayne
-Some additional features added 2009-2011 by Georg Ledermann
+Some additional features added 2009-2012 by Georg Ledermann
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -7,9 +7,9 @@ Settings is a gem/plugin that makes managing a table of key/value pairs easy. Th
 
 ## Requirements
 
-ActiveRecord 2.3.x, 3.0.x or 3.1.x
+Rails 2.3.x, 3.1.x or 3.2.x (due to an [issue with Rails caching](https://github.com/rails/rails/pull/2010) it does not work properly with Rails 3.0.x)
 
-Tested with Ruby 1.8.7, 1.9.2, 1.9.3 and RBX2.0
+Tested with Ruby 1.8.7 and 1.9.3
 
 
 ## Installation
@@ -132,4 +132,9 @@ I you want to find users having or not having some settings, there are named sco
     User.without_settings('color')
     # returns a scope of users having no 'color' setting (means user.settings.color == nil)
 
+For better performance, you can enable caching, e.g.:
+
+    Settings.cache = ActiveSupport::Cache::MemoryStore.new
+    Settings.cache_options = { :expires_in => 5.minutes }
+
 That's all there is to it! Enjoy!

data/ci/Gemfile.rails-3.0.x

@@ -1,5 +1,5 @@
 source :rubygems
 
-gem 'activerecord', '~> 3.0.10'
+gem 'activerecord', '~> 3.0.12'
 gem 'sqlite3'
 gem 'rake'

data/ci/Gemfile.rails-3.1.x

@@ -1,5 +1,5 @@
 source :rubygems
 
-gem 'activerecord', '~> 3.1.1'
+gem 'activerecord', '~> 3.1.4'
 gem 'sqlite3'
 gem 'rake'

data/ci/Gemfile.rails-3.2.x

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'activerecord', '~> 3.2.2'
+gem 'sqlite3'
+gem 'rake'

data/lib/rails-settings.rb

@@ -1,4 +1,5 @@
-require 'rails-settings/version'
-require 'rails-settings/active_record'
-require 'rails-settings/settings'
+require 'rails-settings/version'
+require 'rails-settings/null_store'
+require 'rails-settings/active_record'
+require 'rails-settings/settings'
 require 'rails-settings/scoped_settings'

data/lib/rails-settings/null_store.rb

@@ -0,0 +1,48 @@
+unless defined?(ActiveSupport::Cache::NullStore)
+  # Copied from Rails 3
+  # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/null_store.rb
+  module ActiveSupport
+    module Cache
+      # A cache store implementation which doesn't actually store anything. Useful in
+      # development and test environments where you don't want caching turned on but
+      # need to go through the caching interface.
+      #
+      # This cache does implement the local cache strategy, so values will actually
+      # be cached inside blocks that utilize this strategy. See
+      # ActiveSupport::Cache::Strategy::LocalCache for more details.
+      class NullStore < Store
+        def initialize(options = nil)
+          super()
+          extend Strategy::LocalCache
+        end
+
+        def clear(options = nil)
+        end
+
+        def cleanup(options = nil)
+        end
+
+        def increment(name, amount = 1, options = nil)
+        end
+
+        def decrement(name, amount = 1, options = nil)
+        end
+
+        def delete_matched(matcher, options = nil)
+        end
+
+        protected
+          def read_entry(key, options) # :nodoc:
+          end
+
+          def write_entry(key, entry, options) # :nodoc:
+            true
+          end
+
+          def delete_entry(key, options) # :nodoc:
+            false
+          end
+      end
+    end
+  end
+end

data/lib/rails-settings/settings.rb

@@ -2,11 +2,23 @@ class Settings < ActiveRecord::Base
   class SettingNotFound < RuntimeError; end
   
   cattr_accessor :defaults
-  @@defaults = {}.with_indifferent_access
-  
+  self.defaults = {}.with_indifferent_access
+
+  # cache must follow the contract of ActiveSupport::Cache. Defaults to no-op.
+  cattr_accessor :cache
+  self.cache = ActiveSupport::Cache::NullStore.new
+
+  # options passed to cache.fetch() and cache.write(). example: {:expires_in => 5.minutes}
+  cattr_accessor :cache_options
+  self.cache_options = {}
+
+  def self.cache_key(var_name)
+    [target_id, target_type, var_name].compact.join("::")
+  end
+
   # Support old plugin
   if defined?(SettingsDefaults::DEFAULTS)
-    @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
+    self.defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
   end
   
   #get or set a variable with the variable as the called method
@@ -35,12 +47,18 @@ class Settings < ActiveRecord::Base
     var_name = var_name.to_s
     begin
       target(var_name).destroy
+      cache.delete(cache_key(var_name))
       true
     rescue NoMethodError
       raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
     end
   end
 
+  def self.delete_all(conditions = nil)
+    cache.clear
+    super
+  end
+
   #retrieve all settings as a hash (optionally starting with a given namespace)
   def self.all(starting_with=nil)
     options = starting_with ? { :conditions => "var LIKE '#{starting_with}%'"} : {}
@@ -55,10 +73,12 @@ class Settings < ActiveRecord::Base
   
   #get a setting value by [] notation
   def self.[](var_name)
-    if var = target(var_name)
-      var.value
-    else
-      @@defaults[var_name.to_s]
+    cache.fetch(cache_key(var_name), cache_options) do
+      if (var = target(var_name)).present?
+        var.value
+      else
+        defaults[var_name.to_s]
+      end
     end
   end
   
@@ -67,7 +87,7 @@ class Settings < ActiveRecord::Base
     record = target_scoped.find_or_initialize_by_var(var_name.to_s)
     record.value = value
     record.save!
-    
+    cache.write(cache_key(var_name), value, cache_options)
     value
   end
   
@@ -113,4 +133,4 @@ class Settings < ActiveRecord::Base
   def self.target_type
     nil
   end
-end
+end

data/lib/rails-settings/version.rb

@@ -1,3 +1,3 @@
 module RailsSettings
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/rails-settings.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |s|
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
   s.add_dependency 'activerecord', '>= 2.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sqlite3'
 end

data/test/settings_test.rb

@@ -9,6 +9,7 @@ class SettingsTest < Test::Unit::TestCase
   end
 
   def teardown
+    User.delete_all
     Settings.delete_all
   end
   
@@ -23,6 +24,11 @@ class SettingsTest < Test::Unit::TestCase
     assert_not_nil Settings.target(:foo)
   end
   
+  def tests_defaults_true
+    Settings.defaults[:foo] = true
+    assert_equal true, Settings.foo
+  end
+
   def tests_defaults_false
     Settings.defaults[:foo] = false
     assert_equal false, Settings.foo
@@ -183,4 +189,25 @@ class SettingsTest < Test::Unit::TestCase
         assert_setting value, key
       end
     end
-end
+end
+
+class CachedSettingsTest < SettingsTest
+  def setup
+    Settings.cache = ActiveSupport::Cache::MemoryStore.new
+    Settings.cache_options = { :expires_in => 5.minutes }
+    super
+  end
+
+  def test_caching_is_in_place
+    Settings.progress = "boing"
+    Settings.connection.execute("delete from settings")
+    assert_equal "boing", Settings.progress
+    Settings.cache.clear
+    assert_nil Settings.progress
+  end
+
+  def teardown
+    Settings.cache.clear
+    super
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ledermann-rails-settings
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Georg Ledermann
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-05 00:00:00 +01:00
-default_executable: 
+date: 2012-06-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -33,6 +32,34 @@ dependencies:
         version: "2.3"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Ruby Gem that makes managing a table of key/value pairs easy. Think of it like a Hash stored in you database, that uses simple ActiveRecord like methods for manipulation.
 email: 
 - mail@georg-ledermann.de
@@ -45,6 +72,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .travis.yml
+- Changelog.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -52,16 +80,17 @@ files:
 - ci/Gemfile.rails-2.3.x
 - ci/Gemfile.rails-3.0.x
 - ci/Gemfile.rails-3.1.x
+- ci/Gemfile.rails-3.2.x
 - init.rb
 - lib/rails-settings.rb
 - lib/rails-settings/active_record.rb
+- lib/rails-settings/null_store.rb
 - lib/rails-settings/scoped_settings.rb
 - lib/rails-settings/settings.rb
 - lib/rails-settings/version.rb
 - rails-settings.gemspec
 - test/settings_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: https://github.com/ledermann/rails-settings
 licenses: []
 
@@ -91,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ledermann-rails-settings
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Settings management for ActiveRecord objects