settler 1.1.1 → 1.2.0

data/README.rdoc

@@ -4,7 +4,7 @@ Settler can be used for defining application wide settings in Rails. Settings ar
 
 == Requirements
 
-* Activerecord, tested with Rails 2.3.5 & 2.3.8.
+* Activerecord, tested with Rails 2.3.5, 2.3.8 & rails 3.
 
 == Installation
  
@@ -133,7 +133,16 @@ When you require this class in your application, you can easily use your typecas
     >> Settler.google_analytics_key.destroy
     Setting Load (0.7ms)   SELECT \* FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
     => false
-  
+    
+* As of version 1.2, settings can always be updated when using the update_attribute method. Before that version, a before_filter was used instead of a validation. Note that you can change the validation message for settings that cannot be changed by adding the key 'settler.errors.editable' to I18n. Defaults to: 'cannot be changed'.
+
+* Settings can be reset to the values defined in the configuration file by calling reset!: 
+
+    >> Settler.google_analytics_key.reset!
+    => true
+
+  Note that this will always work regardless of the 'editable' attribute, so be careful when using this method!
+    
 * The Setting model performs a soft delete when it is destroyed, meaning the record is not really destroyed, but just marked as deleted. The reason for doing this is because settings are reloaded from the configuration file when your application is (re)started, unless a setting is already available in the database. Therefore, it should know about all deleted settings, otherwise it would re-insert the deleted setting. If you want to enforce this behaviour, use Setting#delete instead.
 
 == Advanced usage

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/lib/setting.rb

@@ -2,19 +2,23 @@ require 'type_casters'
 
 # The Setting class is an AR model that encapsulates a Settler setting. The key if the setting is the only required attribute.\
 class Setting < ActiveRecord::Base  
+  cattr_accessor :rails3
+  self.rails3 = defined?(ActiveRecord::VERSION) && ActiveRecord::VERSION::MAJOR >= 3  
+
   attr_readonly   :key
   attr_protected  :editable, :deletable, :deleted  
   
-  before_update :ensure_editable
-  
   validates_presence_of :key  
   validate :setting_validations
+  if rails3 then validate(:ensure_editable, :on => :update) else validate_on_update(:ensure_editable) end
   
   serialize :value
   
   default_scope :conditions => ['deleted = ? or deleted IS NULL', false]
-  named_scope :editable, :conditions => { :editable => true }
-  named_scope :deletable, :conditions => { :deletable => true }  
+  
+  scope_method = rails3 ? :scope : :named_scope
+  send scope_method, :editable, :conditions => { :editable => true }
+  send scope_method, :deletable, :conditions => { :deletable => true }  
   
   # Returns the value, typecasted if a typecaster is available.
   def value
@@ -60,6 +64,16 @@ class Setting < ActiveRecord::Base
     end
   end
   
+  # Resets this setting to the default stored in the settler configuration
+  def reset!
+    defaults = Settler.config[self.key]
+    self.alt = defaults['alt']
+    self.value = defaults['value']
+    self.editable = defaults['editable']
+    self.deletable = defaults['deletable']    
+    rails3 ? save(:validate => false) : save(false)
+  end
+  
   # Can be used to get *all* settings, including deleted settings.
   def self.without_default_scope &block
     Setting.with_exclusive_scope(&block)
@@ -68,15 +82,17 @@ class Setting < ActiveRecord::Base
   # Deleted scope is specified as a method as it needs to be an exclusive scope
   def self.deleted
     Setting.without_default_scope{ Setting.all :conditions => { :deleted => true } }
-  end
+  end 
   
-protected
+private
 
   # Performs instance validations as defined in the settler configuration.
   def setting_validations
-    errors.add(:value, I18n.t(:blank, :scope => 'activerecord.errors.messages')) if validators['presence'] && ['1','true',true].include?(validators['presence']) && self.value.nil?
-    errors.add(:value, I18n.t(:inclusion, :scope => 'activerecord.errors.messages')) if valid_values && !valid_values.include?(self.value)
-    errors.add(:value, I18n.t(:invalid, :scope => 'activerecord.errors.messages')) if validators['format'] && !(Regexp.new(validators['format']) =~ self.value)
+    if errors.empty?
+      errors.add(:value, I18n.t(:blank, :scope => 'activerecord.errors.messages')) if validators['presence'] && ['1','true',true].include?(validators['presence']) && self.value.nil?
+      errors.add(:value, I18n.t(:inclusion, :scope => 'activerecord.errors.messages')) if valid_values && !valid_values.include?(self.value)
+      errors.add(:value, I18n.t(:invalid, :scope => 'activerecord.errors.messages')) if validators['format'] && !(Regexp.new(validators['format']) =~ self.value)
+    end
   end
   
   # Retrieves all validators defined for this setting.
@@ -89,7 +105,9 @@ protected
     @typecaster ||= Typecaster.typecaster_for(typecast)    
   end
   
