couchrest_extended_document 1.0.0.beta5

data/lib/couchrest/validation/auto_validate.rb

@@ -0,0 +1,156 @@
+# Ported from dm-migrations
+
+module CouchRest
+  
+  class Property
+    # flag letting us know if we already checked the autovalidation settings
+    attr_accessor :autovalidation_check
+    @autovalidation_check = false
+  end
+
+  module Validation
+    module AutoValidate      
+      
+      # # 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 auto_validate!
+      #   auto_validation = true
+      # end
+      
+      # adds message for validator
+      def options_with_message(base_options, property, validator_name)
+        options = base_options.clone
+        opts = property.options
+        options[:message] = if opts[:messages]
+          if opts[:messages].is_a?(Hash) and msg = opts[:messages][validator_name]
+            msg
+          else
+            nil
+          end
+        elsif opts[:message]
+          opts[:message]
+        else
+          nil
+        end
+        options
+      end
+
+      
+      ##
+      # Auto-generate validations for a given property. This will only occur
+      # if the option :auto_validation is either true or left undefined.
+      #
+      # @details [Triggers]
+      #   Triggers that generate validator creation
+      #
+      #   :nullable => false
+      #       Setting the option :nullable to false causes a
+      #       validates_presence_of validator to be automatically created on
+      #       the property
+      #
+      #   :size => 20 or :length => 20
+      #       Setting the option :size or :length causes a validates_length_of
+      #       validator to be automatically created on the property. If the
+      #       value is a Integer the validation will set :maximum => value if
+      #       the value is a Range the validation will set :within => value
+      #
+      #   :format => :predefined / lambda / Proc
+      #       Setting the :format option causes a validates_format_of
+      #       validator to be automatically created on the property
+      #
+      #   :set => ["foo", "bar", "baz"]
+      #       Setting the :set option causes a validates_within
+      #       validator to be automatically created on the property
+      #
+      #   Integer type
+      #       Using a Integer type causes a validates_numericality_of
+      #       validator to be created for the property.  integer_only
+      #       is set to true
+      #
+      #   Float type
+      #       Using a Integer type causes a validates_is_number
+      #       validator to be created for the property.  integer_only
+      #       is set to false, and precision/scale match the property
+      #
+      #
+      #   Messages
+      #
+      #   :messages => {..}
+      #       Setting :messages hash replaces standard error messages
+      #       with custom ones. For instance:
+      #       :messages => {:presence => "Field is required",
+      #                     :format => "Field has invalid format"}
+      #       Hash keys are: :presence, :format, :length, :is_unique,
+      #                      :is_number, :is_primitive
+      #
+      #   :message => "Some message"
+      #       It is just shortcut if only one validation option is set
+      #
+      def auto_generate_validations(property)
+        return unless ((property.autovalidation_check != true) && self.auto_validation)
+        return if (property.options && (property.options.has_key?(:auto_validation) && !property.options[:auto_validation]) || property.read_only)
+        # value is set by the storage system
+        opts = {}
+        opts[:context] = property.options[:validates] if property.options.has_key?(:validates)
+
+        # presence
+        if opts[:allow_nil] == false
+          validates_presence_of property.name, options_with_message(opts, property, :presence)
+        end
+
+        # length
+        if property.type == String
+          # XXX: maybe length should always return a Range, with the min defaulting to 1
+          # 52 being the max set 
+          len = property.options.fetch(:length, property.options.fetch(:size, 52))
+          if len.is_a?(Range)
+            opts[:within] = len
+          else
+            opts[:maximum] = len
+          end
+          validates_length_of property.name, options_with_message(opts, property, :length)
+        end
+
+        # format
+        if property.options.has_key?(:format)
+          opts[:with] = property.options[:format]
+          # validates_format property.name, opts
+          validates_format property.name, options_with_message(opts, property, :format)
+        end
+
+        # uniqueness validator
+        if property.options.has_key?(:unique)
+          value = property.options[:unique]
+          if value.is_a?(Array) || value.is_a?(Symbol)
+            # validates_is_unique property.name, :scope => Array(value)
+            validates_is_unique property.name, options_with_message({:scope => Array(value)}, property, :is_unique)
+          elsif value.is_a?(TrueClass)
+            # validates_is_unique property.name
+            validates_is_unique property.name, options_with_message({}, property, :is_unique)
+          end
+        end
+
+        # within validator
+        if property.options.has_key?(:set)
+          validates_within property.name, options_with_message({:set => property.options[:set]}, property, :within)
+        end
+
+        # numeric validator
+        if "Integer" == property.type
+          opts[:integer_only] = true
+          validates_numericality_of property.name, options_with_message(opts, property, :is_number)
+        elsif Float == property.type
+          opts[:precision] = property.precision
+          opts[:scale]     = property.scale
+          validates_numericality_of property.name, options_with_message(opts, property, :is_number)
+        end
+        
+        # marked the property has checked
+        property.autovalidation_check = true
+        
+      end
+
+    end # module AutoValidate
+  end # module Validation
+end # module CouchRest

