Format validation in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is format validation in Rails?

Format validation checks if a model attribute matches a specific pattern, usually using regular expressions, to ensure data is in the correct form.

beginner

How do you add a format validation to a Rails model attribute?

Use validates :attribute, format: { with: /regex/, message: 'error message' } inside the model to enforce a pattern.

beginner

Why use format validation instead of just presence validation?

Presence validation only checks if a value exists, but format validation ensures the value follows a specific pattern, like an email or phone number format.

intermediate

Example: Validate an email format in a Rails model.

Use validates :email, format: { with: URI::MailTo::EMAIL_REGEXP, message: 'must be a valid email' } to check email format.

beginner

What happens if a format validation fails when saving a Rails model?

The model will not save, and the error message defined in the validation will be added to the model's errors, which can be shown to the user.

Which method is used to add format validation in a Rails model?

A validate_format_of :attribute

B check_format :attribute, regex

C validates :attribute, format: { with: /regex/ }

D format_validation :attribute

The correct syntax is validates :attribute, format: { with: /regex/ }.

What does the with option specify in format validation?

A The error message to show

B The regular expression pattern to match

C The attribute name

D The validation context

The with option defines the regex pattern the attribute must match.

If a format validation fails, what happens when you try to save the model?

A The model does not save and adds errors

B The model saves without validation

C The model saves but logs a warning

D The model saves and ignores the format

The model will not save and will add error messages for the failed validations.

Which built-in regex can you use to validate emails in Rails?

A /\A[^@]+@[^@]+\z/

B EMAIL_VALIDATOR

C /email_regex/

D URI::MailTo::EMAIL_REGEXP

Rails provides URI::MailTo::EMAIL_REGEXP as a standard email regex.

Can format validation be used to check phone number patterns?

A Yes, by providing a suitable regex

B No, only emails are supported

C Only numeric validations are allowed

D Format validation is not for phone numbers

Format validation works with any regex pattern, including phone numbers.

Explain how to add a format validation to a Rails model attribute and why it is useful.

Think about how you tell Rails to check a pattern for an attribute.

Describe what happens when a format validation fails during model saving in Rails.

Consider the flow of validation and saving.

Practice

1. What is the main purpose of format validation in Rails models?

easy

A. To ensure data matches a specific pattern using regular expressions

B. To check if a field is present and not empty

C. To verify numerical values are within a range

D. To automatically format dates for display

Solution

1. Step 1: Understand format validation role

   Format validation uses regular expressions to check if data fits a pattern.

2. Step 2: Compare with other validations

   Presence validation checks if data exists, numericality checks numbers, and formatting dates is unrelated.

3. Final Answer:

   To ensure data matches a specific pattern using regular expressions -> Option A

4. Quick Check:

   Format validation = pattern check [OK]

Hint: Format validation = pattern matching with regex [OK]

Common Mistakes:

• Confusing format validation with presence validation
• Thinking format validation changes data format
• Mixing format validation with numerical range checks

2. Which of the following is the correct syntax to validate an email format in a Rails model?

easy

A. validates_format_of :email, with: /\A[^@\s]+@[^@\s]+\z/

B. validate :email, format: /\A[^@\s]+@[^@\s]+\z/

C. validates :email, format: { with: /\A[^@\s]+@[^@\s]+\z/ }

D. validates :email, regex: /\A[^@\s]+@[^@\s]+\z/

Solution

1. Step 1: Identify correct validation method

   Rails uses validates with format: { with: REGEX } syntax for format validation.

2. Step 2: Check syntax correctness

   validates :email, format: { with: /\A[^@\s]+@[^@\s]+\z/ } correctly uses validates :email, format: { with: /regex/ }. validate :email, format: /\A[^@\s]+@[^@\s]+\z/ uses wrong method validate. validates_format_of :email, with: /\A[^@\s]+@[^@\s]+\z/ uses deprecated validates_format_of. validates :email, regex: /\A[^@\s]+@[^@\s]+\z/ uses invalid key regex.

3. Final Answer:

   validates :email, format: { with: /\A[^@\s]+@[^@\s]+\z/ } -> Option C

