couch_potato 0.2.22 → 0.2.23

data/CHANGES.md

@@ -1,5 +1,10 @@
 ## Changes
 
+### 0.2.23
+* Couch Potato models now conform to the ActiveModel interface when ActiveModel is installed, see http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/ (langalex)
+* fixed error with dirty tracking and BigDecimals (thilo)
+* added the ability to use ActiveModel validations instead of validatable (martinrehfeld)
+
 ### 0.2.22
 * fixed properties with default values returned default when a blank value like '' or [] was set (langalex)
 

data/README.md

@@ -20,24 +20,26 @@ Lastly Couch Potato aims to provide a seamless integration with Ruby on Rails, e
 
 ### Installation
 
-Couch Potato is hosted as a gem on gemcutter.org which you can install like this:
+Couch Potato is hosted as a gem which you can install like this:
 
-    sudo gem install couch_potato --source http://gemcutter.org
+    (sudo) gem install couch_potato
 
 #### Using with your ruby application:
 
     require 'rubygems'
     require 'couch_potato'
 
-Alternatively you can download or clone the source repository and then require lib/couch_potato.rb.
-
-You MUST specify the name of the database:
+After that you configure the name of the database:
 
     CouchPotato::Config.database_name = 'name_of_the_db'
 
 The server URL will default to http://localhost:5984/ unless specified:
 
     CouchPotato::Config.database_name = "http://example.com:5984/name_of_the_db"
+  
+Optionally you can configure which framework you want to use for validations (either validatable or ActiveModel)
+
+    CouchPotato::Config.validation_framework = :validatable | :active_model
 
 #### Using with Rails
 
@@ -340,7 +342,7 @@ Please fix bugs, add more specs, implement new features by forking the github re
 
 Issues are tracked at github: http://github.com/langalex/couch_potato/issues
 
-There is a mailing list, just write to: couchpotato@librelis.com
+There is a mailing list, just write to: couchpotato@librelist.com
 
 You can run all the specs by calling 'rake spec_unit' and 'rake spec_functional' in the root folder of Couch Potato. The specs require a running CouchDB instance at http://localhost:5984
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:build: 
 :major: 0
 :minor: 2
-:patch: 22
+:patch: 23
+:build: 

data/lib/couch_potato/database.rb

@@ -138,7 +138,7 @@ module CouchPotato
     def valid_document?(document)
       errors = document.errors.errors.dup
       document.valid?
-      errors.each do |k, v|
+      errors.each_pair do |k, v|
         v.each {|message| document.errors.add(k, message)}
       end
       document.errors.empty?

data/lib/couch_potato/persistence/active_model_compliance.rb

@@ -0,0 +1,36 @@
+module CouchPotato
+  module Persistence
+    module ActiveModelCompliance
+      begin
+        require 'active_model'
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def to_model
+          self
+        end
+
+        def errors
+          super || []
+        end
+
+        def destroyed?
+          !!_deleted
+        end
+
+        module ClassMethods
+          def model_name
+            @model_name ||= ::ActiveModel::Name.new(self)
+          end
+        end
+
+      rescue LoadError, NameError
+        # if it's not installed you probably don't want to use it anyway
+      end
+    end
+  end
+end
+
+

data/lib/couch_potato/persistence/callbacks.rb

@@ -49,9 +49,7 @@ module CouchPotato
           :after_destroy
         ].each do |callback|
           define_method callback do |*names|
-            names.each do |name|
-              callbacks[callback] << name
-            end
+            callbacks[callback].push *names
           end
         end
       end

data/lib/couch_potato/persistence/dirty_attributes.rb

@@ -1,3 +1,4 @@
+require 'bigdecimal'
 module CouchPotato
   module Persistence
     module DirtyAttributes
@@ -35,7 +36,7 @@ module CouchPotato
       end
       
       def clone_attribute(value)
-        if [Fixnum, Symbol, TrueClass, FalseClass, NilClass, Float].include?(value.class)
+        if [Fixnum, Symbol, TrueClass, FalseClass, NilClass, Float, BigDecimal].include?(value.class)
           value
         elsif [Hash, Array].include?(value.class)
           #Deep clone

