Module: CouchFoo::Validations

Defined in:
lib/couch_foo/validations.rb

Overview

Couch Foo implement validation by overwriting Base#validate (or the variations, validate_on_create and validate_on_update). Each of these methods can inspect the state of the object, which usually means ensuring that a number of attributes have a certain value (such as not empty, within a given range, matching a certain regular expression).

Example:

class Person < CouchFoo::Base
  protected
    def validate
      errors.add_on_empty %w( first_name last_name )
      errors.add("phone_number", "has invalid format") unless phone_number =~ /[0-9]*/
    end

    def validate_on_create # is only run the first time a new object is saved
      unless valid_discount?(membership_discount)
        errors.add("membership_discount", "has expired")
      end
    end

    def validate_on_update
      errors.add_to_base("No changes have occurred") if unchanged_attributes?
    end
end

person = Person.new("first_name" => "David", "phone_number" => "what?")
person.save                         # => false (and doesn't do the save)
person.errors.empty?                # => false
person.errors.count                 # => 2
person.errors.on "last_name"        # => "can't be empty"
person.errors.on "phone_number"     # => "has invalid format"
person.errors.each_full { |msg| puts msg }
                                    # => "Last name can't be empty\n" +
                                         "Phone number has invalid format"

person.attributes = { "last_name" => "Heinemeier", "phone_number" => "555-555" }
person.save # => true (and person is now saved in the database)

An Errors object is automatically created for every Couch Foo.

Please do have a look at CouchFoo::Validations::ClassMethods for a higher level of validations.

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

VALIDATIONS = 
%w( validate validate_on_create validate_on_update )

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/couch_foo/validations.rb', line 275

def self.included(base) # :nodoc:
  base.extend ClassMethods
  base.class_eval do
    alias_method_chain :save, :validation
    alias_method_chain :save!, :validation
    alias_method_chain :update_attribute, :validation_skipping
  end

  base.send :include, ActiveSupport::Callbacks
  base.define_callbacks *VALIDATIONS
end

Instance Method Details

#errors ⇒ Object

Returns the Errors object that holds all information about attribute error messages.



910
911
912
 
# File 'lib/couch_foo/validations.rb', line 910

def errors
  @errors ||= Errors.new(self)
end

#save_with_validation(perform_validation = true) ⇒ Object

The validation process on save can be skipped by passing false. The regular Base#save method is replaced with this when the validations module is mixed in, which it is by default.



865
866
867
868
869
870
871
 
# File 'lib/couch_foo/validations.rb', line 865

def save_with_validation(perform_validation = true)
  if perform_validation && valid? || !perform_validation
    save_without_validation()
  else
    false
  end
end

#save_with_validation! ⇒ Object

Attempts to save the record just like Base#save but will raise a RecordInvalid exception instead of returning false if the record is not valid.



875
876
877
878
879
880
881
 
# File 'lib/couch_foo/validations.rb', line 875

def save_with_validation!()
  if valid?
    save_without_validation!()
  else
    raise RecordInvalid.new(self)
  end
end

#update_attribute_with_validation_skipping(name, value) ⇒ Object

Updates a single attribute and saves the record without going through the normal validation procedure. This is especially useful for boolean flags on existing records. The regular update_attribute method in Base is replaced with this when the validations module is mixed in, which it is by default.



886
887
888
889
 
# File 'lib/couch_foo/validations.rb', line 886

def update_attribute_with_validation_skipping(name, value)
  send(name.to_s + '=', value)
  save(false)
end

#valid? ⇒ Boolean

Runs validate and validate_on_create or validate_on_update and returns true if no errors were added otherwise false.

Returns:



892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/couch_foo/validations.rb', line 892

def valid?
  errors.clear

  run_callbacks(:validate)
  validate

  if new_record?
    run_callbacks(:validate_on_create)
    validate_on_create
  else
    run_callbacks(:validate_on_update)
    validate_on_update
  end

  errors.empty?
end