dm-validations 1.1.0 → 1.2.0.rc1

data/lib/dm-validations/formats/email.rb

@@ -7,7 +7,12 @@ module DataMapper
 
         def self.included(base)
           DataMapper::Validations::FormatValidator::FORMATS.merge!(
-            :email_address => [ EmailAddress, lambda { |field, value| '%s is not a valid email address'.t(value) }]
+            :email_address => [
+              EmailAddress,
+              lambda { |field, value|
+                '%s is not a valid email address'.t(value)
+              }
+            ]
           )
         end
 
@@ -17,28 +22,41 @@ module DataMapper
         # 99% of the time you do not want to allow these email addresses
         # in a public web application.
         EmailAddress = begin
-            alpha = "a-zA-Z\\p{Lu}\\p{Ll}" # Alpha characters, changed from RFC2822 to include unicode chars
-            digit = "0-9"
-            atext = "[#{alpha}#{digit}\!\#\$\%\&\'\*+\/\=\?\^\_\`\{\|\}\~\-]"
-            dot_atom_text = "#{atext}+([.]#{atext}*)+" # Last char changed from * to +
-            dot_atom = "#{dot_atom_text}"
-            no_ws_ctl = "\\x01-\\x08\\x11\\x12\\x14-\\x1f\\x7f"
-            qtext = "[^#{no_ws_ctl}\\x0d\\x22\\x5c]" # Non-whitespace, non-control character except for \ and "
-            text = "[\\x01-\\x09\\x11\\x12\\x14-\\x7f]"
-            quoted_pair = "(\\x5c#{text})"
-            qcontent = "(?:#{qtext}|#{quoted_pair})"
-            quoted_string = "[\"]#{qcontent}+[\"]"
-            atom = "#{atext}+"
-            word = "(?:#{atom}|#{quoted_string})"
-            obs_local_part = "#{word}([.]#{word})*"
-            local_part = "(?:#{dot_atom}|#{quoted_string}|#{obs_local_part})"
-            dtext = "[#{no_ws_ctl}\\x21-\\x5a\\x5e-\\x7e]"
-            dcontent = "(?:#{dtext}|#{quoted_pair})"
-            domain_literal = "\\[#{dcontent}+\\]"
-            obs_domain = "#{atom}([.]#{atom})+" # Last char changed from * to +
-            domain = "(?:#{dot_atom}|#{domain_literal}|#{obs_domain})"
-            addr_spec = "#{local_part}\@#{domain}"
-            pattern = /^#{addr_spec}$/u
+          if (RUBY_VERSION == '1.9.2' && RUBY_ENGINE == 'jruby' && JRUBY_VERSION <= '1.6.3') || RUBY_VERSION == '1.9.3'
+            # There is an obscure bug in jruby 1.6 that prevents matching
+            # on unicode properties here. Remove this logic branch once
+            # a stable jruby release fixes this.
+            #
+            # http://jira.codehaus.org/browse/JRUBY-5622
+            #
+            # There is a similar bug in preview releases of 1.9.3
+            #
+            # http://redmine.ruby-lang.org/issues/5126
+            letter = 'a-zA-Z'
+          else
+            letter = 'a-zA-Z\p{L}'  # Changed from RFC2822 to include unicode chars
+          end
+          digit          = '0-9'
+          atext          = "[#{letter}#{digit}\!\#\$\%\&\'\*+\/\=\?\^\_\`\{\|\}\~\-]"
+          dot_atom_text  = "#{atext}+([.]#{atext}*)+"
+          dot_atom       = dot_atom_text
+          no_ws_ctl      = '\x01-\x08\x11\x12\x14-\x1f\x7f'
+          qtext          = "[^#{no_ws_ctl}\\x0d\\x22\\x5c]"  # Non-whitespace, non-control character except for \ and "
+          text           = '[\x01-\x09\x11\x12\x14-\x7f]'
+          quoted_pair    = "(\\x5c#{text})"
+          qcontent       = "(?:#{qtext}|#{quoted_pair})"
+          quoted_string  = "[\"]#{qcontent}+[\"]"
+          atom           = "#{atext}+"
+          word           = "(?:#{atom}|#{quoted_string})"
+          obs_local_part = "#{word}([.]#{word})*"
+          local_part     = "(?:#{dot_atom}|#{quoted_string}|#{obs_local_part})"
+          dtext          = "[#{no_ws_ctl}\\x21-\\x5a\\x5e-\\x7e]"
+          dcontent       = "(?:#{dtext}|#{quoted_pair})"
+          domain_literal = "\\[#{dcontent}+\\]"
+          obs_domain     = "#{atom}([.]#{atom})+"
+          domain         = "(?:#{dot_atom}|#{domain_literal}|#{obs_domain})"
+          addr_spec      = "#{local_part}\@#{domain}"
+          pattern        = /\A#{addr_spec}\z/u
         end
 
       end # module Email

