phony 1.6.5 → 1.6.6

data/lib/phony.rb

@@ -12,6 +12,8 @@ require File.expand_path '../phony/national_splitters/default', __FILE__
 require File.expand_path '../phony/national_code', __FILE__
 require File.expand_path '../phony/country', __FILE__
 require File.expand_path '../phony/country_codes', __FILE__
+require File.expand_path '../phony/validator', __FILE__
+require File.expand_path '../phony/validators', __FILE__
 require File.expand_path '../phony/dsl', __FILE__
 
 # Countries.
@@ -37,7 +39,8 @@ module Phony
 
   # Phony uses a single country codes instance.
   #
-  @codes = CountryCodes.instance
+  @codes     = CountryCodes.instance
+  @validator = Validators.instance 
 
   class << self
 
@@ -74,6 +77,16 @@ module Phony
     end
     alias formatted  format
     alias formatted! format!
+    
+    # Makes a plausibility check.
+    #
+    # If it returns false, it is not plausible.
+    # If it returns true, it is unclear whether it is plausible,
+    # leaning towards being plausible.
+    #
+    def plausible? number, hints = {}
+      @validator.plausible? number, hints
+    end
 
     # def service? number
     #   @codes.service? number.dup

data/lib/phony/countries.rb

@@ -27,7 +27,9 @@ Phony.define do
 
   # USA, Canada, etc.
   #
-  country '1', fixed(3) >> split(3,4)
+  country '1',
+          fixed(3) >> split(3,4),
+          invalid_ndcs(/911/)
 
   # Kazakhstan (Republic of) & Russian Federation.
   #
@@ -64,31 +66,33 @@ Phony.define do
 
   # Spain.
   #
-  country '34', fixed(2) >> split(3,4)
+  country '34',
+          fixed(2) >> split(3,4)
 
   # Hungary.
   #
   # TODO Mobile.
   #
-  country '36', one_of('104','105','107','112') >> split(3,3) | # Service
-                one_of('1')                     >> split(3,4) | # Budapest
-                fixed(2)                        >> split(3,4)   # 2-digit NDCs
+  country '36',
+          one_of('104','105','107','112') >> split(3,3) | # Service
+          one_of('1')                     >> split(3,4) | # Budapest
+          fixed(2)                        >> split(3,4)   # 2-digit NDCs
 
   # country '39' # Italy, see special file.
 
   # Romania.
   #
-  country '40', match(/^(112|800|90[036])\d+$/) >> split(3,3) | # Service
-                match(/^(7[1-8])\d+$/)          >> split(3,4) | # Mobile
-                one_of('21', '31')              >> split(3,4) | # Bucureşti
-                fixed(3)                        >> split(3,4)   # 3-digit NDCs
+  country '40',
+          match(/^(112|800|90[036])\d+$/) >> split(3,3) | # Service
+          match(/^(7[1-8])\d+$/)          >> split(3,4) | # Mobile
+          one_of('21', '31')              >> split(3,4) | # Bucureşti
+          fixed(3)                        >> split(3,4)   # 3-digit NDCs
 
   # Switzerland.
   #
-  # :service => %w{800 840 842 844 848}, :mobile  => %w{74 76 77 78 79}
-  swiss_service_regex = /^(800|840|842|844|848)\d+$/
-  country '41', match(swiss_service_regex) >> split(3,3) |
-                fixed(2)                   >> split(3,2,2)
+  country '41',
+          match(/^(8(00|40|42|44|48))\d+$/) >> split(3,3) |
+          fixed(2)                          >> split(3,2,2)
 
 
   # country '43' # Austria, see special file.
@@ -96,61 +100,71 @@ Phony.define do
 
   # Denmark.
   #
-  country '45', none >> split(2,2,2,2)
+  country '45',
+          none >> split(2,2,2,2)
 
   # country '46' # Sweden, see special file.
 
   # Norway.
   #
-  country '47', none >> matched_split(/^[1].*$/ => [3], /^[489].*$/ => [3,2,3], :fallback => [2,2,2,2])
+  country '47',
+          none >> matched_split(/^[1].*$/   => [3],
+                                /^[489].*$/ => [3,2,3],
+                                :fallback   => [2,2,2,2])
 
   # Poland (Republic of)
   # Although the NDCs are 2 digits, the representation is 3 digits.
   # Note: http://wapedia.mobi/en/Telephone_numbers_in_Poland, mobile not yet correct
   #
