phony 1.3.5 → 1.4.0

data/lib/countries.rb

@@ -1,16 +1,16 @@
 # All countries, ordered by country code.
 #
+# Definitions are in the format:
+#   NDC >> National | NDC >> National | # ...
+#
+# As soon as a NDC matches, it goes on to the National part. Then breaks off.
+# If the NDC does not match, it go on to the next (|, or "or") NDC.
+#
 # Available matching/splitting methods:
-# * fixed:  Always splits off a fixed length ndc. (Always use last in a | chain)
 # * none:   Does not have a national destination code, e.g. Denmark, Iceland.
 # * one_of: Matches one of the following numbers. Splits if it does.
-#           Options:
-#           * max_length: Will try to match up to length max_length, then stop.
-#                         (Only use one_of with this option when last in a | chain)
 # * match: Try to match the regex, and if it matches, splits it off.
-#           Options:
-#           * on_fail_take: If it does not match, take n digits, then stop.
-#                           (When you use this option, match must be last in a | chain)
+# * fixed:  Always splits off a fixed length ndc. (Always use last in a | chain)
 #
 # For the national number part, there are two:
 # * split:         Use this number group splitting.
@@ -24,8 +24,9 @@ Phony.define do
   country '1', fixed(3) >> split(3,4) # USA, Canada, etc.
   country '7', fixed(3) >> split(3,2,2) # Kazakhstan (Republic of) & Russian Federation
 
-  country '20', one_of('800') >> split(7) | # Egypt
-                one_of('2', '3', :max_length => 2) >> split(8) # Cairo/Giza, Alexandria
+  country '20', one_of('800')    >> split(7) | # Egypt
+                one_of('2', '3') >> split(8) | # Cairo/Giza, Alexandria
+                fixed(2)         >> split(8)
                 # :mobile? => /^10|11|12|14|16|17|18|19*$/, :service? => /^800.*$/
   country '27', fixed(2) >> split(3,4) # South Africa
 
@@ -55,13 +56,15 @@ Phony.define do
   country '48', fixed(3) >> split(3,3) # Poland
   # country '49', Phony::Countries::Germany
 
-  country '51', one_of('103', '105')               >> split(3,3) | # Peru
-                one_of('1', '9', :max_length => 2) >> split(4,4)   # Lima and mobile.
+  country '51', one_of('103', '105') >> split(3,3) | # Peru
+                one_of('1', '9')     >> split(4,4) | # Lima and mobile.
+                fixed(2)             >> split(4,4)
   country '52', match(/^(0\d{2})\d+$/)   >> split(2,2,2,2) | # Mexico
                 match(/^(33|55|81)\d+$/) >> split(2,2,2,2) |
                 match(/^(\d{3})\d+$/)    >> split(3,2,2)
-  country '53', match(/^(5\d{3})\d+$/)                                   >> split(4) | # Cuba. Mobile.
-                match(/^(7|21|22|23|4[1-8]|3[1-3])/, :on_fail_take => 3) >> split(7)
+  country '53', match(/^(5\d{3})\d+$/)               >> split(4) | # Cuba. Mobile.
+                match(/^(7|21|22|23|4[1-8]|3[1-3])/) >> split(7) | #
+                fixed(3)                             >> split(7)
   country '54', fixed(2) >> split(3,2,2) # TODO Argentine Republic
   brazilian_service = /^(100|128|190|191|192|193|194|197|198|199)\d+$/
   country '55', match(brazilian_service) >> split(3,3) | # Brazil (Federative Republic of)
@@ -106,8 +109,6 @@ Phony.define do
   country '218', fixed(2) >> split(3,2,2) # Lybia
   country '219', fixed(2) >> split(3,2,2) # -
 
-  # TODO From here on.
-
   country '220', fixed(2) >> split(3,2,2) # Gambia
   country '221', fixed(2) >> split(3,2,2) # Senegal
   country '222', fixed(2) >> split(3,2,2) # Mauritania
@@ -186,18 +187,20 @@ Phony.define do
   country '299', fixed(2) >> split(3,2,2) # Greenland
 
   country '350', fixed(2) >> split(3,2,2) # Gibraltar
-  country '351', one_of('700', '800')                 >> split(3,3) | # Portugal
-                 match(/^(9\d)\d+$/)                  >> split(3,4) | # mobile
-                 one_of('21', '22', :max_length => 3) >> split(3,4)   # Lisboa & Porto
+  country '351', one_of('700', '800') >> split(3,3) | # Portugal
+                 match(/^(9\d)\d+$/)  >> split(3,4) | # mobile
+                 one_of('21', '22')   >> split(3,4) | # Lisboa & Porto
+                 fixed(3)             >> split(3,4)
   country '352', fixed(2) >> split(3,2,2) # Luxembourg
   country '353', fixed(2) >> split(3,2,2) # Ireland (0-3-4)
   country '354', none     >> split(3,4)   # Iceland
   country '355', fixed(2) >> split(3,2,2) # Albania
   country '356', fixed(2) >> split(3,2,2) # Malta
   country '357', fixed(2) >> split(3,2,2) # Cyprus
