ohm-contrib 0.0.2 → 0.0.3

data/README.markdown

@@ -48,6 +48,17 @@ Example usage
     Post.create.created_at
     Post.create.updated_at
 
+    # Casting example
+    class Product
+      include Ohm::Typecast
+
+      attribute :price, :decimal
+      attribute :start_of_sale, :time
+      attribute :end_of_sale, :time
+      attribute :priority, :integer
+      attribute :rating, :float
+    end
+
 Credits
 -------
 Thanks to github user gnrfan for the web validations.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/ohm/contrib/typecast.rb

@@ -0,0 +1,48 @@
+require 'bigdecimal'
+require 'time'
+require 'date'
+
+module Ohm
+  module Typecast
+    def self.included(base)
+      base.extend Macros 
+    end
+
+    module Macros
+      def attribute(name, type = :string)
+        define_method(name) do
+          typecast(read_local(name), type)
+        end
+
+        define_method(:"#{name}=") do |value|
+          write_local(name, value && value.to_s)
+        end
+
+        attributes << name unless attributes.include?(name)
+      end
+    end
+
+  protected
+    def typecast(val, type)
+      return val if val.to_s.empty?
+
+      case type
+      when :integer then Integer(val)
+      when :float   then Float(val)
+      when :decimal then BigDecimal(val)
+      when :time    
+        ret = Time.parse(val)
+        ret.to_s == val ? ret : val
+
+      when :date    then Date.parse(val)
+      when :string  then val
+      end
+  
+    # All of the casting methods used above raises an ArgumentError
+    # if it fails to parse the value properly. If this happens,
+    # the least surprising behavior is to return the original value
+    rescue ArgumentError
+      val
+    end
+  end
+end

data/lib/ohm/contrib.rb

@@ -1,6 +1,6 @@
 module Ohm
   module Contrib
-    VERSION = '0.0.1'
+    VERSION = '0.0.3'
   end
 
   autoload :Boundaries,        "ohm/contrib/boundaries"
@@ -8,4 +8,5 @@ module Ohm
   autoload :ToHash,            "ohm/contrib/to_hash"
   autoload :WebValidations,    "ohm/contrib/web_validations"
   autoload :NumberValidations, "ohm/contrib/number_validations"
+  autoload :Typecast,          "ohm/contrib/typecast"
 end

data/ohm-contrib.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ohm-contrib}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/ohm/contrib/number_validations.rb",
      "lib/ohm/contrib/timestamping.rb",
      "lib/ohm/contrib/to_hash.rb",
+     "lib/ohm/contrib/typecast.rb",
      "lib/ohm/contrib/web_validations.rb",
      "ohm-contrib.gemspec",
      "test/helper.rb",
@@ -36,6 +37,7 @@ Gem::Specification.new do |s|
      "test/test_ohm_number_validations.rb",
      "test/test_ohm_timestamping.rb",
      "test/test_ohm_to_hash.rb",
+     "test/test_ohm_typecast.rb",
      "test/test_ohm_web_validations.rb"
   ]
   s.homepage = %q{http://github.com/sinefunc/ohm-contrib}
@@ -50,6 +52,7 @@ Gem::Specification.new do |s|
      "test/test_ohm_number_validations.rb",
      "test/test_ohm_timestamping.rb",
      "test/test_ohm_to_hash.rb",
+     "test/test_ohm_typecast.rb",
      "test/test_ohm_web_validations.rb"
   ]
 

data/test/test_ohm_contrib.rb

@@ -30,5 +30,10 @@ class TestOhmContrib < Test::Unit::TestCase
       Ohm::NumberValidations
     end
   end
-
+  
+  test "autoloading of Typecast" do
+    assert_nothing_raised NameError, LoadError do
+      Ohm::Typecast
+    end
+  end
 end

data/test/test_ohm_typecast.rb

