Skip to content

slavik117/converters_before_validation

Repository files navigation

ConvertersBeforeValidation

string_converter_before_validation adds before_validation callback, which applies necessary function to attributes.

There are some derivatives:

  • squish_before_validation_for
  • downcase_before_validation_for
  • upcase_before_validation_for

Usage

Let's suppose we have model Article with following fields: author_name, contact_email, title, camel_tag.

  # app/models/article.rb
  class Article < ApplicationRecord

    validates :contact_email, format: { with: /\A[^@\s]+@[^@\s]+\z/, message: "Not email format" }

  end

We're setting values for these fields sourced from some inaccurate input:

>> article = Article.new(author_name: '   Boss   ', contact_email: ' Boss@ExAmple.Org', title: ' hello ', camel_tag: 'hello_world')

>> article.valid?
=> false

>> article.author_name
=> '   Boss   '

>> article.contact_email
=> ' Boss@ExAmple.Org'

>> article.title
=> ' hello '

>> article.camel_tag
=> 'hello_world'

We might want to sanitize our values before saving it to our database:
contact_email = contact_email.squish.downcase
author_name = author_name.squish
title = title.squish.upcase
camel_tag = camel_tag.camelcase

This gem's functions are presented for doing this: before_validation callbacks added to its model and do the job.

  # app/models/article.rb
  class Article < ApplicationRecord

    downcase_before_validation_for :contact_email

    squish_before_validation_for :author_name, :contact_email, :title

    upcase_before_validation_for :title

    # and another string function
    string_converter_before_validation :camelcase, :camel_tag

    validates :contact_email, format: { with: /\A[^@\s]+@[^@\s]+\z/, message: "Not email format" }

  end
>> article = Article.new(author_name: '   Boss   ', contact_email: ' Boss@ExAmple.Org', title: ' hello ', camel_tag: 'hello_world')

>> article.valid?
=> true

>> article.author_name
=> 'Boss'

>> article.contact_email
=> 'boss@example.org'

>> article.title
=> 'HELLO'

>> article.camel_tag
=> 'HelloWorld'

Installation

Add this line to your application's Gemfile:

  gem 'converters_before_validation'

And then execute:

  bundle

Or install it yourself as:

  gem install converters_before_validation

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.

About

Formatters for ActiveRecord attributes by before_validation callback.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published