-  country '48', fixed(3) >> split(3,3) # Poland
+  country '48',
+          fixed(3) >> split(3,3) # Poland
 
   # country '49' # Germany, see special file.
 
   # Peru.
   #
-  country '51', one_of('103', '105') >> split(3,3) | # Service.
-                one_of('1', '9')     >> split(4,4) | # Lima and mobile.
-                fixed(2)             >> split(4,4)   # 2-digit NDCs.
+  country '51',
+          one_of('103', '105') >> split(3,3) | # Service.
+          one_of('1', '9')     >> split(4,4) | # Lima and mobile.
+          fixed(2)             >> split(4,4)   # 2-digit NDCs.
 
   # Mexico.
   #
-  country '52', match(/^(0\d{2})\d+$/)   >> split(2,2,2,2) |
-                match(/^(33|55|81)\d+$/) >> split(2,2,2,2) |
-                match(/^(\d{3})\d+$/)    >> split(3,2,2)
+  country '52',
+          match(/^(0\d{2})\d+$/)   >> split(2,2,2,2) |
+          match(/^(33|55|81)\d+$/) >> split(2,2,2,2) |
+          match(/^(\d{3})\d+$/)    >> split(3,2,2)
 
   # Cuba.
   #
-  country '53', match(/^(5\d{3})\d+$/)               >> split(4) | # Mobile
-                match(/^(7|21|22|23|4[1-8]|3[1-3])/) >> split(7) | # Short NDCs
-                fixed(3)                             >> split(7)   # 3-digit NDCs
+  country '53',
+          match(/^(5\d{3})\d+$/)               >> split(4) | # Mobile
+          match(/^(7|21|22|23|4[1-8]|3[1-3])/) >> split(7) | # Short NDCs
+          fixed(3)                             >> split(7)   # 3-digit NDCs
 
   # Argentine Republic.
   #
-  country '54', one_of('11', '911') >> split(4,4) | # Fixed & Mobile
-                match(/^(22[0137]|237|26[14]|29[179]|34[1235]|35[138]|38[1578])/) >> split(3,4) |        # Fixed
-                match(/^(922[0137]|9237|926[14]|929[179]|934[1235]|935[138]|938[1578])/) >> split(3,4) | # Mobile
-                match(/^(9\d{4})/) >> split(2,4) | # Mobile
-                fixed(4) >> split(2,4) # Fixed
+  country '54',
+          one_of('11', '911') >> split(4,4) | # Fixed & Mobile
+          match(/^(22[0137]|237|26[14]|29[179]|34[1235]|35[138]|38[1578])/) >> split(3,4) |        # Fixed
+          match(/^(922[0137]|9237|926[14]|929[179]|934[1235]|935[138]|938[1578])/) >> split(3,4) | # Mobile
+          match(/^(9\d{4})/) >> split(2,4) | # Mobile
+          fixed(4) >> split(2,4) # Fixed
 
   # Brazil (Federative Republic of).
+  # http://en.wikipedia.org/wiki/Telephone_numbers_in_Brazil
   #
   brazilian_service = /^(100|128|190|191|192|193|194|197|198|199)\d+$/
-  country '55', match(brazilian_service) >> split(3,3) | # Service.
-                fixed(2) >> split(4,4)                   # NDCs
-                # :service? => brazilian_service, :mobile? => ?
-                # http://en.wikipedia.org/wiki/Telephone_numbers_in_Brazil
+  country '55',
+          match(brazilian_service) >> split(3,3) | # Service.
+          fixed(2) >> split(4,4)                   # NDCs
 
   # Chile.
   #
-  country '56', match(/^(13[0-79]|14[79])\d+$/) >> split(3,3) | # Service
-                one_of('2', '9')                >> split(8)   | # Santiago, Mobile
-                fixed(2)                        >> split(8)     # 2-digit NDCs
+  country '56',
+          match(/^(13[0-79]|14[79])\d+$/) >> split(3,3) | # Service
+          one_of('2', '9')                >> split(8)   | # Santiago, Mobile
+          fixed(2)                        >> split(8)     # 2-digit NDCs
 
   # TODO Colombia.
   #
@@ -158,14 +172,17 @@ Phony.define do
 
   # Venezuela (Bolivarian Republic of)
   #
-  country '58', fixed(3) >> split(7)
+  country '58',
+          fixed(3) >> split(7)
 
   # country '60' # Malaysia, see special file.
 
   # Australia.
   #