-  # Before_update filter to ensure uneditable settings cannot be updated.
-  def ensure_editable; return false unless editable? end  
+  # Ensures uneditable settings cannot be updated.
+  def ensure_editable
+    errors.add(:value, I18n.t('settler.errors.editable', :default => 'cannot be changed')) if value_changed? && !editable? 
+  end 
     
 end

data/lib/settler.rb

@@ -8,7 +8,7 @@ class Settler
   private_class_method :new
   cattr_accessor  :config, :raise_missing, :report_missing  
   cattr_writer    :namespace, :source
-  
+
   class << self
     # Loads the settler configuration from settler.yml and defines methods for retrieving the found settings.
     def load!    

data/lib/type_casters.rb

@@ -13,7 +13,7 @@ class Typecaster
   # Returns the first typecaster from the list of typecasters that is able to typecast the passed type.
   def self.typecaster_for(typecast)
     typecaster = typecast.constantize.instance rescue nil
-    typecaster.present? && typecaster.is_a?(Typecaster) ? typecaster : registered_typecasters.detect{|tc| tc.type == typecast } || self.new
+    typecaster.present? && typecaster.is_a?(Typecaster) ? typecaster : registered_typecasters.detect{|tc| tc.type == typecast } || self.instance
   end
   
   # Subclasses should implement this method and return the type of data it can typecast.

data/settler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{settler}
-  s.version = "1.1.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Reinier de Lange"]
-  s.date = %q{2010-09-27}
+  s.date = %q{2010-10-27}
   s.description = %q{This gem is a combination of the Squeegy's rails-settings and Binarylogic's settingslogic gem, meaning it reads its configuration from a YAML file, but stores all settings in the database as well for on the fly changes.}
   s.email = %q{r.j.delange@nedforce.nl}
   s.extra_rdoc_files = [
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/moiristo/settler}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Settler manages global application settings in Rails}
   s.test_files = [
     "test/custom_typecaster.rb",
@@ -55,7 +55,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/test/helper.rb

@@ -5,12 +5,10 @@ require 'pp'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require 'FileUtils'
-
 gem "activerecord"
+require 'fileutils'
 require 'active_record'
-
-require File.dirname(__FILE__) + '/../init.rb'
+require 'active_support/core_ext/class/attribute_accessors'
 
 def load_schema
   config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
@@ -36,3 +34,6 @@ def load_schema
   load(File.dirname(__FILE__) + "/schema.rb")
 end  
 
+load_schema
+require File.dirname(__FILE__) + '/../init.rb'
+

data/test/test_settler.rb

@@ -1,8 +1,6 @@
 require 'helper'
 
 class TestSettler < Test::Unit::TestCase
-  load_schema
-  
   def setup
     Setting.without_default_scope{ Setting.delete_all }
     Settler.source = File.dirname(__FILE__) + '/settler.yml'
@@ -55,10 +53,18 @@ class TestSettler < Test::Unit::TestCase
   
   def test_should_not_update_uneditable_setting
     uneditable_setting = Settler.search_algorithm
-    assert !uneditable_setting.update_attributes(:value => 'new_value')
+    assert !uneditable_setting.update_attributes(:value => 'sphinx')
+    assert Setting.rails3 ? uneditable_setting.errors[:value].any? : uneditable_setting.errors.on(:value).present?
     assert_equal 'ferret', Settler[:search_algorithm]
   end
   
+  def test_should_manually_update_uneditable_setting
+    uneditable_setting = Settler.search_algorithm
+    assert uneditable_setting.update_attribute(:value, 'sphinx')
+    assert Setting.rails3 ? uneditable_setting.errors[:value].empty? : uneditable_setting.errors.on(:value).nil?
+    assert_equal 'sphinx', Settler[:search_algorithm]
+  end  
+  
   def test_should_update_editable_setting
     editable_setting = Settler.google_analytics_key
     assert editable_setting.update_attributes(:value => 'UA-xxxxxx-1')
@@ -67,7 +73,7 @@ class TestSettler < Test::Unit::TestCase
   
   def test_key_should_be_readonly_attribute
     setting = Settler.google_analytics_key
-    setting.update_attribute(:key, 'new_key')
+    setting.update_attribute(:key, 'new_key') rescue nil
     assert_equal 'google_analytics_key', setting.reload.key
   end
   
@@ -125,4 +131,16 @@ class TestSettler < Test::Unit::TestCase
     assert !setting.update_attributes(:value => 'invalid_format')    
   end
   
+  def test_should_reset_setting
+    uneditable_setting = Settler.search_algorithm
+    assert uneditable_setting.update_attribute(:deletable, false)
+    assert uneditable_setting.update_attribute(:value, 'sphinx')
+    assert_equal 'sphinx', Settler[:search_algorithm]
+    assert !uneditable_setting.deletable?
+    
+    uneditable_setting.reset!
+    assert_equal 'ferret', Settler[:search_algorithm] 
+    assert uneditable_setting.deletable?    
+  end  
+  
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: settler
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Reinier de Lange
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +02:00
+date: 2010-10-27 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -59,23 +60,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Settler manages global application settings in Rails