codigo_postal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4deb6bb397a6028c2a5fe5580657d07c472e19414e3fb28a7e1adc2d2e91e84e
+  data.tar.gz: dcfd84d88b2eab52daa469b1e1a2cc2d19fa43144e65518b60cd0283ac8199e1
+SHA512:
+  metadata.gz: 99c6a2741a4c0a702dc791f8c2835af1349aafbc44644c3cd09b44afcbb8dd7c59a203f5c55a8f7ea2ba2d77e8ffb12ecb51110f981354418646ccf02c6bcf38
+  data.tar.gz: ac1c6ada139b2f5dae63fe657267c0abe7e8ac940f995ae2a74a743f9d3b385b1694926d119de5a21e824627a5cd43676460206be85d5e984895fc715fee16fc

data/lib/codigo_postal.rb

@@ -0,0 +1,73 @@
+class CodigoPostal
+  CEP_RANGES = [
+  { range_end: 19999999, code: 'SP', name: 'São Paulo' },
+  { range_end: 28999999, code: 'RJ', name: 'Rio de Janeiro' },
+  { range_end: 29999999, code: 'ES', name: 'Espírito Santo' },
+  { range_end: 39999999, code: 'MG', name: 'Minas Gerais' },
+  { range_end: 87999999, code: 'PR', name: 'Paraná' },
+  { range_end: 89999999, code: 'SC', name: 'Santa Catarina' },
+  { range_end: 99999999, code: 'RS', name: 'Rio Grande do Sul' },
+  { range_end: 48999999, code: 'BA', name: 'Bahia' },
+  { range_end: 49999999, code: 'SE', name: 'Sergipe' },
+  { range_end: 56999999, code: 'PE', name: 'Pernambuco' },
+  { range_end: 57999999, code: 'AL', name: 'Alagoas' },
+  { range_end: 58999999, code: 'PB', name: 'Paraíba' },
+  { range_end: 59999999, code: 'RN', name: 'Rio Grande do Norte' },
+  { range_end: 63999999, code: 'CE', name: 'Ceará' },
+  { range_end: 64999999, code: 'PI', name: 'Piauí' },
+  { range_end: 65999999, code: 'MA', name: 'Maranhão' },
+  { range_end: 68899999, code: 'PA', name: 'Pará' },
+  { range_end: 68999999, code: 'AP', name: 'Amapá' },
+  { range_end: 69299999, code: 'AM', name: 'Amazonas' },
+  { range_end: 69399999, code: 'RR', name: 'Roraima' },
+  { range_end: 69899999, code: 'AM', name: 'Amazonas' },
+  { range_end: 69999999, code: 'AC', name: 'Acre' },
+  { range_end: 76999999, code: 'RO', name: 'Rondônia' },
+  { range_end: 77999999, code: 'TO', name: 'Tocantins' },
+  { range_end: 72799999, code: 'DF', name: 'Distrito Federal' },
+  { range_end: 72999999, code: 'GO', name: 'Goiás' },
+  { range_end: 73699999, code: 'DF', name: 'Distrito Federal' },
+  { range_end: 76799999, code: 'GO', name: 'Goiás' },
+  { range_end: 78899999, code: 'MT', name: 'Mato Grosso' },
+  { range_end: 79999999, code: 'MS', name: 'Mato Grosso do Sul' }
+  ]
+
+  attr_reader :state_code, :state_name, :cep_formatted, :cep_digits
+  def initialize(cep)
+    cep_fields = match_cep cep.to_s
+    if !cep_fields.nil?
+      @cep_digits = "#{cep_fields[0]}#{cep_fields[1]}#{cep_fields[2]}".to_i
+      @cep_formatted = "#{cep_fields[0].rjust(2, '0')}#{cep_fields[1]}-#{cep_fields[2]}"
+      state = find_state_by_cep
+      @state_code = state[:code]
+      @state_name = state[:name]
+    end
+  end
+
+  def find_state_by_cep
+    cep_number = @cep_digits
+    CEP_RANGES.sort_by { |range| range[:range_end] }.each do |cep_range|
+      return cep_range if cep_number <= cep_range[:range_end]
+    end
+    nil
+  end
+
+  def match_cep(cep)
+    cep_regex = /^(\d{1,2})\.?(\d{3})\-?(\d{3})$/
+    match_data = cep.match(cep_regex)
+    if match_data
+      return match_data[1..3]
+    else
+      return nil
+    end
+  end
+
+  def ==(other)
+    @cep_digits == other.cep_digits
+  end
+
+  def to_s
+    @cep_formatted
+  end
+
+end

