dm-validations 0.9.2

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

@@ -0,0 +1,40 @@
+module DataMapper
+  module Validate
+    module Format
+      module Email
+
+        def self.included(base)
+          DataMapper::Validate::FormatValidator::FORMATS.merge!(
+            :email_address => [ EmailAddress, lambda { |field, value| '%s is not a valid email address'.t(value) }]
+          )
+        end
+
+        EmailAddress = begin
+            alpha = "a-zA-Z"
+            digit = "0-9"
+            atext = "[#{alpha}#{digit}\!\#\$\%\&\'\*+\/\=\?\^\_\`\{\|\}\~\-]"
+            dot_atom_text = "#{atext}+([.]#{atext}*)*"
+            dot_atom = "#{dot_atom_text}"
+            qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]'
+            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})"
+            no_ws_ctl = "\\x01-\\x08\\x11\\x12\\x14-\\x1f\\x7f"
+            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 = /^#{addr_spec}$/
+        end
+
+      end # module Email
+    end # module Format
+  end # module Validate
+end # module DataMapper

data/lib/dm-validations/generic_validator.rb

@@ -0,0 +1,92 @@
+module DataMapper
+  module Validate
+
+    # All validators extend this base class. Validators must:
+    #
+    # * Implement the initialize method to capture its parameters, also calling
+    #   super to have this parent class capture the optional, general :if and
+    #   :unless parameters.
+    # * Implement the call method, returning true or false. The call method
+    #   provides the validation logic.
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class GenericValidator
+
+      attr_accessor :if_clause
+      attr_accessor :unless_clause
+
+      # Construct a validator. Capture the :if and :unless clauses when present.
+      #
+      # @param field<String, Symbol> The property specified for validation
+      #
+      # @option :if<Symbol, Proc>   The name of a method or a Proc to call to
+      #                     determine if the validation should occur.
+      # @option :unless<Symbol, Proc> The name of a method or a Proc to call to
+      #                         determine if the validation should not occur
+      # All additional key/value pairs are passed through to the validator
+      # that is sub-classing this GenericValidator
+      #
+      def initialize(field, opts = {})
+        @if_clause = opts.has_key?(:if) ? opts[:if] : nil
+        @unless_clause = opts.has_key?(:unless) ? opts[:unless] : nil
+      end
+
+      # Add an error message to a target resource. If the error corresponds to a
+      # specific field of the resource, add it to that field, otherwise add it
+      # as a :general message.
+      #
+      # @param <Object> target the resource that has the error
+      # @param <String> message the message to add
+      # @param <Symbol> field_name the name of the field that caused the error
+      #
+      # TODO - should the field_name for a general message be :default???
+      #
+      def add_error(target, message, field_name = :general)
+        target.errors.add(field_name,message)
+      end
+
+      # Call the validator. "call" is used so the operation is BoundMethod and
+      # Block compatible. This must be implemented in all concrete classes.
+      #
+      # @param <Object> target  the resource that the validator must be called
+      #                         against
+      # @return <Boolean> true if valid, otherwise false
+      def call(target)
+        raise "DataMapper::Validate::GenericValidator::call must be overriden in #{self.class.to_s}"
+      end
+
+      def field_name
+        @field_name
+      end
+
+      # Determines if this validator should be run against the
+      # target by evaluating the :if and :unless clauses
+      # optionally passed while specifying any validator.
+      #
+      # @param <Object> target the resource that we check against
+      # @return <Boolean> true if should be run, otherwise false
+      def execute?(target)
+        return true if self.if_clause.nil? && self.unless_clause.nil?
+
+        if self.unless_clause
+          if self.unless_clause.is_a?(Symbol)
+            return false if target.send(self.unless_clause)
+          elsif self.unless_clause.respond_to?(:call)
+            return false if self.unless_clause.call(target)
+          end
+        end
+
+        if self.if_clause
+          if self.if_clause.is_a?(Symbol)
+            return target.send(self.if_clause)
+          elsif self.if_clause.respond_to?(:call)
+            return self.if_clause.call(target)
+          end
+        end
+        return true
+      end
+
+    end # class GenericValidator
+  end # module Validate
+end # module DataMapper

