phone 0.9.9.1 → 0.9.9.3

data/Readme.rdoc

@@ -10,11 +10,11 @@ Or as a Rails plugin
     script/plugin install git://github.com/carr/phone.git
 
 == Initializing
-You can initialize a new phone object with the number, area code and country code.
+You can initialize a new phone object with the number, area code, country code and extension number
 
     Phone.new('5125486', '91', '385')
 or
-    Phone.new(:number => '5125486', :area_code => '91', :country_code => '385')
+    Phone.new(:number => '5125486', :area_code => '91', :country_code => '385', :extension => '143')
 
 == Parsing
 You can create a new phone object by parsing from a string. Phone does it's best to detect the country and area codes:
@@ -61,8 +61,9 @@ When given a string, it interpolates the string with the following fields:
 * %a - area_code (91)
 * %A - area_code with leading zero (091)
 * %n - number (5125486)
-* %n1 - first @@n1_length characters of number (configured through Phone.n1_length), default is 3 (512)
-* %n2 - last characters of number (5486)
+* %f - first @@n1_length characters of number (configured through Phone.n1_length), default is 3 (512)
+* %l - last characters of number (5486)
+* %x - the extension number
 
     pn = Phone.parse('+385915125486')
     pn.to_s # => "+385915125486"
@@ -72,17 +73,35 @@ When given a string, it interpolates the string with the following fields:
 When given a symbol it is used as a lookup for the format in the <tt>Phone.named_formats</tt> hash.
     pn.format(:europe) # => "+385 (0) 91 512 5486"
     pn.format(:us) # => "(234) 123 4567"    
+    pn.format(:default_with_extension) # => "+3851234567x143"    
 
 You can add your own custom named formats like so:
     Phone.named_formats[:short] = '%A/%n1-%n2'    
     pn.format(:short) # => 091/512-5486
 
 = TODO
-Parse testing for different countries. Currently tested on: US, South Africa, Croatia, Slovenia, Hungary, Serbia, 
-Bosnia and Herzegovina, Germany, France.
-    
+Parse testing for different countries. 
+
+Currently tested on: 
+[AU] Australia
+[BA] Bosnia and Herzegovina
+[BE] Belgium
+[DE] Germany
+[FR] France
+[GB] United Kingdom
+[HR] Croatia
+[HU] Hungary
+[NL] Netherlands
+[RS] Serbia
+[SE] Sweden
+[SI] Slovenia
+[UA] Ukraine
+[US] United States
+[ZA] South Africa
+
 = Author
 Copyright © 2010 Tomislav Car, Infinum
 
-Modifications copyright © 2010 Todd Eichel for Fooala, Inc.
+= Contributors
+Don Morrison, Michael Squires, Todd Eichel (Fooala, Inc.), chipiga, Etienne Samson, Luke Randall
 

data/data/phone_countries.yml

@@ -371,6 +371,7 @@
   :char_3_code: NL
   :name: Netherlands
   :international_dialing_prefix: "0"
+  :area_code: "6760|66|6|800|878|8[4578]|90[069]|1[035]|2[0346]|3[03568]|4[0356]|5[0358]|7[0-9]|11[134578]|16[124-8]|17[24]|18[0-467]|22[2-46-9]|25[125]|29[479]|31[3-8]|32[01]|34[1-8]|41[12368]|47[58]|48[15-8]|49[23579]|5[129][1-9]|54[134-8]|56[126]|57[0-3578]"
 "850": 
   :country_code: "850"
   :national_dialing_prefix: "0"
@@ -413,6 +414,7 @@
   :char_3_code: BE
   :name: Belgium
   :international_dialing_prefix: "0"
+  :area_code: "800|90[0-9]|2|3|4|9|1[0-69]|5[0-9]|6[013-9]|7[01]|8[1-9]"
 "965": 
   :country_code: "965"
   :national_dialing_prefix: None
@@ -487,9 +489,10 @@
   :country_code: "61"
   :national_dialing_prefix: "0"
   :char_2_code: "0"
