couch_potato 0.2.16 → 0.2.17

data/CHANGES.md

@@ -1,5 +1,9 @@
 ## Changes
 
+### 0.2.17
+* fixed nil attributes were omitted in json (jweiss, mattmatt)
+* support for properties of type Fixnum (langalex)
+
 ### 0.2.16
 * fixed problem with classes being not loaded in rails development mode (langalex)
 * fixed persist boolean false value (bernd)

data/README.md

@@ -79,15 +79,27 @@ If you want to store any properties you have to declare them:
       property :name
     end
 
-Properties can be of any type:
+Properties can be typed:
 
     class User
       include CouchPotato::Persistence
 
       property :address, :type => Address
     end
+    
+In this case Address also implements CouchPotato::Persistence which means its JSON representation will be added to the user document.  
+Couch Potato also has support for the basic types (right now only Fixnum is supported):
+
+    class User
+      include CouchPotato::Persistence
+
+      property :age, :type => Fixnum
+    end
+
+With this in place when you set the user's age as a String (e.g. using an hTML form) it will be converted into a Fixnum automatically.
+    
 
-Properties can have a default value
+Properties can have a default value:
 
     class User
       include CouchPotato::Persistence

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:major: 0
+:build: 
 :minor: 2
-:patch: 16
+:patch: 17
+:major: 0

data/lib/couch_potato/database.rb

@@ -63,12 +63,6 @@ module CouchPotato
 
     private
 
-    def clean_hash(hash)
-      hash.each do |k,v|
-        hash.delete k if v.nil?
-      end
-    end
-
     def create_document(document, validate)
       document.database = self
       
@@ -81,7 +75,7 @@ module CouchPotato
       
       document.run_callbacks :before_save
       document.run_callbacks :before_create
-      res = database.save_doc clean_hash(document.to_hash)
+      res = database.save_doc document.to_hash
       document._rev = res['rev']
       document._id = res['id']
       document.run_callbacks :after_save
@@ -99,7 +93,7 @@ module CouchPotato
       
       document.run_callbacks :before_save
       document.run_callbacks :before_update
-      res = database.save_doc clean_hash(document.to_hash)
+      res = database.save_doc document.to_hash
       document._rev = res['rev']
       document.run_callbacks :after_save
       document.run_callbacks :after_update

data/lib/couch_potato/persistence.rb

@@ -8,6 +8,7 @@ require File.dirname(__FILE__) + '/persistence/dirty_attributes'
 require File.dirname(__FILE__) + '/persistence/ghost_attributes'
 require File.dirname(__FILE__) + '/persistence/attachments'
 require File.dirname(__FILE__) + '/persistence/validation'
+require File.dirname(__FILE__) + '/persistence/type_caster'
 require File.dirname(__FILE__) + '/view/custom_views'
 require File.dirname(__FILE__) + '/view/view_query'
 

data/lib/couch_potato/persistence/properties.rb

@@ -42,6 +42,10 @@ module CouchPotato
         end
       end
       
+      def type_caster
+        @type_caster ||= TypeCaster.new
+      end
+      
       module ClassMethods
         # returns all the property names of a model class that have been defined using the #property method
         #

data/lib/couch_potato/persistence/simple_property.rb

@@ -6,18 +6,14 @@ module CouchPotato
       def initialize(owner_clazz, name, options = {})
         self.name = name
         self.type = options[:type]
+        @type_caster = TypeCaster.new
         
         define_accessors accessors_module_for(owner_clazz), name, options
       end
       
       def build(object, json)
         value = json[name.to_s].nil? ? json[name.to_sym] : json[name.to_s]
-        typecast_value =  if type && !value.instance_of?(type)
-                            type.json_create value
-                          else
-                            value
-                          end
-        object.send "#{name}=", typecast_value
+        object.send "#{name}=", @type_caster.cast(value, type)
       end
       
       def dirty?(object)
@@ -62,7 +58,7 @@ module CouchPotato
           end
           
           define_method "#{name}=" do |value|
-            self.instance_variable_set("@#{name}", value)
+            self.instance_variable_set("@#{name}", type_caster.cast(value, options[:type]))
           end
           
           define_method "#{name}?" do

data/lib/couch_potato/persistence/type_caster.rb

@@ -0,0 +1,17 @@
+module CouchPotato
+  module Persistence
+    class TypeCaster
+      def cast(value, type)
+        if type && !value.instance_of?(type)
+          if type == Fixnum
+            value.to_s.scan(/\d/).join.to_i unless value.nil?
+          else
+            type.json_create value
+          end
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/spec/property_spec.rb

@@ -122,6 +122,17 @@ describe 'properties' do
     p = CouchPotato.database.load_document p.id
     p.ship_address.should be_nil
   end
+  
+  it "should actually pass the null value down in the JSON document " do
+    p = Person.new
+    p.ship_address = nil
+    db = mock(:database)
+    db.should_receive(:save_doc).with do |attributes|
+      attributes.has_key?(:ship_address).should == true
+    end.and_return({})
+    CouchPotato.database.stub(:database).and_return(db)
+    CouchPotato.database.save_document! p
+  end
 
   it "should persist false for a false" do
     p = Person.new

data/spec/unit/attributes_spec.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 class Plant
   include CouchPotato::Persistence
   property :leaf_count
+  property :typed_leaf_count, :type => Fixnum
 end
 
 describe "attributes" do
@@ -18,7 +19,7 @@ describe "attributes" do
   describe "attributes" do
     it "should return the attributes" do
       plant = Plant.new(:leaf_count => 1)
-      plant.attributes.should == {:leaf_count => 1, :created_at => nil, :updated_at => nil}
+      plant.attributes.should == {:leaf_count => 1, :created_at => nil, :updated_at => nil, :typed_leaf_count => nil}
     end
   end
   
@@ -44,5 +45,38 @@ describe "attributes" do
     end
   end
 
+  describe 'typed attributes' do
+    describe "fixnum" do
+      before(:each) do
+        @plant = Plant.new
+      end
+      
+      it "should convert a string into a finum" do
+        @plant.typed_leaf_count = '4'
+        @plant.typed_leaf_count.should == 4
+      end
+      
+      it "should leave a fixnum as is" do
+        @plant.typed_leaf_count = 4
+        @plant.typed_leaf_count.should == 4
+      end
+      
+      it "should leave nil as is" do
+        @plant.typed_leaf_count = nil
+        @plant.typed_leaf_count.should be_nil
+      end
+      
+      it "should set the attributes to zero if a string given" do
+        @plant.typed_leaf_count = 'x'
+        @plant.typed_leaf_count.should == 0
+      end
+      
+      it "should parse numbers out of a string" do
+        @plant.typed_leaf_count = 'x123'
+        @plant.typed_leaf_count.should == 123
+      end
+      
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.16
+  version: 0.2.17
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-22 00:00:00 +01:00
+date: 2009-12-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +72,7 @@ files:
 - lib/couch_potato/persistence/magic_timestamps.rb
 - lib/couch_potato/persistence/properties.rb
 - lib/couch_potato/persistence/simple_property.rb
+- lib/couch_potato/persistence/type_caster.rb
 - lib/couch_potato/persistence/validation.rb
 - lib/couch_potato/rspec/matchers.rb
 - lib/couch_potato/rspec/matchers/map_to_matcher.rb