ledermann-rails-settings 1.2.0 → 1.2.1

data/Changelog.md

@@ -1,15 +1,25 @@
+Version 1.2.1 (2013-02-09)
+
+- Quick and dirty fix for design flaw in target scope implementation (thanks to Yves-Eric Martin)
+- Use Thread.current instead of cattr_accessor to be threadsafe
+- Code cleanup
+
+
 Version 1.2.0 (2012-07-21)
 
 - Added model-level settings (thanks to Jim Ryan)
 
+
 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

data/README.md

@@ -150,9 +150,4 @@ 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/lib/rails-settings.rb

@@ -1,5 +1,4 @@
 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/scoped_settings.rb

@@ -1,7 +1,13 @@
 class ScopedSettings < Settings
+
+  @klasses = {}
+
   def self.for_target(target)
-    @target = target
-    self
+    @klasses[target] ||= self.dup.instance_eval do
+      def name; "ScopedSettings"; end # Required by ActiveModel::Naming
+      @target = target
+      self
+    end
   end
   
   def self.target_id

data/lib/rails-settings/settings.rb

@@ -1,26 +1,14 @@
 class Settings < ActiveRecord::Base
   class SettingNotFound < RuntimeError; end
   
-  cattr_accessor :defaults
-  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)
-    self.defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
+  def self.defaults
+    Thread.current[:rails_settings_defaults] ||= {}.with_indifferent_access
   end
   
+  def self.defaults=(value)
+    Thread.current[:rails_settings_defaults] = value
+  end
+
   #get or set a variable with the variable as the called method
   def self.method_missing(method, *args)
     if self.respond_to?(method)
@@ -47,18 +35,12 @@ 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}%'"} : {}
@@ -68,22 +50,20 @@ class Settings < ActiveRecord::Base
     vars.each do |record|
       result[record.var] = record.value
     end
-    defaults = @@defaults.select{ |k, v| k =~ /^#{starting_with}/ }
-    defaults = Hash[defaults] if defaults.is_a?(Array)
-    defaults.merge(result).with_indifferent_access
+    selected_defaults = defaults.select{ |k, v| k =~ /^#{starting_with}/ }
+    selected_defaults = Hash[selected_defaults] if selected_defaults.is_a?(Array)
+    selected_defaults.merge(result).with_indifferent_access
   end
   
   #get a setting value by [] notation
   def self.[](var_name)
-    cache.fetch(cache_key(var_name), cache_options) do
-      if var = target(var_name)
-        var.value
+    if var = target(var_name)
+      var.value
+    else
+      if target_id.nil?
+        defaults[var_name.to_s]
       else
-        if target_id.nil?
-          @@defaults[var_name.to_s]
-        else
-          target_type.constantize.settings[var_name.to_s]
-        end
+        target_type.constantize.settings[var_name.to_s]
       end
     end
   end
@@ -93,7 +73,6 @@ 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
   

data/lib/rails-settings/version.rb

@@ -1,3 +1,3 @@
 module RailsSettings
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/rails-settings.gemspec

@@ -18,11 +18,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # specify any dependencies here; for example:
-  s.add_development_dependency "rake"
-  s.add_development_dependency "sqlite3"
-  # s.add_runtime_dependency "rest-client"
   s.add_dependency 'activerecord', '>= 2.3'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sqlite3'
 end

data/test/settings_test.rb

@@ -78,13 +78,25 @@ class SettingsTest < Test::Unit::TestCase
     
     assert_setting nil, :two, user1
     assert_setting nil, :one, user2
-    
+
     assert_equal({ "one" => 1}, user1.settings.all('one'))
     assert_equal({ "two" => 2}, user2.settings.all('two'))
     assert_equal({ "one" => 1}, user1.settings.all('o'))
     assert_equal({}, user1.settings.all('non_existing_var'))
   end
-  
+
+  def test_target_scope_is_instance_safe
+    user1 = User.create! :name => 'First user'
+    user2 = User.create! :name => 'Second user'
+
+    assert_assign_setting 'Foo one', :foo, user1
+    assert_assign_setting 'Foo two', :foo, user2
+
+    settings_1 = user1.settings
+    settings_2 = user2.settings
+    assert_equal 'Foo one', settings_1.foo
+  end
+
   def test_named_scope
     user_without_settings = User.create! :name => 'User without settings'
     user_with_settings = User.create! :name => 'User with settings'
@@ -141,6 +153,13 @@ class SettingsTest < Test::Unit::TestCase
     assert_equal({ :two => 2 }, Settings[:empty_hash])
   end
   
+  def test_association_merge
+    user = User.create! :name => 'Mr. Foo'
+    user.settings.merge! :foo, { :one => 1, :two => 2}
+
+    assert_equal({:one => 1, :two => 2}, user.settings.foo)
+  end
+  
   def test_destroy
     Settings.destroy :test
     assert_equal nil, Settings.test
@@ -193,6 +212,14 @@ class SettingsTest < Test::Unit::TestCase
     user = User.create! :name => 'Mr. Foo'
     assert_equal({ 'foo' => 'bar' }, user.settings.all)
   end
+  
+  def test_issue_18
+    Settings.one = 'value1'
+    User.settings.two = 'value2'
+    
+    assert_equal({'two' => 'value2'}, User.settings.all)
+  end
+  
 
   private
     def assert_setting(value, key, scope_target=nil)
@@ -228,25 +255,4 @@ class SettingsTest < Test::Unit::TestCase
         assert_setting value, key
       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
+end

data/test/test_helper.rb

@@ -1,7 +1,3 @@
-require 'rubygems'
-
-require 'active_support'
-require 'active_support/test_case'
 require 'active_record'
 require 'test/unit'
 

metadata

@@ -1,103 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ledermann-rails-settings
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
   prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
-authors: 
+authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
+date: 2013-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    none: false
+  type: :runtime
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  type: :development
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
   name: sqlite3
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id005
-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: 
+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
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Changelog.md
@@ -112,7 +114,6 @@ files:
 - 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
@@ -121,37 +122,28 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/ledermann/rails-settings
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
 requirements: []
-
 rubyforge_project: ledermann-rails-settings
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Settings management for ActiveRecord objects
-test_files: 
+test_files:
 - test/settings_test.rb
 - test/test_helper.rb

data/lib/rails-settings/null_store.rb

@@ -1,48 +0,0 @@
-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