phony 1.9.0 → 2.0.0.beta1

data/lib/phony/countries/uruguay.rb

@@ -0,0 +1,51 @@
+# Uruguay (Eastern Republic of)
+# https://www.numberingplans.com/?page=dialling&sub=areacodes
+# https://www.numberingplans.com/?page=plans&sub=phonenr&alpha_2_input=UY
+
+ndcs_with_7_subscriber_numbers = %w(2 4)
+
+ndcs_with_6_subscriber_numbers = %w(
+21
+22
+23
+24
+25
+26
+27
+29
+42
+)
+
+ndcs_with_5_subscriber_numbers = %w(
+433
+434
+436
+437
+438
+443
+444
+445
+447
+452
+453
+455
+462
+463
+464
+472
+473
+)
+
+
+Phony.define do
+  country '598',
+          one_of('800') >> split(3,2) | # freephone
+          one_of('805') >> split(3,2) | # shared cost
+          one_of(%w(900 901 902 903 904 905 906 907 908)) >> split(3,2) | # premium rate
+          one_of('909') >> split(3,2) | # ISP
+          one_of(ndcs_with_5_subscriber_numbers) >> split(3,2) |
+          one_of(ndcs_with_6_subscriber_numbers) >> split(3,3) |
+          one_of(%w(93 94 95 96 97 98 99)) >> split(3,3) | # mobile
+          one_of(ndcs_with_7_subscriber_numbers) >> split(3,4) |
+          fixed(2) >> split(3,3)
+end

data/lib/phony/countries/zimbabwe.rb

@@ -0,0 +1,37 @@
+# Zimbabwe, https://www.numberingplans.com/?page=plans&sub=phonenr&alpha_2_input=ZW
+
+Phony.define do
+  country '263',
+          one_of(%w(2582 2583 5483)) >>
+              matched_split(/\A\d{6}\z/ => [3,3],
+                            /\A\d+\z/ => [3] ) | # geographic [XXXX] XXX(XXX)
+              one_of(%w(147 204 205 222 227 228 238 248 2582 2583 271 272 274 276 281 283
+                      284 286 287 288 289 298 308 317 371 375 376 379 383 387 389 517 518
+                      557 558 628 637 667 668 687 688 698 848)) >>
+                  matched_split(/\A\d{6}\z/ => [3,3],
+                                /\A\d+\z/ => [3] ) | # geographic [XXX] XXX(XXX)
+              one_of(%w(270)) >>
+                  matched_split(/\A\d{6}\z/ => [3,3],
+                                /\A\d+\z/ => [3,2] ) | # geographic [XXX] XXXXX(X)
+              one_of(%w(273 275 277 278 279 282 285)) >>
+                  matched_split(/\A\d{6}\z/ => [3,3],
+                                /\A\d+\z/ => [2,2] ) | # geographic [XXX] XXXX(XX)
+              one_of(%w(912)) >>
+                  matched_split(/\A\d{8}\z/ => [4,4], /\A\d+\z/ => [3]) | # mobile
+              one_of(%w(13 14 15 16 17 18 19 21 24 26 29 30 31 32 34 35 36 50 55 57 58 59 60
+                      63 64 65 66 69)) >>
+                  matched_split(/\A\d{6}\z/ => [3,3],
+                                /\A\d+\z/ => [3] ) | # geographic [XX] XXX(XXX)
+              one_of(%w(20)) >>
+                  matched_split(/\A\d{6}\z/ => [3,3],
+                                /\A\d+\z/ => [3,2] ) | # geographic [XXX] XXXXX(X)
+              one_of(%w(25 33 39 51 52 53 54 56 61 62 67 68 )) >>
+                  matched_split(/\A\d{6}\z/ => [3,3],
+                                /\A\d+\z/ => [2,2] ) | # geographic [XXX] XXXX(XX)
+              one_of(%w(86)) >> split(4,4) | # VoIP telephony
+              one_of(%w(71 73 77)) >> split(4,3) | # mobile
+              one_of(%w(4 9)) >>
+                  matched_split(/\A\d{6}\z/ => [4,4],
+                                /\A\d+\z/ => [3,2] ) | # geographic [X] XXXXX(XXX)
+              fixed(2) >> split(3,3)
+end

data/lib/phony/country.rb

@@ -19,6 +19,14 @@ module Phony
       self
     end
     
+    # Options.
+    #
+    # TODO Rewrite.
+    #
+    def with options = {}
+      @invalid_ndcs = options[:invalid_ndcs] || []
+    end
+    
     # A number is split with the code handlers as given in the initializer.
     #
     # Note: If the ndc is nil, it will not return it.
@@ -29,6 +37,12 @@ module Phony
         return [zero, ndc, *rest] if rest && !rest.empty?
       end
     end
