phony 2.3.0 → 2.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzFlYWI4ZGNmZGYxOTNhOWZjMGZmZTIxZWYxNTNlZjhkZmI1MDdhMg==
-  data.tar.gz: !binary |-
-    MTAyODcwOTk2Zjg2MDFkMjExMzM3MTJmMjY1MTJkYjJiYjgzZTVjZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MzYwODJhZmJkNjU2MGUyMDhmZDc2NDM1OGNkYmQ4MzJjN2U2NDYwOWNlMGNh
-    ZDViOGFiNGJjYWUwZTlkY2FkYjhiZjNhNTg1ODZlNjRhMDU2NjhjNDE0NjEz
-    ZjJhNDI1MGRlOWUwYWFmYzkyMTE1ODE4NmZhZDUzZWFkYmIxMDA=
-  data.tar.gz: !binary |-
-    NzU3Y2FlOGMwMTkzNTBhZDQyZTU0NDIyZDdkZWU5ZmVhMDY3MTgwZDI5ZDJl
-    NWMwNGU3YmQyZGFlMWMzNTJkYTI2YWYzYTIyNDY1MDgwY2M2YTJlMDI4NTdj
-    NWQ1MTc3YzRlZDEzZGExNDhlZDc2OTRjMjc4NTdmNTUyOGQwYjk=
+SHA1:
+  metadata.gz: ffd6c59da8ff1d1b85f32f5caf0203fa49795df3
+  data.tar.gz: c470c3d8f4d599afd2a99f9f85ad9dc2dda12751
+SHA512:
+  metadata.gz: 40fc9bd07e284289fe77be2a92c78acd98713a495995a63779641960773f36ae211ca70215297b7846079014bbf38e486c22191aaef6c382c55f82856cf8b029
+  data.tar.gz: 25dd2c0b3a98cd81a6d4919856231a525b2bb3d241df085bccea5beba790edf152e7b7314e10b3ab5e32cf7c373f055965604aced8af2b1c94919a93a1ae080c

data/lib/phony/countries/austria.rb

@@ -83,7 +83,8 @@ service = [
 # TODO Add more details.
 #
 Phony.define do
-  country '43', one_of('1')       >> split(3..12) | # Vienna
+  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) |

data/lib/phony/countries/ireland.rb

@@ -64,7 +64,8 @@ freefone = [
 ]
 
 Phony.define do
-  country '353', one_of(ndcs_with_7_subscriber_digits)   >> split(3,4) |
+  country '353', trunk('0') |
+                 one_of(ndcs_with_7_subscriber_digits)   >> split(3,4) |
                  one_of(ndcs_with_5_subscriber_digits)   >> split(5)   |
                  one_of(ndcs_with_6_subscriber_digits)   >> split(6)   |
                  one_of(freefone)                        >> split(6)   |

data/lib/phony/countries/russia_kazakhstan_abkhasia_south_ossetia.rb

