langalex-couch_potato 0.2.7 → 0.2.8

data/README.md

@@ -228,12 +228,14 @@ Couch Potato supports the usual lifecycle callbacks known from ActiveRecord:
       include CouchPotato::Persistence
 
       before_create :do_something_before_create
-      before_update {|user, db| user.do_something_on_update}
+      before_update {|user| user.do_something_on_update}
     end
 
-This will call the method do_something_before_create before creating an object and run the given lambda before updating one. Lambda callbacks get passed the model as their first argument. Optionally if a lambda declares two arguments it also gets passed the database object. This is useful for creating other objects or querying views. Method callbacks don't receive any arguments by default but will get passed the database if they declare an argument.
+This will call the method do_something_before_create before creating an object and run the given lambda before updating one. Lambda callbacks get passed the model as their first argument. Method callbacks don't receive any arguments.
 
-Supported callbacks are: :before_validation_on_create, :before_validation_on_update, :before_validation_on_save, :before_create, :after_create, :before_update, :after_update, :before_save, :after_save, :before_destroy, :after_destroy.
+Supported callbacks are: :before_validation, :before_validation_on_create, :before_validation_on_update, :before_validation_on_save, :before_create, :after_create, :before_update, :after_update, :before_save, :after_save, :before_destroy, :after_destroy.
+
+If you need access to the database in a callback: Couch Potato automatically assigns a database instance to the model before saving and when loading. It is available as _database_ accessor from within your model instance.
 
 #### Testing
 

data/VERSION.yml

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

data/lib/core_ext/string.rb

@@ -5,11 +5,15 @@ module ActiveSupportMethods
     end
   end
   
+  # Source
+  # http://github.com/rails/rails/blob/b600bf2cd728c90d50cc34456c944b2dfefe8c8d/activesupport/lib/active_support/inflector.rb
   def underscore
-    gsub(/([A-Z])/) do
-      '_' + $1.downcase
-    end.sub(/^_/, '')
+    gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
   end
 end
 
-String.send :include, ActiveSupportMethods #unless String.new.respond_to?(:camelize)
+String.send :include, ActiveSupportMethods unless String.new.respond_to?(:underscore)

data/lib/core_ext/symbol.rb

@@ -0,0 +1,15 @@
+# taken from ActiveSupport 2.3.2
+unless :to_proc.respond_to?(:to_proc)
+  class Symbol
+    # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
+    #
+    #   # The same as people.collect { |p| p.name }
+    #   people.collect(&:name)
+    #
+    #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
+    #   people.select(&:manager?).collect(&:salary)
+    def to_proc
+      Proc.new { |*args| args.shift.__send__(self, *args) }
+    end
+  end
+end

data/lib/couch_potato/persistence/callbacks.rb

@@ -8,8 +8,8 @@ module CouchPotato
           attr_accessor :skip_callbacks
           def self.callbacks
             @callbacks ||= {}