-  country '61', match(/^(4\d\d)\d+$/) >> split(3,3) | # Mobile
-                fixed(1)              >> split(4,4)   # Rest
+  country '61',
+          match(/^(4\d\d)\d+$/) >> split(3,3) | # Mobile
+          fixed(1)              >> split(4,4)   # Rest
+          
   country '62', todo # TODO Indonesia (Republic of)
   country '63', todo # TODO Philippines (Republic of the)
 
@@ -173,16 +190,19 @@ Phony.define do
   #
   # TODO Mobile?
   #
-  country '64', fixed(1) >> split(3,4)
+  country '64',
+          fixed(1) >> split(3,4)
 
   # Singapore (Republic of).
   #
-  country '65', none >> split(4,4) # TODO Short Codes.
+  country '65',
+          none >> split(4,4) # TODO Short Codes.
 
   # Thailand.
   #
-  country '66', one_of('2') >> split(3,4) | # Bangkok
-                fixed(2)    >> split(3,3)   # Rest
+  country '66',
+          one_of('2') >> split(3,4) | # Bangkok
+          fixed(2)    >> split(3,3)   # Rest
 
   country '81', todo # TODO Japan
 
@@ -194,7 +214,8 @@ Phony.define do
 
   # Turkey.
   #
-  country '90', fixed(3) >> split(3,4)   # Wiki says 7, but the examples say 3, 4.
+  country '90',
+          fixed(3) >> split(3,4)   # Wiki says 7, but the examples say 3, 4.
 
   country '91', todo # TODO India (Republic of)
   country '92', todo # TODO Pakistan (Islamic Republic of), http://en.wikipedia.org/wiki/Telephone_numbers_in_Pakistan, NDC 2-5
@@ -264,11 +285,20 @@ Phony.define do
   country '252', todo # Somali Democratic Republic
   country '253', todo # Djibouti
   country '254', fixed(2) >> split(7) # Kenya
-  country '255', match(/^([89]\d\d)/) >> split(3,3) | # Special/Premium. Tanzania
-                 one_of('112', '118') >> split(3,3) | # Short Codes.
-                 fixed(2)             >> split(3,4)   # Geographic.
-  country '256', match(/^(46[45]|4[78]\d)/) >> split(6) | # Geo 1. Uganda
-                 fixed(2)                   >> split(7)   # Geo 2.
+  
+  # Tanzania.
+  #
+  country '255',
+          match(/^([89]\d\d)/) >> split(3,3) | # Special/Premium.
+          one_of('112', '118') >> split(3,3) | # Short Codes.
+          fixed(2)             >> split(3,4)   # Geographic.
+
+  # Uganda.
+  #
+  country '256',
+          match(/^(46[45]|4[78]\d)/) >> split(6) | # Geo 1.
+          fixed(2)                   >> split(7)   # Geo 2.
+          
   country '257', todo # Burundi
   country '258', todo # Mozambique
   country '259', todo # -
@@ -310,10 +340,11 @@ Phony.define do
 
   # Portugal.
   #
-  country '351', one_of('700', '800') >> split(3,3) | # Service.
-                 match(/^(9\d)\d+$/)  >> split(3,4) | # Mobile.
-                 one_of('21', '22')   >> split(3,4) | # Lisboa & Porto
-                 fixed(3)             >> split(3,4)   # 3-digit NDCs
+  country '351',
+          one_of('700', '800') >> split(3,3) | # Service.
+          match(/^(9\d)\d+$/)  >> split(3,4) | # Mobile.
+          one_of('21', '22')   >> split(3,4) | # Lisboa & Porto
+          fixed(3)             >> split(3,4)   # 3-digit NDCs
 
   country '352', todo # Luxembourg
 
@@ -326,19 +357,25 @@ Phony.define do
 
   # Finland.
   #
-  country '358', match(/^([6-8]00)\d+$/)         >> split(3,3)   | # Service
-                 match(/^(4\d|50)\d+$/)          >> split(3,2,2) | # Mobile
-                 one_of('2','3','5','6','8','9') >> split(3,3)   | # Short NDCs
-                 fixed(2)                        >> split(3,3)     # 2-digit NDCs
-  country '359', fixed(2) >> split(3,2,2) # Bulgaria
+  country '358',
+          match(/^([6-8]00)\d+$/)         >> split(3,3)   | # Service
+          match(/^(4\d|50)\d+$/)          >> split(3,2,2) | # Mobile
+          one_of('2','3','5','6','8','9') >> split(3,3)   | # Short NDCs
+          fixed(2)                        >> split(3,3)     # 2-digit NDCs
+          
+  # Bulgaria.
+  #
+  country '359',
+          fixed(2) >> split(3,2,2) # Bulgaria
 
   # Lithuania.
   #