-  country '358', match(/^([6-8]00)\d+$/)                           >> split(3,3)   | # Finland
-                 match(/^(4\d|50)\d+$/)                            >> split(3,2,2) |
-                 one_of('2','3','5','6','8','9', :max_length => 2) >> split(3,3)
+  country '358', match(/^([6-8]00)\d+$/)         >> split(3,3)   | # Finland
+                 match(/^(4\d|50)\d+$/)          >> split(3,2,2) |
+                 one_of('2','3','5','6','8','9') >> split(3,3)   |
+                 fixed(2)                        >> split(3,3)
   country '359', fixed(2) >> split(3,2,2) # Bulgaria
 
   country '370', one_of('700', '800')  >> split(2,3)   | # Lithuania
@@ -220,15 +223,17 @@ Phony.define do
   country '382', fixed(2) >> split(3,2,2) # -
   country '383', fixed(2) >> split(3,2,2) # -
   country '384', fixed(2) >> split(3,2,2) # -
-  country '385', one_of('1', :max_length => 2) >> split(3,5) # Croatia
+  country '385', one_of('1') >> split(3,5) | # Croatia
+                 fixed(2)    >> split(3,5)
   country '386', fixed(2) >> split(3,2,2) # Slovenia
   country '387', fixed(2) >> split(3,2,2) # Bosnia and Herzegovina
   country '388', fixed(2) >> split(3,2,2) # Group of countries, shared code
   country '389', fixed(2) >> split(3,2,2) # The Former Yugoslav Republic of Macedonia
 
   country '420', fixed(3) >> split(3,3)   # Czech Republic
-  country '421', match(/^(9\d\d).+$/) >> split(7) |        # Slovak Republic
-                 one_of('2', :max_length => 2) >> split(8) # Bratislava
+  country '421', match(/^(9\d\d).+$/) >> split(6) | # Slovak Republic
+                 one_of('2')          >> split(8) | # Bratislava
+                 fixed(2)             >> split(7)
   country '422', fixed(2) >> split(3,2,2) # Spare code
   country '423', none     >> split(3,2,2) # Liechtenstein (Principality of)
   country '424', fixed(2) >> split(3,2,2) # -

data/lib/phony.rb

@@ -44,57 +44,63 @@ module Phony
   #
   @codes = CountryCodes.instance
 
-  # Normalizes the given number.
-  #
-  # Useful before inserting the number into a database.
-  #
-  def self.normalize phone_number
-    normalize! phone_number.dup
-  end
-  def self.normalize! phone_number
-    @codes.normalize phone_number
-  end
+  class << self
 
-  # Splits the phone number into pieces according to the country codes.
-  #
-  def self.split phone_number
-    split! phone_number.dup
-  end
-  def self.split! phone_number
-    @codes.split phone_number
-  end
+    # Normalizes the given number.
+    #
+    # Useful before inserting the number into a database.
+    #
+    def normalize phone_number
+      normalize! phone_number.dup
+    end
+    def normalize! phone_number
+      @codes.normalize phone_number
+    end
 
-  # Formats a E164 number according to local customs.
-  #
-  def self.formatted phone_number, options = {}
-    formatted! phone_number.dup, options
-  end
-  def self.formatted! phone_number, options = {}
-    @codes.formatted phone_number, options
-  end
+    # Splits the phone number into pieces according to the country codes.
+    #
+    def split phone_number
+      split! phone_number.dup
+    end
+    def split! phone_number
+      @codes.split phone_number
+    end
 
-  # def self.service? number
-  #   @codes.service? number.dup
-  # end
-  # def self.mobile? number
-  #   @codes.mobile? number.dup
-  # end
-  # def self.landline? number
-  #   @codes.landline? number.dup
-  # end
+    # Formats a E164 number according to local customs.
+    #
+    def format phone_number, options = {}
+      formatted! phone_number.dup, options
+    end
+    def format! phone_number, options = {}
+      @codes.formatted phone_number, options
+    end
+    alias formatted  format
+    alias formatted! format!
 
