Class: Postnumer

Inherits:
Object
  • Object
show all
Defined in:
lib/postnumer.rb

Overview

The main Postnumer classs

Constant Summary collapse

VERSION =

The current version of Postnumer

'0.2.1'
POSTNUMERASKRA =

The postal code registry

This is based on the official list of Icelandic postal codes.

See Also:

{
  101..113 => 'Reykjavík',
  116      => 'Reykjavík',
  121..125 => 'Reykjavík',
  127..130 => 'Reykjavík',
  132      => 'Reykjavík',
  161..162 => 'Reykjavík',
  170..172 => 'Seltjarnarnes',
  190..192 => 'Vogar',
  200..203 => 'Kópavogur',
  206      => 'Kópavogur',
  210      => 'Garðabær',
  212      => 'Garðabær',
  220..222 => 'Hafnarfjörður',
  225      => 'Garðabær (Álftanes)',
  230      => 'Reykjanesbær',
  232..233 => 'Reykjanesbær',
  235      => 'Keflavíkurflugvöllur',
  240..241 => 'Grindavík',
  245..246 => 'Sandgerði',
  250..251 => 'Garður',
  260      => 'Reykjanesbær',
  262      => 'Reykjanesbær',
  270..271 => 'Mosfellsbær',
  276      => 'Mosfellsbær',
  300..302 => 'Akranes',
  310..311 => 'Borgarnes',
  320      => 'Reykholt í Borgarfirði',
  340..342 => 'Stykkishólmur',
  345      => 'Flatey á Breiðafirði',
  350..351 => 'Grundafjörður',
  355      => 'Ólafsvík',
  356      => 'Snæfellsbær',
  360      => 'Hellissandur',
  370..371 => 'Búðardalur',
  380..381 => 'Reykhólahreppur',
  400..401 => 'Ísafjörður',
  410      => 'Hnífsdalur',
  415..416 => 'Bolungarvík',
  420..421 => 'Súðavík',
  425..426 => 'Flateyri',
  430..431 => 'Suðureyri',
  450..451 => 'Patreksfjörður',
  460..461 => 'Tálknafjörður',
  465..466 => 'Bíldudalur',
  470..471 => 'Þingeyri',
  500      => 'Staður',
  510..512 => 'Hólmavík',
  520      => 'Drangsnes',
  524      => 'Árneshreppur',
  530..531 => 'Hvammstangi',
  540..541 => 'Blönduós',
  545..546 => 'Skagaströnd',
  550..551 => 'Sauðárkrókur',
  560..561 => 'Varmahlíð',
  565..566 => 'Hofsós',
  570      => 'Fljót',
  580..581 => 'Siglufjörður',
  600..607 => 'Akureyri',
  610      => 'Grenivík',
  611      => 'Grímsey',
  616      => 'Grenivík',
  620..621 => 'Dalvík',
  525..526 => 'Ólafsfjörður',
  630      => 'Hrísey',
  640..641 => 'Húsavík',
  645      => 'Fosshóll',
  650      => 'Laugar',
  660      => 'Mývatn',
  670..671 => 'Kópasker',
  675..676 => 'Raufarhöfn',
  680..681 => 'Þórshöfn',
  685..686 => 'Bakkafjörður',
  690..691 => 'Vopnafjörður',
  700..701 => 'Egilsstaðir',
  710..711 => 'Seyðisfjörður',
  715      => 'Mjóifjörður',
  720..721 => 'Borgarfjörður (eystri)',
  730..731 => 'Reyðarfjörður',
  735..736 => 'Eskifjörður',
  740..741 => 'Neskaupsstaður',
  750..751 => 'Fáskrúðsfjörður',
  755..756 => 'Stöðvarfjörður',
  760..761 => 'Breiðdalsvík',
  765..766 => 'Djúpivogur',
  780..781 => 'Höfn í Hornafirði',
  785      => 'Öræfi',
  800..806 => 'Selfoss',
  810      => 'Hveragerði',
  815      => 'Þorlákshöfn',
  816      => 'Ölfus',
  820      => 'Eyrarbakki',
  825      => 'Stokkseyri',
  840      => 'Laugarvatn',
  845..846 => 'Flúðir',
  850..851 => 'Hella',
  860..861 => 'Hvolsvöllur',
  870..871 => 'Vík',
  880..881 => 'Kirkjubæjarklaustur',
  900      => 'Vestmannaeyjar',
  902      => 'Vestmannaeyjar'
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(postal_code) ⇒ Postnumer

Initialize a Postnumer object

Parameters:

  • postal_code (Integer|String) —

    The 3-digit Icelandic postal code

Raises:

  • (ArgumentError) —

    if the postal code is invalid



190
191
192
193
194
195
196
 
# File 'lib/postnumer.rb', line 190

def initialize(postal_code)
  result = POSTNUMERASKRA.select { |p| p === postal_code.to_i }
  raise ArgumentError, 'Postal code is invalid' if result.empty?

  @code     = postal_code.to_i
  @locality = result.first.last
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



116
117
118
 
# File 'lib/postnumer.rb', line 116

def code
  @code
end

#locality ⇒ Object (readonly)

Returns the value of attribute locality.



116
117
118
 
# File 'lib/postnumer.rb', line 116

def locality
  @locality
end

Class Method Details

.all ⇒ Hash

Get every valid postal code as a hash

Returns:

  • (Hash) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/postnumer.rb', line 123

def self.all
  results = {}
  POSTNUMERASKRA.each do |pnr_range, locality|
    if pnr_range.is_a?(Integer)
      results[pnr_range] = locality
      next
    end
    pnr_range.to_a.each do |pnr|
      results[pnr] = locality
    end
  end
  results
end

.all_options ⇒ Array

Get every postal code as an array of arrays

This is useful for bulding select elements in ActionView and Formtastic.

Returns:

  • (Array)

See Also:



146
147
148
149
150
151
152
 
# File 'lib/postnumer.rb', line 146

def self.all_options
  results = []
  all.each do |pnr, locality|
    results << ["#{pnr} #{locality}", pnr]
  end
  results
end

.locality(postal_code) ⇒ NilClass|String

Get the locality name of a specific postal code

Parameters:

  • postal_code (Integer|String) —

    The 3-digit Icelandic postal code

Returns:

  • (NilClass|String) —

    Returns nil if invalid and the locality name as a string if valid



161
162
163
164
165
166
167
 
# File 'lib/postnumer.rb', line 161

def self.locality(postal_code)
  result = POSTNUMERASKRA.select { |p| p === postal_code.to_i }

  return nil if result.empty?

  result.first.last
end

.valid?(postal_code) ⇒ Boolean

Check the validity of a postal code

If the postal code provided is a string and can be cast to an integer, the resulting integer value will be used to test for validity.

Parameters:

  • postal_code (Integer|String) —

    The 3-digit Icelandic postal code

Returns:

  • (Boolean) —

    True if valid, false if invalid



178
179
180
181
182
 
# File 'lib/postnumer.rb', line 178

def self.valid?(postal_code)
  return true if locality(postal_code.to_i)

  false
end