data/lib/couchrest/validation/contextual_validators.rb

@@ -0,0 +1,78 @@
+# 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 ContextualValidators
+
+      def dump
+        contexts.each_pair do |key, context|
+          puts "Key=#{key} Context: #{context}"
+        end
+      end
+
+      # Get a hash of named context validators for the resource
+      #
+      # @return <Hash> a hash of validators <GenericValidator>
+      def contexts
+        @contexts ||= {}
+      end
+
+      # Return an array of validators for a named context
+      #
+      # @return <Array> An array of validators
+      def context(name)
+        contexts[name] ||= []
+      end
+
+      # Clear all named context validators off of the resource
+      #
+      def clear!
+        contexts.clear
+      end
+
+      # Execute all validators in the named context against the target
+      #
+      # @param <Symbol> named_context the context we are validating against
+      # @param <Object> target        the resource that we are validating
+      # @return <Boolean> true if all are valid, otherwise false
+      def execute(named_context, target)
+        raise(ArgumentError, 'invalid context specified') if !named_context || (contexts.length > 0 && !contexts[named_context])
+        target.errors.clear!
+        result = true
+        context(named_context).each do |validator|
+          next unless validator.execute?(target)
+          result = false unless validator.call(target)
+        end
+
+        result
+      end
+
+    end # module ContextualValidators
+  end # module Validation
+end # module CouchRest

data/lib/couchrest/validation/validation_errors.rb

@@ -0,0 +1,125 @@
+# 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 ValidationErrors
+
+      include Enumerable
+
+      @@default_error_messages = {
+        :absent => '%s must be absent',
+        :inclusion => '%s must be one of [%s]',
+        :invalid => '%s has an invalid format',
+        :confirmation => '%s does not match the confirmation',
+        :accepted  => "%s is not accepted",
+        :nil => '%s must not be nil',
+        :blank => '%s must not be blank',
+        :length_between => '%s must be between %s and %s characters long',
+        :too_long => '%s must be less than %s characters long',
+        :too_short => '%s must be more than %s characters long',
+        :wrong_length => '%s must be %s characters long',
+        :taken => '%s is already taken',
+        :not_a_number => '%s must be a number',
+        :not_an_integer => '%s must be an integer',
+        :greater_than => '%s must be greater than %s',
+        :greater_than_or_equal_to => "%s must be greater than or equal to %s",
+        :equal_to => "%s must be equal to %s",
+        :less_than => '%s must be less than %s',
+        :less_than_or_equal_to => "%s must be less than or equal to %s",
+        :value_between => '%s must be between %s and %s',
+        :primitive => '%s must be of type %s'
+      }
+
+      # Holds a hash with all the default error messages that can be replaced by your own copy or localizations.
+      cattr_writer :default_error_messages
+
+      def self.default_error_message(key, field, *values)
+        field = field.to_s.humanize
+        @@default_error_messages[key] % [field, *values].flatten
+      end
+
+      # Clear existing validation errors.
+      def clear!
+        errors.clear
+      end
+
+      # Add a validation error. Use the field_name :general if the errors does
+      # not apply to a specific field of the Resource.
+      #
+      # @param <Symbol> field_name the name of the field that caused the error
+      # @param <String> message    the message to add
+      def add(field_name, message)
+        (errors[field_name.to_sym] ||= []) << message
+      end
+
+      # Collect all errors into a single list.
+      def full_messages
+        errors.inject([]) do |list, pair|
+          list += pair.last
+        end
+      end
+
+      # Return validation errors for a particular field_name.
+      #
+      # @param <Symbol> field_name the name of the field you want an error for
+      def on(field_name)
+        errors_for_field = errors[field_name.to_sym]
+        errors_for_field.blank? ? nil : errors_for_field
+      end
+
+      def each
+        errors.map.each do |k, v|
+          next if v.blank?
+          yield(v)
+        end
+      end
+
+      def empty?
+        entries.empty?
+      end
+
+      # Return size of errors hash
+      #
+      # Allows us to play nicely with Rails' helpers
+      def count
+        errors.size
+      end
+
+      def method_missing(meth, *args, &block)
+        errors.send(meth, *args, &block)
+      end
+
+      private
+      def errors
+        @errors ||= {}
+      end
+
+    end # class ValidationErrors
+  end # module Validation
+end # module CouchRest

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