-  # Returns true if there is a character in the number
-  # after the first four numbers.
-  #
-  def self.vanity? phone_number
-    @codes.vanity? phone_number.dup
-  end
+    # def service? number
+    #   @codes.service? number.dup
+    # end
+    # def mobile? number
+    #   @codes.mobile? number.dup
+    # end
+    # def landline? number
+    #   @codes.landline? number.dup
+    # end
+
+    # Returns true if there is a character in the number
+    # after the first four numbers.
+    #
+    def vanity? phone_number
+      @codes.vanity? phone_number.dup
+    end
+
+    # Converts any character in the vanity_number to its numeric representation.
+    # Does not check if the passed number is a valid vanity_number, simply does replacement.
+    #
+    def vanity_to_number vanity_number
+      @codes.vanity_to_number vanity_number.dup
+    end
 
-  # Converts any character in the vanity_number to its numeric representation.
-  # Does not check if the passed number is a valid vanity_number, simply does replacement.
-  #
-  def self.vanity_to_number vanity_number
-    @codes.vanity_to_number vanity_number.dup
   end
 
 end

data/spec/lib/phony_spec.rb

@@ -9,10 +9,10 @@ describe Phony do
       it "should normalize an already normalized number" do
         Phony.normalize('41443643533').should == '41443643533'
       end
-      it "should normalize a formatted number" do
+      it "should normalize a format number" do
         Phony.normalize('+41 44 364 35 33').should == '41443643533'
       end
-      it "should normalize a formatted number" do
+      it "should normalize a format number" do
         Phony.normalize('+41 44 364 35 33').should == '41443643533'
       end
       it "should normalize a service number" do
@@ -42,105 +42,111 @@ describe Phony do
     end
   end
   
-  describe "formatted" do
+  describe 'formatted' do
+    it 'is an alias of format' do
+      Phony.formatted('41443643532').should == '+41 44 364 35 32'
+    end
+  end
+  
+  describe "format" do
     describe "default" do
       it "should format swiss numbers" do
-        Phony.formatted('41443643532').should == '+41 44 364 35 32'
+        Phony.format('41443643532').should == '+41 44 364 35 32'
       end
       # TODO
       #
       it "should format swiss service numbers" do
-        Phony.formatted('41800112233').should == '+41 800 112 233'
+        Phony.format('41800112233').should == '+41 800 112 233'
       end
       it "should format austrian numbers" do
-        Phony.formatted('43198110').should == '+43 1 98110'
+        Phony.format('43198110').should == '+43 1 98110'
       end
       it "should format american numbers" do
-        Phony.formatted('18705551122').should == '+1 870 555 1122'
+        Phony.format('18705551122').should == '+1 870 555 1122'
       end
     end
     describe "international" do
       it "should format north american numbers" do
-        Phony.formatted('18091231234', :format => :international).should == '+1 809 123 1234'
+        Phony.format('18091231234', :format => :international).should == '+1 809 123 1234'
       end
       it "should format austrian numbers" do
-        Phony.formatted('43198110', :format => :international).should == '+43 1 98110'
+        Phony.format('43198110', :format => :international).should == '+43 1 98110'
       end
       it "should format austrian numbers" do
-        Phony.formatted('43198110', :format => :international_absolute).should == '+43 1 98110'
+        Phony.format('43198110', :format => :international_absolute).should == '+43 1 98110'
       end
       it "should format french numbers" do
-        Phony.formatted('33142278186', :format => :+).should == '+33 1 42 27 81 86'
+        Phony.format('33142278186', :format => :+).should == '+33 1 42 27 81 86'
       end
       it "should format austrian numbers" do
-        Phony.formatted('43198110', :format => :international_relative).should == '0043 1 98110'
+        Phony.format('43198110', :format => :international_relative).should == '0043 1 98110'
       end
       it 'should format liechtensteiner numbers' do
-        Phony.formatted('4233841148', :format => :international_relative).should == '00423 384 11 48'
+        Phony.format('4233841148', :format => :international_relative).should == '00423 384 11 48'
       end
       context 'with no spaces' do
         it "should format north american numbers" do
-          Phony.formatted('18091231234', :format => :international, :spaces => '').should == '+18091231234'
+          Phony.format('18091231234', :format => :international, :spaces => '').should == '+18091231234'
         end
         it "should format austrian numbers" do
-          Phony.formatted('43198110', :format => :international, :spaces => '').should == '+43198110'
+          Phony.format('43198110', :format => :international, :spaces => '').should == '+43198110'
         end
         it "should format austrian numbers" do
-          Phony.formatted('43198110', :format => :international_absolute, :spaces => '').should == '+43198110'
+          Phony.format('43198110', :format => :international_absolute, :spaces => '').should == '+43198110'
         end
         it "should format french numbers" do
-          Phony.formatted('33142278186', :format => :+, :spaces => '').should == '+33142278186'
+          Phony.format('33142278186', :format => :+, :spaces => '').should == '+33142278186'
         end
         it "should format austrian numbers" do