4. Quick Check:

   Correct syntax = validates :email, format: { with: /\A[^@\s]+@[^@\s]+\z/ } [OK]

Hint: Use validates with format: { with: regex } [OK]

Common Mistakes:

• Using validate instead of validates
• Using invalid keys like regex instead of format
• Using deprecated validates_format_of method

3. Given this model validation:

validates :username, format: { with: /\A[a-z0-9_]+\z/, message: "only allows lowercase letters, numbers, and underscores" }

What happens if you try to save username = "User123"?

medium

A. The record saves successfully

B. The record fails to save with a format error

C. The record saves but the username is changed to lowercase

D. A syntax error occurs

Solution

1. Step 1: Analyze the regex pattern

   The regex /\A[a-z0-9_]+\z/ allows only lowercase letters, digits, and underscores from start to end.

2. Step 2: Check the input against the pattern

   Input "User123" contains uppercase 'U', which does not match the pattern.

3. Final Answer:

   The record fails to save with a format error -> Option B

4. Quick Check:

   Uppercase breaks regex = validation fails [OK]

Hint: Regex is case sensitive; uppercase breaks lowercase-only pattern [OK]

Common Mistakes:

• Assuming validation auto-changes case
• Thinking uppercase letters are allowed
• Confusing syntax error with validation failure

4. Identify the error in this validation code:

validates :phone, format: { with: /\d{10}/, message: "must be 10 digits" }

medium

A. The regex does not anchor start and end, allowing invalid matches

B. The regex should be enclosed in quotes

C. The message key is misspelled

D. The validates method is missing a colon before phone

Solution

1. Step 1: Review the regex pattern

   The regex /\d{10}/ matches any 10 digits anywhere in the string, not necessarily the whole string.

2. Step 2: Understand validation implications

   Without anchors \A and \z, strings with extra characters before or after 10 digits will pass incorrectly.

3. Final Answer:

   The regex does not anchor start and end, allowing invalid matches -> Option A

4. Quick Check:

   Regex anchors needed for exact match [OK]

Hint: Always anchor regex with \A and \z for full string match [OK]

Common Mistakes:

• Forgetting to anchor regex start/end
• Assuming regex in quotes is required
• Misspelling keys like message or validates

5. You want to validate a postal code that must be exactly 5 digits or 5 digits followed by a dash and 4 digits (like '12345' or '12345-6789'). Which validation is correct?

hard

A. validates :postal_code, format: { with: /\A\d{5}-\d{4}\z/, message: "invalid postal code" }

B. validates :postal_code, format: { with: /\d{5}(-\d{4})?/, message: "invalid postal code" }

C. validates :postal_code, format: { with: /\A\d{9}\z/, message: "invalid postal code" }

D. validates :postal_code, format: { with: /\A\d{5}(-\d{4})?\z/, message: "invalid postal code" }

Solution

1. Step 1: Understand the postal code formats

   Valid formats are 5 digits alone or 5 digits plus dash and 4 digits.

2. Step 2: Analyze regex options

   validates :postal_code, format: { with: /\A\d{5}(-\d{4})?\z/, message: "invalid postal code" } uses anchors \A and \z and allows 5 digits with optional dash and 4 digits. validates :postal_code, format: { with: /\d{5}(-\d{4})?/, message: "invalid postal code" } lacks anchors, allowing partial matches. validates :postal_code, format: { with: /\A\d{5}-\d{4}\z/, message: "invalid postal code" } requires dash and 4 digits always, disallowing 5-digit only. validates :postal_code, format: { with: /\A\d{9}\z/, message: "invalid postal code" } requires exactly 9 digits, no dash.

3. Final Answer:

   validates :postal_code, format: { with: /\A\d{5}(-\d{4})?\z/, message: "invalid postal code" } -> Option D

4. Quick Check:

   Anchored regex with optional group = validates :postal_code, format: { with: /\A\d{5}(-\d{4})?\z/, message: "invalid postal code" } [OK]

Hint: Use anchors and optional group for flexible exact match [OK]

Common Mistakes:

• Omitting anchors causing partial matches
• Forcing dash and extra digits when optional
• Using wrong digit counts or missing optional group