simplificator-has_setting 0.3.9 → 0.4.0

data/README

@@ -0,0 +1,104 @@
+==What is it?
+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.3.10:
+   * added boolean and booleans formatters
+ * 0.3.9:
+   * added type :strings, :floats, :ints. They store the contents of an array as a comma separated string. 
+ * 0.3.8:
+   * added dependent destroy option. no more zombie settings lingering around.
+ * 0.3.7: 
+   * Gem is now built using jeweler... after messing around and bumping versions and getting 
+     strange errors, this is 'it works' feeling coming back
+ * 0.3.4: 
+   * Added custom formatter support. no new formatters though...
+ * 0.3.1: 
+   * Bug Fixed: has_many(:settings) is not added to ActiveRecord::Base but only to the classes with has_setting
+   * Bug Fixed: options are not shared between classes
+   * Again changed the way settings are saved. Save is now done on parent.save with an after_save callback. (like this the settings are treated as if they were attributes of the owner)
+ * 0.2.x: 
+   * Added :default option
+   * changed way settings are saved so that unsaved parents can have settings too
+   * changed nameing scheme of setting names (incompatible with versions prior 0.2.x but since nobody uses the gem i dont care :-))
+ * 0.1.x: First Version
+
+
+==Installation
+sudo gem install simplificator-has_setting
+
+==Setup
+ * Add a migration that looks more or less like the one in <em>help/001_create_settings.rb</em>
+ * Make sure the gem is loaded when your application starts
+
+==Config
+The model you want to hold settings (i.e. User, Profile, ...):
+<tt>has_setting(:name_of_the_setting)</tt>
+This will create the following methods for you on the owner class:
+ * <tt>name_of_the_setting=(value)</tt> a standard setter
+ * <tt>name_of_the_setting()</tt> a standard getter (the getter method takes an optional hash to override some options, possible values are the same as the options in has_setting())
+ 
+<tt>has_setting(name, options)</tt> takes an optional hash of options. Following options are supported:
+<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>: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>: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.
+
+
+
+==How it works
+A polymorphic parent-child relation is created between Setting and the parent/owning class.
+Getters/setters are added through meta-programming-magic. If the setter is invoked on a unsafed parent then the setting is not saved until the parent is saved, else setting is saved upon creation (i.e. first time the setter is called) / change (subsequent calls).
+The getters/setters can be used in standard AR validations, Rails mass assignments/form helpers and so on.
+
+==Gotchas
+ * Values are stored as Strings in the DB. Values are converted with one of the formatters (depending on selected :type). If you try to store an unsupported type or anything other than the type you selected there might be an exception (i.e. if you try to store "foobar" as an :type => :int)
+ * Currently there are no length validations on the 'name' and 'value' column of Setting. Take care not to store values to big. Especially when using the array formatters (:floats, :ints, :strings)
+ 
+ 
+==Example
+<code>
+class Foo < ActiveRecord::Base
+  has_setting(:string_setting)
+  has_setting(:another_string_setting, :type => :string)
+  has_setting(:int_setting, :type => :int)
+  has_setting(:float_setting, :type => :float, :default => 3.3)
+end
+
+
+foo = Foo.create
+
+foo.string_setting
+=> nil
+foo.string_setting= 'a string'
+foo.string_setting
+=> 'a string'
+
+foo.int_setting = 123
+foo.int_setting
+=> 123
+foo.int_setting = '123'
+foo.int_setting
+=> 123
+
+foo.float_setting
+=> 3.3
+foo.float_setting = nil
+foo.float_setting
+=> nil
+
+</code>
+
+   
+==Todo
+has_setting should stay as simple as possible... still some ideas are around:
+ * Custom formatter (to convert arbitrary objects, i.e. Date/Time/DateTime...)
+ * Add validation options
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "has_setting"
+    s.summary = %Q{simple setting extension to AR}
+    s.email = "info@simplificator.com"
+    s.homepage = "http://github.com/simplificator/has_setting"
+    s.description = 'Stores settings as key/value pairs in a settings table and provides accessors for them on the owning object'
+    s.authors = ["Simplificator GmbH"]
+    s.files.exclude '**/*.sqlite3'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'has_setting'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :test