data/test/test_codigo_postal.rb

@@ -0,0 +1,112 @@
+puts " - -- - - - -- - >>>>      Running tests from #{__FILE__}"
+require 'minitest/autorun'
+require 'codigo_postal'
+
+class CodigoPostalTest < Minitest::Test
+  def test_find_state_by_cep
+  ceps = [
+    ['01000-000', 'SP'],
+    ['19999-999', 'SP'],
+    ['28000-000', 'RJ'],
+    ['28999-999', 'RJ'],
+    ['29000-000', 'ES'],
+    ['29999-999', 'ES'],
+    ['30000-000', 'MG'],
+    ['39999-999', 'MG'],
+    ['80000-000', 'PR'],
+    ['87999-999', 'PR'],
+    ['88000-000', 'SC'],
+    ['89999-999', 'SC'],
+    ['90000-000', 'RS'],
+    ['99999-999', 'RS'],
+    ['40000-000', 'BA'],
+    ['48999-999', 'BA'],
+    ['49000-000', 'SE'],
+    ['49999-999', 'SE'],
+    ['50000-000', 'PE'],
+    ['56999-999', 'PE'],
+    ['57000-000', 'AL'],
+    ['57999-999', 'AL'],
+    ['58000-000', 'PB'],
+    ['58999-999', 'PB'],
+    ['59000-000', 'RN'],
+    ['59999-999', 'RN'],
+    ['60000-000', 'CE'],
+    ['63999-999', 'CE'],
+    ['64000-000', 'PI'],
+    ['64999-999', 'PI'],
+    ['65000-000', 'MA'],
+    ['65999-999', 'MA'],
+    ['66000-000', 'PA'],
+    ['68899-999', 'PA'],
+    ['68900-000', 'AP'],
+    ['68999-999', 'AP'],
+    ['69000-000', 'AM'],
+    ['69299-999', 'AM'],
+    ['69300-000', 'RR'],
+    ['69399-999', 'RR'],
+    ['69400-000', 'AM'],
+    ['69899-999', 'AM'],
+    ['69900-000', 'AC'],
+    ['69999-999', 'AC'],
+    ['76800-000', 'RO'],
+    ['76999-999', 'RO']
+  ]
+
+  ceps.each do |cep, expected_code|
+    assert_equal expected_code, CodigoPostal.new(cep).state_code
+  end
+end
+
+  def test_rio_pardo
+    rio_pardo = CodigoPostal.new('13.720-000')
+    assert_equal 'SP', rio_pardo.state_code
+    assert_equal '13720-000', rio_pardo.cep_formatted
+    assert_equal 13720000, rio_pardo.cep_digits
+  end
+
+  def test_floripa
+    floripa = CodigoPostal.new('88.063-500')
+    assert_equal 'SC', floripa.state_code
+    assert_equal '88063-500', floripa.cep_formatted
+    assert_equal 88063500, floripa.cep_digits
+  end
+
+  def test_catedral
+    catedral = CodigoPostal.new(1001000)
+    assert_equal 'SP', catedral.state_code
+    assert_equal '01001-000', catedral.cep_formatted
+    assert_equal 1001000, catedral.cep_digits
+  end
+
+  def test_ibirapuera
+    ibirapuera = CodigoPostal.new('04.094-050')
+    reasonable_formats = [
+      '04094-050',
+      '04094050',
+      '04.094-050',
+      '04.094050',
+      '4094050',
+      '4094-050',
+      '4.094050',
+      '4.094-050',
+      4094050
+    ]
+    unreasonable_formats = [
+      '04-094.050',
+      '04-094050',
+      '04-094-050'
+    ]
+
+    reasonable_formats.each do |format|
+      assert_equal ibirapuera, CodigoPostal.new(format)
+    end
+
+    unreasonable_formats.each do |format|
+      refute_equal ibirapuera, CodigoPostal.new(format)
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: codigo_postal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Felipe Mesquita
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This gem provides a simple way to find Brazilian states by postal code.
+email: felipemesquita@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/codigo_postal.rb
+- test/test_codigo_postal.rb
+homepage: https://github.com/felipedmesquita/codigo-postal
+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: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: A gem to find Brazilian states by postal code
+test_files:
+- test/test_codigo_postal.rb