+    def split_ndc national_number
+      @codes.each do |code|
+        zero, ndc, *rest = code.split national_number
+        return [code.local_splitter, zero, ndc, *rest] if rest && !rest.empty?
+      end
+    end
     
     # Removes 0s from partially normalized numbers
     # such as 410443643533.
@@ -46,6 +60,33 @@ module Phony
       return nil
     end
     
+    # Tests for plausibility of this national number.
+    #
+    def plausible? rest, hints = {}
+      local, _, ndc, *rest = split_ndc rest
+      
+      # Element based checking.
+      #
+      # Note: ndc == false means the country has none.
+      #
+      return false if ndc.nil?
+      return false if ndc && ndc.empty?
+      return false if @invalid_ndcs.include? ndc # TODO Refactor.
+      
+      # # A valid range for the rest is 0 or 3+ total digits.
+      # #
+      # return false if (1..2) === rest_size
+      
+      # National destination code plausible?
+      #
+      ndc_needed = hints[:ndc]
+      return false if ndc_needed && !(ndc_needed === ndc)
+      
+      # Local code specific checks.
+      #
+      return local.plausible? rest, hints
+    end
+    
     # Is this national number a vanity number?
     #
     def vanity? national_number

data/lib/phony/country_codes.rb

@@ -22,7 +22,13 @@ module Phony
       @instance ||= new
     end
 
-    @@basic_normalizing_pattern = /^0+|\D/
+    # 00 for the standard international call prefix.
+    # http://en.wikipedia.org/wiki/List_of_international_call_prefixes
+    #
+    # We can't know from what country that person was calling, so we
+    # can't remove the intl' call prefix.
+    #
+    @@basic_normalizing_pattern = /^00?|\D/
     def clean number
       clean! number && number.dup
     end
@@ -33,15 +39,15 @@ module Phony
     end
     def normalize number
       clean! number
-      national_handler, cc, rest = split_cc number
-      @normalize_format % [cc, national_handler.normalize(rest)]
+      country, cc, rest = split_cc number
+      @normalize_format % [cc, country.normalize(rest)]
     end
 
     # Splits this number into cc, ndc and locally split number parts.
     #
     def split number
-      country_handler, cc, rest = split_cc number
-      [cc, *country_handler.split(rest)]
+      country, cc, rest = split_cc number
+      [cc, *country.split(rest)]
     end
 
     def formatted number, options = {}
@@ -88,40 +94,61 @@ module Phony
     #
     #
     def service? number
-      country_handler, cc, rest = split_cc number
-      country_handler.service? rest
+      country, cc, rest = split_cc number
+      country.service? rest
     end
     def mobile? number
-      country_handler, cc, rest = split_cc number
-      country_handler.mobile? rest
+      country, cc, rest = split_cc number
+      country.mobile? rest
     end
     def landline? number
-      country_handler, cc, rest = split_cc number
-      country_handler.landline? rest
+      country, cc, rest = split_cc number
+      country.landline? rest
     end
 
     # Is the given number a vanity number?
     #
     def vanity? number
-      country_handler, _, rest = split_cc number
-      country_handler.vanity? rest
+      country, _, rest = split_cc number
+      country.vanity? rest
     end
     # Converts a vanity number into a normalized E164 number.
     #
     def vanity_to_number vanity_number
-      country_handler, cc, rest = split_cc vanity_number
-      "#{cc}#{country_handler.vanity_to_number(rest)}"
+      country, cc, rest = split_cc vanity_number
+      "#{cc}#{country.vanity_to_number(rest)}"
     end
-
+    
     def split_cc rest
       presumed_cc = ''
       1.upto(3) do |i|
         presumed_cc << rest.slice!(0..0)
-        country_handler = splitter_mapping[i][presumed_cc]
-        return [country_handler, presumed_cc, rest] if country_handler
+        country = splitter_mapping[i][presumed_cc]
+        return [country, presumed_cc, rest] if country
       end
       # This line is never reached as CCs are in prefix code.
     end
+    
+    def plausible? number, hints = {}
+      normalized = clean number
+      
+      # False if it fails the basic check.
+      #
+      return false unless (4..15) === normalized.size
+      
+      country, cc, rest = split_cc normalized
+      
+      # Country code plausible?
+      #
+      cc_needed = hints[:cc]
+      return false if cc_needed && !(cc_needed === cc)
+      
+      # Country specific tests.
+      #
+      country.plausible? rest, hints
+    rescue StandardError => e
+      return false
+    end
 
     # # TODO
     # #

data/lib/phony/dsl.rb

@@ -49,9 +49,30 @@ module Phony
     # Example:
     #   country '27', # CC, followed by rules, for example fixed(2) >> ...
     #
