ohm-contrib 0.0.20 → 0.0.21

data/README.markdown

@@ -68,6 +68,76 @@ Example usage
 
 Typecasting explained
 ---------------------
+
+I studied various typecasting behaviors implemented by a few ORMs in Ruby.
+
+### ActiveRecord
+
+    class Post < ActiveRecord::Base
+      # say we have an integer column in the DB named votes
+    end
+    Post.new(:votes => "FooBar").votes == 0
+    # => true
+
+### DataMapper
+    class Post
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :votes, Integer
+    end
+
+    post = Post.new(:votes => "FooBar")
+    post.votes == "FooBar"
+    # => true
+
+    post.save
+    post.reload
+
+    # Get ready!!!!
+    post.votes == 0
+    # => true
+
+### Ohm::Typecast approach.
+
+#### Mindset:
+
+1. Explosion everytime is too cumbersome.
+2. Mutation of data is less than ideal (Also similar to MySQL silently allowing you
+   to store more than 255 chars in a VARCHAR and then truncating that data. Yes I know
+   you can configure it to be noisy but the defaults kill).
+3. We just want to operate on it like it should!
+
+#### Short Demo:
+    class Post < Ohm::Model
+      include Ohm::Typecast
+      attribute :votes
+    end
+
+    post = Post.new(:votes => "FooBar")
+    post.votes == "FooBar"
+    # => true
+
+    post.save
+    post = Post[post.id]
+    post.votes == "FooBar"
+    # => true
+
+    # Here comes the cool part...
+    post.votes * 1
+    # => ArgumentError: invalid value for Integer: "FooBar"
+
+    post.votes = 50
+    post.votes * 2 == 100
+    # => true
+
+    post.votes.class == Ohm::Types::Integer
+    # => true
+    post.votes.inspect == "50"
+    # => true
+
+#### More examples just to show the normal case.
+
     require 'ohm'
     require 'ohm/contrib'
 
@@ -77,9 +147,14 @@ Typecasting explained
       attribute :price, Decimal
       attribute :available_at, Time
       attribute :stock, Integer
+      attribute :address, Hash
+      attribute :tags, Array
     end
 
-    post = Post.create(:price => "10.20", :stock => "100")
+    post = Post.create(:price => "10.20", :stock => "100",
+                       :address => { "city" => "Boston", "country" => "US" },
+                       :tags => ["redis", "ohm", "typecast"])
+
     post.price.to_s == "10.20"
     # => true
 
@@ -89,6 +164,23 @@ Typecasting explained
     post.stock / 10 == 10
     # => true
 
+    post.address["city"] == "Boston"
+    post.tags.map { |tag| tag.upcase }
+
+    # of course mutation works for both cases
+    post.price += 5
+    post.stock -= 1
+    post.tags << "contrib"
+    post.address["state"] = "MA"
+    post.save
+    post = Post[post.id]
+
+    post.address["state"] == "MA"
+    # => true
+    post.tags.include?("contrib")
+    # => true
+
+
 Credits
 -------
 Thanks to github user gnrfan for the web validations.

data/VERSION

@@ -1 +1 @@
-0.0.20
+0.0.21

data/lib/ohm/contrib.rb

@@ -1,6 +1,6 @@
 module Ohm
   module Contrib
-    VERSION = '0.0.20'
+    VERSION = '0.0.21'
   end
 
   autoload :Boundaries,        "ohm/contrib/boundaries"

data/lib/ohm/contrib/callbacks.rb

@@ -170,4 +170,4 @@ module Ohm
       end
     end
   end
-end
+end

data/lib/ohm/contrib/typecast.rb

@@ -24,7 +24,7 @@ module Ohm
     def self.[](type)
       const_get(type.to_s.split('::').last)
     end
-  
+
     class Base < BasicObject
       class Exception < ::Exception; end
 
@@ -36,23 +36,23 @@ module Ohm
 
       def self.[](value)
         return self::EMPTY if value.to_s.empty?
-    
+
         new(value)
       end
 
       def self.delegate_to(klass, except = @@delegation_blacklist)
         methods = klass.public_instance_methods.map(&:to_sym) - except
-        def_delegators :object, *methods          
+        def_delegators :object, *methods
       end
 
       def inspect
-        object.inspect
+        @raw.inspect
       end
     end
 
     class Primitive < Base
       EMPTY = nil
-      
+
       def initialize(value)
         @raw = value
       end
@@ -64,7 +64,7 @@ module Ohm
       def ==(other)
         to_s == other.to_s
       end
-     
+
     protected
       def object
         @raw
