phony 2.15.0 → 2.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5773702ad69699c8cefd3a0001d444b341f44582
-  data.tar.gz: e9550ac45100b93cb5ea04e328f0e7d1b6b45916
+SHA256:
+  metadata.gz: f2e0337c11693c028c028c978936d9753067bab16cceb1deba77f39e535fbb50
+  data.tar.gz: 45468532f0d66381ce8b52f8c500881ee6a34f134450f6ffac5b57193c1d4323
 SHA512:
-  metadata.gz: 809eec8aa6c21b477bca405d453303fd3ddb5b32960253c092d0fa107a47ad742b9326a518dab360a04aa50afb1b12c6cd95a7c26f3d2d6acdc4d9f36f4bdf9b
-  data.tar.gz: 55ba7177b59174f902c988ceccd54db3df53c840a325ea6ed0e25dee9464e366ac62adfa7b3d01b35f4c02cdd1daab54ff4502408d5cf757cd2e9c1fea1e3533
+  metadata.gz: 1c2ad0d4272a0eaf808bc95f8ace53b1d3c5f7fe2718bd555547b5611915eee4a5f34ea968ef7ebe8fb7b4b8cb86b9040b8af48a8181a7d287a9a39d9906f312
+  data.tar.gz: 0a2e811f7f43f4e357fbe384381565a884073d98e6f1376664df1f457cf210dc759bf50c140749e7447cb034cc40e9d2916a77d3c7555df7f922fa5f522652f0

data/README.textile

@@ -5,29 +5,29 @@
 
 h1. Phony
 
-Disclaimer: Phony works with international numbers only, such as @+61 412 345 678@!
+Disclaimer: Phony works with international numbers only, such as @61 412 345 678@!
 
 The (admittedly crazy) goal of this Gem is to be able to normalize/format/split all phone numbers in the world.
 
 Used in: "airbnb.com":http://airbnb.com, "socialcam.com":http://socialcam.com, "zendesk.com":http://www.zendesk.com/ (and many, many others).
 