-  :char_3_code: CC
-  :name: Cocos (Keeling) Islands
+  :char_3_code: AU
+  :name: Australia
   :international_dialing_prefix: "11"
+  :area_code: "[234578]"
 "880": 
   :country_code: "880"
   :national_dialing_prefix: "0"
@@ -963,11 +966,12 @@
   :international_dialing_prefix: "0"
 "380": 
   :country_code: "380"
-  :national_dialing_prefix: "8"
-  :char_2_code: "8"
+  :national_dialing_prefix: "0"
+  :char_2_code: "0"
   :char_3_code: UA
   :name: Ukraine
-  :international_dialing_prefix: "810"
+  :international_dialing_prefix: "00"
+  :area_code: "[1-9][0-9]"
 "41": 
   :country_code: "41"
   :national_dialing_prefix: "0"
@@ -1130,6 +1134,7 @@
   :char_3_code: GB
   :name: United Kingdom
   :international_dialing_prefix: "0"
+  :area_code: "2[03489]|11[3-8]|1[2-69]1|1[2-9][0-9]{2}|70|7[0-9]{3}|[8|9][0-9]{2}|3[0-9]{2}"
 "242": 
   :country_code: "242"
   :national_dialing_prefix: None
@@ -1187,6 +1192,7 @@
   :char_3_code: SE
   :name: Sweden
   :international_dialing_prefix: "0"
+  :area_code: "900|1[013689]|2[0136]|3[1356]|4[0246]|54|6[03]|7[01236]|8|9[09]|1[2457][0-9]|2[2457-9][0-9]|3[0247-9][0-9]|4[1357-9][0-9]|5[0-35-9][0-9]|6[124-9][0-9]|74[0-9]|9[1-8][0-9]"
 "386": 
   :country_code: "386"
   :national_dialing_prefix: "0"
@@ -1379,13 +1385,6 @@
   :char_3_code: HN
   :name: Honduras
   :international_dialing_prefix: "0"
-"618": 
-  :country_code: "618"
-  :national_dialing_prefix: "0"
-  :char_2_code: "0"
-  :char_3_code: CX
-  :name: Christmas Island
-  :international_dialing_prefix: "11"
 "250": 
   :country_code: "250"
   :national_dialing_prefix: "0"

data/lib/phone.rb

@@ -9,13 +9,13 @@
 #   Phone.default_country_code
 #   Phone.default_area_code
 #
-require 'active_support/core_ext' # for Class#cattr_accessor, String#present?
+require File.join(File.dirname(__FILE__), 'support') unless defined? ActiveSupport
 require File.join(File.dirname(__FILE__), 'phone_country')
-class Phone    
-  NUMBER = '([^0][0-9]{1,7})$'  
+class Phone
+  NUMBER = '([0-9]{1,8})$'  
   DEFAULT_AREA_CODE = '[2-9][0-8][0-9]' # USA
   
-  attr_accessor :country_code, :area_code, :number
+  attr_accessor :country_code, :area_code, :number, :extension
   
   cattr_accessor :default_country_code
   cattr_accessor :default_area_code  
@@ -28,6 +28,7 @@ class Phone
   
   @@named_formats = {
     :default => "+%c%a%n",
+    :default_with_extension => "+%c%a%nx%x",
     :europe => '+%c (0) %a %f %l',
     :us => "(%a) %f-%l"
   }
@@ -35,14 +36,15 @@ class Phone
   def initialize(*hash_or_args)    
     if hash_or_args.first.is_a?(Hash)
       hash_or_args = hash_or_args.first
-      keys = {:number => :number, :area_code => :area_code, :country_code => :country_code}
+      keys = {:number => :number, :area_code => :area_code, :country_code => :country_code, :extension => :extension}
     else