data/lib/dm-validations/formats/url.rb

@@ -7,7 +7,12 @@ module DataMapper
 
         def self.included(base)
           DataMapper::Validations::FormatValidator::FORMATS.merge!(
-            :url => [ Url, lambda { |field, value| '%s is not a valid URL'.t(value) }]
+            :url => [
+              Url,
+              lambda { |field, value|
+                '%s is not a valid URL'.t(value)
+              }
+            ]
           )
         end
 

data/lib/dm-validations/support/object.rb

@@ -1,4 +1,17 @@
 class Object
+  # If receiver is callable, calls it and returns result.
+  # If not, just returns receiver itself
+  #
+  # @return [Object]
+  # @api private
+  def try_call(*args)
+    if self.respond_to?(:call)
+      self.call(*args)
+    else
+      self
+    end
+  end
+
   def validatable?
     false
   end

data/lib/dm-validations/validation_errors.rb

@@ -1,7 +1,5 @@
 module DataMapper
   module Validations
-
-    ##
     #
     # @author Guy van den Berg
     # @since  0.9
@@ -56,24 +54,31 @@ module DataMapper
         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.
+      # 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 [Symbol] field_name the name of the field that caused the error
-      # @param [String] message    the message to add
+      # @param [String] message
+      #   The message to add
       def add(field_name, message)
         # see 6abe8fff in extlib, but don't enforce
         # it unless Edge version is installed
         if message.respond_to?(:try_call)
-
           # DM resource
-          message = if resource.respond_to?(:model) && resource.model.respond_to?(:properties)
-            message.try_call(resource, resource.model.properties[field_name])
-          else
-            # pure Ruby object
-            message.try_call(resource)
-          end
+          message = if (resource.respond_to?(:model) &&
+                        resource.model.respond_to?(:properties))
+                      message.try_call(
+                        resource,
+                        resource.model.properties[field_name]
+                      )
+                    else
+                      # pure Ruby object
+                      message.try_call(resource)
+                    end
         end
+
         (errors[field_name] ||= []) << message
       end
 
@@ -86,18 +91,20 @@ module DataMapper
 
       # Return validation errors for a particular field_name.
       #
-      # @param [Symbol] field_name the name of the field you want an error for
+      # @param [Symbol] field_name
+      #   The name of the field you want an error for.
+      #
       # @return [Array<DataMapper::Validations::Error>]
-      #   array of validation errors or empty array, if there are no errors on given field
+      #   Array of validation errors or empty array, if there are no errors
+      #   on given field
       def on(field_name)
         errors_for_field = errors[field_name]
         DataMapper::Ext.blank?(errors_for_field) ? nil : errors_for_field.uniq
       end
 
       def each
-        errors.map.each do |k, v|
-          next if DataMapper::Ext.blank?(v)
-          yield(v)
+        errors.each_value do |v|
+          yield(v) unless DataMapper::Ext.blank?(v)
         end
       end
 
@@ -114,12 +121,13 @@ module DataMapper
       end
 
       def [](property_name)
-        if property_errors = errors[property_name.to_sym]
+        if (property_errors = errors[property_name.to_sym])
           property_errors
         end
       end
 
       private
+
       def errors
         @errors
       end

data/lib/dm-validations/validators/absent_field_validator.rb

@@ -1,29 +1,31 @@
 module DataMapper
   module Validations
-
-    ##
     #
     # @author Guy van den Berg
     # @since  0.9
     class AbsenceValidator < GenericValidator
+
       def call(target)
         value = target.validation_property_value(field_name)
         return true if DataMapper::Ext.blank?(value)
 
-        error_message = self.options[:message] || ValidationErrors.default_error_message(:absent, field_name)
-        add_error(target, error_message, field_name)
+        error_message = (
+          self.options[:message] || ValidationErrors.default_error_message(
+            :absent, field_name
+          )
+        )
 
+        add_error(target, error_message, field_name)
         false
       end
+
     end # class AbsenceValidator
 
     module ValidatesAbsence
-
       extend Deprecate
 
-      ##
-      # Validates that the specified attribute is "blank" via the attribute's
-      # #blank? method.
+      # Validates that the specified attribute is "blank" via the
+      # attribute's #blank? method.
       #
       # @note
       #   dm-core's support lib adds the #blank? method to many classes,
@@ -47,12 +49,10 @@ module DataMapper
       #   end
       #
       def validates_absence_of(*fields)
