validators 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f181df550b243432c4e517dd043cddbbdc01615
-  data.tar.gz: c8c9555509201f15b3699c23d371c13ab8083fe2
+  metadata.gz: 17b8dea8b888cbb70e92c7c97fdc67135a27121a
+  data.tar.gz: c7b932ae83a70238d74764c888a48d5884ef2c1f
 SHA512:
-  metadata.gz: 51a00aa0c7ba19e185a8e8cee3a3f41935acd175d586a923b87d82d4cb49b5243c1e18ccf3eb48c172d02d0ef6f20f085f86cc4150251836c3017da99d8943ca
-  data.tar.gz: 667464a246123492c30054884096f1e865b6bb0826026a4ef20e44f922c741ee1362de6e0896e6a0a8613591b3f6bbdbfb3708349533685e77f9d1279a7492d2
+  metadata.gz: ce83811dfd880c856fcee5cace391b438b3b6045b1cee3f456b2e9d70a377bf31ed55b9a55833719da8a1dba35d4de68fd2ed90ed9f9df453edb7e7644294959
+  data.tar.gz: 16f6cbd5a1f73bfd6402b005b59b4de83c2084b4dfbd54dec401dfd435b561e579a2d8cf9ed240f2d27e75f8796901ba00b5729a8976c1e0e6c46734bdda2311

data/.rspec

@@ -1 +1 @@
---color --format documentation
+--color

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validators (2.0.0)
+    validators (2.1.0)
 
 GEM
   remote: http://rubygems.org/
@@ -26,6 +26,7 @@ GEM
     awesome_print (1.2.0)
     builder (3.1.4)
     coderay (1.0.9)
+    cpf_cnpj (0.2.0)
     diff-lcs (1.2.5)
     i18n (0.6.5)
     method_source (0.8.2)
@@ -67,6 +68,7 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (>= 3.0)
+  cpf_cnpj
   pry-meta
   rake
   rspec

data/README.md