-      keys = {:number => 0, :area_code => 1, :country_code => 2}
+      keys = {:number => 0, :area_code => 1, :country_code => 2, :extension => 3}
     end
     
     self.number = hash_or_args[ keys[:number] ]
     self.area_code = hash_or_args[ keys[:area_code] ] || self.default_area_code
     self.country_code = hash_or_args[ keys[:country_code] ] || self.default_country_code      
+    self.extension = hash_or_args[ keys[:extension] ]
 
     raise "Must enter number" if self.number.blank?
     raise "Must enter area code or set default area code" if self.area_code.blank?
@@ -54,6 +56,7 @@ class Phone
   def self.parse(string, options={})       
     if string.present?    
       PhoneCountry.load
+      extension = extract_extension(string)
       string = normalize(string)
       
       options[:country_code] ||= self.default_country_code
@@ -62,6 +65,10 @@ class Phone
       parts = split_to_parts(string, options)      
       
       pn = Phone.new(parts) if parts
+      if pn.present? and extension.present?
+        pn.extension = extension
+      end
+      return pn
     end
   end
   
@@ -125,7 +132,7 @@ class Phone
     area_code_regexp = country.area_code || DEFAULT_AREA_CODE
     {
       # 047451588, 013668734
-      :short => Regexp.new('^0(' + area_code_regexp + ')' + NUMBER),
+      :short => Regexp.new('^0?(' + area_code_regexp + ')' + NUMBER),
       # 451588
       :really_short => Regexp.new('^' + NUMBER)
     }    
@@ -138,7 +145,11 @@ class Phone
       arr << format if string_with_number =~ regexp
     end
     
-    raise "Detected more than 1 format for #{string_with_number}" if arr.size > 1
+#    raise "Detected more than 1 format for #{string_with_number}" if arr.size > 1
+    if arr.length > 1
+#      puts %Q{detect_format: more than one format found - #{arr.inspect}}
+      return :really_short
+    end
     arr.first
   end
   
@@ -146,7 +157,29 @@ class Phone
   def self.normalize(string_with_number)
     string_with_number.gsub("(0)", "").gsub(/[^0-9+]/, '').gsub(/^00/, '+')
   end
-  
+
+  # pull off anything that look like an extension
+  #TODO: refactor things so this doesn't change string as a side effect
+  #
+  def self.extract_extension(string)
+    return nil if string.nil?
+    if string.sub! /[ ]*(ext|ex|x|xt|#|:)+[^0-9]*\(*([-0-9]{1,})\)*#?$/i, ''
+      extension = $2
+      return extension
+    end
+    #
+    # We already returned any recognizable extension.
+    # However, we might still have extra junk to the right
+    # of the phone number proper, so just chop it off.
+    #
+    idx = string.rindex(/[0-9]/)
+    return nil if idx.nil?
+    return nil if idx == (string.length - 1)      # at the end
+    string.slice!((idx+1)..-1)                    # chop it
+    return nil
+  end
+
+  # format area_code with trailing zero (e.g. 91 as 091)
   # format area_code with trailing zero (e.g. 91 as 091)
   def area_code_long
     "0" + area_code if area_code
@@ -171,8 +204,9 @@ class Phone
   # * %a - area_code (91)
   # * %A - area_code with leading zero (091)
   # * %n - number (5125486)
-  # * %n1 - first @@n1_length characters of number (configured through Phone.n1_length), default is 3 (512)
-  # * %n2 - last characters of number (5486)
+  # * %f - first @@n1_length characters of number (configured through Phone.n1_length), default is 3 (512)
+  # * %l - last characters of number (5486)
+  # * %x - entire extension
   #
   # if the method argument is a Symbol, it is used as a lookup key for a format String in Phone.named_formats
   #   pn.format(:europe)
@@ -203,11 +237,13 @@ class Phone
   private
   
   def format_number(fmt)
-    fmt.gsub("%c", country_code || "").
+    result = fmt.gsub("%c", country_code || "").
            gsub("%a", area_code || "").
            gsub("%A", area_code_long || "").           
            gsub("%n", number || "").
            gsub("%f", number1 || "").
-           gsub("%l", number2 || "")                          
+           gsub("%l", number2 || "").
+           gsub("%x", extension || "")
+    return result
   end
 end

data/lib/phone_country.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext' # for Class#cattr_accessor
-
 class PhoneCountry < Struct.new(:name, :country_code, :char_2_code, :area_code)
   cattr_accessor :all
   

data/lib/support.rb

@@ -0,0 +1,78 @@
+require 'yaml'
+# support methods to remove dependencies on ActiveSupport
+class String
+  def present?
+    !blank?
+  end
+
+  def blank?
+    if respond_to?(:empty?) && respond_to?(:strip) 
+      empty? or strip.empty? 
+    elsif respond_to?(:empty?) 
+      empty? 
+    else 
+      !self 
+    end     
+  end
+end
+
+class Hash
+  alias_method :blank?, :empty? 
+
+  def present?
+    !blank?
+  end   
+end
+
+class Object
+  def present?
+    self.class!=NilClass
+  end
+end
+
+class NilClass #:nodoc: 
+  def blank? 
+    true 
+  end 
+
+  def present?
+    false
+  end
+end
+
+module Accessorize
+  module ClassMethods
+    def cattr_accessor(*syms)
+      syms.flatten.each do |sym|
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}
+            @@#{sym} = nil
+          end
+
+          def self.#{sym}
+            @@#{sym}
+          end
+
+          def #{sym}=(value)
+            @@#{sym} = value
+          end
+
+          def self.#{sym}=(value)
+            @@#{sym} = value
+          end
+
+          def #{sym}
+            @@#{sym}
+          end
+        EOS
+      end
+    end    
+  end
+
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+  end
+end
+
+Object.send(:include, Accessorize)