data/VERSION.yml

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

data/lib/has_setting.rb

@@ -14,3 +14,5 @@ HasSetting::Formatters.register_formatter(:float, HasSetting::Formatters::FloatF
 HasSetting::Formatters.register_formatter(:floats, HasSetting::Formatters::FloatFormatter.new)
 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::BooleanFormatter.new)

data/lib/has_setting/formatters.rb

@@ -36,13 +36,29 @@ module HasSetting
     
     # Formatter for Strings
     class StringFormatter < NilSafeFormatter
-      def to_type(value)
+      def safe_to_type(value)
         value
       end
       def safe_to_s(value)
         value.to_s
       end
     end
+    class BooleanFormatter < NilSafeFormatter
+      def safe_to_type(value)
+        value == '1'
+      end
+      def safe_to_s(value)
+        value ? '1' : '0'
+      end
+    end
+    class BooleansFormatter < NilSafeFormatter
+      def safe_to_type(value)
+        value.split(',').map() {|item| Formatters.for_type(:boolean).to_type(item)}
+      end
+      def safe_to_s(value)
+        Array(value).map() {|item| Formatters.for_type(:boolean).to_s(item)}.join(',')
+      end
+    end
     
     class IntsFormatter < NilSafeFormatter
       def safe_to_type(value)

data/test/unit/formatters_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../test_helper'
 include HasSetting
 class FormattersTest < Test::Unit::TestCase
   def test_for_type
-    [:string, :float, :floats, :int, :ints, :strings].each do |symbol|
+    [:string, :float, :floats, :int, :ints, :strings, :boolean, :booleans].each do |symbol|
       assert(Formatters.for_type(symbol), "No formatter for #{symbol}")
     end
     assert_raises(ArgumentError) do
@@ -26,6 +26,7 @@ class FormattersTest < Test::Unit::TestCase
     assert_equal([',schni,schna,', 'bli', ',bla'], f.to_type('\,schni\,schna\,,bli,\,bla'))
     assert_equal([',,,,', ',,,', ',,', ','], f.to_type('\,\,\,\,,\,\,\,,\,\,,\,'))
   end
+  
 
   def test_string_formatter()
     f = Formatters::StringFormatter.new
@@ -35,6 +36,18 @@ class FormattersTest < Test::Unit::TestCase
     assert_equal('a', f.to_type('a'))
   end
   
+  def test_boolean_formatter
+    f = Formatters::BooleanFormatter.new
+    assert_equal('1', f.to_s(''))
+    assert_equal('1', f.to_s(true))
+    assert_equal('0', f.to_s(false))
+    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 
@@ -107,5 +120,16 @@ class FormattersTest < Test::Unit::TestCase
     assert_equal([1.2,1.3], f.to_type('1.2,1.3'))
     assert_equal([1.2,1.3], f.to_type('1.2, 1.3'))
   end
-  
+  def test_booleans_formatter
+    f = Formatters::BooleansFormatter.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(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'))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-has_setting
 version: !ruby/object:Gem::Version 
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors: 
 - Simplificator GmbH
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-07 00:00:00 -08:00
+date: 2009-06-30 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,28 +19,26 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
+- Rakefile
 - VERSION.yml
-- lib/has_setting
+- lib/has_setting.rb
 - lib/has_setting/ar_extensions.rb
 - lib/has_setting/formatters.rb
 - lib/has_setting/setting.rb
-- lib/has_setting.rb
 - test/bar.rb
 - test/baz.rb
 - test/foo.rb
 - test/test_helper.rb
-- test/unit
 - test/unit/formatters_test.rb
 - test/unit/has_setting_test.rb
-- test/unit/test.sqlite3
+- README
 has_rdoc: true
-homepage: http://github.com/pascalbetz/has_setting
+homepage: http://github.com/simplificator/has_setting
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -61,7 +59,12 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: simple setting extension to AR
-test_files: []
-
+test_files: 
+- test/bar.rb
+- test/baz.rb
+- test/foo.rb
+- test/test_helper.rb
+- test/unit/formatters_test.rb
+- test/unit/has_setting_test.rb