settings-goo 0.2.0 → 0.3.0

data/README.rdoc

@@ -42,9 +42,4 @@ Remove a setting:
   Settings[:admin_email]    # returns nil
   
 List all setting keys:
-  Settings.keys             # returns [:admin_email, :ca_tax, :per_page, :role_enabled]
-  
-== TODO
-
-  Cache Settings.keys
-  Cache Create rails plugin gem
+  Settings.keys             # returns [:admin_email, :ca_tax, :per_page, :role_enabled]

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/settings.rb

@@ -1,7 +1,12 @@
 class Settings < ActiveRecord::Base
+  validates_presence_of :key
   validates_uniqueness_of :key
   after_save :clear_cache
+  after_create :clear_cache_keys
+  #TODO - Only clear cached keys when :key is updated, not :value
+  after_update :clear_cache_keys
   after_destroy :clear_cache
+  after_destroy :clear_cache_keys
 
   def value
     val = self[:value]
@@ -32,7 +37,9 @@ class Settings < ActiveRecord::Base
   end
   
   def self.keys
-    self.find(:all, :select => 'key', :order => 'key ASC').map{|s| s.key.to_sym}
+    Rails.cache.fetch("settings/settings.keys") {
+      self.find(:all, :select => 'key', :order => 'key ASC').map{|s| s.key.to_sym}
+    }
   end
   
   def self.remove(key)
@@ -53,4 +60,8 @@ private
   def clear_cache
     Rails.cache.delete("settings/#{key}")
   end
+  
+  def clear_cache_keys
+    Rails.cache.delete("settings/settings.keys")
+  end
 end

data/settings-goo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{settings-goo}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Kilmer"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-02-19}
   s.description = %q{A simple ActiveRecord based model for storing global application settings for your rails application in your database.}
   s.email = %q{chris.kilmer@dogwalkercentral.com}
   s.extra_rdoc_files = [

data/test/test_settings.rb

@@ -7,6 +7,14 @@ class SettingsTest < ActiveSupport::TestCase
     Rails.cache.clear
   end
   
+  ##############################
+  # Validations                #
+  ##############################
+  test 'should require key' do
+    setting = Settings.create(:key => nil)
+    assert_not_nil setting.errors.on(:key)
+  end
+    
   ##############################
   # Proper Serialization       #
   ##############################
@@ -64,6 +72,13 @@ class SettingsTest < ActiveSupport::TestCase
     assert_equal setting, val
   end
   
+  test 'should retrieve key immediatley after setting (when created with symbol)' do
+    key = :with_key
+    val = 'some val'
+    Settings[key] = val
+    assert_equal val, Settings[key]
+  end
+  
   test 'should set key' do
     val = true
     Settings[@key_name] = val
@@ -84,7 +99,13 @@ class SettingsTest < ActiveSupport::TestCase
   test 'should return nil when trying to remove non-existent key' do
     assert_nil Settings.remove :non_existent_key
   end
-   
+  
+  test 'should not create setting with nil key' do
+    assert_no_difference('Settings.count') do
+      Settings[nil] = 'something'
+    end
+  end
+     
   ##############################
   # Duplicate Handling         #
   ##############################
@@ -147,4 +168,50 @@ class SettingsTest < ActiveSupport::TestCase
     Settings.remove @key_name
     assert_nil Rails.cache.fetch(cache_key)    
   end
+  
+  test 'should create cache for Settings.keys' do
+    cache_key = "settings/settings.keys"
+    #Create a key
+    Settings[@key_name] = 'some val'
+    #Call to set cache
+    Settings.keys
+    assert_not_nil Rails.cache.fetch(cache_key)
+  end
+  
+  test 'should remove cache for Settings.keys whenever a new key is added' do
+    cache_key = "settings/settings.keys"
+    #Create a key
+    Settings[@key_name] = 'some val'
+    #Call to set cache
+    Settings.keys
+    assert_not_nil Rails.cache.fetch(cache_key)
+    #Add a new key
+    Settings[:another_key] = 'some other val'
+    assert_nil Rails.cache.fetch(cache_key)
+  end
+  
+  test 'should remove cache for Settings.keys whenever a key is updated' do
+    cache_key = "settings/settings.keys"
+    #Create a key
+    Settings[@key_name] = 'some val'
+    #Call to set cache
+    Settings.keys
+    assert_not_nil Rails.cache.fetch(cache_key)
+    #Update a key
+    setting = Settings.find_by_key(@key_name.to_s)
+    setting.update_attribute(:key, 'another_key')
+    assert_nil Rails.cache.fetch(cache_key)
+  end
+  
+  test 'should remove cache for Settings.keys whenever a key is removed' do
+    cache_key = "settings/settings.keys"
+    #Create a key
+    Settings[@key_name] = 'some val'
+    #Call to set cache
+    Settings.keys
+    assert_not_nil Rails.cache.fetch(cache_key)
+    #Update a key
+    Settings.remove(@key_name)
+    assert_nil Rails.cache.fetch(cache_key)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: settings-goo
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Kilmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 -07:00
+date: 2010-02-19 00:00:00 -07:00
 default_executable: 
 dependencies: []