Giter Club home page Giter Club logo

cns_brazil's Introduction

CNS Brazil

Usage

Installing

Add this line to your application's Gemfile:

gem 'cns_brazil'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cns_brazil

Validator

ActiveRecord

  • Just use as any other validator:
class User < ActiveRecord::Base
  validates :cns, '::CnsBrazil::Cns': true
end
  • Use with anny column name
class User < ActiveRecord::Base
  validates :my_cns, '::CnsBrazil::Cns': true
end
  • Allow blank value
class User < ActiveRecord::Base
  validates :cns, '::CnsBrazil::Cns': true, allow_blank: true
end

Elsewhere

require "cns_brazil"

cns_validator = CnsBrazil::Cns.new(value: '1234567891234516')

cns_validator.valid? # true || false

Generator

require "cns_brazil"

CnsBrazil::Cns.generate  # returns a valid CNS

Test

Obs: If your project has shoulda-matchers gem you can use next matcher

Create a file spec/support/cns_brazil.rb and add next content

require 'cns_brazil/validate_cns_matcher'

Use in your tests:

specify { is_expected.to validate_cns } # It will test the attribute :cns by default
specify { is_expected.to validate_cns(:my_cns) }

With blank value

specify { is_expected.to validate_cns.allow_blank }
specify { is_expected.to validate_cns(:my_cns).allow_blank }

Usage example

Contributing

  • Run using Docker: docker-compose run web bash
  • In bash Run: bundle install
  • Run spec: spec
  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

cns_brazil's People

Contributors

hdias avatar owalmirneto avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.