Properly Moving Validation into Models

When you first start to learn Rails, you read about Model Validation, which consists of statements such as “validates_numericality_of :the_field”.  This prevents non-conforming models from being saved.  Properly leveraged, these help ensure business constraints with an iron fist (excepting validation override).

Where to Best Enforce Business Constraints

Web apps constantly process form inputs and do the following:

  1. Ensure inputs conform to business constraints (e.g., is the value only 1 to 60)
  2. Give the user feedback on non-conforming inputs to allow changes.

This validation is typically done at one of the following three levels:

  1. Controllers.  This is the last place validation should be done, but it is often the most tempting.  Keep controllers as lean as possible and place business logic in models to conform to MVC.  If your system exposes an API, controller business logic will be missed or duplicated.
  2. Method within Model.  This is an improvement.  Controllers can invoke this method to ensure business constraints prior to the models being saved.  Furthermore, the logic remains in the model.   However, if the controller forgets to invoke this method, then the logic is missed.
  3. Model Validation Statement or Validation Method. This is the most iron-clad way to enforce system constraints.  If they do not conform, they simply cannot be saved (unless you use the Rails option to ignore validation, of course).

In addition, the testing of the model business logic can be handled in the unit as opposed to functional tests.

Potential Problems

When first moving existing validation logic into the third option, you should expect to spend some time updating previously less strict test data.

Sometimes you will run into problems with what I call phantom models, as follows:

  1. In response to multi-step user input, a blank phantom model instance is first created.
  2. After all appropriate inputs are received, this phantom model is updated.
  3. You later add validation(s) to the model.
  4. Step 1 no longer works because a blank model does not conform to the new validation.
  5. Thus, you need to either refactor, remove the validations, or add the blank model without validation being enforced (with the risks of invalid data in the database).

The control Rails gives you over generated error messages using declarations is also not ideal.  Consider the following for a field named minutes_running:

:message => “must be a whole number between 0 and 60”

This will generate the following message:

“Minutes Running must be a whole number between 0 and 60”

Want a different message that does not begin with the database field name?  I would love to know how.

Declarative Constraints

What I like best about doing this at the model level is the declarative approach.  You simply declare the constraints, which is simpler, faster than coding, and clearer later on to you and others.  If not powerful enough, you can also write validation methods and declare them as being part of model validation.

One mistake I made was not realizing how flexible and configurable these declarative statements are.  The following (trimmed) sample from a single model ends this article:

validates_presence_of :user_name
validates_presence_of :run_count,
    :if => :can_process, # boolean entity in model, could also use boolean method
    :message => "must be specified if this can be processed"
validates_numericality_of :minutes_exercising,
    :greater_than => -1,
    :less_than => 61,
    :only_integer => true, # no floating points allowed!
    :message => "must be a whole number between 0 and 60"
validate :some_method_with_complex_validation?
Advertisements

One thought on “Properly Moving Validation into Models

  1. Additionally, I just made a change that required validation in a new area of the UI. Because it was already built into the model, no additional changes were required on my part.

    Reply

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s