@@ -78,10 +78,6 @@ module Ohm
     class Decimal < Primitive
       delegate_to ::BigDecimal
 
-      def inspect
-        object.to_s('F')
-      end
-
     protected
       def object
         ::Kernel::BigDecimal(@raw)
@@ -123,28 +119,36 @@ module Ohm
         ::Date.parse(@raw)
       end
     end
-    
+
     class Serialized < Base
       attr :object
 
       def initialize(raw)
         @object = case raw
-        when self.class::RAW then raw
-        when ::String        then ::JSON.parse(raw)
-        when self.class      then raw.object
+        when self.class::RAW
+          raw
+        when ::String
+          begin
+            ::JSON.parse(raw)
+          rescue ::JSON::ParserError
+            raw
+          end
+        when self.class
+          raw.object
         else
-          ::Kernel.raise ::TypeError, 
+          ::Kernel.raise ::TypeError,
             "%s does not accept %s" % [self.class, raw.inspect]
         end
       end
 
       def ==(other)
-        object == other        
+        object == other
       end
-     
+
       def to_s
         object.to_json
       end
+      alias :inspect :to_s
     end
 
     class Hash < Serialized
@@ -163,9 +167,9 @@ module Ohm
     class Array < Serialized
       EMPTY = []
       RAW   = ::Array
-      
+
       delegate_to ::Array
-      
+
       # @private since basic object doesn't include a #class we need
       # to define this manually
       def class
@@ -234,7 +238,7 @@ module Ohm
       # Defines a typecasted attribute.
       #
       # @example
-      #   
+      #
       #   class User < Ohm::Model
       #     include Ohm::Typecast
       #
@@ -258,9 +262,9 @@ module Ohm
       #   user = User.new(:age => 20)
       #   user.age - 1 == 19
       #   => true
-      # 
+      #
       # @param [Symbol] name the name of the attribute to define.
-      # @param [Class] type (defaults to Ohm::Types::String) a class defined in 
+      # @param [Class] type (defaults to Ohm::Types::String) a class defined in
       #                Ohm::Types. You may define custom types in Ohm::Types if
       #                you need to.
       # @return [Array] the array of attributes already defined.
@@ -269,8 +273,8 @@ module Ohm
         define_method(name) do
           # Primitive types maintain a reference to the original object
           # stored in @_attributes[att]. Hence mutation works for the
-          # Primitive case. For cases like Hash, Array where the value 
-          # is `JSON.parse`d, we need to set the actual Ohm::Types::Hash 
+          # Primitive case. For cases like Hash, Array where the value
+          # is `JSON.parse`d, we need to set the actual Ohm::Types::Hash
           # (or similar) to @_attributes[att] for mutation to work.
           if klass.superclass == Ohm::Types::Primitive
             klass[read_local(name)]
@@ -296,4 +300,4 @@ module Ohm
       end
     end
   end
-end
+end

data/lib/ohm/contrib/web_validations.rb