data/lib/couch_potato/persistence.rb

@@ -1,5 +1,6 @@
 require 'digest/md5'
 require File.dirname(__FILE__) + '/database'
+require File.dirname(__FILE__) + '/persistence/active_model_compliance'
 require File.dirname(__FILE__) + '/persistence/properties'
 require File.dirname(__FILE__) + '/persistence/magic_timestamps'
 require File.dirname(__FILE__) + '/persistence/callbacks'
@@ -7,7 +8,6 @@ require File.dirname(__FILE__) + '/persistence/json'
 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'
@@ -19,7 +19,7 @@ module CouchPotato
     def self.included(base) #:nodoc:
       base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews
       base.send :include, DirtyAttributes, GhostAttributes, Attachments
-      base.send :include, MagicTimestamps
+      base.send :include, MagicTimestamps, ActiveModelCompliance
       base.class_eval do
         attr_accessor :_id, :_rev, :_deleted, :database
         alias_method :id, :_id

data/lib/couch_potato/validation/with_active_model.rb

@@ -0,0 +1,27 @@
+module CouchPotato
+  module Validation
+    module WithActiveModel
+      def self.included(base)
+        require 'active_model'
+        require 'active_model/translation'
+        base.send :include, ::ActiveModel::Validations
+        base.instance_eval do
+          def before_validation(*names)
+            names.each do |name|
+              validate name
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# provide same interface to errors object as in Validatable
+module ::ActiveModel
+  class Errors
+    def errors
+      self
+    end
+  end
+end

data/lib/couch_potato/{persistence/validation.rb → validation/with_validatable.rb}

@@ -1,10 +1,9 @@
-require 'validatable'
-
 module CouchPotato
-  module Persistence
-    module Validation
-      def self.included(base) #:nodoc:
-        base.send :include, Validatable
+  module Validation
+    module WithValidatable
+      def self.included(base)
+        require 'validatable'
+        base.send :include, ::Validatable
         base.class_eval do
           # Override the validate method to first run before_validation callback
           def valid?
@@ -21,4 +20,13 @@ module CouchPotato
       end
     end
   end
-end
+end
+
+# add [] method to Validatable's implementation of the Errors class
+module Validatable
+  class Errors
+    def [](attribute)
+      [on(attribute)].flatten.compact
+    end
+  end
+end

data/lib/couch_potato/validation.rb

@@ -0,0 +1,16 @@
+module CouchPotato
+  module Validation
+    def self.included(base) #:nodoc:
+      case CouchPotato::Config.validation_framework
+      when :validatable
+        require File.dirname(__FILE__) + '/validation/with_validatable'
+        base.send :include, CouchPotato::Validation::WithValidatable
+      when :active_model
+        require File.dirname(__FILE__) + '/validation/with_active_model'
+        base.send :include, CouchPotato::Validation::WithActiveModel
+      else
+        raise "Unknown CouchPotato::Config.validation_framework #{CouchPotato::Config.validation_framework.inspect}, options are :validatable or :active_model"
+      end
+    end
+  end
+end

data/lib/couch_potato/view/model_view_spec.rb

@@ -21,13 +21,13 @@ module CouchPotato
       
       def map_function
         map_body do
-          "emit(#{formatted_key(key)}, null);"
+          "emit(#{formatted_key(key)}, 1);"
         end
       end
       
       def reduce_function
         "function(key, values) {
-          return values.length;
+          return sum(values);
         }"
       end
       

data/lib/couch_potato.rb

@@ -8,7 +8,8 @@ require 'ostruct'
 JSON.create_id = 'ruby_class'
 
 module CouchPotato
-  Config = Struct.new(:database_name).new
+  Config = Struct.new(:database_name, :validation_framework).new
+  Config.validation_framework = :validatable # default to the validatable gem for validations
 
   # Returns a database instance which you can then use to create objects and query views. You have to set the CouchPotato::Config.database_name before this works.
   def self.database
@@ -37,5 +38,6 @@ require File.dirname(__FILE__) + '/core_ext/time'
 require File.dirname(__FILE__) + '/core_ext/date'
 require File.dirname(__FILE__) + '/core_ext/string'
 require File.dirname(__FILE__) + '/core_ext/symbol'