@@ -0,0 +1,159 @@
+require "helper"
+
+class TestOhmTypecast < Test::Unit::TestCase
+  context "decimal typecasting" do
+    class Product < Ohm::Model
+      include Ohm::Typecast
+
+      attribute :price, :decimal
+    end
+
+    should "properly preserve the right precision" do
+      product = Product.create(:price => 0.0001)
+      product = Product[product.id]
+      sum = 0
+      1_000.times { sum += product.price }
+
+      assert_equal 0.1, sum
+    end
+  end
+
+  context "time typecasting" do
+    class Product < Ohm::Model
+      include Ohm::Typecast
+
+      attribute :start_of_sale, :time
+    end
+
+    test "read / write" do
+      @time = Time.now.utc
+      product = Product.create(:start_of_sale => @time)
+      product = Product[product.id]
+      
+      assert_equal @time, product.start_of_sale
+    end
+
+    test "the retrieved value is a Time object" do
+      @time = Time.now.utc
+      product = Product.create(:start_of_sale => @time)
+      product = Product[product.id]
+      
+      assert_instance_of Time, product.start_of_sale
+    end
+
+    test "an invalid string" do
+      product = Product.create(:start_of_sale => "invalid time")
+      product = Product[product.id]
+
+      assert_equal "invalid time", product.start_of_sale
+    end
+
+    test "when nil" do
+      product = Product.new(:start_of_sale => nil)
+      assert_nil product.start_of_sale
+    end
+
+    test "when empty string" do
+      product = Product.new(:start_of_sale => "")
+      assert_equal "", product.start_of_sale
+    end
+  end
+
+  context "date typecasting" do
+    class Product < Ohm::Model
+      include Ohm::Typecast
+
+      attribute :date_bought, :date
+    end
+
+    test "read / write" do
+      @date = Date.today
+      product = Product.create(:date_bought => @date)
+      product = Product[product.id]
+
+      assert_equal @date, product.date_bought
+    end
+
+    test "the retrieved value is a Date object" do
+      @date = Date.today
+      product = Product.create(:date_bought => @date)
+      product = Product[product.id]
+      
+      assert_instance_of Date, product.date_bought
+    end
+
+    test "assigning a string which is not a valid date before persisting" do
+      product = Product.create(:date_bought => "Bla Bla")
+      
+      assert_equal "Bla Bla", product.date_bought
+    end
+  
+    test "when nil" do
+      assert_nil Product.new.date_bought
+    end
+
+    test "empty string" do
+      assert_equal "", Product.new(:date_bought => "").date_bought
+    end
+  end
+
+  context "integer typecasting" do
+    class Product < Ohm::Model
+      include Ohm::Typecast
+
+      attribute :stock_count, :integer
+    end
+
+    test "when nil" do
+      assert_nil Product.new(:stock_count => nil).stock_count
+    end
+
+    test "when empty string" do
+      assert_equal "", Product.new(:stock_count => "").stock_count
+    end
+
+    test "when unparseable" do
+      assert_equal "FooBar", Product.new(:stock_count => "FooBar").stock_count
+    end
+
+    test "when a float" do
+      assert_equal '1.0', Product.new(:stock_count => "1.0").stock_count
+    end
+
+    test "when a real int" do
+      assert_equal 1, Product.new(:stock_count => '1').stock_count
+    end
+  end
+
+  context "float typecasting" do
+    class Product < Ohm::Model
+      include Ohm::Typecast
+
+      attribute :vat, :float
+    end
+
+    test "when nil" do
+      assert_nil Product.new(:vat => nil).vat
+    end
+
+    test "when empty string" do
+      assert_equal "", Product.new(:vat => "").vat
+    end
+
+    test "when unparseable" do
+      assert_equal "FooBar", Product.new(:vat => "FooBar").vat
+    end
+
+    test "when a float" do
+      assert_equal 1.0, Product.new(:vat => "1.0").vat
+    end
+
+    test "when an int" do
+      assert_equal 1.0, Product.new(:vat => '1').vat
+    end
+
+    test "when a .12 value" do
+      assert_equal 0.12, Product.new(:vat => ".12").vat
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Cyril David
@@ -86,6 +86,7 @@ files:
 - lib/ohm/contrib/number_validations.rb
 - lib/ohm/contrib/timestamping.rb
 - lib/ohm/contrib/to_hash.rb
+- lib/ohm/contrib/typecast.rb
 - lib/ohm/contrib/web_validations.rb
 - ohm-contrib.gemspec
 - test/helper.rb
@@ -94,6 +95,7 @@ files:
 - test/test_ohm_number_validations.rb
 - test/test_ohm_timestamping.rb
 - test/test_ohm_to_hash.rb
+- test/test_ohm_typecast.rb
 - test/test_ohm_web_validations.rb
 has_rdoc: true
 homepage: http://github.com/sinefunc/ohm-contrib
@@ -132,4 +134,5 @@ test_files:
 - test/test_ohm_number_validations.rb
 - test/test_ohm_timestamping.rb
 - test/test_ohm_to_hash.rb
+- test/test_ohm_typecast.rb
 - test/test_ohm_web_validations.rb