davber_couchrest_extended_document 1.0.0

data/lib/couchrest/validation/validators/method_validator.rb

@@ -0,0 +1,89 @@
+# 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.
+
+module CouchRest
+  module Validation
+
+    ##
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class MethodValidator < GenericValidator
+
+      def initialize(field_name, options={})
+        super
+        @field_name, @options = field_name, options.clone
+        @options[:method] = @field_name unless @options.has_key?(:method)
+      end
+
+      def call(target)
+        result, message = target.send(@options[:method])
+        add_error(target, message, field_name) unless result
+        result
+      end
+
+      def ==(other)
+        @options[:method] == other.instance_variable_get(:@options)[:method] && super
+      end
+    end # class MethodValidator
+
+    module ValidatesWithMethod
+
+      ##
+      # Validate using the given method. The method given needs to return:
+      # [result::<Boolean>, Error Message::<String>]
+      #
+      # @example [Usage]
+      #
+      #   class Page
+      #
+      #     property :zip_code, String
+      #
+      #     validates_with_method :in_the_right_location?
+      #
+      #     def in_the_right_location?
+      #       if @zip_code == "94301"
+      #         return true
+      #       else
+      #         return [false, "You're in the wrong zip code"]
+      #       end
+      #     end
+      #
+      #     # A call to valid? will return false and
+      #     # populate the object's errors with "You're in the
+      #     # wrong zip code" unless zip_code == "94301"
+      #
+      #     # You can also specify field:
+      #
+      #     validates_with_method :zip_code, :in_the_right_location?
+      #
+      #     # it will add returned error message to :zip_code field
+      #
+      def validates_with_method(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, CouchRest::Validation::MethodValidator)
+      end
+
+    end # module ValidatesWithMethod
+  end # module Validation
+end # module CouchRest

data/lib/couchrest/validation/validators/numeric_validator.rb

