simplificator-has_setting 0.4.2 → 0.4.3

data/README

@@ -3,6 +3,10 @@ has_setting is a simple extension that enables ActiveRecord models to
 store settings in a separate settings table as key/value pairs where the key and value are stored as Strings.
 
 ==History
+ * 0.4.3:
+   * Changed behaviour of :boolean formatters: Now they treat '0', 0, false, nil and '' as false, everything else as true
+     This is not the same behaviour as ruby (treating only nil and false as false) but should help with input from web forms (i.e. checkboxes)
+     If you want strict ruby boolean behaviour, then use :strict_boolean as :type
  * 0.4.2:
    * bug fixes for boolean types default values
  * 0.3.10:
@@ -45,12 +49,14 @@ This will create the following methods for you on the owner class:
 <em>:type</em> allows you to convert the value:
   * <em>:string</em> (default) Uses the StringFormatter to convert from/to String (actually this formatter just leaves the value as it is)
   * <em>:int</em> Uses the IntFormatter to convert from/to int values.
-  * <em>:boolean</em> Uses the BooleanFormatter to convert from/to boolean values.
+  * <em>:boolean</em> Uses the BooleanFormatter to convert from/to boolean values; treating 0, '0', false, '' and nil as false.
+  * <em>:strict_boolean</em> Uses the StrictBooleanFormatter to convert from/to boolean values; treating false, and nil as false.
   * <em>:float</em> Uses the FloatFormatter to convert from/to float values.
   * <em>:ints</em> Uses the IntsFormatter to convert from/to int[]
   * <em>:floats</em> Uses the FloatsFormatter to convert from/to float[]
   * <em>:strings</em> Uses the StringsFormatter to convert from/to string[]
   * <em>:booleans</em> Uses the BooleansFormatter to convert from/to boolean[]
+  * <em>:strict_booleans</em> Uses the BooleansFormatter to convert from/to boolean[]
 <em>:default</em> allows you to specify a default value that will be returned if the setting does not exist (i.e. has never been written). Note that the default value is _ignored_ if the setting exists, no matter what the value of the setting is. The default value is returned as is, no type conversion takes place.
 
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 4
-:patch: 2
+:patch: 3
 :major: 0