-          Phony.formatted('43198110', :format => :international_relative, :spaces => '').should == '0043198110'
+          Phony.format('43198110', :format => :international_relative, :spaces => '').should == '0043198110'
         end
         it 'should format liechtensteiner numbers' do
-          Phony.formatted('4233841148', :format => :international_relative, :spaces => '').should == '004233841148'
+          Phony.format('4233841148', :format => :international_relative, :spaces => '').should == '004233841148'
         end
       end
       context 'with special spaces' do
         it "should format swiss numbers" do
-          Phony.formatted('41443643532', :format => :international).should == '+41 44 364 35 32'
+          Phony.format('41443643532', :format => :international).should == '+41 44 364 35 32'
         end
         it "should format north american numbers" do
-          Phony.formatted('18091231234', :format => :international, :spaces => :-).should == '+1-809-123-1234'
+          Phony.format('18091231234', :format => :international, :spaces => :-).should == '+1-809-123-1234'
         end
         it "should format austrian numbers" do
-          Phony.formatted('43198110', :format => :international, :spaces => :-).should == '+43-1-98110'
+          Phony.format('43198110', :format => :international, :spaces => :-).should == '+43-1-98110'
         end
         it "should format austrian numbers" do
-          Phony.formatted('43198110', :format => :international_absolute, :spaces => :-).should == '+43-1-98110'
+          Phony.format('43198110', :format => :international_absolute, :spaces => :-).should == '+43-1-98110'
         end
         it "should format french numbers" do
-          Phony.formatted('33142278186', :format => :+, :spaces => :-).should == '+33-1-42-27-81-86'
+          Phony.format('33142278186', :format => :+, :spaces => :-).should == '+33-1-42-27-81-86'
         end
         it "should format austrian numbers" do
-          Phony.formatted('43198110', :format => :international_relative, :spaces => :-).should == '0043-1-98110'
+          Phony.format('43198110', :format => :international_relative, :spaces => :-).should == '0043-1-98110'
         end
         it 'should format liechtensteiner numbers' do
-          Phony.formatted('4233841148', :format => :international_relative, :spaces => :-).should == '00423-384-11-48'
+          Phony.format('4233841148', :format => :international_relative, :spaces => :-).should == '00423-384-11-48'
         end
       end
     end
     describe "national" do
       it "should format swiss numbers" do
-        Phony.formatted('41443643532', :format => :national).should == '044 364 35 32'
+        Phony.format('41443643532', :format => :national).should == '044 364 35 32'
       end
       # TODO
       #
       it "should format swiss service numbers" do
-        Phony.formatted('41800112233', :format => :national).should == '0800 112 233'
+        Phony.format('41800112233', :format => :national).should == '0800 112 233'
       end
       it "should format austrian numbers" do
-        Phony.formatted('43198110', :format => :national).should == '01 98110'
+        Phony.format('43198110', :format => :national).should == '01 98110'
       end
     end
     describe "local" do
       it "should format swiss numbers" do
-        Phony.formatted('41443643532', :format => :local).should == '364 35 32'
+        Phony.format('41443643532', :format => :local).should == '364 35 32'
       end
       it "should format german numbers" do
-        Phony.formatted('493038625454', :format => :local).should == '386 25454'
+        Phony.format('493038625454', :format => :local).should == '386 25454'
       end
     end
   end
@@ -164,13 +170,13 @@ describe Phony do
     end
     context 'formatting' do
       it 'handles completely missing numbers well enough' do
-        Phony.formatted('4144').should == '+41 44 '
+        Phony.format('4144').should == '+41 44 '
       end
       it 'handles a missing number part' do
-        Phony.formatted('4144364').should == '+41 44 364'
+        Phony.format('4144364').should == '+41 44 364'
       end
       it 'handles a missing number part' do
-        Phony.formatted('414436435').should == '+41 44 364 35'
+        Phony.format('414436435').should == '+41 44 364 35'
       end
     end
   end
@@ -203,13 +209,13 @@ describe Phony do
         performance_of { @phone_numbers.each { |number| Phony.normalize(number) } }.should < 0.00016
       end
     end
-    describe 'formatted' do
+    describe 'format' do
       it 'is fast' do
         number = @phone_numbers.first
-        performance_of { Phony.formatted(number) }.should < 0.000075
+        performance_of { Phony.format(number) }.should < 0.000075
       end
       it 'is fast' do
-        performance_of { @phone_numbers.each { |number| Phony.formatted(number) } }.should < 0.00016
+        performance_of { @phone_numbers.each { |number| Phony.format(number) } }.should < 0.00016
       end
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: phony
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors: 
 - Florian Hanke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-30 00:00:00 +10:00
+date: 2011-05-02 00:00:00 +10:00
 default_executable: 
 dependencies: []