-  country '370', one_of('700', '800')  >> split(2,3)   | # Service
-                 match(/^(6\d\d)\d+$/) >> split(2,3)   | # Mobile
-                 one_of('5')           >> split(3,2,2) | # Vilnius
-                 one_of('37','41')     >> split(2,2,2) | # Kaunas, Šiauliai
-                 fixed(3)              >> split(1,2,2)   # 3-digit NDCs.
+  country '370',
+          one_of('700', '800')  >> split(2,3)   | # Service
+          match(/^(6\d\d)\d+$/) >> split(2,3)   | # Mobile
+          one_of('5')           >> split(3,2,2) | # Vilnius
+          one_of('37','41')     >> split(2,2,2) | # Kaunas, Šiauliai
+          fixed(3)              >> split(1,2,2)   # 3-digit NDCs.
 
   country '371', todo # Latvia
   country '372', todo # Estonia

data/lib/phony/country_codes.rb

@@ -6,7 +6,7 @@ module Phony
   #
   class CountryCodes
 
-    attr_reader   :mapping
+    attr_reader   :splitter_mapping
     attr_accessor :international_absolute_format, :international_relative_format, :national_format
 
     def initialize
@@ -22,11 +22,14 @@ module Phony
       @instance ||= new
     end
 
-    @@normalizing_pattern = /^0+|\D/
-    def normalize number
+    @@basic_normalizing_pattern = /^0+|\D/
+    def clean number
       # Remove non-digit chars.
       #
-      number.gsub! @@normalizing_pattern, EMPTY_STRING
+      number.gsub! @@basic_normalizing_pattern, EMPTY_STRING
+    end
+    def normalize number
+      clean number
       national_handler, cc, rest = split_cc number
       @normalize_format % [cc, national_handler.normalize(rest)]
     end
@@ -102,7 +105,7 @@ module Phony
       presumed_cc = ''
       1.upto(3) do |i|
         presumed_cc << rest.slice!(0..0)
-        national_code_handler = mapping[i][presumed_cc]
+        national_code_handler = splitter_mapping[i][presumed_cc]
         return [national_code_handler, presumed_cc, rest] if national_code_handler
       end
       # This line is never reached as CCs are in prefix code.
@@ -121,9 +124,9 @@ module Phony
       country_code = country_code.to_s
       optimized_country_code_access = country_code.size
 
-      @mapping ||= {}
-      @mapping[optimized_country_code_access] ||= {}
-      @mapping[optimized_country_code_access][country_code] = country
+      @splitter_mapping ||= {}
+      @splitter_mapping[optimized_country_code_access] ||= {}
+      @splitter_mapping[optimized_country_code_access][country_code] = country
     end
 
   end

data/lib/phony/dsl.rb

@@ -46,8 +46,9 @@ module Phony
 
     #
     #
-    def country country_code, country
+    def country country_code, country, validator = nil
       Phony::CountryCodes.instance.add country_code, country
+      Phony::Validators.instance.add country_code, validator if validator
     end
 
     # National matcher & splitters.
@@ -89,6 +90,12 @@ module Phony
     def matched_split options = {}
       Phony::LocalSplitters::Regex.instance_for options
     end
+    
+    # Validators
+    #
+    def invalid_ndcs ndc
+      Validator.new.ndc_check ndc
+    end
 
   end
 

data/lib/phony/validator.rb

@@ -0,0 +1,26 @@
+module Phony
+  
+  class Validator
+  
+    attr_reader :ndc_checks 
+  
+    def initialize
+      @ndc_checks = []
+    end
+  
+    def plausible? ndc, rest
+      ndc_checks && ndc_checks.each do |ndc_check|
+        return false if ndc_check === ndc
+      end
+      
+      true
+    end
+  
+    def ndc_check ndc
+      @ndc_checks << ndc
+      self
+    end
+    
+  end
+  
+end

data/lib/phony/validators.rb

