cpf_tools 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc316f7ab66ab0ce32c02a5fce788c0d571d4b9603c856ca97b3caad158583b
-  data.tar.gz: 13efd3b03c0c0dfbc76d178bd0df07e07926ace87c367a01eb7ccdfedb5dd198
+  metadata.gz: c5c3e89ec707c076fa095bb710771f33097d3ad68e585f55988c50253bb2f48f
+  data.tar.gz: 696eb53b5a97816400ea240a028a5e5daf44795c0c97c7943e3b06b25f5437ca
 SHA512:
-  metadata.gz: f65061c314a9ff8fe40e6abfe657b70f1aa39fa062e8c9c045b1c96ae3356f5aec6f96874a581c407fe04c1a4f59c8794d50c79d4c3f8ad13344134eae0b5aef
-  data.tar.gz: ad18ec611cd2ab55f181506c2fb9dc4d57f4b84137ca28cd327b7905f77768bdb4fe2becb17aa767f6236112327a1f439400e9a5700d1e2bf938cdd46a387879
+  metadata.gz: 4f3b403dcec389bd970b9cf6afa074082c023df36bc281e781eeda8af6ade5f84fa02b3923e34b5dd3e85a4030bb4a765ef6c4433bebdb7c082850e5b5bcf687
+  data.tar.gz: 79387d02ea4e73c18df4473e75a9f71d58813b97ca8f27e54de8a3ab50868b7467545b9a9710748734375db54fadda46bfd1cf07a8475077860015a3d2969c5d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpf_tools (0.1.0)
+    cpf_tools (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -42,15 +42,31 @@ If the string length is different from 11 (CPF standard length) an empty string
 
 ### with_mask
 A string with default mask applied will be returned -> '###.###.###-##'
-    
+
     CpfTools.format('19906064072') => '199.060.640-72'
 
 ### digits_only
 A string with digits only will be returned.
-    
+
     CpfTools.format('199.060.640-72', format: :digits_only) => '19906064072'
 
 
+### CpfTools.return_valid (string)
+This method combines valid? and format and will return a formatted string if CPF is valid.
+
+If the string length is different from 11 (CPF standard length) or CPF isn't valid an empty string will be returned.
+
+### with_mask
+A string with default mask applied will be returned -> '###.###.###-##'
+
+    CpfTools.return_valid('19906064072') => '199.060.640-72'
+
+### digits_only
+A string with digits only will be returned.
+
+    CpfTools.return_valid('199.060.640-72', format: :digits_only) => '19906064072'
+
+
 ## Development
 
 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.

data/cpf_tools.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['mers.escobar@gmail.com']
 
   spec.summary       = 'Tools to work with the Brazilian Tax ID'
-  spec.description   = 'The Brazilian tax ID (CPF) validation and formatting, more functions to come'
+  spec.description   = 'The Brazilian Tax ID (CPF) validation and formatting, more functions to come'
   spec.homepage      = 'http://github.com/m-escobar/cpf_tools'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')

data/lib/cpf_tools.rb

@@ -33,6 +33,10 @@ module CpfTools
       end
     end
 
+    def return_valid(cpf, format: :masked)
+      valid?(cpf) ? format(cpf, format: format) : ''
+    end
+
     private
     def cpf_to_s(cpf)
       cpf = cpf.to_s if cpf.is_a? Integer

data/lib/cpf_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CpfTools
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpf_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcelo Escobar
@@ -10,7 +10,7 @@ bindir: exe
 cert_chain: []
 date: 2021-02-19 00:00:00.000000000 Z
 dependencies: []
-description: The Brazilian tax ID (CPF) validation and formatting, more functions
+description: The Brazilian Tax ID (CPF) validation and formatting, more functions
   to come
 email:
 - mers.escobar@gmail.com