@@ -12,9 +12,9 @@ module Ohm
   module WebValidations
     # @see http://fightingforalostcause.net/misc/2006/compare-email-regex.php
     EMAIL_REGEX = /^([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)$/i
-  
+
     SLUG_REGEX  = /^[-\w]+$/
-   
+
     URL_REGEX   = /^(http|https):\/\/([a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}|(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|localhost)(:[0-9]{1,5})?(\/.*)?$/ix
 
     IPV4_REGEX  = /^(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}$/
@@ -48,4 +48,4 @@ module Ohm
       assert_ipv4(att, error)
     end
   end
-end
+end

data/ohm-contrib.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ohm-contrib}
-  s.version = "0.0.20"
+  s.version = "0.0.21"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
-  s.date = %q{2010-05-29}
+  s.date = %q{2010-05-30}
   s.description = %q{Highly decoupled drop-in functionality for Ohm models}
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [

data/test/test_ohm_contrib_callbacks.rb

@@ -14,7 +14,7 @@ class OhmContribCallbacksTest < Test::Unit::TestCase
 
     before :save,     :do_before_save
     after  :save,     :do_after_save
-    
+
     before :delete,   :do_before_delete
     after  :delete,   :do_after_delete
 
@@ -151,8 +151,8 @@ class OhmContribCallbacksTest < Test::Unit::TestCase
       @post = Post[@post.id]
       @post.delete
     end
-    
-    
+
+
     should "call delete related callbacks once" do
       assert_equal 1, @post.count(:do_before_delete)
       assert_equal 1, @post.count(:do_after_delete)
@@ -167,4 +167,4 @@ class OhmContribCallbacksTest < Test::Unit::TestCase
       assert ! @post.did?(:do_after_save)
     end
   end
-end
+end

data/test/test_ohm_typecast.rb

@@ -92,14 +92,23 @@ class TestOhmTypecast < Test::Unit::TestCase
       assert_kind_of String, post.price.to_s
     end
 
-    test "equality matching" do
+    test "equality and comparable matching" do
       post = Post.create(:price => "399.50")
       assert (post.price == "399.50")
+      assert (post.price < 399.51)
+      assert (post.price > 399.49)
+      assert (post.price <= 399.50)
+      assert (post.price <= 399.51)
+      assert (post.price >= 399.50)
+      assert (post.price >= 399.49)
     end
 
     test "inspecting a Decimal" do
       post = Post.new(:price => 399.50)
-      assert_equal '399.5', post.price.inspect
+      assert_equal '"399.5"', post.price.inspect
+
+      post.price = 'FooBar'
+      assert_equal '"FooBar"', post.price.inspect
     end
   end
 
@@ -145,7 +154,10 @@ class TestOhmTypecast < Test::Unit::TestCase
 
     test "inspecting" do
       post = Post.new(:price => "50000")
-      assert_equal '50000', post.price.inspect
+      assert_equal '"50000"', post.price.inspect
+
+      post.price = 'FooBar'
+      assert_equal '"FooBar"', post.price.inspect
     end
   end
 
@@ -191,7 +203,10 @@ class TestOhmTypecast < Test::Unit::TestCase
 
     test "inspecting" do
       post = Post.new(:price => "12345.67890")
-      assert_equal '12345.6789', post.price.inspect
+      assert_equal '"12345.67890"', post.price.inspect
+
+      post.price = 'FooBar'
+      assert_equal '"FooBar"', post.price.inspect
     end
   end
 
@@ -250,6 +265,14 @@ class TestOhmTypecast < Test::Unit::TestCase
         post.created_at.slice
       end
     end
+
+    test "inspecting" do
+      post = Post.create(:created_at => Time.utc(2010, 05, 05))
+      assert_equal '"2010-05-05 00:00:00 UTC"', post.created_at.inspect
+
+      post.created_at = 'FooBar'
+      assert_equal '"FooBar"', post.created_at.inspect
+    end
   end
 
   context "when using a date" do
@@ -317,6 +340,14 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "still able to access Date" do
       assert_equal Date.today, Post.new.today
     end
+
+    test "inspecting" do
+      post = Post.create(:created_on => Date.new(2010, 5, 5))
+      assert_equal '"2010-05-05"', post.created_on.inspect
+
+      post.created_on = 'FooBar'
+      assert_equal '"FooBar"', post.created_on.inspect
+    end
   end
 
   context "when using a Hash" do
@@ -333,13 +364,13 @@ class TestOhmTypecast < Test::Unit::TestCase
         Hash
       end
     end
-    
+
     test "importing" do
       assert_equal Hash.new, Ohm::Types::Hash[nil]
       assert_equal Hash.new, Ohm::Types::Hash[""]
       assert_equal Hash.new, Ohm::Types::Hash[{}]
 
-      assert_equal Hash[:a => "b", :c => "d"], 
+      assert_equal Hash[:a => "b", :c => "d"],
         Ohm::Types::Hash[{ :a => "b", :c => "d" }]
     end
 
@@ -360,7 +391,7 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "handles nil case correctly" do
       post = Post.create(:address => nil)
       assert_equal({}, post.address)
-      
+
       post = Post[post.id]
       assert_equal({}, post.address)
     end
@@ -368,7 +399,7 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "handles empty string case correctly" do
       post = Post.create(:address => "")
       assert_equal({}, post.address)
-      
+
       post = Post[post.id]
       assert_equal({}, post.address)
     end
@@ -377,7 +408,7 @@ class TestOhmTypecast < Test::Unit::TestCase
       address = { "address1" => "#123", "city" => "Singapore", "country" => "SG"}
       post = Post.create(:address => address)
       assert_equal address, post.address
-      
+
       post = Post[post.id]
       assert_equal address, post.address
     end
@@ -385,7 +416,7 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "allows for hash operations" do
       address = { "address1" => "#123", "city" => "Singapore", "country" => "SG"}
       post = Post.create(:address => address)
-      
+
       assert_equal ["address1", "city", "country"], post.address.keys
       assert_equal ["#123", "Singapore", "SG"], post.address.values
 
@@ -397,7 +428,7 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "handles mutation" do
       address = { "address1" => "#123", "city" => "Singapore", "country" => "SG"}
       post = Post.create(:address => address)
-      
+
       post.address["address1"] = "#456"
       post.save
 
@@ -408,7 +439,7 @@ class TestOhmTypecast < Test::Unit::TestCase
       assert_equal ["address1", "city", "country"], post.address.keys
       assert_equal ["#456", "Singapore", "SG"], post.address.values
     end
-  
+
     Address = Class.new(Struct.new(:city, :country))
 
     test "raises when trying to assign a non-hash" do
@@ -420,6 +451,18 @@ class TestOhmTypecast < Test::Unit::TestCase
         Post.new(:address => Address.new)
       end
     end
+
+    test "inspecting" do
+      post = Post.create(:address => { "address1" => "#456",
+                                       "city" => "Singapore",
+                                       "country" => "SG" })
+
+      assert_equal %q{{"address1":"#456","city":"Singapore","country":"SG"}},
+        post.address.inspect
+
+      post.address = 'FooBar'
+      assert_equal %{"\\\"FooBar\\\""}, post.address.inspect
+    end
   end
 
   context "when using an Array" do
@@ -436,7 +479,7 @@ class TestOhmTypecast < Test::Unit::TestCase
         Array
       end
     end
-    
+
     test "importing" do
       assert_equal [], Ohm::Types::Array[nil]
       assert_equal [], Ohm::Types::Array[""]
@@ -463,7 +506,7 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "handles nil case correctly" do
       post = Post.create(:addresses => nil)
       assert_equal([], post.addresses)
-      
+
       post = Post[post.id]
       assert_equal([], post.addresses)
     end
@@ -471,7 +514,7 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "handles empty string case correctly" do
       post = Post.create(:addresses => "")
       assert_equal([], post.addresses)
-      
+
       post = Post[post.id]
       assert_equal([], post.addresses)
     end
@@ -482,11 +525,11 @@ class TestOhmTypecast < Test::Unit::TestCase
 
       post = Post.create(:addresses => addresses)
       assert_equal addresses, post.addresses
-      
+
       post = Post[post.id]
       assert_equal addresses, post.addresses
     end
-    
+
     class Address < Struct.new(:city, :country)
       def to_json
         [city, country].to_json
@@ -496,10 +539,10 @@ class TestOhmTypecast < Test::Unit::TestCase
     test "handles an arbitrary class as an element of the array" do
       addresses = [Address.new("Singapore", "SG"),
                    Address.new("Philippines", "PH")]
-  
+
       post = Post.create(:addresses => addresses)
       assert_equal [['Singapore', 'SG'], ['Philippines', 'PH']], post.addresses
-      
+
       post = Post[post.id]
       assert_equal [['Singapore', 'SG'], ['Philippines', 'PH']], post.addresses
     end
@@ -520,9 +563,23 @@ class TestOhmTypecast < Test::Unit::TestCase
         post.addresses.push({"city" => "Hong Kong", "country" => "ZN"})
     end
 
+    test "looping! and other enumerablems" do
+      array = [1, 2, 3]
+      post = Post.create(:addresses => array)
+
+      total = 0
+      post.addresses.each { |e| total += e }
+      assert_equal 6, total
+
+      post = Post[post.id]
+      total = 0
+      post.addresses.each { |e| total += e }
+      assert_equal 6, total
+    end
+
     test "handles mutation" do
       post = Post.create(:addresses => [1, 2, 3])
-      
+
       post.addresses.push(4, 5, 6)
       post.save
 
@@ -533,7 +590,7 @@ class TestOhmTypecast < Test::Unit::TestCase
       assert_equal 6, post.addresses.size
       assert_equal [1, 2, 3, 4, 5, 6], post.addresses
     end
-  
+
 
     test "raises when trying to assign a non-array" do
       assert_raise TypeError do
@@ -544,5 +601,17 @@ class TestOhmTypecast < Test::Unit::TestCase
         Post.new(:addresses => Address.new)
       end
     end
+
+    test "inspecting" do
+      post = Post.create(:addresses => [{ "address1" => "#456",
+                                          "city" => "Singapore",
+                                          "country" => "SG" }])
+
+      assert_equal %q{[{"address1":"#456","city":"Singapore","country":"SG"}]},
+        post.addresses.inspect
+
+      post.addresses = 'FooBar'
+      assert_equal %{"\\\"FooBar\\\""}, post.addresses.inspect
+    end
   end
-end
+end

data/test/test_ohm_web_validations.rb

@@ -111,4 +111,4 @@ class TestOhmWebValidations < Test::Unit::TestCase
     end
 
   end
-end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 20
-  version: 0.0.20
+  - 21
+  version: 0.0.21
 platform: ruby
 authors: 
 - Cyril David
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-29 00:00:00 +08:00
+date: 2010-05-30 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency