The categories of validations

… and check why 5600+ Rails engineers read also this

The categories of validations

There are many reasons why rails changed the landscape of web development when it was released. I think one of the aspects was how easy it was to communicate mistakes (errors) to the user. Validations is a very nice convention for CRUD applications. Over time however, many of our active record objects tend to grow in terms of validations. I think they fit at least into a few categories (probably more).

  • trivial validations
    • “is this field empty?”
    • trivial doesn’t mean not important (we still need them)
  • domain validations
    • “is this product available in inventory”
    • “does this coupon code apply in this situation”
  • security validation
    • “is this user allowed to do it”
    • “is the data not crafted in wrong way”
    • “do all associated children belong to the same user as parent record”
  • use-case based
    • “is this facebook user registering and does she/he have this attribute present”
  • aggregate internal state
    • “is this Order without empty OrderLines”
    • “does the order transaction amount equal amount from sum of order lines”

So it’s not uncommon to have half a dozen unrelated validations in an active record class. And they sometimes lack cohesion when you look at them together. To achieve better clarity and modularity in the application it might be good to start moving them to separate places.

Maybe the trivial validations are better suited in form objects in your case? Maybe domain checks should be moved into Service objects because our Order class shouldn’t know and access the Inventory related data? Maybe security validations don’t need to be validations at all? If security constraint is violated raising an exception could be better. Polite users won’t see this validation ever anyway. Why be nice to hackers and display them a nice validation message?

Use-case based verifications? Maybe they belong to that one usecase (service object) only and the rest of the app doesn’t need to know about it. The point being…

Once you find yourself in a situation where your object is coupled with many validations, especially such that are crossing multiple boundaries and verifying things from completely other parts of the system, you might wanna decouple it a little bit. Make it lighter. Move the validations into other places where they fit better. Validations are often big bag of things that we need to check before we let the user proceed further. It’s worth to think from time to time how to organize this bag. Maybe into a nice rucksack?

That’s why Fearless Refactoring: Rails Controllers 1.1 release includes 2 practical and 2 theoretical chapters that will help you get started.

  • Extract conditional validation into Service Object
  • Extract a form object
  • Validations: Contexts
  • Validations: Objectify

Happy refactoring

Robert Pankowecki & Andrzej Krzywda

You might also like