codigo_postal 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 658e9b35e21f110f4956c87016af752bed1e2ece7f1e319b41697c37c0d22f52
-  data.tar.gz: c0c26790305fa4e8290b5267f4c23e14a43b6de0bd95d7903369ced7810611a2
+  metadata.gz: 57d34d49219a1449735f55baad0fd6cb2b7a10212aed130ea6b250f378c9c5f4
+  data.tar.gz: b854b3f76f91b3af50af999bd52542d8a55ab6681c9f2eeadab709ff509c5258
 SHA512:
-  metadata.gz: 8c09400332fd46a8e092eb82100b72ee341e426b0782e2680ecc1b06c6a2b202f0cefff24d28f3ead731fca30d1ed234b4a19400a7d6dfbfc80e624747c9ff18
-  data.tar.gz: f6b3a185f564cd4b1b8e3cb406c89d7321b088eb6d5c08f9e36aeb8c13deca8bb9041824047b3bb8891e6108813dbe410f9cfcc1055091ad4f2dc74b0b711183
+  metadata.gz: cdc61e8f5d27267294bf80e8dc6abb38ad87c311a28cdcff27d74bc2acc5b4a89b044a455708ea34c9cdafc779b23e38b11def809a67c43816761ad89b20db91
+  data.tar.gz: 6bd9ba0ca65aa52c22a75f68432e3ef1161fd0dcb5477f8e82a1ebc4bae0c0fb76ee35fb227e4b8d5252d2f1e48bc72dd460ee1b9d327591d021998d70cff195

data/lib/codigo_postal.rb

@@ -1,73 +1,86 @@
 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' }
+  SORTED_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: 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: 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: 76999999, code: "RO", name: "Rondônia"},
+    {range_end: 77999999, code: "TO", name: "Tocantins"},
+    {range_end: 78899999, code: "MT", name: "Mato Grosso"},
+    {range_end: 79999999, code: "MS", name: "Mato Grosso do Sul"},
+    {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"}
   ]
 
-  attr_reader :state_code, :state_name, :cep_formatted, :cep_digits
+  CEP_PATTERN = /
+    ^
+    \s*
+    (\d{1,2}) # leading zero can be ommited
+    \.?       # incorrect, but allowed as it's somewhat common
+    (\d{3})
+    -?
+    (\d{3})
+    \s*
+    $
+  /x
+
+  attr_reader :state_code, :state_name, :formatted, :digits
+
+  # for backwards compatibility
+  alias_method :cep_formatted, :formatted
+  alias_method :cep_digits, :digits
+
   def initialize(cep)
-    cep_fields = match_cep cep.to_s.strip
-    if !cep_fields.nil?
-      @cep_digits = "#{cep_fields[0].rjust(2, '0')}#{cep_fields[1]}#{cep_fields[2]}"
-      @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
+    components = cep.to_s.match CEP_PATTERN
+    return unless components
 
-  def find_state_by_cep
-    @cep_digits
-    CEP_RANGES.sort_by { |range| range[:range_end] }.each do |cep_range|
-      return cep_range if @cep_digits.to_i <= cep_range[:range_end]
-    end
-    nil
+    @digits = components.captures.join
+    @digits.prepend "0" if @digits.length == 7
+
+    @formatted = @digits.dup.insert 5, "-"
+
+    state = lookup_state
+    @state_code = state[:code]
+    @state_name = state[:name]
   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
+  def to_s
+    @formatted
   end
 
   def ==(other)
-    @cep_digits == other.cep_digits
+    @digits == other.digits
   end
 
-  def to_s
-    @cep_formatted
+  def eql?(other)
+    self == other
   end
 
+  private
+
+  def lookup_state
+    SORTED_RANGES.find do |range|
+      @digits.to_i <= range[:range_end]
+    end
+  end
 end

metadata

@@ -1,43 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: codigo_postal
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Felipe Mesquita
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: tldr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-description: Validate, format and get the corresponding Brazilian state for a CEP
-  without making HTTP requests.
+        version: '1.0'
+description: Validate, format, and get the corresponding Brazilian state for a given
+  CEP without making network requests.
 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
@@ -52,9 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An offline gem to find Brazilian states by postal code
-test_files:
-- test/test_codigo_postal.rb
+test_files: []

data/test/test_codigo_postal.rb

@@ -1,131 +0,0 @@
-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 '01001000', 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
-
-  def test_readme_examples
-    assert_output("SP\nSão Paulo\n01001-000\n") do
-      cep = CodigoPostal.new(1001000)
-      puts cep.state_code # => 'SP'
-      puts cep.state_name # => 'São Paulo'
-      puts cep.to_s # => '01001-000'
-    end
-
-    assert_output("true\n") do
-      cep1 = CodigoPostal.new(4094050)
-      cep2 = CodigoPostal.new("04.094-050")
-      puts cep1 == cep2 # => true
-    end
-  end
-
-  def test_strip_whitspace
-    assert_equal CodigoPostal.new('  04.094-050  '), CodigoPostal.new('04.094-050')
-  end
-
-end
-