data/lib/dm-validations/length_validator.rb

@@ -0,0 +1,113 @@
+module DataMapper
+  module Validate
+
+    ##
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class LengthValidator < GenericValidator
+
+      def initialize(field_name, options)
+        super
+        @field_name = field_name
+        @options = options
+
+        @min = options[:minimum] || options[:min]
+        @max = options[:maximum] || options[:max]
+        @equal = options[:is] || options[:equals]
+        @range = options[:within] || options[:in]
+
+        @validation_method ||= :range if @range
+        @validation_method ||= :min if @min && @max.nil?
+        @validation_method ||= :max if @max && @min.nil?
+        @validation_method ||= :equals unless @equal.nil?
+      end
+
+      def call(target)
+        field_value = target.validation_property_value(@field_name)
+        return true if @options[:allow_nil] && field_value.nil?
+
+        field_value = '' if field_value.nil?
+
+        # XXX: HACK seems hacky to do this on every validation, probably should
+        #      do this elsewhere?
+        field = Extlib::Inflection.humanize(@field_name)
+        min = @range ? @range.min : @min
+        max = @range ? @range.max : @max
+        equal = @equal
+
+        case @validation_method
+        when :range then
+          unless valid = @range.include?(field_value.size)
+            error_message = '%s must be between %s and %s characters long'.t(field, min, max)
+          end
+        when :min then
+          unless valid = field_value.size >= min
+            error_message = '%s must be more than %s characters long'.t(field, min)
+          end
+        when :max then
+          unless valid = field_value.size <= max
+            error_message = '%s must be less than %s characters long'.t(field, max)
+          end
+        when :equals then
+          unless valid = field_value.size == equal
+            error_message = '%s must be %s characters long'.t(field, equal)
+          end
+        end
+
+        error_message ||= @options[:message]
+
+        add_error(target, error_message, @field_name) unless valid
+
+        return valid
+      end
+
+    end # class LengthValidator
+
+    module ValidatesLength
+
+      # Validates that the length of the attribute is equal to, less than,
+      # greater than or within a certain range (depending upon the options
+      # you specify).
+      #
+      # @option :allow_nil<Boolean> true/false (default is true)
+      # @option :minimum    ensures that the attribute's length is greater than
+      #   or equal to the supplied value
+      # @option :min        alias for :minimum
+      # @option :maximum    ensures the attribute's length is less than or equal
+      #   to the supplied value
+      # @option :max        alias for :maximum
+      # @option :equals     ensures the attribute's length is equal to the
+      #   supplied value
+      # @option :is         alias for :equals
+      # @option :in<Range>  given a Range, ensures that the attributes length is
+      #   include?'ed in the Range
+      # @option :within<Range>  alias for :in
+      #
+      # @example [Usage]
+      #   require 'dm-validations'
+      #
+      #   class Page
+      #     include DataMapper::Resource
+      #
+      #     property high, Integer
+      #     property low, Integer
+      #     property just_right, Integer
+      #
+      #     validates_length :high, :min => 100000000000
+      #     validates_length :low, :equals => 0
+      #     validates_length :just_right, :within => 1..10
+      #
+      #     # a call to valid? will return false unless:
+      #     # high is greater than or equal to 100000000000
+      #     # low is equal to 0
+      #     # just_right is between 1 and 10 (inclusive of both 1 and 10)
+      #
+      def validates_length(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, DataMapper::Validate::LengthValidator)
+      end
+
+    end # module ValidatesLength
+  end # module Validate
+end # module DataMapper

data/lib/dm-validations/method_validator.rb