@@ -0,0 +1,128 @@
+# Validators
+
+Add some nice Rails 3 ActiveRecord validators.
+
+## Installation
+
+```
+gem install validators
+```
+
+Then add it to your Gemfile:
+
+```ruby
+gem "validators"
+```
+
+## Usage
+
+### validates_email_format_of
+
+```ruby
+class User < ActiveRecord::Base
+  # old fashion
+  validates_email_format_of :email
+
+  # alternative way
+  validates :email, :email => true
+end
+```
+
+### validates_url_format_of
+
+```ruby
+class User < ActiveRecord::Base
+  validates_url_format_of :site
+end
+```
+
+### validates_ownership_of
+
+```ruby
+class Task < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :category
+
+  validates_ownership_of :category, :with => :user
+end
+
+user = User.find(1)
+another_user = User.find(2)
+
+user_category = user.categories.first
+another_user_category = another_user.categories.first
+
+task = user.tasks.create(:category => user_category)
+task.valid?
+#=> true
+
+task = user.tasks.create(:category => another_user_category)
+task.valid?
+#=> false
+```
+
+### validates_ip_address
+
+```ruby
+class Server < ActiveRecord::Base
+  validates_ip_address :address
+  validates_ip_address :address, :only => :v4
+  validates_ip_address :address, :only => :v6
+end
+```
+
+### validates_datetime
+
+```ruby
+class Server < ActiveRecord::Base
+  validates_datetime :starts_at
+  validates_datetime :ends_at, :after => :starts_at, :if => :starts_at?
+  validates_datetime :ends_at, :after => :now
+  validates_datetime :ends_at, :before => :today
+
+  validates :starts_at, :datetime => true
+end
+```
+
+### validates_cpf_format_of
+
+```ruby
+class User < ActiveRecord::Base
+  validates_cpf_format_of :document
+end
+```
+
+### validates_cnpj_format_of
+
+```ruby
+class User < ActiveRecord::Base
+  validates_cnpj_format_of :document
+end
+```
+
+## Maintainer
+
+* [Nando Vieira](http://simplesideias.com.br)
+
+## License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/validators/validates_cnpj_format_of.rb

@@ -0,0 +1,29 @@
+module ActiveModel
+  module Validations
+    class CnpjValidator < EachValidator
+      def validate_each(record, attribute, value)
+        record.errors.add(attribute, :invalid_cnpj,
+          message: options[:message],
+          value: value
+        ) unless CNPJ.valid?(value)
+      end
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified CNPJ is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_cnpj_format_of :document
+      #   end
+      #
+      def validates_cnpj_format_of(*attr_names)
+        require "cnpj"
+        validates_with CnpjValidator, _merge_attributes(attr_names)
+      rescue LoadError
+        fail "cpf_cnpj is not part of the bundle. Add it to Gemfile."
+      end
+
+      alias_method :validates_cnpj, :validates_cnpj_format_of
+    end
+  end
+end

data/lib/validators/validates_cpf_format_of.rb

@@ -0,0 +1,29 @@
+module ActiveModel
+  module Validations
+    class CpfValidator < EachValidator
+      def validate_each(record, attribute, value)
+        record.errors.add(attribute, :invalid_cpf,
+          message: options[:message],
+          value: value
+        ) unless CPF.valid?(value)
+      end
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified CPF is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_cpf_format_of :document
+      #   end
+      #
+      def validates_cpf_format_of(*attr_names)
+        require "cpf"
+        validates_with CpfValidator, _merge_attributes(attr_names)
+      rescue LoadError
+        fail "cpf_cnpj is not part of the bundle. Add it to Gemfile."
+      end
+
+      alias_method :validates_cpf, :validates_cpf_format_of
+    end
+  end
+end

data/lib/validators/version.rb

@@ -1,7 +1,7 @@
 module Validators
   module Version
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end

data/lib/validators.rb

@@ -5,6 +5,8 @@ require "validators/validates_ip_address"
 require "validators/validates_email_format_of"
 require "validators/validates_url_format_of"
 require "validators/validates_ownership_of"
+require "validators/validates_cpf_format_of"
+require "validators/validates_cnpj_format_of"
 
 module Validators
 end

data/spec/support/emails.rb

@@ -21,7 +21,8 @@ INVALID_EMAILS = [
   # corrected in http://www.rfc-editor.org/errata_search.php?rfc=3696
   'Fred\ Bloggs_@example.com',
   'Abc\@def+@example.com',
-  'Joe.\\Blow@example.com'
+  'Joe.\\Blow@example.com',
+  "invalid@invalid.invalid"
 ]
 
 VALID_EMAILS = [

data/spec/support/translations.yml

@@ -1,5 +1,5 @@
 en:
-  activerecord:
+  activerecord: &activerecord
     errors:
       messages:
         record_invalid: "Errors: %{errors}"
@@ -12,12 +12,22 @@ en:
         invalid_ipv6_address: "is not a valid IPv6 address"
         invalid_address: "is not a valid IP address"
         invalid_owner: "is not associated with your user"
+        invalid_cpf: "is not a valid CPF"
+        invalid_cnpj: "is not a valid CNPJ"
+
+  activemodel:
+    <<: *activerecord
 
 pt-BR:
-  activerecord:
+  activerecord: &activerecord
     errors:
       messages:
         record_invalid: "Erros: %{errors}"
         invalid_email: "não parece ser um e-mail válido"
         invalid_url: "não parece ser uma URL válida"
         invalid_owner: "não está associado ao seu usuário"
+        invalid_cpf: "não é um CPF válido"
+        invalid_cnpj: "não é um CNPJ válido"
+
+  activemodel:
+    <<: *activerecord

data/spec/validators/validates_cnpj_format_of_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe ".validates_cnpj_format_of" do
+  let(:model) { Class.new {
+    def self.name
+      "User"
+    end
+
+    include ActiveModel::Model
+    validates_cnpj_format_of :document
+    attr_accessor :document
+  } }
+
+  it "requires valid CNPJ" do
+    record = model.new(document: "invalid")
+    record.valid?
+
+    expect(record.errors[:document]).not_to be_empty
+  end
+
+  it "accepts formatted CNPJ" do
+    record = model.new(document: CNPJ.generate(true))
+    record.valid?
+
+    expect(record.errors[:document]).to be_empty
+  end
+
+  it "accepts stripped CNPJ" do
+    record = model.new(document: CNPJ.generate)
+    record.valid?
+
+    expect(record.errors[:document]).to be_empty
+  end
+
+  it "sets translated error message" do
+    I18n.locale = "pt-BR"
+
+    record = model.new
+    record.valid?
+
+    expect(record.errors[:document]).to include("não é um CNPJ válido")
+  end
+end

data/spec/validators/validates_cpf_format_of_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe ".validates_cpf_format_of" do
+  let(:model) { Class.new {
+    def self.name
+      "User"
+    end
+
+    include ActiveModel::Model
+    validates_cpf_format_of :document
+    attr_accessor :document
+  } }
+
+  it "requires valid CPF" do
+    record = model.new(document: "invalid")
+    record.valid?
+
+    expect(record.errors[:document]).not_to be_empty
+  end
+
+  it "accepts formatted CPF" do
+    record = model.new(document: CPF.generate(true))
+    record.valid?
+
+    expect(record.errors[:document]).to be_empty
+  end
+
+  it "accepts stripped CPF" do
+    record = model.new(document: CPF.generate)
+    record.valid?
+
+    expect(record.errors[:document]).to be_empty
+  end
+
+  it "sets translated error message" do
+    I18n.locale = "pt-BR"
+
+    record = model.new
+    record.valid?
+
+    expect(record.errors[:document]).to include("não é um CPF válido")
+  end
+end

data/validators.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "sqlite3-ruby"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry-meta"
+  s.add_development_dependency "cpf_cnpj"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validators
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nando Vieira
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cpf_cnpj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add some nice ActiveRecord validators.
 email:
 - fnando.vieira@gmail.com
@@ -91,11 +105,13 @@ files:
 - .rspec
 - Gemfile
 - Gemfile.lock
-- README.rdoc
+- README.md
 - Rakefile
 - lib/validators.rb
 - lib/validators/constants.rb
 - lib/validators/ip.rb
+- lib/validators/validates_cnpj_format_of.rb
+- lib/validators/validates_cpf_format_of.rb
 - lib/validators/validates_datetime.rb
 - lib/validators/validates_email_format_of.rb
 - lib/validators/validates_ip_address.rb
@@ -111,6 +127,8 @@ files:
 - spec/support/translations.yml
 - spec/support/urls.rb
 - spec/validators/ip_spec.rb
+- spec/validators/validates_cnpj_format_of_spec.rb
+- spec/validators/validates_cpf_format_of_spec.rb
 - spec/validators/validates_datetime_spec.rb
 - spec/validators/validates_email_format_of_spec.rb
 - spec/validators/validates_ip_address_spec.rb

data/README.rdoc

@@ -1,98 +0,0 @@
-= Validators
-
-Add some nice Rails 3 ActiveRecord validators.
-
-== Installation
-
-  gem install validators
-
-Then add it to your Gemfile:
-
-  gem "validators"
-
-== Usage
-
-=== validates_email_format_of
-
-  class User < ActiveRecord::Base
-    # old fashion
-    validates_email_format_of :email
-
-    # alternative way
-    validates :email, :email => true
-  end
-
-=== validates_url_format_of
-
-  class User < ActiveRecord::Base
-    validates_url_format_of :site
-  end
-
-=== validates_ownership_of
-
-  class Task < ActiveRecord::Base
-    belongs_to :user
-    belongs_to :category
-
-    validates_ownership_of :category, :with => :user
-  end
-
-  user = User.find(1)
-  another_user = User.find(2)
-
-  user_category = user.categories.first
-  another_user_category = another_user.categories.first
-
-  task = user.tasks.create(:category => user_category)
-  task.valid?
-  #=> true
-
-  task = user.tasks.create(:category => another_user_category)
-  task.valid?
-  #=> false
-
-=== validates_ip_address
-
-  class Server < ActiveRecord::Base
-    validates_ip_address :address
-    validates_ip_address :address, :only => :v4
-    validates_ip_address :address, :only => :v6
-  end
-
-=== validates_datetime
-
-  class Server < ActiveRecord::Base
-    validates_datetime :starts_at
-    validates_datetime :ends_at, :after => :starts_at, :if => :starts_at?
-    validates_datetime :ends_at, :after => :now
-    validates_datetime :ends_at, :before => :today
-
-    validates :starts_at, :datetime => true
-  end
-
-== Maintainer
-
-* Nando Vieira - http://simplesideias.com.br
-
-== License
-
-(The MIT License)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.