-            @callbacks[self.name] ||= {:before_validation_on_create => [],
-              :before_validation_on_update => [], :before_validation_on_save => [], :before_create => [],
+            @callbacks[self.name] ||= {:before_validation => [], :before_validation_on_create => [], 
+              :before_validation_on_update => [], :before_validation_on_save => [], :before_create => [], 
               :after_create => [], :before_update => [], :after_update => [],
               :before_save => [], :after_save => [],
               :before_destroy => [], :after_destroy => []}
@@ -35,6 +35,7 @@ module CouchPotato
 
       module ClassMethods
         [
+          :before_validation,
           :before_validation_on_create,
           :before_validation_on_update,
           :before_validation_on_save,

data/lib/couch_potato/persistence/json.rb

@@ -31,6 +31,7 @@ module CouchPotato
         
         # creates a model instance from JSON
         def json_create(json)
+          return if json.nil?
           instance = self.new
           instance._id = json[:_id] || json['_id']
           instance._rev = json[:_rev] || json['_rev']

data/lib/couch_potato/persistence/properties.rb

@@ -28,6 +28,7 @@ module CouchPotato
         end
 
         def json_create(json) #:nodoc:
+          return if json.nil?
           instance = super
           instance.send(:assign_attribute_copies_for_dirty_tracking)
           instance

data/lib/couch_potato/persistence/validation.rb

@@ -0,0 +1,18 @@
+require 'validatable'
+
+module CouchPotato
+  module Persistence
+    module Validation
+      def self.included(base)
+        base.send :include, Validatable
+        base.class_eval do
+          # Override the validate method to first run before_validation callback
+          def valid?
+            self.run_callbacks :before_validation
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence.rb

@@ -5,6 +5,7 @@ require File.dirname(__FILE__) + '/persistence/magic_timestamps'
 require File.dirname(__FILE__) + '/persistence/callbacks'
 require File.dirname(__FILE__) + '/persistence/json'
 require File.dirname(__FILE__) + '/persistence/dirty_attributes'
+require File.dirname(__FILE__) + '/persistence/validation'
 require File.dirname(__FILE__) + '/view/custom_views'
 require File.dirname(__FILE__) + '/view/view_query'
 
@@ -13,7 +14,7 @@ module CouchPotato
   module Persistence
     
     def self.included(base)
-      base.send :include, Properties, Callbacks, Validatable, Json, CouchPotato::View::CustomViews
+      base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews
       base.send :include, DirtyAttributes
       base.send :include, MagicTimestamps
       base.class_eval do
@@ -78,6 +79,7 @@ module CouchPotato
     def new?
       _rev.nil?
     end
+    alias_method :new_record?, :new?
     
     # returns the document id
     # this is used by rails to construct URLs

data/lib/couch_potato.rb

@@ -5,8 +5,6 @@ require 'json/add/rails'
 
 require 'ostruct'
 
-require 'validatable'
-
 
 module CouchPotato
   Config = OpenStruct.new

data/spec/callbacks_spec.rb

@@ -7,7 +7,7 @@ class CallbackRecorder
   
   validates_presence_of :required_property
   
-  [:before_validation_on_create,
+  [:before_validation, :before_validation_on_create,
     :before_validation_on_save, :before_validation_on_update, 
     :before_save, :before_create, :before_create,
     :after_save, :after_create, :after_create,
@@ -76,6 +76,11 @@ describe 'create callbacks' do
        @recorder.required_property = 1
     end
     
+    it "should call before_validation" do
+      @recorder.valid?
+      @recorder.callbacks.should include(:before_validation)
+    end
+        
     it "should call before_validation_on_create" do
       @db.save_document! @recorder
       @recorder.callbacks.should include(:before_validation_on_create)
@@ -110,6 +115,11 @@ describe 'create callbacks' do
   
   describe "failed create" do
     
+    it "should call before_validation" do
+      @recorder.valid?
+      @recorder.callbacks.should include(:before_validation)
+    end
+    
     it "should call before_validation_on_create" do
       @db.save_document @recorder
       @recorder.callbacks.should include(:before_validation_on_create)
@@ -161,6 +171,10 @@ describe "update callbacks" do
       @db.save_document! @recorder
     end
     
+    it "should call before_validation" do
+      @recorder.callbacks.should include(:before_validation)
+    end
+    
     it "should call before_validation_on_update" do
       @recorder.callbacks.should include(:before_validation_on_update)
     end
@@ -194,6 +208,10 @@ describe "update callbacks" do
        @db.save_document @recorder
     end
     
+    it "should call before_validation" do
+      @recorder.callbacks.should include(:before_validation)
+    end
+    
     it "should call before_validation_on_update" do
       @recorder.callbacks.should include(:before_validation_on_update)
     end

data/spec/fixtures/address.rb

@@ -0,0 +1,9 @@
+class Address
+  include CouchPotato::Persistence
+  
+  property :street
+  property :city
+  property :state
+  property :zip
+  property :country
+end

data/spec/fixtures/person.rb

@@ -0,0 +1,6 @@
+class Person
+  include CouchPotato::Persistence
+  
+  property :name
+  property :ship_address, :type => Address
+end

data/spec/property_spec.rb

@@ -1,4 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), 'fixtures', 'address')
+require File.join(File.dirname(__FILE__), 'fixtures', 'person')
 
 class Watch
   include CouchPotato::Persistence
@@ -44,6 +46,23 @@ describe 'properties' do
     w.time.year.should == Time.now.year
   end
   
+  it "should persist an object" do
+    p = Person.new :name => 'Bob'
+    a = Address.new :city => 'Denver'
+    p.ship_address = a
+    CouchPotato.database.save_document! p
+    p = CouchPotato.database.load_document p.id
+    p.ship_address.should === a
+  end
+  
+  it "should persist null for a null " do
+    p = Person.new :name => 'Bob'
+    p.ship_address = nil
+    CouchPotato.database.save_document! p
+    p = CouchPotato.database.load_document p.id
+    p.ship_address.should be_nil
+  end
+  
   describe "predicate" do
     it "should return true if property set" do
       Comment.new(:title => 'title').title?.should be_true

data/spec/unit/callbacks_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class Tree
+  include CouchPotato::Persistence
+  before_validation :water!
+  before_validation lambda {|tree| tree.root_count += 1 }
+  
+  property :leaf_count
+  property :root_count
+  
+  def water!
+    self.leaf_count += 1
+  end
+end
+
+
+describe 'before_validation callback' do
+  before :each do
+    @tree = Tree.new(:leaf_count => 1, :root_count => 1)
+  end
+  
+  it "should call water! when validated" do
+    @tree.leaf_count.should == 1
+    @tree.should be_valid
+    @tree.leaf_count.should == 2
+  end
+  
+  it "should call lambda when validated" do
+    @tree.root_count.should == 1
+    @tree.should be_valid
+    @tree.root_count.should == 2
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: langalex-couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-21 00:00:00 -07:00
+date: 2009-07-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ files:
 - lib/core_ext/date.rb
 - lib/core_ext/object.rb
 - lib/core_ext/string.rb
+- lib/core_ext/symbol.rb
 - lib/core_ext/time.rb
 - lib/couch_potato.rb
 - lib/couch_potato/database.rb
@@ -69,6 +70,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/validation.rb
 - lib/couch_potato/view/base_view_spec.rb
 - lib/couch_potato/view/custom_view_spec.rb
 - lib/couch_potato/view/custom_views.rb
@@ -81,10 +83,13 @@ files:
 - spec/create_spec.rb
 - spec/custom_view_spec.rb
 - spec/destroy_spec.rb
+- spec/fixtures/address.rb
+- spec/fixtures/person.rb
 - spec/property_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/unit/attributes_spec.rb
+- spec/unit/callbacks_spec.rb
 - spec/unit/create_spec.rb
 - spec/unit/customs_views_spec.rb
 - spec/unit/database_spec.rb
@@ -123,9 +128,12 @@ test_files:
 - spec/create_spec.rb
 - spec/custom_view_spec.rb
 - spec/destroy_spec.rb
+- spec/fixtures/address.rb
+- spec/fixtures/person.rb
 - spec/property_spec.rb
 - spec/spec_helper.rb
 - spec/unit/attributes_spec.rb
+- spec/unit/callbacks_spec.rb
 - spec/unit/create_spec.rb
 - spec/unit/customs_views_spec.rb
 - spec/unit/database_spec.rb