couchrest_extended_document 1.0.0.beta5

data/lib/couchrest/validation.rb

@@ -0,0 +1,245 @@
+# Extracted from dm-validations 0.9.10
+#
+# Copyright (c) 2007 Guy van den Berg
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class Object
+  def validatable?
+    false
+  end
+end
+
+require 'pathname'
+
+dir = File.join(Pathname(__FILE__).dirname.expand_path, 'validation')
+
+require File.join(dir, 'validation_errors')
+require File.join(dir, 'contextual_validators')
+require File.join(dir, 'auto_validate')
+
+require File.join(dir, 'validators', 'generic_validator')
+require File.join(dir, 'validators', 'required_field_validator')
+require File.join(dir, 'validators', 'absent_field_validator')
+require File.join(dir, 'validators', 'format_validator')
+require File.join(dir, 'validators', 'length_validator')
+require File.join(dir, 'validators', 'numeric_validator')
+require File.join(dir, 'validators', 'method_validator')
+require File.join(dir, 'validators', 'confirmation_validator')
+
+module CouchRest
+  module Validation
+    
+    def self.included(base)
+      base.extlib_inheritable_accessor(:auto_validation)
+      base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          # Callbacks
+          define_callbacks :validate
+          
+          # Turn off auto validation by default
+          self.auto_validation ||= false
+          
+          # Force the auto validation for the class properties
+          # This feature is still not fully ported over,
+          # test are lacking, so please use with caution
+          def self.auto_validate!
+            self.auto_validation = true
+          end
+          
+          # share the validations with subclasses
+          def self.inherited(subklass)
+            self.validators.contexts.each do |k, v|
+              subklass.validators.contexts[k] = v.dup
+            end
+            super
+          end
+      EOS
+      
+      base.extend(ClassMethods)
+      base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+        define_callbacks :validate
+        if method_defined?(:_run_save_callbacks)
+          set_callback :save, :before, :check_validations
+        end
+      EOS
+      base.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def self.define_property(name, options={})
+          super
+          auto_generate_validations(properties.last) if properties && properties.size > 0
+          autovalidation_check = true
+        end
+      RUBY_EVAL
+    end
+
+    # Ensures the object is valid for the context provided, and otherwise
+    # throws :halt and returns false.
+    #
+    def check_validations(context = :default)
+      throw(:halt, false) unless context.nil? || valid?(context)
+    end
+    
+    # Return the ValidationErrors
+    #
+    def errors
+      @errors ||= ValidationErrors.new
+    end
+
+    # Mark this resource as validatable. When we validate associations of a
+    # resource we can check if they respond to validatable? before trying to
+    # recursivly validate them
+    #
+    def validatable?
+      true
+    end
+
+    # Alias for valid?(:default)
+    #
+    def valid_for_default?
+      valid?(:default)
+    end
+
+    # Check if a resource is valid in a given context
+    #
+    def valid?(context = :default)
+      recursive_valid?(self, context, true)
+    end
+    
+    # checking on casted objects
+    def validate_casted_arrays
+      result = true
+      array_casted_properties = self.class.properties.select { |property| property.casted && property.type.instance_of?(Array) }
+      array_casted_properties.each do |property|
+        casted_values = self.send(property.name)
+        next unless casted_values.is_a?(Array) && casted_values.first.respond_to?(:valid?)
+        casted_values.each do |value|
+          result = (result && value.valid?) if value.respond_to?(:valid?)
+        end
+      end
+      result
+    end
+
+    # Do recursive validity checking
+    #
+    def recursive_valid?(target, context, state)
+      valid = state
+      target.each do |key, prop|
+        if prop.is_a?(Array)
+          prop.each do |item|
+            if item.validatable?
+              valid = recursive_valid?(item, context, valid) && valid
+            end
+          end
+        elsif prop.validatable?
+          valid = recursive_valid?(prop, context, valid) && valid
+        end
+      end
+      target._run_validate_callbacks do
+        target.class.validators.execute(context, target) && valid
+      end
+    end
+
+
+    def validation_property_value(name)
+      self.respond_to?(name, true) ? self.send(name) : nil
+    end
+
+    # Get the corresponding Object property, if it exists.
+    def validation_property(field_name)
+      properties.find{|p| p.name == field_name}
+    end
+
+    module ClassMethods
+      include CouchRest::Validation::ValidatesPresent
+      include CouchRest::Validation::ValidatesAbsent
+      include CouchRest::Validation::ValidatesIsConfirmed
+      # include CouchRest::Validation::ValidatesIsPrimitive
+      # include CouchRest::Validation::ValidatesIsAccepted
+      include CouchRest::Validation::ValidatesFormat
+      include CouchRest::Validation::ValidatesLength
+      # include CouchRest::Validation::ValidatesWithin
+      include CouchRest::Validation::ValidatesIsNumber
+      include CouchRest::Validation::ValidatesWithMethod
+      # include CouchRest::Validation::ValidatesWithBlock
+      # include CouchRest::Validation::ValidatesIsUnique
+      include CouchRest::Validation::AutoValidate
+      
+      # Return the set of contextual validators or create a new one
+      #
+      def validators
+        @validations ||= ContextualValidators.new
+      end
+      
+      # Clean up the argument list and return a opts hash, including the
+      # merging of any default opts. Set the context to default if none is
+      # provided. Also allow :context to be aliased to :on, :when & group
+      #
+      def opts_from_validator_args(args, defaults = nil)
+        opts = args.last.kind_of?(Hash) ? args.pop : {}
+        context = :default
+        context = opts[:context] if opts.has_key?(:context)
+        context = opts.delete(:on) if opts.has_key?(:on)
+        context = opts.delete(:when) if opts.has_key?(:when)
+        context = opts.delete(:group) if opts.has_key?(:group)
+        opts[:context] = context
+        opts.merge!(defaults) unless defaults.nil?
+        opts
+      end
+      
+      # Given a new context create an instance method of
+      # valid_for_<context>? which simply calls valid?(context)
+      # if it does not already exist
+      #
+      def create_context_instance_methods(context)
+        name = "valid_for_#{context.to_s}?"           # valid_for_signup?
+        if !self.instance_methods.include?(name)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{name}                               # def valid_for_signup?
+              valid?('#{context.to_s}'.to_sym)        #   valid?('signup'.to_sym)
+            end                                       # end
+          EOS
+        end
+      end
+
+      # Create a new validator of the given klazz and push it onto the
+      # requested context for each of the attributes in the fields list
+      #
+      def add_validator_to_context(opts, fields, klazz)
+        fields.each do |field|
+          validator = klazz.new(field.to_sym, opts)
+          if opts[:context].is_a?(Symbol)
+            unless validators.context(opts[:context]).include?(validator)
+              validators.context(opts[:context]) << validator
+              create_context_instance_methods(opts[:context])
+            end
+          elsif opts[:context].is_a?(Array)
+            opts[:context].each do |c|
+              unless validators.context(c).include?(validator)
+                validators.context(c) << validator
+                create_context_instance_methods(c)
+              end
+            end
+          end
+        end
+      end
+      
+    end # module ClassMethods
+  end # module Validation
+
+end # module CouchRest

