ledermann-rails-settings 1.1.0 → 1.2.0

data/Changelog.md

@@ -1,3 +1,7 @@
+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)

data/README.md

@@ -78,7 +78,7 @@ Decide you dont want to track a particular setting anymore?
     Settings.foo
     # => nil
 
-Want a list of all the settings?
+Want a list of all the settings (including defaults)?
 
     Settings.all
     # => { 'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y' }
@@ -91,17 +91,6 @@ You need name spaces and want a list of settings for a give name space? Just cho
     Settings.all('preferences.')
     # => { '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/settings.rb
-with the following:
-
-    Settings.defaults[:some_setting] = 'footastic'
-  
-Now even if the database is completely empty, you app will have some intelligent defaults:
-
-    Settings.some_setting
-    # => 'footastic'
-
 Settings may be bound to any existing ActiveRecord object. Define this association like this:
 
     class User < ActiveRecord::Base
@@ -118,6 +107,35 @@ Then you can set/get a setting for a given user instance just by doing this:
     user.settings.all
     # => { "color" => :red }
 
+
+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/settings.rb
+with the following:
+
+    Settings.defaults[:foo] = 'footastic'
+  
+Now even if the database is completely empty, you app will have some intelligent defaults:
+
+    Settings.foo
+    # => 'footastic'
+
+Defaults can be defined on the model level, too:
+
+    User.settings.foo = 'bar'
+    User.find(123).settings.foo
+    # => 'bar'
+
+If the setting doesn't exist on the object or the model, you'll get the default, as expected:
+
+    Settings.defaults[:some_default] = 'foo'
+    
+    User.settings.some_default
+    # => 'foo'
+    
+    User.find(123).settings.some_default
+    # => 'foo'
+
+
 I you want to find users having or not having some settings, there are named scopes for this:
 
     User.with_settings

data/lib/rails-settings/active_record.rb

@@ -4,7 +4,15 @@ ActiveRecord::Base.class_eval do
       def settings
         ScopedSettings.for_target(self)
       end
-      
+
+      def self.settings
+        ScopedSettings.for_target(self)
+      end
+
+      def settings=(hash)
+        hash.each { |k,v| settings[k] = v }
+      end
+
       after_destroy { |user| user.settings.target_scoped.delete_all }
 
       scope_method = ActiveRecord::VERSION::MAJOR < 3 ? :named_scope : :scope

data/lib/rails-settings/scoped_settings.rb

@@ -5,10 +5,10 @@ class ScopedSettings < Settings
   end
   
   def self.target_id
-    @target.id
+    @target.is_a?(Class) ? nil : @target.id
   end
   
   def self.target_type
-    @target.class.base_class.to_s
+    @target.is_a?(Class) ? @target.name : @target.class.base_class.to_s
   end
 end

data/lib/rails-settings/settings.rb

@@ -68,16 +68,22 @@ class Settings < ActiveRecord::Base
     vars.each do |record|
       result[record.var] = record.value
     end
-    result.with_indifferent_access
+    defaults = @@defaults.select{ |k, v| k =~ /^#{starting_with}/ }
+    defaults = Hash[defaults] if defaults.is_a?(Array)
+    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)).present?
+      if var = target(var_name)
         var.value
       else
-        defaults[var_name.to_s]
+        if target_id.nil?
+          @@defaults[var_name.to_s]
+        else
+          target_type.constantize.settings[var_name.to_s]
+        end
       end
     end
   end

data/lib/rails-settings/version.rb

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

data/rails-settings.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
+  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'

data/test/settings_test.rb

@@ -4,8 +4,11 @@ class SettingsTest < Test::Unit::TestCase
   setup_db
   
   def setup
-    Settings.create(:var => 'test',  :value => 'foo')
-    Settings.create(:var => 'test2', :value => 'bar')
+    Settings.create!(:var => 'test',  :value => 'foo')
+    Settings.create!(:var => 'test2', :value => 'bar')
+    
+    # Reset defaults
+    Settings.defaults = {}.with_indifferent_access
   end
 
   def teardown
@@ -61,8 +64,8 @@ class SettingsTest < Test::Unit::TestCase
   end
   
   def test_target_scope
-    user1 = User.create :name => 'First user'
-    user2 = User.create :name => 'Second user'
+    user1 = User.create! :name => 'First user'
+    user2 = User.create! :name => 'Second user'
     
     assert_assign_setting 1, :one, user1
     assert_assign_setting 2, :two, user2
@@ -83,8 +86,8 @@ class SettingsTest < Test::Unit::TestCase
   end
   
   def test_named_scope
-    user_without_settings = User.create :name => 'User without settings'
-    user_with_settings = User.create :name => 'User with settings'
+    user_without_settings = User.create! :name => 'User without settings'
+    user_with_settings = User.create! :name => 'User with settings'
     user_with_settings.settings.one = '1'
     user_with_settings.settings.two = '2'
     
@@ -100,8 +103,8 @@ class SettingsTest < Test::Unit::TestCase
   end
   
   def test_delete_settings_after_destroying_target
-    user1 = User.create :name => 'Mr. Foo'
-    user2 = User.create :name => 'Mr. Bar'
+    user1 = User.create! :name => 'Mr. Foo'
+    user2 = User.create! :name => 'Mr. Bar'
     user1.settings.example = 42
     user2.settings.example = 43
     
@@ -155,6 +158,42 @@ class SettingsTest < Test::Unit::TestCase
     assert_setting(nil, 'test3')
   end
   
+  def test_class_level_settings
+    assert_equal User.settings.name, "ScopedSettings"
+  end
+
+  def test_object_inherits_class_settings_before_default
+    Settings.defaults[:foo] = 'global default'
+    User.settings.foo = 'model default'
+    
+    user = User.create! :name => 'Dwight'
+    
+    assert_equal user.settings.foo, 'model default'
+    assert_equal 'global default', Settings.foo
+  end
+
+  def test_class_inherits_default_settings
+    Settings.defaults[:foo] = 'bar'
+    assert_equal User.settings.foo, 'bar'
+  end
+
+  def test_sets_settings_with_hash
+    user = User.create! :name => 'Mr. Foo'
+    user.settings[:one] = '1'
+    user.settings[:two] = '2'
+    user.settings = { :two => '2a', :three => '3' }
+    
+    assert_equal '1',  user.settings[:one]   # ensure existing settings remain intact
+    assert_equal '2a', user.settings[:two]   # ensure settings are properly overwritten
+    assert_equal '3',  user.settings[:three] # ensure new setting are created
+  end
+
+  def test_all_includes_defaults
+    Settings.defaults[:foo] = 'bar'
+    user = User.create! :name => 'Mr. Foo'
+    assert_equal({ 'foo' => 'bar' }, user.settings.all)
+  end
+
   private
     def assert_setting(value, key, scope_target=nil)
       key = key.to_sym

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ledermann-rails-settings
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Georg Ledermann
@@ -15,12 +15,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-01 00:00:00 Z
+date: 2012-07-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  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: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,11 +59,11 @@ dependencies:
         - 3
         version: "2.3"
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,11 +73,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: sqlite3
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -59,7 +87,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  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: 
 - mail@georg-ledermann.de