+require File.dirname(__FILE__) + '/couch_potato/validation'
 require File.dirname(__FILE__) + '/couch_potato/persistence'
 

data/spec/callbacks_spec.rb

@@ -273,28 +273,30 @@ end
 describe "validation callbacks" do
   class ValidatedUser
     include CouchPotato::Persistence
-    
+
     property :name
     before_validation :check_name
     validates_presence_of :name
-    
+
     def check_name
       errors.add(:name, 'should be Paul') unless name == "Paul"
     end
   end
-  
+
   it "should keep error messages set in custom before_validation filters" do
     user = ValidatedUser.new(:name => "john")
     user.valid?.should == false
     user.errors.on(:name).should == "should be Paul"
   end
-  
+
   it "should combine the errors from validations and callbacks" do
     user = ValidatedUser.new(:name => nil)
     user.valid?.should == false
-    user.errors.on(:name).should == ["can't be empty", "should be Paul"]
+    user.errors.on(:name).any? {|msg| msg =~ /can't be (empty|blank)/ }.should == true
+    user.errors.on(:name).any? {|msg| msg == "should be Paul" }.should == true
+    user.errors.on(:name).size.should == 2
   end
-  
+
   it "should clear the errors on subsequent calls to valid?" do
     user = ValidatedUser.new(:name => nil)
     user.valid?.should == false

data/spec/custom_view_spec.rb

@@ -164,7 +164,7 @@ describe 'view' do
   describe "inherited views" do
     it "should support parent views for objects of the subclass" do
       CouchPotato.database.save_document CustomBuild.new(:state => 'success', :time => '2008-01-01')
-      CouchPotato.database.view(CustomBuild.timeline).should have(1).item
+      CouchPotato.database.view(CustomBuild.timeline).size.should == 1
       CouchPotato.database.view(CustomBuild.timeline).first.should be_kind_of(CustomBuild)
     end
   end

data/spec/spec_helper.rb

@@ -6,6 +6,14 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'couch_potato'
 
 CouchPotato::Config.database_name = 'couch_potato_test'
+CouchPotato::Config.validation_framework = ENV['VALIDATION_FRAMEWORK'].to_sym unless ENV['VALIDATION_FRAMEWORK'].blank?
+
+# silence deprecation warnings from ActiveModel as the Spec uses Errors#on
+begin
+  ActiveSupport::Deprecation.silenced = true
+rescue
+  # ignore errors, ActiveSupport is probably not installed
+end
 
 class Child
   include CouchPotato::Persistence
@@ -13,8 +21,6 @@ class Child
   property :text
 end
 
-
-
 class Comment
   include CouchPotato::Persistence
 

data/spec/unit/active_model_compliance_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+begin
+  require 'active_model'
+  
+  describe 'ActiveModel conformance of couch potato objects' do
+    include ActiveModel::Lint::Tests
+
+    instance_methods.sort.select{|method| method.to_s.scan(/^test_/).first}.each do |method|
+      it "should #{method.to_s.sub(/^test_/, '').gsub('_', ' ')}" do
+        send method
+      end
+    end
+
+    class ActiveComment
+      include CouchPotato::Persistence
+      property :name
+      property :email
+      validates_presence_of :name, :email
+      validates_format_of :email, :with => /.+@.+/
+    end
+
+    before(:each) do
+      @model = ActiveComment.new
+    end
+    
+    describe "#errors" do
+      it "should return a single error as array" do
+        @model.valid?
+        @model.errors[:name].should be_kind_of(Array)
+      end
+      
+      it "should return multiple errors as array" do
+        @model.valid?
+        @model.errors[:email].size.should == 2
+      end
+      
+      it "should return no error as an empty array" do
+        @model.errors[:name].should == []
+      end
+      
+      it "should be able to be Marshal.dump'ed" do
+        lambda { Marshal.dump(@model.errors) }.should_not raise_error
+      end
+    end
+
+    describe "#destroyed" do
+      it "should return destroyed if the object is deleted" do
+        @model._deleted = true
+        @model.should be_destroyed
+      end
+
+      it "should not return destroyed if it's not deleted" do
+        @model.should_not be_destroyed
+      end
+    end
+
+    def assert(boolean, message)
+      boolean || raise(message)
+    end
+
+    def assert_kind_of(klass, object)
+      object.should be_a(klass)
+    end
+  end
+  
+rescue LoadError
+  STDERR.puts "WARNING: active_model gem not installed. Not running ActiveModel specs."
+end
+
+
+
+

data/spec/unit/callbacks_spec.rb

@@ -1,33 +1,32 @@
 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
+describe 'before_validation callback' do
+  before(:each) do
+    @tree = Tree.new(:leaf_count => 1, :root_count => 1)
   end
-end
 
+  class Tree
+    include CouchPotato::Persistence
 
-describe 'before_validation callback' do
-  before :each do
-    @tree = Tree.new(:leaf_count => 1, :root_count => 1)
+    before_validation :water!, lambda {|tree| tree.root_count += 1 }
+
+    property :leaf_count
+    property :root_count
+
+    def water!
+      self.leaf_count += 1
+    end
   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
+end

data/spec/unit/couch_potato_spec.rb

@@ -17,4 +17,23 @@ describe CouchPotato, 'full_url_to_database' do
     CouchPotato::Config.database_name = 'http://db.local/test'
     CouchPotato.full_url_to_database.should == 'http://db.local/test'
   end
-end
+end
+
+describe CouchPotato, 'validation_framework' do
+  before(:each) do
+    @original_validation_framework = CouchPotato::Config.validation_framework
+  end
+  after(:each) do
+    CouchPotato::Config.validation_framework = @original_validation_framework
+  end
+
+  it "should allow setting the validation_framework to :active_model" do
+    CouchPotato::Config.validation_framework = :active_model
+    CouchPotato::Config.validation_framework.should == :active_model
+  end
+
+  it "should allow setting the validation_framework to :validatable" do
+    CouchPotato::Config.validation_framework = :validatable
+    CouchPotato::Config.validation_framework.should == :validatable
+  end
+end

data/spec/unit/database_spec.rb

@@ -168,7 +168,7 @@ describe CouchPotato::Database, 'save_document' do
     it "should keep errors added in before_validation_on_* callbacks when creating a new object" do
       spock = Vulcan.new(:name => 'spock')
       @db.save_document(spock, false)
-      spock.new_record?.should == false
+      spock.new?.should == false
       spock.name = "spock's father"
       @db.save_document(spock)
       spock.errors.on(:validation).should == 'failed'
@@ -178,7 +178,7 @@ describe CouchPotato::Database, 'save_document' do
       spock = Vulcan.new
       @db.save_document(spock)
       spock.errors.on(:validation).should == 'failed'
-      spock.errors.on(:name).should == "can't be empty"
+      spock.errors.on(:name).should =~ /can't be (empty|blank)/
     end
     
     it "should clear errors on subsequent, valid saves when creating" do
@@ -196,7 +196,7 @@ describe CouchPotato::Database, 'save_document' do
       
       spock.name = nil
       @db.save_document(spock)
-      spock.errors.on(:name).should == "can't be empty"
+      spock.errors.on(:name).should =~ /can't be (empty|blank)/
       
       spock.name = 'Spock'
       @db.save_document(spock)

data/spec/unit/dirty_attributes_spec.rb

@@ -64,6 +64,27 @@ describe 'dirty attribute tracking' do
         @plate.food = 'burger'
         @plate.food_was.should == 'sushi'
       end
+      
+      describe "with type BigDecimal" do
+        before(:each) do
+          class ::Plate
+            property :price
+          end
+        end
+        it "should not dup BigDecimal" do
+
+          lambda {
+            Plate.new :price => BigDecimal.new("5.23") 
+          }.should_not raise_error(TypeError)
+        end
+        
+        it "should return the old value" do
+          plate = Plate.new :price => BigDecimal.new("5.23") 
+          plate.price = BigDecimal.new("2.23")
+          plate.price_was.should == 5.23
+        end
+        
+      end
     end
 
     describe "check for dirty" do

data/spec/unit/validation_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'CouchPotato::Config.validation_framework' do
+  before(:each) do
+    @original_validation_framework = CouchPotato::Config.validation_framework
+  end
+  after(:each) do
+    CouchPotato::Config.validation_framework = @original_validation_framework
+  end
+  
+  describe "access to errors object" do
+    it "should description" do
+      model_class = Class.new
+      model_class.send(:include, CouchPotato::Persistence)
+      model_class.new.errors.should respond_to(:errors)
+    end
+  end
+
+  begin
+    require 'active_model'
+
+    describe 'with :active_model' do
+      before(:each) do
+        CouchPotato::Config.validation_framework = :active_model
+      end
+
+      it "should include ActiveModel::Validations upon inclusion of CouchPotato::Persistence" do
+        model_class = Class.new
+        ActiveModel::Validations.should_receive(:included).with(model_class)
+        model_class.send(:include, CouchPotato::Persistence)
+      end
+    end
+
+  rescue LoadError
+    STDERR.puts "WARNING: active_model gem not installed. Not running ActiveModel validation specs."
+  end
+
+  begin
+    require 'validatable'
+
+    describe 'with :validatable' do
+      before(:each) do
+        CouchPotato::Config.validation_framework = :validatable
+      end
+
+      it "should include ActiveModel::Validations upon inclusion of CouchPotato::Persistence" do
+        model_class = Class.new
+        Validatable.should_receive(:included).with(model_class)
+        model_class.send(:include, CouchPotato::Persistence)
+      end
+    end
+
+  rescue LoadError
+    STDERR.puts "WARNING: validatable gem not installed. Not running Validatable validation specs."
+  end
+
+  describe 'with an unknown framework' do
+    before(:each) do
+      CouchPotato::Config.validation_framework = :unknown_validation_framework
+    end
+
+    it "should raise an error" do
+      model_class = Class.new
+      lambda { model_class.send(:include, CouchPotato::Persistence) }.should raise_error
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.22
+  version: 0.2.23
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 +01:00
+date: 2010-02-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - lib/couch_potato.rb
 - lib/couch_potato/database.rb
 - lib/couch_potato/persistence.rb
+- lib/couch_potato/persistence/active_model_compliance.rb
 - lib/couch_potato/persistence/attachments.rb
 - lib/couch_potato/persistence/callbacks.rb
 - lib/couch_potato/persistence/dirty_attributes.rb
@@ -73,11 +74,13 @@ files:
 - 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
 - lib/couch_potato/rspec/matchers/print_r.js
 - lib/couch_potato/rspec/matchers/reduce_to_matcher.rb
+- lib/couch_potato/validation.rb
+- lib/couch_potato/validation/with_active_model.rb
+- lib/couch_potato/validation/with_validatable.rb
 - lib/couch_potato/view/base_view_spec.rb
 - lib/couch_potato/view/custom_view_spec.rb
 - lib/couch_potato/view/custom_views.rb
@@ -99,6 +102,7 @@ files:
 - spec/rails_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/unit/active_model_compliance_spec.rb
 - spec/unit/attributes_spec.rb
 - spec/unit/base_view_spec_spec.rb
 - spec/unit/callbacks_spec.rb
@@ -111,6 +115,7 @@ files:
 - spec/unit/model_view_spec_spec.rb
 - spec/unit/rspec_matchers_spec.rb
 - spec/unit/string_spec.rb
+- spec/unit/validation_spec.rb
 - spec/unit/view_query_spec.rb
 - spec/update_spec.rb
 has_rdoc: true
@@ -153,6 +158,7 @@ test_files:
 - spec/property_spec.rb
 - spec/rails_spec.rb
 - spec/spec_helper.rb
+- spec/unit/active_model_compliance_spec.rb
 - spec/unit/attributes_spec.rb
 - spec/unit/base_view_spec_spec.rb
 - spec/unit/callbacks_spec.rb
@@ -165,5 +171,6 @@ test_files:
 - spec/unit/model_view_spec_spec.rb
 - spec/unit/rspec_matchers_spec.rb
 - spec/unit/string_spec.rb
+- spec/unit/validation_spec.rb
 - spec/unit/view_query_spec.rb
 - spec/update_spec.rb