data/test/countries/au_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+# 0x 5551 reserved for fictitious use. (not including x=3)
+# 0x 7010 reserved for fictitious use.
+
+## Australia
+class AUTest < Test::Unit::TestCase
+  
+  # 00 Emergency and International access
+  # 01 Alternate phone services
+  # 014 Satellite phone services
+  # 016 Paging [+3D or +6D]
+  # 018 Analogue (AMPS) mobile phone - few numbers still in use [+6D]
+  # 0198 Data networks [+2D or +6D] - e.g. 0198 379 000 is the Dial-Up POP number for iiNet
+  
+  # 02 Central East region (NSW, ACT)
+  def test_central_east
+    parse_test('+61 2 5551 1234', '61', '2', '55511234')
+  end
+  
+  # 03 South-east region (VIC, TAS)
+  def test_south_east
+    parse_test('+61 3 5551 1234', '61', '3', '55511234')
+  end
+  
+  # 04 Mobile services (Digital - GSM, CDMA, 3G)
+  def test_mobile
+    parse_test('+61 4 5551 1234', '61', '4', '55511234')
+  end
+  
+  # 05 Universal/Personal numberings (uncommon)
+  def test_personal
+    parse_test('+61 5 5551 1234', '61', '5', '55511234')
+  end
+  
+  # 07 North-east region (QLD)
+  def test_north_east
+    parse_test('+61 7 5551 1234', '61', '7', '55511234')
+  end
+  
+  # 08 Central and West region (SA, NT, WA)
+  def test_central
+    parse_test('+61 8 5551 1234', '61', '8', '55511234')
+  end
+  
+  # (Geographical region boundaries do not exactly follow state borders.)
+  # 1 Non-geographic numbers
+  
+end

data/test/countries/ba_test.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+## Bosnia and Herzegovina
+class BATest < Test::Unit::TestCase
+  
+  def test_local
+    parse_test('+387 33 25 02 33', '387', '33', '250233')
+  end
+  
+end

data/test/countries/be_test.rb