data/lib/couchrest_extended_document.rb

@@ -0,0 +1,21 @@
+
+# require File.join(File.dirname(__FILE__), "couchrest", "extended_document")
+
+gem 'couchrest'
+
+require 'couchrest'
+
+require 'active_support/core_ext'
+require 'mime/types'
+require "enumerator"
+
+# Monkey patches applied to couchrest
+require File.join(File.dirname(__FILE__), 'couchrest', 'support', 'couchrest')
+
+# Base libraries
+require File.join(File.dirname(__FILE__), 'couchrest', 'extended_document')
+require File.join(File.dirname(__FILE__), 'couchrest', 'casted_model')
+
+# Add rails support *after* everything has loaded
+require File.join(File.dirname(__FILE__), 'couchrest', 'support', 'rails') if defined?(Rails)
+

data/spec/couchrest/attribute_protection_spec.rb

@@ -0,0 +1,150 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "ExtendedDocument", "no declarations" do
+  class NoProtection < CouchRest::ExtendedDocument
+    use_database TEST_SERVER.default_database
+    property :name
+    property :phone
+  end
+
+  it "should not protect anything through new" do
+    user = NoProtection.new(:name => "will", :phone => "555-5555")
+
+    user.name.should == "will"
+    user.phone.should == "555-5555"
+  end
+
+  it "should not protect anything through attributes=" do
+    user = NoProtection.new
+    user.attributes = {:name => "will", :phone => "555-5555"}
+
+    user.name.should == "will"
+    user.phone.should == "555-5555"
+  end
+  
+  it "should recreate from the database properly" do
+    user = NoProtection.new
+    user.name = "will"
+    user.phone = "555-5555"
+    user.save!
+    
+    user = NoProtection.get(user.id)
+    user.name.should == "will"
+    user.phone.should == "555-5555"
+  end
+end
+
+describe "ExtendedDocument", "accessible flag" do
+  class WithAccessible < CouchRest::ExtendedDocument
+    use_database TEST_SERVER.default_database
+    property :name, :accessible => true
+    property :admin, :default => false
+  end
+
+  it "should recognize accessible properties" do
+    props = WithAccessible.accessible_properties.map { |prop| prop.name}
+    props.should include("name")
+    props.should_not include("admin")
+  end
+
+  it "should protect non-accessible properties set through new" do
+    user = WithAccessible.new(:name => "will", :admin => true) 
+
+    user.name.should == "will"
+    user.admin.should == false
+  end
+
+  it "should protect non-accessible properties set through attributes=" do
+    user = WithAccessible.new
+    user.attributes = {:name => "will", :admin => true}
+
+    user.name.should == "will"
+    user.admin.should == false
+  end
+end
+
+describe "ExtendedDocument", "protected flag" do
+  class WithProtected < CouchRest::ExtendedDocument
+    use_database TEST_SERVER.default_database
+    property :name
+    property :admin, :default => false, :protected => true
+  end
+
+  it "should recognize protected properties" do
+    props = WithProtected.protected_properties.map { |prop| prop.name}
+    props.should_not include("name")
+    props.should include("admin")
+  end
+
+  it "should protect non-accessible properties set through new" do
+    user = WithProtected.new(:name => "will", :admin => true) 
+
+    user.name.should == "will"
+    user.admin.should == false
+  end
+
+  it "should protect non-accessible properties set through attributes=" do
+    user = WithProtected.new
+    user.attributes = {:name => "will", :admin => true}
+
+    user.name.should == "will"
+    user.admin.should == false
+  end
+end
+
+describe "ExtendedDocument", "protected flag" do
+  class WithBoth < CouchRest::ExtendedDocument
+    use_database TEST_SERVER.default_database
+    property :name, :accessible => true
+    property :admin, :default => false, :protected => true
+  end
+
+  it "should raise an error when both are set" do
+    lambda { WithBoth.new }.should raise_error 
+  end
+end
+
+describe "ExtendedDocument", "from database" do
+  class WithProtected < CouchRest::ExtendedDocument
+    use_database TEST_SERVER.default_database
+    property :name
+    property :admin, :default => false, :protected => true
+    view_by :name
+  end
+  
+  before(:each) do
+    @user = WithProtected.new
+    @user.name = "will"
+    @user.admin = true
+    @user.save!
+  end
+
+  def verify_attrs(user)
+    user.name.should  == "will"
+    user.admin.should == true
+  end
+
+  it "ExtendedDocument#get should not strip protected attributes" do
+    reloaded = WithProtected.get( @user.id )
+    verify_attrs reloaded 
+  end
+
+  it "ExtendedDocument#get! should not strip protected attributes" do
+    reloaded = WithProtected.get!( @user.id )
+    verify_attrs reloaded 
+  end
+
+  it "ExtendedDocument#all should not strip protected attributes" do
+    # all creates a CollectionProxy
+    docs = WithProtected.all(:key => @user.id)
+    docs.size.should == 1
+    reloaded = docs.first
+    verify_attrs reloaded 
+  end
+
+  it "views should not strip protected attributes" do
+    docs = WithProtected.by_name(:startkey => "will", :endkey => "will")
+    reloaded = docs.first
+    verify_attrs reloaded 
+  end
+end

data/spec/couchrest/casted_extended_doc_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require File.join(FIXTURE_PATH, 'more', 'cat')
+require File.join(FIXTURE_PATH, 'more', 'person')
+require File.join(FIXTURE_PATH, 'more', 'card')
+
+class Driver < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  # You have to add a casted_by accessor if you want to reach a casted extended doc parent
+  attr_accessor :casted_by
+  
+  property :name
+end
+
+class Car < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  
+  property :name
+  property :driver, :cast_as => 'Driver'
+  property :backseat_driver, :cast_as => Driver
+end
+
+describe "casting an extended document" do
+  
+  before(:each) do
+    @driver = Driver.new(:name => 'Matt')
+    @car    = Car.new(:name => 'Renault 306', :driver => @driver)
+    @car2   = Car.new(:name => 'Renault 306', :backseat_driver => @driver.dup)
+  end
+
+  it "should retain all properties of the casted attribute" do
+    @car.driver.should == @driver
+    @car2.backseat_driver.should == @driver
+  end
+  
+  it "should let the casted document know who casted it" do
+    @car.driver.casted_by.should == @car
+    @car2.backseat_driver.casted_by.should == @car2
+  end
+end
+
+describe "assigning a value to casted attribute after initializing an object" do
+
+  before(:each) do
+    @car    = Car.new(:name => 'Renault 306')
+    @driver = Driver.new(:name => 'Matt')
+  end
+  
+  it "should not create an empty casted object" do
+    @car.driver.should be_nil
+  end
+  
+  it "should let you assign the value" do
+    @car.driver = @driver
+    @car.driver.name.should == 'Matt'
+  end
+  
+  it "should cast attribute" do
+    @car.driver = JSON.parse(@driver.to_json)
+    @car.driver.should be_instance_of(Driver)
+  end
+
+end
+
+describe "casting an extended document from parsed JSON" do
+
+  before(:each) do
+    @driver = Driver.new(:name => 'Matt')
+    @car    = Car.new(:name => 'Renault 306', :driver => @driver)
+    @new_car = Car.new(JSON.parse(@car.to_json))
+  end
+
+  it "should cast casted attribute" do
+    @new_car.driver.should be_instance_of(Driver)
+  end
+  
+  it "should retain all properties of the casted attribute" do
+    @new_car.driver.should == @driver
+  end
+end