-h2. Runtime Memory Usage
+h2(#memory). Runtime Memory Usage
 
-According to "memory_profiler":https://github.com/SamSaffron/memory_profiler, the Phony gem uses roughly 1 MB of memory per Ruby process.
-Usage was generated using: @ruby -e 'require "memory_profiler"; MemoryProfiler.report(allow_files: "phony"){ require "phony" }.pretty_print'@
+According to "memory_profiler":https://github.com/SamSaffron/memory_profiler, the Phony gem uses roughly 1MB of memory per Ruby process.
+Usage was generated using (look for @Total retained@): @ruby -e 'require "memory_profiler"; MemoryProfiler.report(allow_files: "phony"){ require "phony" }.pretty_print'@
 
 h2. Description
 
 This gem normalizes, formats and splits "*E164 phone numbers*":http://en.wikipedia.org/wiki/E.164. A valid E164 phone number *must* include a country code.
 
-E164 numbers are international numbers with a country dial prefix, usually an area code and a subscriber number. For example, the Austalian number number @+61 412 345 678@ can be broken down into the following components:
+E164 numbers are international numbers with a country dial prefix, usually an area code and a subscriber number. For example, the Australian number @+61 412 345 678@ can be broken down into the following components:
 * Country Code (CC): a country code of @61@
 * National Destination Code (NDC): a mobile number denoted by the @4@ (specific to Australia)
 * Local Number Part: a subscriber number of @12 345 678@
 
 It currently handles the countries listed at the end of this README.
 
-It is covered by roughly 1,800 tests (June 2015).
+It is covered by roughly 2,250 tests that run in 2 seconds (April 2019).
 If it doesn't work, please "enter an issue":http://github.com/floere/phony/issues or better, fork and "send a pull request":http://github.com/floere/phony/pulls.
 
 h2. Installation
@@ -78,9 +78,37 @@ NB If a country does not have an NDC, @#split@ will return @false@ in the NDC po
 
 @Phony.split('4512121212').assert == ['45', false, '12', '12', '12', '12']@
 
+h3(#loading). Loading only a country subset (Phony 2.18.0+).
+
+Use this in case you'd like to save "memory":#memory that is used by Phony's CC rules.
+
+"Phony::Config.load docs":./qed/config.md
+
+First, @require 'phony/config'@.
+Then, one of the following, which will load the rest of Phony.
+
+Load only these CCs:
+@Phony::Config.load(only: ['41', '44'])@
+
+Loads everything except these CCs:
+@Phony::Config.load(except: ['41', '44'])@
+
+Convenience form of @only@:
+@Phony::Config.load('41', '44')@
+
+Each of these loads the rest of Phony.
+
+Memory usage can be checked using (look for @Total retained@):
+@ruby -e 'require "memory_profiler"; MemoryProfiler.report(allow_files: "phony"){ require "phony/config"; Phony::Config.load("1") }.pretty_print'@
+For example, when just loading the NANP CC, the retained memory usage is ~63kB.
+
 h2. List of Handled Countries
 
-Mildly unmaintained list: Abhas, Afghan, Algerian, Argentinan, Austrian, Australian, Azerbaijani, Belgian, Brazilian, Cambodian, Chilean, Chinese, Croatian, Cuban, Cypriot, Czech, Danish, Dutch, Egyptian, El Salvadorian, Estonian, French, German, Ghanan, Gibraltar, Greek, Haiti, Hong Kong, Hungarian, Indian, Iran, Irish, Israel, Italian, Kazakh, Liberian, Lithuanian, Luxembourgian, Malaysian, Malta, Mexican, Monaco, Morocco, New Zealand, Nigerian, Norwegian, Peruvian, Polish, Romanian, Russian, Rwandan, Seychelles, Singapore, Slovakian, South African, South Korean, South Osetian, Spanish, Sri Lankan, Sudan, Swedish, Swiss, Thailand, Tunisian, Turkish, Liechtenstein, UK, US, Venezuelan, Vietnamese, and Zambian numbers.
+Mildly unmaintained list: Abhas, Afghan, Algerian, Argentina, Austrian, Australian, Azerbaijani, Belgian, Brazilian, Cambodian, Chilean, Chinese, Croatian, Cuban, Cypriot, Czech, Danish, Dutch, Egyptian, El Salvadorian, Estonian, French, German, Ghanan, Gibraltar, Greek, Haiti, Hong Kong, Hungarian, Indian, Iran, Irish, Israel, Italian, Japanese, Kazakh, Liberian, Lithuanian, Luxembourgian, Malaysian, Malta, Mexican, Monaco, Morocco, New Zealand, Nigerian, Norwegian, Peruvian, Polish, Romanian, Russian, Rwandan, Seychelles, Singapore, Slovakian, South African, South Korean, South Osetian, Spanish, Sri Lankan, Sudan, Swedish, Swiss, Thailand, Tunisian, Turkish, Liechtenstein, UK, US, Venezuelan, Vietnamese, and Zambian numbers.
+
+h2. Proud Sponsors
+
+* Renuo AG (July 22 –): "Github":https://github.com/renuo, "Homepage":https://www.renuo.ch
 
 h2. License
 

data/lib/phony/config.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Phony
+  
+  # Add config.
+  class << self
+    attr_writer :config
+    
+    def config
+      # Default config includes all CCs.
+      @config ||= Config.new([], [])
+    end
+  end
+  
+  # The Config class is only used to configure Phony and to load specific
+  # subsets of CCs.
+  #
+  class Config
+    
+    attr_reader :included_ccs, :excluded_ccs
+    
+    def initialize included_ccs, excluded_ccs
+      @included_ccs = included_ccs || []
+      @excluded_ccs = excluded_ccs || []
+    end
+    
+    def load? cc
+      return false if has_excluded? && excluded_ccs.include?(cc)
+      
+      if has_included?
+        # We have to check the included_ccs, otherwise false.
+        return true if included_ccs.include?(cc)
+        
+        false
+      else
+        # It's not in excluded and no included was given.
+        true
+      end
+    end
+    def has_included?
+      !included_ccs.empty?
+    end
+    def has_excluded?
+      !excluded_ccs.empty?
+    end
+    
+    # Use as follows:
+    #
+    #   require 'phony/config'
+    #   
+    #   # Load only these:
+    #   Phony::Config.load(only: ['41', '44'])
+    #   # or all except these:
+    #   Phony::Config.load(except: ['41', '44'])
+    #   # or "only", in short form.
+    #   Phony::Config.load('41', '44')
+    #   # or even shorter form:
+    #   Phony::Config.load(41, 44)
+    #
+    def self.load *options
+      # Extract options.
+      last = options.last
+      only, except = if last.respond_to?(:to_hash)
+        # We have the explicit form.
+        [last[:only], last[:except]]
+      elsif options.respond_to?(:to_ary)
+        # We have the convenience short forms.
+        [options, []]
+      end
+      
+      # Set defaults.
+      only, except = [only || [], except || []]
+      # Convert to expected format if possible.
+      only, except = [only.map(&:to_s), except.map(&:to_s)]
+      
+      # Check params.
+      raise "Params given to Phony::Config.load must be Array-like. The one given was: #{only}" unless only.respond_to?(:to_ary)
+      raise "Params given to Phony::Config.load must be Array-like. The one given was: #{except}" unless except.respond_to?(:to_ary)
+      
+      # Configure Phony.
+      Phony.config = new(only, except)
+      
+      # Load phony.
+      Kernel.load File.expand_path('../../phony.rb', __FILE__)
+      
+      # Return the stored config data.
+      Phony.config
+    end
+    
+  end
+end

data/lib/phony/countries/argentina.rb

@@ -0,0 +1,355 @@
+# frozen_string_literal: true
+
+# Argentinian numbers are all ten digits long.
+# Information taken from:
+# https://www.enacom.gob.ar/multimedia/normativas/1997/Resolucion%2046_97.pdf
+# http://www.wtng.info/wtng-54-ar.html
+# https://en.wikipedia.org/wiki/Telephone_numbers_in_Argentina
+# Area codes collected from https://www.enacom.gob.ar/indicativos-interurbanos_p366 (06/27/19)
+
+
+# Landline
+area_codes_2digits = [
+    '11',
+]
+
+area_codes_3digits = [
+    '220',
+    '221',
+    '223',
+    '230',
+    '236',
+    '237',
+    '249',
+    '260',
+    '261',
+    '263',
+    '264',
+    '266',
+    '280',
+    '291',
+    '294',
+    '297',
+    '298',
+    '299',
+    '336',
+    '341',
+    '342',
+    '343',
+    '345',
+    '348',
+    '351',
+    '353',
+    '358',
+    '362',
+    '364',
+    '370',
+    '376',
+    '379',
+    '380',
+    '381',
+    '383',
+    '385',
+    '387',
+    '388',
+]
+
+area_codes_4digits = [
+    '2202',
+    '2221',
+    '2223',
+    '2224',
+    '2225',
+    '2226',
+    '2227',
+    '2229',
+    '2241',
+    '2242',
+    '2243',
+    '2244',
+    '2245',
+    '2246',
+    '2252',
+    '2254',
+    '2255',
+    '2257',
+    '2261',
+    '2262',
+    '2264',
+    '2265',
+    '2266',
+    '2267',
+    '2268',
+    '2271',
+    '2272',
+    '2273',
+    '2274',
+    '2281',
+    '2283',
+    '2284',
+    '2285',
+    '2286',
+    '2291',
+    '2292',
+    '2296',
+    '2297',
+    '2302',
+    '2314',
+    '2316',
+    '2317',
+    '2320',
+    '2323',
+    '2324',
+    '2325',
+    '2326',
+    '2331',
+    '2333',
+    '2334',
+    '2335',
+    '2336',
+    '2337',
+    '2338',
+    '2342',
+    '2343',
+    '2344',
+    '2345',
+    '2346',
+    '2352',
+    '2353',
+    '2354',
+    '2355',
+    '2356',
+    '2357',
+    '2358',
+    '2392',
+    '2393',
+    '2394',
+    '2395',
+    '2396',
+    '2473',
+    '2474',
+    '2475',
+    '2477',
+    '2478',
+    '2622',
+    '2624',
+    '2625',
+    '2626',
+    '2646',
+    '2647',
+    '2648',
+    '2651',
+    '2655',
+    '2656',
+    '2657',
+    '2658',
+    '2901',
+    '2902',
+    '2903',
+    '2920',
+    '2921',
+    '2922',
+    '2923',
+    '2924',
+    '2925',
+    '2926',
+    '2927',
+    '2928',
+    '2929',
+    '2931',
+    '2932',
+    '2933',
+    '2934',
+    '2935',
+    '2936',
+    '2940',
+    '2942',
+    '2945',
+    '2946',
+    '2948',
+    '2952',
+    '2953',
+    '2954',
+    '2962',
+    '2963',
+    '2964',
+    '2966',
+    '2972',
+    '2982',
+    '2983',
+    '3327',
+    '3329',
+    '3382',
+    '3385',
+    '3387',
+    '3388',
+    '3400',
+    '3401',
+    '3402',
+    '3404',
+    '3405',
+    '3406',
+    '3407',
+    '3408',
+    '3409',
+    '3435',
+    '3436',
+    '3437',
+    '3438',
+    '3442',
+    '3444',
+    '3445',
+    '3446',
+    '3447',
+    '3454',
+    '3455',
+    '3456',
+    '3458',
+    '3460',
+    '3462',
+    '3463',
+    '3464',
+    '3465',
+    '3466',
+    '3467',
+    '3468',
+    '3469',
+    '3471',
+    '3472',
+    '3476',
+    '3482',
+    '3483',
+    '3487',
+    '3489',
+    '3491',
+    '3492',
+    '3493',
+    '3496',
+    '3497',
+    '3498',
+    '3521',
+    '3522',
+    '3524',
+    '3525',
+    '3532',
+    '3533',
+    '3537',
+    '3541',
+    '3542',
+    '3543',
+    '3544',
+    '3546',
+    '3547',
+    '3548',
+    '3549',
+    '3562',
+    '3563',
+    '3564',
+    '3571',
+    '3572',
+    '3573',
+    '3574',
+    '3575',
+    '3576',
+    '3582',
+    '3583',
+    '3584',
+    '3585',
+    '3711',
+    '3715',
+    '3716',
+    '3718',
+    '3721',
+    '3725',
+    '3731',
+    '3734',
+    '3735',
+    '3741',
+    '3743',
+    '3751',
+    '3754',
+    '3755',
+    '3756',
+    '3757',
+    '3758',
+    '3772',
+    '3773',
+    '3774',
+    '3775',
+    '3777',
+    '3781',
+    '3782',
+    '3786',
+    '3821',
+    '3825',
+    '3826',
+    '3827',
+    '3832',
+    '3835',
+    '3837',
+    '3838',
+    '3841',
+    '3843',
+    '3844',
+    '3845',
+    '3846',
+    '3854',
+    '3855',
+    '3856',
+    '3857',
+    '3858',
+    '3861',
+    '3862',
+    '3863',
+    '3865',
+    '3867',
+    '3868',
+    '3869',
+    '3873',
+    '3876',
+    '3877',
+    '3878',
+    '3885',
+    '3886',
+    '3887',
+    '3888',
+    '3891',
+    '3892',
+    '3894',
+]
+
+# Mobile
+# Mobile phone numbers in Argentina are assigned the same geographic area codes as fixed lines,
+# according to the subscriber's choice or residence, and can be 6, 7 or 8 digits long, just as
+# landline numbers are. The difference with landline numbers is that a prefix 15, never used for
+# landlines, must be dialed.
+
+
+
+# International: +54 + 9 + area code + subscriber number (without '15' prefix)
+# Domestic: area code + 15 + subscriber number
+# Mobile numbers in Argentina may be listed as 15-xxxxxxx. However, the leading '15'
+# is a domestic prefix which must be omitted when calling these from outside Argentina,
+# with the xxxxxxx being the actual subscriber number portion.
+
+# Non-geographic numbers 0ppp-nnn-nnnn
+special_numbers = [
+  '800', # toll-free telephone numbers
+  '810', # calls from any area chargeable at local rate
+  '822', # toll-free numbers used for calling card access
+  '600', # premium-rate telephone numbers
+  '609', # premium, fixed-rate gaming numbers
+  '610', # dial-up Internet access numbers, usually cheaper than a local call, less frequently used as dial-up Internet access decreased
+  '605', # premium-rate telephone numbers for charity donations
+]
+
+Phony.define do
+  country '54', trunk('0')                                |
+      one_of(area_codes_4digits) >> split(2, 4) | # landline
+      one_of(area_codes_3digits) >> split(3, 4) | # landline
+      one_of(area_codes_2digits) >> split(4, 4) | # landline
+      one_of(area_codes_2digits.map{|x| "9#{x}" }) >> split(4, 4) | # mobile
+      one_of(area_codes_3digits.map{|x| "9#{x}" }) >> split(3, 4) | # mobile
+      one_of(area_codes_4digits.map{|x| "9#{x}" }) >> split(2, 4) | # mobile
+      one_of(special_numbers)            >> split(3, 4)
+end

data/lib/phony/countries/austria.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Austria uses a variable-length ndc code, thus we use a separate file to not let all_other.rb explode.
 #
 ndcs = [
@@ -10,20 +12,22 @@ ndcs = [
  '732'  # Linz
 ]
 
+corporate_2digit = [
+  '57',
+  '59'
+]
+
 corporate = [
-  '57',  # -
-  '59',  # -
-  '501', # -
-  '502', # -
-  '503', # -
-  '504', # -
-  '505', # -
-  '506', # -
-  '507', # -
-  '508', # -
-  '509', # -
-  '517', # -
-  '720', #
+  '501',
+  '502',
+  '503',
+  '504',
+  '505',
+  '506',
+  '507',
+  '508',
+  '509',
+  '517'
 ]
 
 mobile = [
@@ -43,10 +47,14 @@ mobile = [
  '667',
  '668',
  '669',
+ '670',
  '676',
+ '677',
+ '678',
  '680',
  '681',
  '688',
+ '690',
  '699',
 ]
 
@@ -64,7 +72,6 @@ service = [
  '730',
  '740',
  '780',
- '800',
  '802',
  '804',
  '810',
@@ -78,18 +85,21 @@ service = [
  '939'
 ]
 
-# https://www.rtr.at/en/tk/E129/2312_Austrian_Numbering_Plan_2011-03-30.pdf
+# https://www.rtr.at/en/tk/E129/Austrian_Numbering_Plan_2011-03-30.pdf
 #
 # TODO Add more details.
 #
 Phony.define do
-  country '43', trunk('0') |
-                one_of('1')       >> split(3..12) | # Vienna
-                one_of(service)   >> split(9..9) |
-                one_of(corporate) >> split(5..5) |
-                one_of(ndcs)      >> split(6..6) |
-                one_of('663')     >> split(6..6) | # 6 digit mobile.
-                one_of(mobile)    >> split(4,3..9) |
-                one_of(mobile_2digit) >> split(7..7) | # Separate as mobile contains 676 - 67 violates the prefix rule.
-                fixed(4)          >> split(3..9) # Number length is 7..13.
+  country '43', trunk('0')                                |
+                one_of('1')              >> split(3..12)  | # Vienna
+                one_of(service)          >> split(9..9)   |
+                one_of('720')            >> split(6..10)  | # VoIP number length is 9..13
+                one_of('800')            >> split(6..10)  | # Free number length is 9..13
+                one_of(corporate_2digit) >> split(3..11)  | # Corporate number length is 5..13
+                one_of(corporate)        >> split(2..10)  | # Corporate number length is 5..13
+                one_of(ndcs)             >> split(5..10)  |
+                one_of('663')            >> split(6..8)   | # 6..8 digit mobile.
+                one_of(mobile)           >> split(4,3..9) |
+                one_of(mobile_2digit)    >> split(7..7)   | # Separate as mobile contains 676 - 67 violates the prefix rule.
+                fixed(4)                 >> split(3..9)     # Number length is 7..13.
 end

data/lib/phony/countries/bangladesh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Bangladesh (People's Republic of)
 # https://www.numberingplans.com
 

data/lib/phony/countries/belarus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Belarus
 # http://www.eng.beltelecom.by/en/subscribers/phone-codes
 # https://www.numberingplans.com

data/lib/phony/countries/brazil.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Brazilian phone numbers.
 #
 #
@@ -87,17 +89,17 @@
  # 98 #Maranhão
  # 99 #Maranhão
 
-ndcs = /(11|12|13|14|15|16|17|18|19|21|22|24|27|28|31|32|33|34|35|36|37|38|41|42|43|44|45|46|47|48|49|51|52|53|54|55|61|62|63|64|65|66|67|68|69|71|72|73|74|75|77|78|79|81|82|83|84|85|86|87|88|89|91|92|93|94|95|96|97|98|99)\d{8}/
+ndcs = "(11|12|13|14|15|16|17|18|19|21|22|24|27|28|31|32|33|34|35|36|37|38|41|42|43|44|45|46|47|48|49|51|52|53|54|55|61|62|63|64|65|66|67|68|69|71|72|73|74|75|77|78|79|81|82|83|84|85|86|87|88|89|91|92|93|94|95|96|97|98|99)"
 
 service = %w{ 100 128 190 191 192 193 194 197 198 199 } # State specific numbers were not added. See http://www.brasil.gov.br/navegue_por/aplicativos/agenda
 
 special_numbers_3_4 = %w{ 0800 }
-special_numbers_4 = %w{ 3003 4004 4020 }
+special_numbers_4 = %w{ 3003 4003 4004 4020 }
 
 Phony.define do
   country '55',
-    match(/^(11|12|13|14|15|16|17|18|19|21|22|24|27|28|81|82|83|84|85|86|87|88|89|91|92|93|94|95|96|97|98|99)9\d{8}$/) >> split(5,4) |
-    match(ndcs)                  >> split(4,4) |
+    match(/^#{ndcs}9\d{8}$/)     >> split(5,4) |
+    match(/^#{ndcs}\d{8}$/)      >> split(4,4) |
     one_of(special_numbers_3_4)  >> split(3,4) |
     one_of(special_numbers_4)    >> split(4) |
     one_of(service)              >> split(3) |