-        opts = opts_from_validator_args(fields)
-        add_validator_to_context(opts, fields, DataMapper::Validations::AbsenceValidator)
+        validators.add(AbsenceValidator, *fields)
       end
 
       deprecate :validates_absent, :validates_absence_of
-
     end # module ValidatesAbsent
   end # module Validations
 end # module DataMapper

data/lib/dm-validations/validators/acceptance_validator.rb

@@ -1,8 +1,5 @@
 module DataMapper
   module Validations
-
-    ##
-    #
     # @author Martin Kihlgren
     # @since  0.9
     class AcceptanceValidator < GenericValidator
@@ -19,7 +16,11 @@ module DataMapper
       def call(target)
         return true if valid?(target)
 
-        error_message = @options[:message] || ValidationErrors.default_error_message(:accepted, field_name)
+        error_message = (
+          @options[:message] || ValidationErrors.default_error_message(
+            :accepted, field_name
+          )
+        )
         add_error(target, error_message, field_name)
 
         false
@@ -36,20 +37,22 @@ module DataMapper
       def allow_nil?(value)
         @options[:allow_nil] && value.nil?
       end
+
     end # class AcceptanceValidator
 
     module ValidatesAcceptance
       extend Deprecate
 
-      ##
-      # Validates that the attributes's value is in the set of accepted values.
+      # Validates that the attributes's value is in the set of accepted
+      # values.
+      #
+      # @option [Boolean] :allow_nil (true)
+      #   true if nil is allowed, false if not allowed.
       #
-      # @option :allow_nil<Boolean> true if nil is allowed, false if not
-      #                             allowed. Default is true.
-      # @option :accept<Array>      a list of accepted values.
-      #                             Default are ["1", 1, "true", true, "t"]).
+      # @option [Array] :accept (["1", 1, "true", true, "t"])
+      #   A list of accepted values.
       #
-      # @example [Usage]
+      # @example Usage
       #   require 'dm-validations'
       #
       #   class Page
@@ -66,8 +69,7 @@ module DataMapper
       #     # terms_accepted is one of ["1", 1, "true", true, "t"]
       #
       def validates_acceptance_of(*fields)
-        opts = opts_from_validator_args(fields)
-        add_validator_to_context(opts, fields, DataMapper::Validations::AcceptanceValidator)
+        validators.add(AcceptanceValidator, *fields)
       end
 
       deprecate :validates_is_accepted, :validates_acceptance_of

data/lib/dm-validations/validators/block_validator.rb

@@ -1,13 +1,8 @@
 module DataMapper
   module Validations
-
-    ##
-    #
     # @author teamon
     # @since  0.9
     module ValidatesWithBlock
-
-      ##
       # Validate using the given block. The block given needs to return:
       # [result::<Boolean>, Error Message::<String>]
       #
@@ -46,15 +41,21 @@ module DataMapper
       def validates_with_block(*fields, &block)
         @__validates_with_block_count ||= 0
         @__validates_with_block_count += 1
+
         # create method and pass it to MethodValidator
-        raise ArgumentError.new('You need to pass a block to validates_with_block method') unless block_given?
+        unless block_given?
+          raise ArgumentError, 'You need to pass a block to validates_with_block method'
+        end
+
         method_name = "__validates_with_block_#{@__validates_with_block_count}".to_sym
-        define_method(method_name, block)
-        opts = opts_from_validator_args(fields)
-        opts[:method] = method_name
-        add_validator_to_context(opts, fields.empty? ? [method_name] : fields, DataMapper::Validations::MethodValidator)
-      end
+        define_method(method_name, &block)
+
+        options = fields.last.is_a?(Hash) ? fields.last.pop.dup : {}
+        options[:method] = method_name
+        fields = [method_name] if fields.empty?
 
+        validators.add(MethodValidator, *fields + [options])
+      end
     end # module ValidatesWithMethod
   end # module Validations
 end # module DataMapper

data/lib/dm-validations/validators/confirmation_validator.rb

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 module DataMapper
   module Validations
-
-    ##
-    #
     # @author Guy van den Berg
     # @since  0.9
     class ConfirmationValidator < GenericValidator
@@ -13,13 +10,19 @@ module DataMapper
 
         set_optional_by_default
 
-        @confirm_field_name  = (options[:confirm] || "#{field_name}_confirmation").to_sym
+        @confirm_field_name = (
+          options[:confirm] || "#{field_name}_confirmation"
+        ).to_sym
       end
 
       def call(target)
         return true if valid?(target)
 
-        error_message = @options[:message] || ValidationErrors.default_error_message(:confirmation, field_name)
+        error_message = (
+          @options[:message] || ValidationErrors.default_error_message(
+            :confirmation, field_name
+          )
+        )
         add_error(target, error_message, field_name)
 
         false