@@ -0,0 +1,77 @@
+# # Number: A possible phone number, E164 or not.
+# # Hints: Information that helps or constricts the plausibility check.
+# #
+# plausible? number, hints = {}
+#
+
+# plausible? number # Uses the definitions from the country definition to plausibility check.
+# plausible? number, cc: 1 # => Checks cc.
+# plausible? number, pattern: /[^5]/ # Uses def, checks against split.
+# plausible? number, country: 1, pattern: [3, 4, 3] # Uses given country – adds cc.
+#
+
+# Basic plausibility is:
+# * Max digits are 15.
+# * Min digits are 2 (?)
+#
+
+module Phony
+  
+  class Validators
+    
+    def initialize
+      @validators = {}
+    end
+    
+    def self.instance
+      @instance ||= new
+    end
+    
+    # Add a specific country validator.
+    #
+    def add cc, validator
+      @validators[cc] = validator
+    end
+    
+    # Is the given number plausible?
+    #
+    def plausible? number, hints = {}
+      normalized = CountryCodes.instance.clean number
+      
+      # False if it fails the basic check.
+      #
+      return false unless (2..15) === normalized.size
+      
+      # Hint based checking.
+      #
+      cc, ndc, *rest = Phony.split normalized
+      
+      # CC.
+      #
+      cc_needed = hints[:cc]
+      return false if cc_needed && cc_needed != cc
+      
+      # NDC.
+      #
+      ndc_needed = hints[:ndc]
+      return false if ndc_needed && ndc_needed != ndc
+      
+      # Country specific checks.
+      #
+      validator = validator_for cc
+      validator.plausible? ndc, rest
+    rescue StandardError
+      return false
+    end
+    
+    def validator_for cc
+      @validators[cc] || default_validator
+    end
+    
+    def default_validator
+      @default_validator ||= Validator.new
+    end
+    
+  end
+  
+end

data/spec/lib/phony/validations_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe 'validations' do
+
+  describe 'plausible?' do
+
+    it "is correct" do
+      Phony.plausible?('0000000').should be_false
+    end
+    it "is correct" do
+      Phony.plausible?('hello').should be_false
+    end
+    
+    it "is correct" do
+      Phony.plausible?('+41 44 111 22 33').should be_true
+    end
+    it "is correct for explicit checks" do
+      Phony.plausible?('+41 44 111 22 33', cc: '41').should be_true
+    end
+    it "is correct for explicit checks" do
+      Phony.plausible?('+41 44 111 22 33', ndc: '44').should be_true
+    end
+    it "is correct for explicit checks" do
+      Phony.plausible?('+41 44 111 22 33', cc: '1').should be_false
+    end
+    it "is correct for explicit checks" do
+      Phony.plausible?('+41 44 111 22 33', ndc: '43').should be_false
+    end
+    
+    context 'countries' do
+      
+      it "is correct for US numbers" do
+        Phony.plausible?('1-800-692-7753').should be_true
+        Phony.plausible?('1-911').should be_false
+      end
+      
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phony
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.6.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000 Z
+date: 2012-03-18 00:00:00.000000000 Z
 dependencies: []
 description: ! 'Fast international phone number (E164 standard) normalizing, splitting
   and formatting. Lots of formatting options: International (+.., 00..), national
@@ -43,6 +43,8 @@ files:
 - lib/phony/national_splitters/none.rb
 - lib/phony/national_splitters/regex.rb
 - lib/phony/national_splitters/variable.rb
+- lib/phony/validator.rb
+- lib/phony/validators.rb
 - lib/phony/vanity.rb
 - lib/phony.rb
 - README.textile
@@ -57,6 +59,7 @@ files:
 - spec/lib/phony/national_splitters/none_spec.rb
 - spec/lib/phony/national_splitters/regex_spec.rb
 - spec/lib/phony/national_splitters/variable_spec.rb
+- spec/lib/phony/validations_spec.rb
 - spec/lib/phony/vanity_spec.rb
 - spec/lib/phony_spec.rb
 homepage: http://github.com/floere/phony
@@ -96,5 +99,6 @@ test_files:
 - spec/lib/phony/national_splitters/none_spec.rb
 - spec/lib/phony/national_splitters/regex_spec.rb
 - spec/lib/phony/national_splitters/variable_spec.rb
+- spec/lib/phony/validations_spec.rb
 - spec/lib/phony/vanity_spec.rb
 - spec/lib/phony_spec.rb