data/has_setting.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_setting}
-  s.version = "0.4.2"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simplificator GmbH"]
-  s.date = %q{2009-08-21}
+  s.date = %q{2009-09-02}
   s.description = %q{Stores settings as key/value pairs in a settings table and provides accessors for them on the owning object}
   s.email = %q{info@simplificator.com}
   s.extra_rdoc_files = [

data/lib/has_setting.rb

@@ -15,4 +15,6 @@ HasSetting::Formatters.register_formatter(:floats, HasSetting::Formatters::Float
 HasSetting::Formatters.register_formatter(:int, HasSetting::Formatters::IntFormatter.new)
 HasSetting::Formatters.register_formatter(:ints, HasSetting::Formatters::IntsFormatter.new)
 HasSetting::Formatters.register_formatter(:boolean, HasSetting::Formatters::BooleanFormatter.new)
-HasSetting::Formatters.register_formatter(:booleans, HasSetting::Formatters::BooleansFormatter.new)
+HasSetting::Formatters.register_formatter(:booleans, HasSetting::Formatters::BooleansFormatter.new)
+HasSetting::Formatters.register_formatter(:strict_boolean, HasSetting::Formatters::StrictBooleanFormatter.new)
+HasSetting::Formatters.register_formatter(:strict_booleans, HasSetting::Formatters::StrictBooleansFormatter.new)

data/lib/has_setting/formatters.rb

@@ -43,12 +43,15 @@ module HasSetting
         value.to_s
       end
     end
+    # Convert a Boolean to String and Back
+    # nil, '0', false, 0 and '' are considered __false__, everything else is __true__
+    # This is not like ruby where only nil and false are considered __false__
     class BooleanFormatter < NilSafeFormatter
       def safe_to_type(value)
         value == '1'
       end
       def safe_to_s(value)
-        value ? '1' : '0'
+        value && value != '0' && value != 0 && value != '' ? '1' : '0'
       end
     end
     class BooleansFormatter < NilSafeFormatter
@@ -60,6 +63,23 @@ module HasSetting
       end
     end
     
+    class StrictBooleanFormatter < NilSafeFormatter
+      def safe_to_type(value)
+        value == '1'
+      end
+      def safe_to_s(value)
+        value ? '1' : '0'
+      end
+    end
+    class StrictBooleansFormatter < NilSafeFormatter
+      def safe_to_type(value)
+        value.split(',').map() {|item| Formatters.for_type(:strict_boolean).to_type(item)}
+      end
+      def safe_to_s(value)
+        Array(value).map() {|item| Formatters.for_type(:strict_boolean).to_s(item)}.join(',')
+      end
+    end
+    
     class IntsFormatter < NilSafeFormatter
       def safe_to_type(value)
         value.split(',').map() {|item| Formatters.for_type(:int).to_type(item)}

data/test/unit/formatters_test.rb

@@ -2,9 +2,15 @@ require File.dirname(__FILE__) + '/../test_helper'
 include HasSetting
 class FormattersTest < Test::Unit::TestCase
   def test_for_type
-    [:string, :float, :floats, :int, :ints, :strings, :boolean, :booleans].each do |symbol|
+    [:string, :float, :floats, :int, :ints, :strings, :boolean, :booleans, :strict_boolean, :strict_booleans].each do |symbol|
       assert(Formatters.for_type(symbol), "No formatter for #{symbol}")
-      assert_equal(Formatters.for_type(symbol).class.to_s, "HasSetting::Formatters::#{symbol.to_s.capitalize}Formatter")
+      if symbol == :strict_boolean
+        assert_equal(Formatters.for_type(symbol).class.to_s, "HasSetting::Formatters::StrictBooleanFormatter")
+      elsif symbol == :strict_booleans
+        assert_equal(Formatters.for_type(symbol).class.to_s, "HasSetting::Formatters::StrictBooleansFormatter")
+      else
+        assert_equal(Formatters.for_type(symbol).class.to_s, "HasSetting::Formatters::#{symbol.to_s.capitalize}Formatter")
+      end
     end
     assert_raises(ArgumentError) do
       Formatters.for_type(:rarararararara_i_do_not_exist)
@@ -39,9 +45,12 @@ class FormattersTest < Test::Unit::TestCase
   
   def test_boolean_formatter
     f = Formatters::BooleanFormatter.new
-    assert_equal('1', f.to_s(''))
+    assert_equal('0', f.to_s(''))
     assert_equal('1', f.to_s(true))
     assert_equal('0', f.to_s(false))
+    assert_equal('0', f.to_s('0'))
+    assert_equal('0', f.to_s(0))
+    assert_equal('0', f.to_s(''))
     assert_equal(nil, f.to_s(nil))
     
     assert_equal(true, f.to_type('1'))
@@ -49,6 +58,18 @@ class FormattersTest < Test::Unit::TestCase
     assert_equal(nil, f.to_type(nil))
   end
   
+  def test_strict_boolean_formatter
+    f = Formatters::StrictBooleanFormatter.new
+    assert_equal('1', f.to_s(''))
+    assert_equal('1', f.to_s(true))
+    assert_equal('0', f.to_s(false))
+    assert_equal('1', f.to_s('0'))
+    assert_equal(nil, f.to_s(nil))
+    
+    assert_equal(true, f.to_type('1'))
+    assert_equal(false, f.to_type('0'))
+    assert_equal(nil, f.to_type(nil))
+  end
   def test_int_formatter()
     f = Formatters::IntFormatter.new
     assert_raises(ArgumentError) do 
@@ -127,6 +148,7 @@ class FormattersTest < Test::Unit::TestCase
     assert_equal('1', f.to_s(true))
     assert_equal('1', f.to_s([true]))
     assert_equal('1,0', f.to_s([true,false]))
+    assert_equal('0,0,0,0,', f.to_s(['', 0, false, '0', nil]))
     
     assert_equal(nil, f.to_type(nil))
     assert_equal([], f.to_type(''))
@@ -137,7 +159,25 @@ class FormattersTest < Test::Unit::TestCase
     # test boolean with values != true|false
     assert_equal('1', f.to_s('true'))
     assert_equal('1', f.to_s(555))
+  end
+  
+  
+  def test_strict_booleans_formatter
+    f = Formatters::StrictBooleansFormatter.new
+    assert_equal(nil, f.to_s(nil))
+    assert_equal('1', f.to_s(true))
+    assert_equal('1', f.to_s([true]))
+    assert_equal('1,0', f.to_s([true,false]))
+    assert_equal('1,1', f.to_s([1,0]))
+    
+    assert_equal(nil, f.to_type(nil))
+    assert_equal([], f.to_type(''))
+    assert_equal([true], f.to_type('1'))
+    assert_equal([true, false], f.to_type('1,0'))
     
     
+    # test boolean with values != true|false
+    assert_equal('1', f.to_s('true'))
+    assert_equal('1', f.to_s(555))
   end
 end

data/test/unit/has_setting_test.rb

@@ -8,18 +8,18 @@ class HasSettingTest < Test::Unit::TestCase
   end
   
   
-  def _test_setting_has_accessors
+  def test_setting_has_accessors
     assert @foo.respond_to?(:setting_1)
     assert @foo.respond_to?(:setting_1=)
   end
   
   
-  def _test_has_many
+  def test_has_many
     assert @foo.respond_to?(:settings)
     assert @foo.settings.is_a?(Array)
   end
   
-  def _test_settings_are_destroyed
+  def test_settings_are_destroyed
     count_before = HasSetting::Setting.count
     @foo.setting_1 = 10
     @foo.save!
@@ -29,7 +29,7 @@ class HasSettingTest < Test::Unit::TestCase
     
   end
   
-  def _test_write_setting
+  def test_write_setting
     count_before = HasSetting::Setting.count
     @foo.write_setting('name', 'value1')
     @foo.save!
@@ -45,7 +45,7 @@ class HasSettingTest < Test::Unit::TestCase
     assert_equal('value2', setting.value)
   end
   
-  def _test_setting_accessors
+  def test_setting_accessors
     count_before = HasSetting::Setting.count
     assert(!@foo.setting_1)
     @foo.setting_1 = 'bli'
@@ -56,7 +56,7 @@ class HasSettingTest < Test::Unit::TestCase
     assert_equal('bla', @foo.setting_1)
   end
   
-  def _test_different_classes_do_not_share_setting
+  def test_different_classes_do_not_share_setting
     count_before = HasSetting::Setting.count
     @foo.setting_1 = 'foo'
     @foo.save!
@@ -69,13 +69,13 @@ class HasSettingTest < Test::Unit::TestCase
   end
 
   
-  def _test_has_nil_setting
+  def test_has_nil_setting
     @foo.setting_1 = nil
     assert(@foo.read_setting('setting_1'))
     assert(!@foo.setting_1)
   end
   
-  def _test_options_on_getter
+  def test_options_on_getter
     @foo.setting_1 = '12.3'
     assert_equal('12.3', @foo.setting_1)
     assert_equal(12, @foo.setting_1(:type => :int))
@@ -86,21 +86,21 @@ class HasSettingTest < Test::Unit::TestCase
     assert_equal('12.3', @foo.setting_2(:type => :string))
   end
   
-  def _test_different_classes_do_not_share_options()
+  def test_different_classes_do_not_share_options()
     @foo.setting_2 = 12.3
     assert_equal(12.3, @foo.setting_2)
     @bar.setting_2 = 12.3
     assert_equal(12, @bar.setting_2)
   end
   
-  def _test_default_values()
+  def test_default_values()
     assert_equal('def', @foo.with_default)
     assert_equal('override def', @foo.with_default(:default => 'override def'))
     @foo.with_default = 'not def'
     assert_equal('not def', @foo.with_default)
   end
   
-  def _test_write_settings_without_saved_parent
+  def test_write_settings_without_saved_parent
     my_foo = Foo.new
     count_before = HasSetting::Setting.count
     my_foo.with_default = 'radabumm'
@@ -111,24 +111,37 @@ class HasSettingTest < Test::Unit::TestCase
     assert_equal('radabumm', my_foo.with_default)
   end
   
-  def _test_not_everyone_has_settings_association
+  def test_not_everyone_has_settings_association
     assert_equal(true, @foo.respond_to?(:settings))
     assert_equal(true, @bar.respond_to?(:settings))
     assert_equal(false, @baz.respond_to?(:settings))
   end
   
   
-  def _test_boolean_setting_without_default
+  def test_boolean_setting_without_default
     assert_equal nil, @foo.setting_3
     @foo.setting_3 = true
     @foo.save!
-    assert_equal true, @foo.reload.setting_3
+    
+    @foo = Foo.find @foo.id
+    assert_equal true, @foo.setting_3
   end
   def test_boolean_setting_with_default
     assert_equal false, @foo.setting_4
     @foo.setting_4 = true
     @foo.save!
-    assert_equal true, @foo.reload.setting_4
+    @foo = Foo.find @foo.id
+    assert_equal true, @foo.setting_4
+  end
+  
+  def test_boolean_setting_with_default_and_no_saving
+    assert_equal false, @foo.setting_4
+    @foo.setting_4 = true
+    assert_equal true, @foo.setting_4
+    @foo.setting_4 = nil
+    assert_equal nil, @foo.setting_4
+    @foo.setting_4 = false
+    assert_equal false, @foo.setting_4
   end
   
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-has_setting
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors: 
 - Simplificator GmbH
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-21 00:00:00 -07:00
+date: 2009-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -40,7 +40,6 @@ files:
 - test/unit/has_setting_test.rb
 has_rdoc: true
 homepage: http://github.com/simplificator/has_setting
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -61,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: simple setting extension to AR