ValidatesIdentity::BrCpf

This projects aims to validate Brazilian CPF identification document. This project depends on validates_identity gem and is a plugin for it.

Add this line to your application's Gemfile:

gem 'validates_identity-br_cpf'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install validates_identity-br_cpf

Just use as any other validator:

class User < ActiveRecord::Base
  # :identity_type is the attribute that will be used to determine the identity type and is required
  validates :identity, identity: { identity_type: :identity_type }
end

New Identity Validators can be registered through the public apis of ValidatesIdentity

ValidatesIdentity.register_identity_type('CustomIdentity', CustomIdentityValidator)

Each Validator should have:

• a constructor with 2 params: value and options as a hash
• a valid? method that returns a boolean

In case of a legacy system where keys were already defined and differ from the official ones, aliases can be registered as well

ValidatesIdentity.register_identity_type_alias('LegacyIdentity', 'CustomIdentity')

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/plribeiro3000/validates_identity-br_cpf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

Everyone interacting in the ValidatesIdentity::BrCpf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.