@@ -0,0 +1,109 @@
+# 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.
+
+module CouchRest
+  module Validation
+
+    ##
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class NumericValidator < GenericValidator
+
+      def initialize(field_name, options={})
+        super
+        @field_name, @options = field_name, options
+        @options[:integer_only] = false unless @options.has_key?(:integer_only)
+      end
+
+      def call(target)
+        value = target.send(field_name)
+        return true if @options[:allow_nil] && value.nil?
+
+        value = (defined?(BigDecimal) && value.kind_of?(BigDecimal)) ? value.to_s('F') : value.to_s
+
+        error_message = @options[:message]
+        precision     = @options[:precision]
+        scale         = @options[:scale]
+
+        if @options[:integer_only]
+          return true if value =~ /\A[+-]?\d+\z/
+          error_message ||= ValidationErrors.default_error_message(:not_an_integer, field_name)
+        else
+          # FIXME: if precision and scale are not specified, can we assume that it is an integer?
+          #        probably not, as floating point numbers don't have hard
+          #        defined scale. the scale floats with the length of the
+          #        integral and precision. Ie. if precision = 10 and integral
+          #        portion of the number is 9834 (4 digits), the max scale will
+          #        be 6 (10 - 4). But if the integral length is 1, max scale
+          #        will be (10 - 1) = 9, so 1.234567890.
+          if precision && scale
+            #handles both Float when it has scale specified and BigDecimal
+            if precision > scale && scale > 0
+              return true if value =~ /\A[+-]?(?:\d{1,#{precision - scale}}|\d{0,#{precision - scale}}\.\d{1,#{scale}})\z/
+            elsif precision > scale && scale == 0
+              return true if value =~ /\A[+-]?(?:\d{1,#{precision}}(?:\.0)?)\z/
+            elsif precision == scale
+              return true if value =~ /\A[+-]?(?:0(?:\.\d{1,#{scale}})?)\z/
+            else
+              raise ArgumentError, "Invalid precision #{precision.inspect} and scale #{scale.inspect} for #{field_name} (value: #{value.inspect} #{value.class})"
+            end
+          elsif precision && scale.nil?
+            # for floats, if scale is not set
+
+            #total number of digits is less or equal precision
+            return true if value.gsub(/[^\d]/, '').length <= precision
+
+            #number of digits before decimal == precision, and the number is x.0. same as scale = 0
+            return true if value =~ /\A[+-]?(?:\d{1,#{precision}}(?:\.0)?)\z/
+          else
+            return true if value =~ /\A[+-]?(?:\d+|\d*\.\d+)\z/
+          end
+          error_message ||= ValidationErrors.default_error_message(:not_a_number, field_name)
+        end
+
+        add_error(target, error_message, field_name)
+
+        # TODO: check the gt, gte, lt, lte, and eq options
+
+        return false
+      end
+    end # class NumericValidator
+
+    module ValidatesIsNumber
+
+      # Validate whether a field is numeric
+      #
+      def validates_numericality_of(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, CouchRest::Validation::NumericValidator)
+      end
+      
+      def validates_is_number(*fields)
+        warn "[DEPRECATION] `validates_is_number` is deprecated.  Please use `validates_numericality_of` instead."
+        validates_numericality_of(*fields)
+      end
+
+    end # module ValidatesIsNumber
+  end # module Validation
+end # module CouchRest

data/lib/couchrest/validation/validators/required_field_validator.rb

@@ -0,0 +1,114 @@
+# 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.
+
+module CouchRest
+  module Validation
+
+    ##
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class RequiredFieldValidator < GenericValidator
+
+      def initialize(field_name, options={})
+        super
+        @field_name, @options = field_name, options
+      end
+
+      def call(target)
+        value = target.validation_property_value(field_name)
+        property = target.validation_property(field_name.to_s)
+        return true if present?(value, property)
+
+        error_message = @options[:message] || default_error(property)
+        add_error(target, error_message, field_name)
+
+        false
+      end
+
+      protected
+
+      # Boolean property types are considered present if non-nil.
+      # Other property types are considered present if non-blank.
+      # Non-properties are considered present if non-blank.
+      def present?(value, property)
+        boolean_type?(property) ? !value.nil? : !value.blank?
+      end
+
+      def default_error(property)
+        actual = boolean_type?(property) ? :nil : :blank
+        ValidationErrors.default_error_message(actual, field_name)
+      end
+
+      # Is +property+ a boolean property?
+      #
+      # Returns true for Boolean, ParanoidBoolean, TrueClass, etc. properties.
+      # Returns false for other property types.
+      # Returns false for non-properties.
+      def boolean_type?(property)
+        property ? property.type == 'Boolean' : false
+      end
+
+    end # class RequiredFieldValidator
+
+    module ValidatesPresent
+
+      ##
+      # Validates that the specified attribute is present.
+      #
+      # For most property types "being present" is the same as being "not
+      # blank" as determined by the attribute's #blank? method. However, in
+      # the case of Boolean, "being present" means not nil; i.e. true or
+      # false.
+      #
+      # @note
+      #   dm-core's support lib adds the blank? method to many classes,
+      # @see lib/dm-core/support/blank.rb (dm-core) for more information.
+      #
+      # @example [Usage]
+      #
+      #   class Page
+      #
+      #     property :required_attribute, String
+      #     property :another_required, String
+      #     property :yet_again, String
+      #
+      #     validates_presence_of :required_attribute
+      #     validates_presence_of :another_required, :yet_again
+      #
+      #     # a call to valid? will return false unless
+      #     # all three attributes are !blank?
+      #   end
+      def validates_presence_of(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, CouchRest::Validation::RequiredFieldValidator)
+      end
+      
+      def validates_present(*fields)
+        warn "[DEPRECATION] `validates_present` is deprecated.  Please use `validates_presence_of` instead."
+        validates_presence_of(*fields)
+      end
+
+    end # module ValidatesPresent
+  end # module Validation
+end # module CouchRest

data/lib/couchrest_extended_document.rb

@@ -0,0 +1,23 @@
+gem 'couchrest', ">=1.0.0.beta"
+require 'couchrest'
+
+gem "builder", ">=2.1.2"
+
+gem 'activesupport', ">= 2.3.0"
+require 'active_support/core_ext'
+require 'active_support/json'
+
+gem "mime-types", ">= 1.15"
+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