doc_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b7460f23539be66a9bd3c728fc4bb803cf72d73d7abad9391d79c9d56102d54
+  data.tar.gz: d379bdd889e02ce20ee34726fffdfd781f1059cb7badc562f69b5f40b55829c6
+SHA512:
+  metadata.gz: 2edb714c5bb9b6923a40e4959a90b4e61e7526babce5bead5a203a4ae3636339fc1d860b1fda5c65d02ee73aefb12f4d79338a24108a1082bbf43572e17bf9bf
+  data.tar.gz: ce7955d8973d8f89069c766cb69dbe581c5994dd7765c4a66dbb0c3e02e57a0e531b1f8d5750f2c0ea93edbf253baab0c0b82008cc015b59d397665dc4e5c212

data/README.md

@@ -0,0 +1,120 @@
+
+# DocValidator
+
+DocValidator é uma gem Ruby projetada para validar e formatar documentos comuns no Brasil, como CPF, CNPJ, RG, CNH e outros. Ela fornece métodos fáceis de usar para verificar a validade desses documentos e formatá-los corretamente.
+
+## Instalação
+
+Adicione a gem ao seu `Gemfile`:
+
+```ruby
+gem 'doc_validator'
+```
+
+Depois, execute o comando para instalar:
+
+```bash
+bundle install
+```
+
+Ou, se preferir, instale diretamente com o comando `gem`:
+
+```bash
+gem install doc_validator
+```
+
+## Uso
+
+### Validação de CPF
+
+Para validar um CPF, use o método `.valid?`:
+
+```ruby
+DocValidator::CpfValidator.valid?("123.456.789-09")  # Retorna true
+DocValidator::CpfValidator.valid?("112.345.678-900") # Retorna false
+```
+
+Para formatar um CPF, use o método `.format`:
+
+```ruby
+DocValidator::CpfValidator.format("12345678909")  # Retorna "123.456.789-09"
+```
+
+### Validação de CNPJ
+
+Para validar um CNPJ, use o método `.valid?`:
+
+```ruby
+DocValidator::CnpjValidator.valid?("12.345.678/0001-95")  # Retorna true
+DocValidator::CnpjValidator.valid?("123.456.789-09")      # Retorna false
+```
+
+Para formatar um CNPJ, use o método `.format`:
+
+```ruby
+DocValidator::CnpjValidator.format("12345678000195")  # Retorna "12.345.678/0001-95"
+```
+
+### Validação de RG
+
+Para validar um RG, use o método `.valid?`:
+
+```ruby
+DocValidator::RgValidator.valid?("12.345.678/0001-95")  # Retorna true
+DocValidator::RgValidator.valid?("11.234.567/0001-000") # Retorna false
+```
+
+Para formatar um RG, use o método `.format`:
+
+```ruby
+DocValidator::RgValidator.format("12345678000195")  # Retorna "12.345.678/0001-95"
+```
+
+### Validação de CNH
+
+Em breve, adicionaremos suporte para a validação e formatação de CNH.
+
+## Dependências
+
+- Ruby 3.4.2 ou superior
+- Nenhuma outra dependência externa além da própria gem.
+
+## Testes
+
+Para rodar os testes, você pode usar o RSpec. Se ainda não tiver o RSpec instalado, adicione ao seu `Gemfile`:
+
+```ruby
+gem 'rspec'
+```
+
+Então, execute:
+
+```bash
+bundle install
+```
+
+Para rodar os testes:
+
+```bash
+rspec
+```
+
+### Cobertura de Testes
+
+DocValidator utiliza o SimpleCov para gerar cobertura de testes. Após rodar os testes, você pode verificar a cobertura gerada em `coverage/index.html`.
+
+## Contribuição
+
+1. Fork o projeto.
+2. Crie uma branch (`git checkout -b minha-nova-feature`).
+3. Faça suas alterações e adicione testes para cobrir as mudanças.
+4. Execute os testes para garantir que tudo está funcionando corretamente.
+5. Envie um pull request.
+
+## Licença
+
+Distribuído sob a licença MIT. Veja `LICENSE` para mais informações.
+
+## Autores
+
+- Seu Nome - Criador e mantenedor

data/lib/doc_validator/cnpj_validator.rb

@@ -0,0 +1,17 @@
+module DocValidator
+  class CnpjValidator
+    def self.valid?(cnpj)
+      # Algoritmo de validação do CNPJ
+      cnpj = cnpj.gsub(/\D/, '')  # Remover todos os caracteres não numéricos
+      return false if cnpj.length != 14
+      # Implementação da validação do CNPJ
+      # ...
+      true
+    end
+
+    def self.format(cnpj)
+      # Formatar o CNPJ para o padrão 00.000.000/0001-00
+      cnpj.gsub(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/, '\1.\2.\3/\4-\5')
+    end
+  end
+end

data/lib/doc_validator/cpf_validator.rb

@@ -0,0 +1,17 @@
+module DocValidator
+  class CpfValidator
+    def self.valid?(cpf)
+      # Algoritmo de validação do CPF
+      cpf = cpf.gsub(/\D/, '')  # Remover todos os caracteres não numéricos
+      return false if cpf.length != 11
+      # Implementação da validação do CPF
+      # ...
+      true
+    end
+
+    def self.format(cpf)
+      # Formatar o CPF para o padrão 000.000.000-00
+      cpf.gsub(/(\d{3})(\d{3})(\d{3})(\d{2})/, '\1.\2.\3-\4')
+    end
+  end
+end

data/lib/doc_validator/rg_validator.rb

@@ -0,0 +1,17 @@
+module DocValidator
+  class RgValidator
+    def self.valid?(rg)
+      # Algoritmo de validação do RG
+      rg = rg.gsub(/\D/, '')  # Remover todos os caracteres não numéricos
+      return false if rg.length != 9
+      # Implementação da validação do RG
+      # ...
+      true
+    end
+
+    def self.format(rg)
+      # Formatar o RG para o padrão XX.XXX.XXX-X
+      rg.gsub(/(\d{2})(\d{3})(\d{3})(\d{1})/, '\1.\2.\3-\4')
+    end
+  end
+end

data/lib/doc_validator/version.rb

@@ -0,0 +1,3 @@
+module DocValidator
+  VERSION = "0.1.0"
+end

data/lib/doc_validator.rb

@@ -0,0 +1,8 @@
+require "doc_validator/version"
+require "doc_validator/cpf_validator"
+require "doc_validator/cnpj_validator"
+require "doc_validator/rg_validator"
+
+module DocValidator
+  # Aqui você pode incluir métodos gerais, se necessário
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: doc_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maikon Douglas
+bindir: bin
+cert_chain: []
+date: 2025-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Essa gem fornece funcionalidades para validar, formatar e gerar documentos
+  comuns como CPF, CNPJ, RG e CNH.
+email:
+- maikonconta0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/doc_validator.rb
+- lib/doc_validator/cnpj_validator.rb
+- lib/doc_validator/cpf_validator.rb
+- lib/doc_validator/rg_validator.rb
+- lib/doc_validator/version.rb
+homepage: https://github.com/maikondouglas/doc_validator
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Uma gem para validar e formatar documentos como CPF, CNPJ, RG, CNH
+test_files: []