@@ -38,23 +41,28 @@ module DataMapper
         confirm_value = target.instance_variable_get("@#{@confirm_field_name}")
         value == confirm_value
       end
+
     end # class ConfirmationValidator
 
     module ValidatesConfirmation
       extend Deprecate
 
       ##
-      # 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.
+      # 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 [Boolean] :allow_nil (true)
+      #   true or false.
+      #
+      # @option [Boolean] :allow_blank (true)
+      #   true or false.
       #
-      # @option :allow_nil<Boolean>   true/false (default is true)
-      # @option :allow_blank<Boolean> true/false (default is true)
-      # @option :confirm<Symbol>      the attribute that you want to validate
-      #                               against (default is firstattr_confirmation)
+      # @option [Symbol] :confirm (firstattr_confirmation)
+      #   The attribute that you want to validate against.
       #
-      # @example [Usage]
+      # @example Usage
       #   require 'dm-validations'
       #
       #   class Page
@@ -74,8 +82,7 @@ module DataMapper
       #     # email == email_repeated
       #
       def validates_confirmation_of(*fields)
-        opts = opts_from_validator_args(fields)
-        add_validator_to_context(opts, fields, DataMapper::Validations::ConfirmationValidator)
+        validators.add(ConfirmationValidator, *fields)
       end
 
       deprecate :validates_is_confirmed, :validates_confirmation_of

data/lib/dm-validations/validators/format_validator.rb

@@ -8,13 +8,12 @@ module DataMapper
   module Validations
     class UnknownValidationFormat < ::ArgumentError; end
 
-    ##
-    #
     # @author Guy van den Berg
     # @since  0.9
     class FormatValidator < GenericValidator
 
       FORMATS = {}
+
       include DataMapper::Validations::Format::Email
       include DataMapper::Validations::Format::Url
 
@@ -29,9 +28,17 @@ module DataMapper
 
         value = target.validation_property_value(field_name)
 
-        error_message = @options[:message] || ValidationErrors.default_error_message(:invalid, field_name)
-        add_error(target, error_message.try_call(humanized_field_name, value), field_name)
-
+        error_message = (
+          @options[:message] || ValidationErrors.default_error_message(
+            :invalid, field_name
+          )
+        )
+
+        add_error(
+          target,
+          error_message.try_call(humanized_field_name, value),
+          field_name
+        )
         false
       end
 
@@ -43,37 +50,54 @@ module DataMapper
 
         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
+        if validation.is_a?(Symbol) && !FORMATS.has_key?(validation)
+          raise("No such predefined format '#{validation}'")
+        end
+
+        validator = if validation.is_a?(Symbol)
+                      FORMATS[validation][0]
+                    else
+                      validation
+                    end
 
         case validator
           when Proc   then validator.call(value)
-          when Regexp then (value.kind_of?(Numeric) ? value.to_s : value) =~ validator
+          when Regexp then value ? value.to_s =~ validator : false
           else
-            raise UnknownValidationFormat, "Can't determine how to validate #{target.class}##{field_name} with #{validator.inspect}"
+            raise(UnknownValidationFormat, "Can't determine how to validate #{target.class}##{field_name} with #{validator.inspect}")
         end
+      rescue Encoding::CompatibilityError
+        # This is to work around a bug in jruby - see formats/email.rb
+        false
       end
-    end # class FormatValidator
 
+    end # class FormatValidator
 
     module ValidatesFormat
       extend Deprecate
 
-      ##
-      # 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.
+      # 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 [Boolean] :allow_nil (true)
+      #   true or false.
+      #
+      # @option [Boolean] :allow_blank (true)
+      #   true or false.
       #
-      # @option :allow_nil<Boolean>         true/false (default is true)
-      # @option :allow_blank<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
+      # @option [Format, Proc, Regexp] :as
+      #   The pre-defined format, Proc or Regexp to validate against.
+      #
+      # @option [Format, Proc, Regexp] :with
+      #   An alias for :as.
       #
       #   :email_address (format is specified in DataMapper::Validations::Format::Email - note that unicode emails will *not* be matched under MRI1.8.7)
       #   :url (format is specified in DataMapper::Validations::Format::Url)
       #
-      # @example [Usage]
+      # @example Usage
       #   require 'dm-validations'
       #
       #   class Page
@@ -91,12 +115,10 @@ module DataMapper
       #     # 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, DataMapper::Validations::FormatValidator)
+        validators.add(FormatValidator, *fields)
       end
 
       deprecate :validates_format, :validates_format_of
-
     end # module ValidatesFormat
   end # module Validations
 end # module DataMapper