-    def country country_code, country, validator = nil
-      Phony::CountryCodes.instance.add country_code, country
-      Phony::Validators.instance.add country_code, validator if validator
+    def country country_code, definition, options = {}
+      definition.with options
+      Phony::CountryCodes.instance.add country_code, definition
+    end
+    
+    class Trunk
+      
+      def initialize code, options = {}
+        @code = code
+        @normalize = options[:normalize]
+      end
+      
+      def national_splitter= national_splitter
+        @national_splitter = national_splitter
+      end
+      
+      def >> local_splitter
+        @national_splitter.country_for local_splitter, @normalize, @code
+      end
+      
+    end
+    
+    def trunk code, options = {}
+      Trunk.new code, options
     end
 
     # National matcher & splitters.
@@ -68,6 +89,7 @@ module Phony
     # Example:
     #   country '33', fixed(1) >> split(2,2,2,2) # France, uses a fixed NDC of size 1.
     #
+
     def fixed length, options = {}
       options[:zero] = true if options[:zero].nil?
       NationalSplitters::Fixed.instance_for length, options
@@ -122,7 +144,6 @@ module Phony
       #
       raise "Regexp /#{regex.source}/ needs a group in it that defines which digits belong to the NDC." unless regex.source =~ /\(/
       
-      on_fail_take = options.delete :on_fail_take
       NationalSplitters::Regex.instance_for regex, options[:on_fail_take], options
     end
     
@@ -158,6 +179,10 @@ module Phony
     #                           :fallback   => [2,2,2,2])
     #
     def matched_split options = {}
+      # TODO: Refactor: it's a workaround. It creates high coupling with Phony::LocalSplitters::Regex.
+      options.each do |_, format|
+        format << format.pop + 10
+      end
       Phony::LocalSplitters::Regex.instance_for options
     end
     
@@ -173,10 +198,11 @@ module Phony
     #     fixed(3, :zero => false) >> split(3,4),
     #     invalid_ndcs('911') # The regexp /911/ would also work.
     #
-    def invalid_ndcs ndc
-      Validator.new.ndc_check ndc
+    def invalid_ndcs *ndc
+      Validators::NDC.new invalid: ndc
     end
 
+
   end
 
-end
+end

data/lib/phony/local_splitters/fixed.rb

@@ -27,7 +27,8 @@ module Phony
       # The format [3, 2, 2] splits a number like '3332222' into ['333', '22', '22'].
       #
       def initialize format = nil
-        @format = format || [3, 2, 2]
+        @format = format && format.dup || [3, 2, 2]
+        # @format << @format.pop + 10 # Allow for call-through numbers with an arbitrary size.
       end
     
       # Split a local number according to an assumed country specific format.
@@ -43,6 +44,18 @@ module Phony
         end
       end
       
+      # TODO Fix length fudging.
+      #
+      def plausible? rest, hints = {}
+        (length > 10 ? length - 10 : length) === rest.inject(0) { |total, part| total + part.size }
+      end
+      
+      # A valid length.
+      #
+      def length
+        @length ||= @format.inject { |total, part| total + part }
+      end
+      
     end
     
   end

data/lib/phony/local_splitters/regex.rb

@@ -42,6 +42,17 @@ module Phony
         split_with number, fallback
       end
       
+      def plausible? rest, hints = {}
+        number = rest.inject('', :+)
+        mapping.each do |regex, format|
+          next unless number =~ regex
+          length = format.inject(0, :+)
+          length -= 10 if length > 10
+          return number.length == length
+        end
+        false
+      end
+      
       private
         
         def split_with number, format
@@ -51,7 +62,7 @@ module Phony
             result
           end
         end
-      
+
     end
     
   end

data/lib/phony/national_code.rb

@@ -3,13 +3,17 @@ module Phony
   # NationalCodes have a special numbers splitter, a national code splitter and a local code splitter.
   #
   class NationalCode
-
+    
+    attr_reader :local_splitter
+    
     #
     #
-    def initialize national_splitter, local_splitter, normalize = nil
+    def initialize national_splitter, local_splitter, normalize = nil, trunk_code = '0'
       @national_splitter = national_splitter
       @local_splitter    = local_splitter
       @normalize         = normalize != false
+      @trunk_code        = trunk_code
+      @trunk_code_replacement = /\A#{@trunk_code}+/
     end
 
     # Split gets a number without country code and splits it into
@@ -27,7 +31,7 @@ module Phony
     #
     def normalize national_number
       return national_number unless @normalize
-      national_number.gsub(/^0+/, '')
+      national_number.gsub(@trunk_code_replacement, EMPTY_STRING)
     end
 
   end

data/lib/phony/national_splitters/default.rb

@@ -1,7 +1,9 @@
 module Phony
 
   module NationalSplitters
-
+    
+    # TODO Default = Fixed.new(...)?
+    #
     class Default < DSL
 
       def self.instance_for
@@ -11,6 +13,16 @@ module Phony
       def split national_number
         [national_number]
       end
+      
+      def plausible? rest, size, hints = {}
+        true
+      end
+      
+      # A valid length (at least 3).
+      #
+      def length
+        3
+      end
 
     end
   end