@@ -119,10 +119,10 @@ ndcs_with_7_subscriber_digits = %w(342 343 347 351 383 391 473 495 496 498 499 8
 Phony.define do
   country '7', 
     trunk('8') |
-    one_of(ndcs_with_5_subscriber_digits)  >> split(1, 2, 2) |
-    one_of(ndcs_with_6_subscriber_digits)  >> split(2, 2, 2) |
-    one_of(ndcs_with_7_subscriber_digits)  >> split(3, 2, 2) |
-    one_of(%w(800))                        >> split(3, 2, 2) | # Russia free number
-    one_of(%w(995344 9971 99744 9976 997)) >> split(2, 2, 2) | # South Osetia
-    fixed(3)                               >> split(2, 2, 3)
+    one_of(ndcs_with_5_subscriber_digits)  >> split(1, 4) |
+    one_of(ndcs_with_6_subscriber_digits)  >> split(2, 4) |
+    one_of(ndcs_with_7_subscriber_digits)  >> split(3, 4) |
+    one_of(%w(800))                        >> split(3, 4) | # Russia free number
+    one_of(%w(995344 9971 99744 9976 997)) >> split(2, 4) | # South Osetia
+    fixed(3)                               >> split(2, 5)
 end

data/lib/phony/countries.rb

@@ -6,11 +6,14 @@
 # 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.
 #
+# For the pre-ndc part, there's:
+# * trunk: If the country has a trunk code (options normalize/split – remove trunk on these method, default false).
+#
 # Available matching/splitting methods:
 # * none:   Does not have a national destination code, e.g. Denmark, Iceland.
 # * one_of: Matches one of the following numbers. Splits if it does.
 # * match: Try to match the regex, and if it matches, splits it off.
-# * fixed:  Always splits off a fixed length ndc. (Always use last in a | chain as a catchall) Offers a "zero" formatting option (default true).
+# * fixed:  Always splits off a fixed length ndc. (Always use last in a | chain as a catchall)
 #
 # For the national number part, there are two:
 # * split:         Use this number group splitting.
@@ -28,8 +31,8 @@ Phony.define do
   # USA, Canada, etc.
   #
   country '1',
-    trunk('1') |
-    fixed(3, :zero => false) >> split(3,4),
+    trunk('1', normalize: true) | # http://en.wikipedia.org/wiki/Trunk_prefix
+    fixed(3) >> split(3,4),
     :invalid_ndcs => ['911']
 
   # Kazakhstan (Republic of) & Russsian Federation.
@@ -110,6 +113,7 @@ Phony.define do
   # Switzerland.
   #
   country '41',
+          trunk('0', normalize: true) |
           match(/^(8(00|4[0248]))\d+$/) >> split(3,3)|
           fixed(2)                      >> split(3,2,2)
 

data/lib/phony/country.rb

@@ -14,7 +14,7 @@ module Phony
 
     # Chain two codes together.
     #
-    def |(other)
+    def | other
       self.codes = self.codes + other.codes
       self
     end
@@ -33,13 +33,15 @@ module Phony
     # Note: If the ndc is nil, it will not return it.
     #
     def split national_number
+      trunk = nil
       @codes.each do |code|
-        zero, ndc, *rest = code.split national_number
-        return [zero, ndc, *rest] if rest && !rest.empty?
+        new_trunk, ndc, *rest = code.split national_number
+        trunk ||= new_trunk
+        return [trunk, ndc, *rest] if rest && !rest.empty?
       end
       # Best effort in error case.
       #
-      [nil, national_number, []]
+      [trunk, national_number, []]
     end
     def split_ndc national_number
       @codes.each do |code|

data/lib/phony/national_splitters/fixed.rb

@@ -20,7 +20,7 @@ module Phony
       
       def initialize size, options = {}
         @size = size
-        @zero = options[:zero] == false ? nil : '0'
+        @zero = nil # options[:zero] == false ? nil : '0'
       end
       
       # Takes a national number and splits it into ndc and rest.

data/lib/phony/trunk_code.rb

@@ -2,9 +2,17 @@ module Phony
 
   class TrunkCode
   
+    # Parameters:
+    #  * code: The trunk code, e.g. 0.
+    #
+    # Options:
+    #  * normalize: Remove the trunk code when normalizing (only use if number scheme is defined unambiguously).
+    #  * split: Remove the trunk code when splitting (only use if number scheme is defined unambiguously).
+    #
     def initialize code, options = {}
+      @code = code
       @trunk_code_replacement = /\A#{code}/
-      @normalize = options[:normalize] != false
+      @normalize = options[:normalize]
       @split     = options[:split]
     end
     
@@ -20,12 +28,12 @@ module Phony
     #
     def split national_number
       national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @split
-      return [nil, national_number]
+      return [@code, national_number]
     end
     
     def normalize national_number
-      return national_number unless @normalize
-      national_number.gsub @trunk_code_replacement, EMPTY_STRING
+      national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @normalize
+      return national_number
     end
   
   end

data/spec/lib/phony/countries_spec.rb

@@ -508,14 +508,14 @@ describe 'country descriptions' do
       it_splits '40249123123', ['40', '249', '123', '123'] # Olt
     end
     describe 'Russia' do
-      it_splits '78122345678',   ['7', '812', '234', '56', '78'] # Russia 3-digit
-      it_splits '74012771077',   ['7', '4012', '77', '10', '77'] # Russia 4-digit
-      it_splits '78402411212',   ['7', '84024', '1', '12', '12'] # Russia 5-digit
-      it_splits '79296119119',   ['7', '929', '611', '91', '19'] # Russia 3-digit, Megafon Mobile.
-      it_splits '7840121212',    ['7', '840', '12', '12', '12']  # Abhasia
-      it_splits '7799121212',    ['7', '799', '12', '12', '12']  # Kazachstan
-      it_splits '7995344121212', ['7','995344','12','12','12']   # South Osetia
-      it_splits '7209175276',    ['7', '209', '17', '52', '76']  # Fantasy number
+      it_splits '78122345678',   ['7', '812', '234', '5678'] # Russia 3-digit
+      it_splits '74012771077',   ['7', '4012', '77', '1077'] # Russia 4-digit
+      it_splits '78402411212',   ['7', '84024', '1', '1212'] # Russia 5-digit
+      it_splits '79296119119',   ['7', '929', '611', '9119'] # Russia 3-digit, Megafon Mobile.
+      it_splits '7840121212',    ['7', '840', '12', '1212']  # Abhasia
+      it_splits '7799121212',    ['7', '799', '12', '1212']  # Kazachstan
+      it_splits '7995344121212', ['7','995344','12','1212']   # South Osetia
+      it_splits '7209175276',    ['7', '209', '17', '5276']  # Fantasy number
     end
 		describe 'Rwanda' do
       it_splits '250781234567', ['250', '78', '1234567'] # mobile

data/spec/lib/phony/country_codes_spec.rb

@@ -40,7 +40,9 @@ describe Phony::CountryCodes do
       old_format = @countries.national_format
       @countries.national_format = '%s%s'
       
-      @countries.formatted('11231231234', :format => :national).should eql '123 123 1234'
+      # Removes CC 1, but adds national call prefix 1.
+      #
+      @countries.formatted('11231231234', :format => :national).should eql '1123 123 1234'
       
       @countries.national_format = old_format
     end
@@ -63,13 +65,13 @@ describe Phony::CountryCodes do
       @countries.formatted('41443643532', :format => :national, :spaces => :-).should eql '044-364-35-32'
     end
     context 'specific' do
-      it 'formats ireland correctly' do
+      it 'formats Ireland correctly' do
         @countries.formatted("3533451234", :format => :national).should eql '0345 1234'
       end
-      it 'formats ireland correctly' do
+      it 'formats Ireland correctly' do
         @countries.formatted("353411231234", :format => :national).should eql '041 123 1234'
       end
-      it 'formats spain correctly' do
+      it 'formats Spain correctly' do
         @countries.formatted("34123456789", :format => :national).should eql '123 456 789'
       end
     end

data/spec/lib/phony/country_spec.rb

@@ -29,7 +29,7 @@ describe Phony::Country do
     
     describe "split" do
       it "should handle ZH" do
-        @switzerland.split('443643532').should == ['0', '44', '364', '35', '32']
+        @switzerland.split('443643532').should == [nil, '44', '364', '35', '32']
       end
     end
     describe 'normalize' do
@@ -54,10 +54,10 @@ describe Phony::Country do
     
     describe "split" do
       it "should handle ZH" do
-        @switzerland.split('443643532').should == ['0', '44', '364', '35', '32']
+        @switzerland.split('443643532').should == [nil, '44', '364', '35', '32']
       end
       it "should handle 800" do
-        @switzerland.split('800333666').should == ['0', '800', '333', '666']
+        @switzerland.split('800333666').should == [nil, '800', '333', '666']
       end
     end
   end

data/spec/lib/phony/national_code_spec.rb

@@ -24,10 +24,10 @@ describe Phony::NationalCode do
         @national         = Phony::NationalCode.new national_splitter, local_splitter
       end
       it 'splits correctly' do
-        @national.split('443643532').should == ['0', '44', '364', '35', '32']
+        @national.split('443643532').should == [nil, '44', '364', '35', '32']
       end
       it 'splits correctly' do
-        @national.split('44364353').should == ['0', '44', '364', '35', '3']
+        @national.split('44364353').should == [nil, '44', '364', '35', '3']
       end
       it 'normalizes correctly' do
         @national.normalize('044364353').should == '44364353'
@@ -44,10 +44,10 @@ describe Phony::NationalCode do
         @national         = Phony::NationalCode.new national_splitter, local_splitter
       end
       it 'splits correctly' do
-        @national.split('142278186').should == ['0', '1', '42', '27', '81', '86']
+        @national.split('142278186').should == [nil, '1', '42', '27', '81', '86']
       end
       it 'splits correctly' do
-        @national.split('14227818').should == ['0', '1', '42', '27', '81', '8']
+        @national.split('14227818').should == [nil, '1', '42', '27', '81', '8']
       end
       it 'normalizes correctly' do
         @national.normalize('0142278186').should == '142278186'

data/spec/lib/phony/national_splitters/fixed_spec.rb

@@ -16,13 +16,13 @@ describe Phony::NationalSplitters::Fixed do
       @splitter = Phony::NationalSplitters::Fixed.new 2
     end
     it 'splits correctly' do
-      @splitter.split('443643532').should == ['0', '44', '3643532']
+      @splitter.split('443643532').should == [nil, '44', '3643532']
     end
     it 'splits correctly even when the number is too long' do
-      @splitter.split('44364353211').should == ['0', '44', '364353211']
+      @splitter.split('44364353211').should == [nil, '44', '364353211']
     end
     it 'splits correctly even when the number is too short' do
-      @splitter.split('443').should == ['0', '44','3']
+      @splitter.split('443').should == [nil, '44','3']
     end
   end
   describe 'split' do
@@ -30,13 +30,13 @@ describe Phony::NationalSplitters::Fixed do
       @splitter = Phony::NationalSplitters::Fixed.new nil
     end
     it 'splits correctly' do
-      @splitter.split('443643532').should == ['0', '443643532']
+      @splitter.split('443643532').should == [nil, '443643532']
     end
     it 'splits correctly even when the number is too long' do
-      @splitter.split('44364353211').should == ['0', '44364353211']
+      @splitter.split('44364353211').should == [nil, '44364353211']
     end
     it 'splits correctly even when the number is too short' do
-      @splitter.split('443').should == ['0', '443']
+      @splitter.split('443').should == [nil, '443']
     end
   end
   

data/spec/lib/phony/national_splitters/regex_spec.rb

@@ -15,7 +15,7 @@ describe Phony::NationalSplitters::Regex do
     context 'with on_fail 2' do
       let(:splitter) { described_class.instance_for(/^(123)\d+$/, 2) }
       it 'uses the on_fail_take' do
-        splitter.split('23456789').should == ['0', '23', '456789']
+        splitter.split('23456789').should == [nil, '23', '456789']
       end
     end
   end

data/spec/lib/phony/national_splitters/variable_spec.rb

@@ -8,16 +8,16 @@ describe Phony::NationalSplitters::Variable do
         @splitter = Phony::NationalSplitters::Variable.new 4, ['1', '316', '67', '68', '669', '711']
       end
       it "handles Vienna" do
-        @splitter.split('198110').should == ['0', '1', '98110']
+        @splitter.split('198110').should == [nil, '1', '98110']
       end
       it "handles some mobile services" do
-        @splitter.split('66914093902').should == ['0', '669', '14093902']
+        @splitter.split('66914093902').should == [nil, '669', '14093902']
       end
       it "handles Graz" do
-        @splitter.split('3161234567891').should == ['0', '316', '1234567891']
+        @splitter.split('3161234567891').should == [nil, '316', '1234567891']
       end
       it "handles Rohrau" do
-        @splitter.split('2164123456789').should == ['0', '2164', '123456789']
+        @splitter.split('2164123456789').should == [nil, '2164', '123456789']
       end
     end
     context 'special handling for using the variable size splitter for Swiss service numbers' do
@@ -25,7 +25,7 @@ describe Phony::NationalSplitters::Variable do
         @splitter = Phony::NationalSplitters::Variable.new 2, ['800']
       end
       it "should handle swiss service numbers" do
-        @splitter.split('800223344').should == ['0', '800', '223344']
+        @splitter.split('800223344').should == [nil, '800', '223344']
       end
     end
   end

data/spec/lib/phony_spec.rb

@@ -6,8 +6,10 @@ describe Phony do
 
   describe 'regression' do
     it '#151' do
-      described_class.normalize('1-111-111-1111').should == '1111111111' # One 1 is removed because 1 is the trunk code.
-      described_class.normalize('111-111-1111', cc: '1').should == '1111111111' # One 1 is removed because 1 is the trunk code.
+      # Normalizes, but this is a non-real case.
+      #
+      described_class.normalize('1-111-111-1111').should        == '1111111111'
+      described_class.normalize('111-111-1111', cc: '1').should == '1111111111'
     end
     it 'best effort #152' do
       described_class.split('39694805123').should == ['39', '694805123', []]
@@ -71,9 +73,6 @@ describe Phony do
       it 'should normalize a number with colons' do
         Phony.normalize('1.906.387.1698').should eql '19063871698'
       end
-      it 'should normalize a number with optional ndc' do
-        Phony.normalize('+41 (044) 364 35 33').should eql '41443643533'
-      end
       it 'should normalize a number with erroneous zero inside' do
         Phony.normalize('+410443643533').should eql '41443643533'
       end
@@ -81,15 +80,15 @@ describe Phony do
         Phony.normalize('+390909709511').should eql '390909709511'
       end
 
-      context 'special trunk prefixes' do
+      context 'special trunk prefixes are not handled' do
         it 'normalizes Hungary' do
-          Phony.normalize('36 0630245506').should eql '3630245506'
+          Phony.normalize('36 0630245506').should eql '360630245506'
         end
         it 'normalizes Russia' do
-          Phony.normalize('7 8 342 1234567').should eql '73421234567'
+          Phony.normalize('7 8 342 1234567').should eql '783421234567'
         end
         it 'normalizes Lithuania' do
-          Phony.normalize('370 8 5 1234567').should eql '37051234567'
+          Phony.normalize('370 8 5 1234567').should eql '370851234567'
         end
         it 'normalizes Belarus' do
           Phony.normalize('375 152450911').should eql '375152450911'
@@ -124,18 +123,21 @@ describe Phony do
       end
     end
     describe 'default' do
-      it 'should format swiss numbers' do
+      it 'should format Swiss numbers' do
         Phony.format('41443643532').should eql '+41 44 364 35 32'
       end
+      it 'should format Swiss national numbers' do
+        Phony.format('41443643532', :format => :national).should eql '044 364 35 32'
+      end
       # TODO
       #
-      it 'should format swiss service numbers' do
+      it 'should format Swiss service numbers' do
         Phony.format('41800112233').should eql '+41 800 112 233'
       end
-      it 'should format austrian numbers' do
+      it 'should format Austrian numbers' do
         Phony.format('43198110').should eql '+43 1 98110'
       end
-      it 'should format american numbers' do
+      it 'should format American numbers' do
         Phony.format('18705551122').should eql '+1 870 555 1122'
       end
       it 'should format New Zealand 021 6-digit mobile numbers' do
@@ -153,6 +155,18 @@ describe Phony do
       it 'should format Indian numbers' do
         Phony.format('914433993939').should eql '+91 44 339 93 939'
       end
+      it 'should format Russian numbers' do
+        Phony.format(Phony.normalize('+370 800 12345'), :format => :international).should eql '+370 800 12 345'
+      end
+      it 'should format Russian numbers' do
+        Phony.format(Phony.normalize('+7 812 123 4567'), :format => :international).should eql '+7 812 123 4567'
+      end
+      it 'should format Russian numbers' do
+        Phony.format(Phony.normalize('+370 800 12345'), :format => :national).should eql '8800 12 345'
+      end
+      it 'should format Russian numbers' do
+        Phony.format(Phony.normalize('+7 812 123 4567'), :format => :national).should eql '8812 123 4567'
+      end
     end
     describe 'international' do
       it 'should format north american numbers' do
@@ -243,8 +257,8 @@ describe Phony do
       it 'should format austrian numbers' do
         Phony.format('43198110', :format => :national).should eql '01 98110'
       end
-      it 'should format US numbers without a leading zero' do
-        Phony.format('14159224711', :format => :national).should eql '415 922 4711'
+      it 'should format US numbers with a leading trunk 1' do
+        Phony.format('14159224711', :format => :national).should eql '1415 922 4711'
       end
     end
     describe 'local' do
@@ -260,7 +274,7 @@ describe Phony do
   context 'minimal cases' do
     context 'normalizing' do
       it "handles completely crazy 'numbers'" do
-        Phony.normalize('Hello, I am Cora, the 41th parrot, and 044 is my 364 times 35 funky number. 32.').should eql '41443643532'
+        Phony.normalize('Hello, I am Cora, the 41th parrot, and 44 is my 364 times 35 funky number. 32.').should eql '41443643532'
       end
     end
     context 'splitting' do

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: phony
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies: []
-description: ! 'Fast international phone number (E164 standard) normalizing, splitting
+description: 'Fast international phone number (E164 standard) normalizing, splitting
   and formatting. Lots of formatting options: International (+.., 00..), national
   (0..), and local.'
 email: florian.hanke+phony@gmail.com
@@ -19,6 +19,9 @@ extensions: []
 extra_rdoc_files:
 - README.textile
 files:
+- README.textile
+- lib/phony.rb
+- lib/phony/countries.rb
 - lib/phony/countries/austria.rb
 - lib/phony/countries/bangladesh.rb
 - lib/phony/countries/belarus.rb
@@ -57,7 +60,6 @@ files:
 - lib/phony/countries/uruguay.rb
 - lib/phony/countries/vietnam.rb
 - lib/phony/countries/zimbabwe.rb
-- lib/phony/countries.rb
 - lib/phony/country.rb
 - lib/phony/country_codes.rb
 - lib/phony/dsl.rb
@@ -72,8 +74,6 @@ files:
 - lib/phony/national_splitters/variable.rb
 - lib/phony/trunk_code.rb
 - lib/phony/vanity.rb
-- lib/phony.rb
-- README.textile
 - spec/functional/error_spec.rb
 - spec/functional/normalize_spec.rb
 - spec/functional/plausibility_spec.rb
@@ -100,17 +100,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fast international phone number (E164 standard) normalizing, splitting and