@@ -0,0 +1,116 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+## Belgium
+class BETest < Test::Unit::TestCase
+  
+  ## single digit
+  # 02:   Brussels (Bruxelles/Brussel)
+  def test_brussels
+    parse_test('+32 2 1234567', '32', '2', '1234567')
+  end
+  # 03:   Antwerpen (Antwerp), Sint-Niklaas
+  def test_antwerpen
+    parse_test('+32 3 1234567', '32', '3', '1234567')
+  end
+  # 04:   Liège (Luik), Voeren (Fourons)
+  def test_liege
+    parse_test('+32 4 1234567', '32', '4', '1234567')
+  end
+  # 09:   Gent (Ghent/Gand)
+  def test_gent
+    parse_test('+32 9 1234567', '32', '9', '1234567')
+  end
+  
+  ## two digit
+  # 010:  Wavre (Waver)
+  def test_wavre
+    parse_test('+32 10 123456', '32', '10', '123456')
+  end
+  # 011:  Hasselt
+  def test_hasselt
+    parse_test('+32 11 123456', '32', '11', '123456')
+  end
+  # 012:  Tongeren (Tongres)
+  def test_tongeren
+    parse_test('+32 12 123456', '32', '12', '123456')
+  end
+  # 013:  Diest
+  def test_diest
+    parse_test('+32 13 123456', '32', '13', '123456')
+  end
+  # 014:  Herentals, Turnhout
+  # 015:  Mechelen (Malines)
+  # 016:  Leuven (Louvain), Tienen (Tirlemont)
+  # 019:  Waremme (Borgworm)
+  def test_waremme
+    parse_test('+32 19 123456', '32', '19', '123456')
+  end
+  
+  # 050:  Brugge (Bruges), Zeebrugge
+  def test_brugge
+    parse_test('+32 50 123456', '32', '50', '123456')
+  end
+  # 051:  Roeselare (Roulers)
+  def test_roeselare
+    parse_test('+32 51 123456', '32', '51', '123456')
+  end
+  # 052:  Dendermonde (Termonde)
+  # 053:  Aalst (Alost)
+  # 054:  Ninove
+  # 055:  Ronse (Renaix)
+  # 056:  Kortrijk (Courtrai), Comines-Warneton, Mouscron (Moeskroen)
+  # 057:  Ieper (Ypres)
+  # 058:  Veurne (Furnes)
+  # 059:  Oostende (Ostend)
+  def test_oostende
+    parse_test('+32 59 123456', '32', '59', '123456')
+  end
+  
+  # 060:  Chimay
+  def test_chimay
+    parse_test('+32 60 123456', '32', '60', '123456')
+  end
+  # 061:  Bastogne, Libramont-Chevigny
+  # 063:  Arlon (Aarlen)
+  # 064:  La Louviere
+  # 065:  Mons (Bergen)
+  # 067:  Nivelles (Nijvel)
+  def test_nivelles
+    parse_test('+32 67 123456', '32', '67', '123456')
+  end
+  # 068:  Ath (Aat)
+  # 069:  Tournai (Doornik)
+  
+  # 070:  Specialty Numbers (i.e. bus information or bank information)
+  def test_specialty
+    parse_test('+32 70 123456', '32', '70', '123456')
+  end
+  # 071:  Charleroi
+  
+  # 081:  Namur (Namen)
+  def test_namur
+    parse_test('+32 81 123456', '32', '81', '123456')
+  end
+  # 082:  Dinant
+  # 083:  Ciney
+  # 084:  Jemelle, Marche-en-Famenne
+  # 085:  Huy
+  # 086:  Durbuy
+  # 087:  Verviers
+  # 089:  Genk
+
+  # 0800: toll free service
+  def test_toll_free
+    parse_test('+32 800 12345', '32', '800', '12345')
+  end
+  
+  # 090x: Premium numbers (0900, 0901, 0902, 0903, 0904, 0905, 0906, 0907, 0908, 0909)
+  def test_premium_900
+    parse_test('+32 900 12345', '32', '900', '12345')
+  end
+  
+  def test_premium_901
+    parse_test('+32 901 12345', '32', '901', '12345')
+  end
+  
+end