pasep-pis-nit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49607d004efbcee250604f8cb29ca0a6a3a58d10
+  data.tar.gz: b6b8e6fec87043f9aacae6a812ed1fd4c168ce39
+SHA512:
+  metadata.gz: 1b874894807b06d4737e9bcfa4ecbb8d8cffd900f285f890ebe829048f0db09b36047b015a16fb1f2152b41b6cb29042266cb9dedc29f5a610f455f80ee73ed5
+  data.tar.gz: 504e7acb1a323c29a78179dceb27785b12f6022d5c85de9aa0e4a041c6181f60304b01e9423072515285be2e5e5257b7944c75f680672a1af31fe653fe2aa297

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paseppisnit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jefferson Queiroz Venerando
+
+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/README.md

@@ -0,0 +1,35 @@
+# pasep-pis-nit
+
+Allows ActiveModel backed classes to validate PASEP/PIS/NIT fields.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pasep-pis-nit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pasep-pis-nit
+
+## Usage
+
+Add to your model:
+
+```ruby
+validates :my_pasep_pis_nit_attribute, :pasep_pis_nit => true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/shamanime/pasep-pis-nit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/pasep-pis-nit.rb

@@ -0,0 +1,3 @@
+require 'pasep-pis-nit/version'
+require 'pasep-pis-nit/pis'
+require 'pasep-pis-nit/validator'

data/lib/pasep-pis-nit/pis.rb

@@ -0,0 +1,57 @@
+module PasepPisNit
+  class Pis
+    # http://www.macoratti.net/alg_pis.htm
+    attr_reader :numero
+
+    def initialize(numero)
+      @numero           = numero
+      @match            = @numero =~ PASEP_PIS_NIT_REGEX
+      @numero_puro      = $1
+      @para_verificacao = $2
+      @numero           = (@match ? format_number! : nil)
+    end
+
+    def to_s
+      @numero || ''
+    end
+
+    def ==(outro_doc)
+      self.numero == outro_doc.numero
+    end
+
+    # Verifica se o número possui o formato correto e se
+    # constitui um número de documento válido
+    def valido?
+      return false unless @match
+      verifica_numero
+    end
+
+    private
+      PASEP_PIS_NIT_REGEX = /\A(\d{3}\.?\d{4}\.?\d{3})-?(\d)\Z/ # 125.6483.635-8
+      PESO = %w(3 2 9 8 7 6 5 4 3 2)
+
+      def verifica_numero
+        @numero_puro.gsub!(/[\.\/-]/, '')
+        return false if @numero_puro.length != 10
+
+        total = soma_digitos
+
+        resto = total % 11
+
+        verificador = 11 - resto
+        verificador = 0 if (verificador == 10 || verificador == 11)
+        verificador.to_s == @para_verificacao
+      end
+
+      def soma_digitos
+        soma = 0
+        PESO.each_with_index { |p, idx| soma += p.to_i * @numero_puro[idx].to_i }
+        soma
+      end
+
+      def format_number!
+        @numero =~ /^(\d{3})\.?(\d{4})\.?(\d{3})-?(\d)$/
+        @numero = "#{$1}.#{$2}.#{$3}-#{$4}"
+      end
+  end
+end

data/lib/pasep-pis-nit/validator.rb

@@ -0,0 +1,6 @@
+class PasepPisNitValidator < ::ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.nil?
+    record.errors.add(attribute, options[:message] || :invalid) unless PasepPisNit::Pis.new(value).valido?
+  end
+end

data/lib/pasep-pis-nit/version.rb

@@ -0,0 +1,3 @@
+module PasepPisNit
+  VERSION = "0.0.1"
+end

data/pasep-pis-nit.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pasep-pis-nit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pasep-pis-nit'
+  spec.version       = PasepPisNit::VERSION
+  spec.authors       = ['Jefferson Queiroz Venerando']
+  spec.email         = ['jefferson@shamani.me']
+  spec.summary       = %q{Validação de PASEP/PIS/NIT para sua aplicação.}
+  spec.description   = %q{Validação de PASEP/PIS/NIT para sua aplicação.}
+  spec.homepage      = 'https://github.com/shamanime/pasep-pis-nit'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "activemodel", "~> 4.0"
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 0'
+end

data/spec/pasep_pis_nit_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+class TestPerson < TestModel
+  validates :pasep_pis_nit, :pasep_pis_nit => true
+end
+
+class TestPersonAllowsNil < TestModel
+  validates :pasep_pis_nit, :pasep_pis_nit => {:allow_blank => true}
+end
+
+class TestPersonAllowsNilFalse < TestModel
+  validates :pasep_pis_nit, :pasep_pis_nit => {:allow_blank => false}
+end
+
+class TestPersonWithMessage < TestModel
+  validates :pasep_pis_nit_address, :pasep_pis_nit => {:message => 'is not looking very good!'}
+end
+
+describe PasepPisNitValidator do
+
+  describe "validation" do
+    context "given the valid PASEP/PIS/NIT" do
+      [
+        '125.5256.164-2',
+        '125.1765.831-7',
+        '125.4779.406-5',
+        '125.6132.272-8',
+        '125.4657.521-1',
+        '125.7768.118-8',
+        '125.1632.712-0',
+        '125.2545.275-7',
+        '125.4607.879-0',
+        '125.6395.441-1',
+        '125.0151.564-3',
+        '125.8227.898-1',
+        '12561488324',
+        '12588968467',
+        '12547781800'
+      ].each do |pasep_pis_nit|
+
+        it "#{pasep_pis_nit.inspect} should be valid" do
+          expect(TestPerson.new(:pasep_pis_nit => pasep_pis_nit).valid?).to be_truthy
+        end
+
+      end
+
+    end
+
+    context "given the invalid PASEP/PIS/NIT" do
+      [
+        "",
+        "f@s",
+        "f@s.c",
+        "@bar",
+        "test@",
+        "! \#$%\`|@invalid-characters-in-local.org",
+        "<>@[]\`|@125.5256.164-2",
+        "125.5256.164-2\n<script>alert('hello')</script>",
+        "127 2226 164 2",
+        '129.9996.164-2',
+        '125.3365.831-7',
+        '125.4779.406-0',
+        '125.6162.272-8',
+        '235.4757.521-1',
+        '1245.628.118-8',
+        '525.5332.712-6',
+        '267.4545.267-7',
+        '275.4607.879-0',
+        '235.6395.443-1',
+        '225.0151.564-3',
+        '12a.8227.898-1',
+        '15.6148.8342-4',
+        '18896.8416-7',
+        '125477818300'
+      ].each do |pasep_pis_nit|
+
+        it "#{pasep_pis_nit.inspect} should not be valid" do
+          expect(TestPerson.new(:pasep_pis_nit => pasep_pis_nit).valid?).to be_falsey
+        end
+
+      end
+    end
+  end
+
+  describe "error messages" do
+    context "when the message is not defined" do
+      subject { TestPerson.new :pasep_pis_nit => '15.6148.8342-4' }
+      before { subject.valid? }
+
+      it "should add the default message" do
+        expect(subject.errors[:pasep_pis_nit]).to include "is invalid"
+      end
+    end
+
+    context "when the message is defined" do
+      subject { TestPersonWithMessage.new :pasep_pis_nit_address => '15.6148.8342-4' }
+      before { subject.valid? }
+
+      it "should add the customized message" do
+        expect(subject.errors[:pasep_pis_nit_address]).to include "is not looking very good!"
+      end
+    end
+  end
+
+  describe "blank PASEP/PIS/NIT" do
+    it "should not be valid when :allow_blank option is missing" do
+      person = TestPerson.new(:pasep_pis_nit => '')
+      expect(person.valid?).to be_falsey
+    end
+
+    it "should be valid when :allow_blank options is set to true" do
+      person = TestPersonAllowsNil.new(:pasep_pis_nit => '')
+      expect(person.valid?).to be_truthy
+    end
+
+    it "should not be valid when :allow_blank option is set to false" do
+      person = TestPersonAllowsNilFalse.new(:pasep_pis_nit => '')
+      expect(person.valid?).to_not be_truthy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rspec'
+require 'active_model'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'pasep-pis-nit'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: pasep-pis-nit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jefferson Queiroz Venerando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Validação de PASEP/PIS/NIT para sua aplicação.
+email:
+- jefferson@shamani.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pasep-pis-nit.rb
+- lib/pasep-pis-nit/pis.rb
+- lib/pasep-pis-nit/validator.rb
+- lib/pasep-pis-nit/version.rb
+- pasep-pis-nit.gemspec
+- spec/pasep_pis_nit_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shamanime/pasep-pis-nit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Validação de PASEP/PIS/NIT para sua aplicação.
+test_files:
+- spec/pasep_pis_nit_spec.rb
+- spec/spec_helper.rb