@@ -0,0 +1,74 @@
+# 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
+    class AbsentFieldValidator < GenericValidator
+
+      def initialize(field_name, options={})
+        super
+        @field_name, @options = field_name, options
+      end
+
+      def call(target)
+        value = target.send(field_name)
+        return true if (value.nil? || (value.respond_to?(:empty?) && value.empty?))
+
+        error_message = @options[:message] || ValidationErrors.default_error_message(:absent, field_name)
+        add_error(target, error_message, field_name)
+
+        return false
+      end
+    end # class AbsentFieldValidator
+
+    module ValidatesAbsent
+
+      ##
+      #
+      # @example [Usage]
+      #
+      #   class Page
+      #
+      #     property :unwanted_attribute, String
+      #     property :another_unwanted, String
+      #     property :yet_again, String
+      #
+      #     validates_absent :unwanted_attribute
+      #     validates_absent :another_unwanted, :yet_again
+      #
+      #     # a call to valid? will return false unless
+      #     # all three attributes are blank
+      #   end
+      #
+      def validates_absent(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, CouchRest::Validation::AbsentFieldValidator)
+      end
+
+    end # module ValidatesAbsent
+  end # module Validation
+end # module CouchRest

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

@@ -0,0 +1,107 @@
+# 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 ConfirmationValidator < GenericValidator
+
+      def initialize(field_name, options = {})
+        super
+        @options = options
+        @field_name, @confirm_field_name = field_name, (options[:confirm] || "#{field_name}_confirmation").to_sym
+        @options[:allow_nil] = true unless @options.has_key?(:allow_nil)
+      end
+
+      def call(target)
+        unless valid?(target)
+          error_message = @options[:message] || ValidationErrors.default_error_message(:confirmation, field_name)
+          add_error(target, error_message, field_name)
+          return false
+        end
+
+        return true
+      end
+
+      def valid?(target)
+        field_value = target.send(field_name)
+        return true if @options[:allow_nil] && field_value.nil?
+        return false if !@options[:allow_nil] && field_value.nil?
+
+        confirm_value = target.instance_variable_get("@#{@confirm_field_name}")
+        field_value == confirm_value
+      end
+
+    end # class ConfirmationValidator
+
+    module ValidatesIsConfirmed
+
+      ##
+      # Validates that the given attribute is confirmed by another attribute.
+      # A common use case scenario is when you require a user to confirm their
+      # password, for which you use both password and password_confirmation
+      # attributes.
+      #
+      # @option :allow_nil<Boolean> true/false (default is true)
+      # @option :confirm<Symbol>    the attribute that you want to validate
+      #                             against (default is firstattr_confirmation)
+      #
+      # @example [Usage]
+      #
+      #   class Page < Hash
+      #     include CouchRest::ExtendedModel
+      #     include CouchRest::Validations
+      #
+      #     property :password, String
+      #     property :email, String
+      #     attr_accessor :password_confirmation
+      #     attr_accessor :email_repeated
+      #
+      #     validates_confirmation_of :password
+      #     validates_confirmation_of :email, :confirm => :email_repeated
+      #
+      #     # a call to valid? will return false unless:
+      #     # password == password_confirmation
+      #     # and
+      #     # email == email_repeated
+      #
+      def validates_confirmation_of(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, CouchRest::Validation::ConfirmationValidator)
+      end
+      
+      def validates_is_confirmed(*fields)
+        warn "[DEPRECATION] `validates_is_confirmed` is deprecated.  Please use `validates_confirmation_of` instead."
+        validates_confirmation_of(*fields)
+      end
+      
+      
+      
+
+    end # module ValidatesIsConfirmed
+  end # module Validation
+end # module CouchRest

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

@@ -0,0 +1,122 @@
+# 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.
+
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path + 'formats/email'
+require Pathname(__FILE__).dirname.expand_path + 'formats/url'
+
+module CouchRest
+  module Validation
+
+    ##
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class FormatValidator < GenericValidator
+
+      FORMATS = {}
+      include CouchRest::Validation::Format::Email
+      include CouchRest::Validation::Format::Url
+
+      def initialize(field_name, options = {}, &b)
+        super(field_name, options)
+        @field_name, @options = field_name, options
+        @options[:allow_nil] = false unless @options.has_key?(:allow_nil)
+      end
+
+      def call(target)
+        value = target.validation_property_value(field_name)
+        return true if @options[:allow_nil] && value.nil?
+
+        validation = @options[:as] || @options[:with]
+
+        raise "No such predefined format '#{validation}'" if validation.is_a?(Symbol) && !FORMATS.has_key?(validation)
+        validator = validation.is_a?(Symbol) ? FORMATS[validation][0] : validation
+
+        valid = case validator
+          when Proc   then validator.call(value)
+          when Regexp then value =~ validator
+          else
+            raise UnknownValidationFormat, "Can't determine how to validate #{target.class}##{field_name} with #{validator.inspect}"
+        end
+
+        return true if valid
+
+        error_message = @options[:message] || ValidationErrors.default_error_message(:invalid, field_name)
+
+        field = field_name.to_s.humanize
+        error_message = error_message.call(field, value) if error_message.respond_to?(:call)
+
+        add_error(target, error_message, field_name)
+
+        false
+      end
+
+      #class UnknownValidationFormat < StandardError; end
+
+    end # class FormatValidator
+
+    module ValidatesFormat
+
+      ##
+      # Validates that the attribute is in the specified format. You may use the
+      # :as (or :with, it's an alias) option to specify the pre-defined format
+      # that you want to validate against. You may also specify your own format
+      # via a Proc or Regexp passed to the the :as or :with options.
+      #
+      # @option :allow_nil<Boolean>         true/false (default is true)
+      # @option :as<Format, Proc, Regexp>   the pre-defined format, Proc or Regexp to validate against
+      # @option :with<Format, Proc, Regexp> an alias for :as
+      #
+      # @details [Pre-defined Formats]
+      #   :email_address (format is specified in DataMapper::Validation::Format::Email)
+      #   :url (format is specified in DataMapper::Validation::Format::Url)
+      #
+      # @example [Usage]
+      #
+      #   class Page
+      #
+      #     property :email, String
+      #     property :zip_code, String
+      #
+      #     validates_format_of :email, :as => :email_address
+      #     validates_format_of :zip_code, :with => /^\d{5}$/
+      #
+      #     # a call to valid? will return false unless:
+      #     # email is formatted like an email address
+      #     # and
+      #     # zip_code is a string of 5 digits
+      #
+      def validates_format_of(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, CouchRest::Validation::FormatValidator)
+      end
+      
+      def validates_format(*fields)
+        warn "[DEPRECATION] `validates_format` is deprecated.  Please use `validates_format_of` instead."
+        validates_format_of(*fields)
+      end
+
+    end # module ValidatesFormat
+  end # module Validation
+end # module CouchRest