@@ -0,0 +1,58 @@
+module DataMapper
+  module Validate
+
+    ##
+    #
+    # @author Guy van den Berg
+    # @since  0.9
+    class MethodValidator < GenericValidator
+
+      def initialize(method_name, options={})
+        super
+        @method_name, @options = method_name, options
+        @options[:integer_only] = false unless @options.has_key?(:integer_only)
+      end
+
+      def call(target)
+        result,message = target.send(@method_name)
+        add_error(target,message,@method_name) if !result
+        result
+      end
+    end # class MethodValidator
+
+    module ValidatesWithMethod
+
+      ##
+      # Validate using the given method. The method given needs to return:
+      # [result::<Boolean>, Error Message::<String>]
+      #
+      # @example [Usage]
+      #   require 'dm-validations'
+      #
+      #   class Page
+      #     include DataMapper::Resource
+      #
+      #     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"
+      #
+      def validates_with_method(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, DataMapper::Validate::MethodValidator)
+      end
+
+    end # module ValidatesWithMethod
+  end # module Validate
+end # module DataMapper

data/lib/dm-validations/numeric_validator.rb

@@ -0,0 +1,66 @@
+module DataMapper
+  module Validate
+
+    ##
+    #
+    # @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 = 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 ||= '%s must be an integer'.t(Extlib::Inflection.humanize(@field_name))
+        else
+          # FIXME: if precision and scale are not specified, can we assume that it is an integer?
+          if precision && scale
+            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
+          else
+            return true if value =~ /\A[+-]?(?:\d+|\d*\.\d+)\z/
+          end
+          error_message ||= '%s must be a number'.t(Extlib::Inflection.humanize(@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_is_number(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, DataMapper::Validate::NumericValidator)
+      end
+
+    end # module ValidatesIsNumber
+  end # module Validate
+end # module DataMapper

data/lib/dm-validations/primitive_validator.rb

@@ -0,0 +1,60 @@
+module DataMapper
+  module Validate
+
+    ##
+    #
+    # @author Dirkjan Bussink
+    # @since  0.9
+    class PrimitiveValidator < 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)
+        return true if value.nil? || value.kind_of?(property.primitive)
+
+        error_message = @options[:message] || default_error(property)
+        add_error(target, error_message, @field_name)
+
+        false
+      end
+
+      protected
+
+      def default_error(property)
+        "%s must be of type #{property.primitive.to_s}".t(Extlib::Inflection.humanize(@field_name))
+      end
+
+    end # class PrimitiveValidator
+
+    module ValidatesIsPrimitive
+
+      ##
+      # Validates that the specified attribute is of the correct primitive type.
+      #
+      # @example [Usage]
+      #   require 'dm-validations'
+      #
+      #   class Person
+      #     include DataMapper::Resource
+      #
+      #     property :birth_date, Date
+      #
+      #     validates_is_primitive :birth_date
+      #
+      #     # a call to valid? will return false unless
+      #     # the birth_date is something that can be properly
+      #     # casted into a Date object.
+      #   end
+      def validates_is_primitive(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, DataMapper::Validate::PrimitiveValidator)
+      end
+
+    end # module ValidatesPresent
+  end # module Validate
+end # module DataMapper

data/lib/dm-validations/required_field_validator.rb

@@ -0,0 +1,88 @@
+module DataMapper
+  module Validate
+
+    ##
+    #
+    # @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)
+        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"
+        "%s must not be #{actual}".t(Extlib::Inflection.humanize(@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.primitive == TrueClass : 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]
+      #   require 'dm-validations'
+      #
+      #   class Page
+      #     include DataMapper::Resource
+      #
+      #     property :required_attribute, String
+      #     property :another_required, String
+      #     property :yet_again, String
+      #
+      #     validates_present :required_attribute
+      #     validates_present :another_required, :yet_again
+      #
+      #     # a call to valid? will return false unless
+      #     # all three attributes are !blank?
+      #   end
+      def validates_present(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, DataMapper::Validate::RequiredFieldValidator)
+      end
+
+    end # module ValidatesPresent
+  end # module Validate
+end # module DataMapper