phony 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e19199a57d389032d55f939a10cae73a78287d4d
-  data.tar.gz: 009422959de3b6f962b97413f94a74f4577cef18
+  metadata.gz: ad23d7833af7d5c22a7a2157ac509e762c16ad39
+  data.tar.gz: 0d2aab1c49bdac649ce7d2c0a93e4acf2234f714
 SHA512:
-  metadata.gz: 67a4d6045871dbc59c274fa902be56c78fbe50b754b473d2cc4340ae1426367ae13d52bdc47dcd42636985bf256b2eb753a362006a32d638103195c340115c37
-  data.tar.gz: fe40d41769928ef6a86eb949e88f67a259373392cb051989744a2d0d0e01785815ac6084c9733693691e028bcaaf660d0cec3bc852695d6506e7eb24e8c51f4f
+  metadata.gz: 089b667c5e5651ce2b8b1ae611cd74fa84cd32b71207a1246aa143c96c78ed50e29799e9cda94def9dee22027c68a0c06753fdaef2e00a531d5aca9c251c24ac
+  data.tar.gz: cc36ddfa8d3afef335858bcf700fc726cfcc2fcc8d87db4327356f09eb09b54b9df595a84e8cdf971fc7935e6659da417303fd3399fdb9e71abe9d520d6d4813

data/lib/phony.rb

@@ -177,9 +177,7 @@ module Phony
     #   Phony.split!("13015550100") # => ["1", "301", "555", "0100"]
     #
     def split! phone_number
-      parts = @codes.split phone_number
-      parts.delete_at 1
-      parts
+      @codes.split phone_number
     end
 
     # Formats a normalized E164 number according to a country's formatting scheme.

data/lib/phony/countries.rb

@@ -51,9 +51,11 @@ Phony.define do
   #
   country '1',
     # The US has a delimiter between NDC and local number.
-    trunk('1%s', normalize: true) | # http://en.wikipedia.org/wiki/Trunk_prefix
+    trunk('1%s', normalize: true, format: false) | # http://en.wikipedia.org/wiki/Trunk_prefix
     fixed(3) >> split(3,4),
-    :invalid_ndcs => /[0-1]\d{2}|[3-9]11/
+    :invalid_ndcs => /[0-1]\d{2}|[3-9]11/,
+    :parentheses => true,
+    :local_space => :-
 
   # Kazakhstan (Republic of) & Russsian Federation.
   # also Abhasia and South Osetia autonomous regions / recognized by some states as independent countries

data/lib/phony/country.rb

@@ -4,15 +4,24 @@ module Phony
   #
   class Country
     
-    attr_reader :format, :space, :local_space
     attr_accessor :codes
 
-    #
+    @@international_absolute_format = '+%s%s%s%s%s'
+    @@international_relative_format = '00%s%s%s%s%s'
+    @@national_format               = '%s%s%s%s'
+  
+    @@default_space = ' '
+    @@default_local_space = ' '
+    @@default_parentheses = false
+
+    # TODO Doc.
     #
     def initialize *codes
       @codes = codes
     end
 
+    # DSL method.
+    #
     # Chain two codes together.
     #
     def | other
@@ -26,10 +35,13 @@ module Phony
     #
     def with cc, options = {}
       @cc           = cc
+      
       @invalid_ndcs = options[:invalid_ndcs]
+      
       @format       = options[:format]
       @space        = options[:space]
       @local_space  = options[:local_space]
+      @parentheses  = options[:parentheses]
     end
 
     # A number is split with the code handlers as given in the initializer.
@@ -53,6 +65,68 @@ module Phony
         return [code.local_splitter, zero, ndc, *rest] if rest && !rest.empty?
       end
     end
+    
+    # Format the number, given the national part of it.
+    #
+    def format national_number, options = {}
+      type         = options[:format]       || @format
+      space        = options[:spaces]       || @space       || @@default_space
+      local_space  = options[:local_spaces] || @local_space || space           || @@default_local_space
+      parentheses  = options[:parentheses]
+      parentheses  = @parentheses || @@default_parentheses if parentheses.nil?
+      use_trunk    = options[:trunk]
+      
+      trunk, ndc, *local_pieces = split national_number
+      
+      local = format_local local_pieces, local_space
+      
+      format_cc_ndc trunk, ndc, local, type, space, parentheses, use_trunk
+    end
+    def format_local local, local_space
+      if local.empty?
+        EMPTY_STRING
+      else
+        local.compact!
+        local.join local_space.to_s
+      end
+    end
+    def format_cc_ndc trunk, ndc, local, type, space, parentheses, use_trunk
+      case type
+      when String
+        trunk &&= trunk.format(space, use_trunk)
+        type % { :trunk => trunk, :cc => @cc, :ndc => ndc, :local => local }
+      when nil, :international_absolute, :international, :+
+        if ndc
+          ndc = parentheses ? "(#{ndc})" : ndc
+          format_with_ndc(@@international_absolute_format, @cc, ndc, local, space)
+        else
+          format_without_ndc(@@international_absolute_format, @cc, local, space)
+        end
+      when :international_relative
+        if ndc
+          ndc = parentheses ? "(#{ndc})" : ndc
+          format_with_ndc(@@international_relative_format, @cc, ndc, local, space)
+        else
+          format_without_ndc(@@international_relative_format, @cc, local, space)
+        end
+      when :national
+        trunk &&= trunk.format(space, use_trunk)
+        if ndc && !ndc.empty?
+          ndc = parentheses ? "(#{ndc})" : ndc
+          @@national_format % [trunk, ndc, space, local]
+        else
+          @@national_format % [trunk, nil, nil,   local]
+        end
+      when :local
+        local
+      end
+    end
+    def format_with_ndc format, cc, ndc, local, space
+      format % [cc, space, ndc, space, local]
+    end
+    def format_without_ndc format, cc, local, space
+      format % [cc, space, local, nil, nil]
+    end
 
     # Cleans all non-numeric characters.
     #

data/lib/phony/country_codes.rb

@@ -9,18 +9,23 @@ module Phony
     attr_reader   :countries
     attr_accessor :international_absolute_format, :international_relative_format, :national_format
 
-    def initialize
-      @international_absolute_format = '+%s%s%s%s%s'
-      @international_relative_format = '00%s%s%s%s%s'
-      @national_format               = '%s%s%s%s'
-
-      @default_space = ' '
-      @default_local_space = ' '
-    end
-
+    # Singleton instance.
+    #
     def self.instance
       @instance ||= new
     end
+    
+    # Add the given country to the mapping under the
+    # given country code.
+    #
+    def add country_code, country
+      country_code = country_code.to_s
+      optimized_country_code_access = country_code.size
+
+      @countries ||= {}
+      @countries[optimized_country_code_access] ||= {}
+      @countries[optimized_country_code_access][country_code] = country
+    end
 
     # Get the Country object for the given CC.
     #
@@ -42,18 +47,6 @@ module Phony
       number.gsub!(@@basic_cleaning_pattern, EMPTY_STRING) || number
     end
 
-    # Adds the country code to the front
-    # if it does not already start with it.
-    #
-    # Note: This won't be correct in some cases, but it is the best we can do.
-    #
-    def countrify number, cc
-      countrify!(number, cc) || number
-    end
-    def countrify! number, cc
-      number.sub!(/\A/, cc) # @countrify_regex, @cc
-    end
-
     # 00 for the standard international call prefix.
     # http://en.wikipedia.org/wiki/List_of_international_call_prefixes
     #
@@ -70,7 +63,7 @@ module Phony
         self[cc]
       else
         clean! number
-        country, cc, number = split_cc number
+        country, cc, number = partial_split number
         country
       end
       number = country.normalize number
@@ -80,114 +73,21 @@ module Phony
     # Splits this number into cc, ndc and locally split number parts.
     #
     def split number
-      _, *cc_split_rest = internal_split number
-      cc_split_rest
-    end
-    
-    def internal_split number
-      country, cc, rest = split_cc number
-      [country, cc, *country.split(rest)]
+      # TODO Think about reordering.
+      country, cc, trunk, *pieces = internal_split number
+      [cc, *pieces]
     end
 
+    # Format the number.
+    #
     def format number, options = {}
-      country, cc, trunk, ndc, *parts = internal_split number
-      format_cc_ndc_local \
-        options[:format]       || country.format,
-        options[:spaces]       || country.space                           || @default_space,
-        options[:local_spaces] || country.local_space || options[:spaces] || @default_local_space,
-        cc,
-        options[:trunk] == false ? nil : trunk,
-        ndc,
-        *parts
+      country, _, national = partial_split number
+      country.format national, options
     end
     alias formatted format
 
-    # Formats country code and national destination code.
-    #
-    def format_cc_ndc_local format, space, local_space, cc, trunk, ndc, *parts
-      local = if parts.empty?
-                EMPTY_STRING
-              else
-                format_local(local_space, parts) unless parts.empty?
-              end
-      
-      format_cc_ndc format, space, cc, trunk, ndc, local
-      
-      # cc_ndc = cc_ndc.slice 0...cc_ndc.rindex(space.to_s) if parts.empty?
-    end
-    def format_cc_ndc format, space, cc, trunk, ndc, local
-      case format
-      when String
-        trunk = trunk % space if trunk && trunk.size > 1
-        format % { :trunk => trunk, :cc => cc, :ndc => ndc, :local => local }
-      when nil, :international_absolute, :international, :+
-        ndc ?
-          format_with_ndc(@international_absolute_format, cc, ndc, local, space) :
-          format_without_ndc(@international_absolute_format, cc, local, space)
-      when :international_relative
-        ndc ?
-          format_with_ndc(@international_relative_format, cc, ndc, local, space) :
-          format_without_ndc(@international_relative_format, cc, local, space)
-      when :national
-        # Replaces the %s in the trunk code with a "space".
-        trunk = trunk % space if trunk && trunk.size > 1
-        ndc && !ndc.empty? ?
-          @national_format % [trunk, ndc, space, local] :
-          @national_format % [trunk, nil, nil,   local]
-      when :local
-        local
-      end
-    end
-    def format_local local_space, parts_ary
-      parts_ary.compact!
-      parts_ary.join local_space.to_s
-    end
-    
-    def format_with_ndc format, cc, ndc, local, space
-      format % [cc, space, ndc, space, local]
-    end
-    def format_without_ndc format, cc, local, space
-      format % [cc, space, local, nil, nil]
-    end
-
-    #
-    #
-    def service? number
-      country, _, rest = split_cc number
-      country.service? rest
-    end
-    def mobile? number
-      country, _, rest = split_cc number
-      country.mobile? rest
-    end
-    def landline? number
-      country, _, rest = split_cc number
-      country.landline? rest
-    end
-
-    # Is the given number a vanity number?
-    #
-    def vanity? number
-      country, _, rest = split_cc number
-      country.vanity? rest
-    end
-    # Converts a vanity number into a normalized E164 number.
+    # Is this number plausible?
     #
-    def vanity_to_number vanity_number
-      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 = countries[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
 
@@ -195,7 +95,7 @@ module Phony
       #
       return false unless (4..15) === normalized.size
 
-      country, cc, rest = split_cc normalized
+      country, cc, rest = partial_split normalized
 
       # Country code plausible?
       #
@@ -208,25 +108,60 @@ module Phony
     rescue StandardError
       return false
     end
-
-    # # TODO
-    # #
-    # def self.with_cc cc
-    #   mapping[cc.size][cc.to_s]
-    # end
-
-    # Add the given country to the mapping under the
-    # given country code.
+    
+    # Is the given number a vanity number?
     #
-    def add country_code, country
-      country_code = country_code.to_s
-      optimized_country_code_access = country_code.size
-
-      @countries ||= {}
-      @countries[optimized_country_code_access] ||= {}
-      @countries[optimized_country_code_access][country_code] = country
+    def vanity? number
+      country, _, national = partial_split number
+      country.vanity? national
+    end
+    # Converts a vanity number into a normalized E164 number.
+    #
+    def vanity_to_number vanity_number
+      country, cc, national = partial_split vanity_number
+      "#{cc}#{country.vanity_to_number(national)}"
     end
 
+    private
+    
+      # Return a country for the number.
+      #
+      def country_for number
+        country, _ = partial_split number
+        country
+      end
+      
+      # Return a country and the split pieces of a number. 
+      #
+      def internal_split number
+        country, cc, national = partial_split number
+        [country, cc, *country.split(national)]
+      end
+    
+      # Split off the country and the cc, and also return the national number part.
+      #
+      def partial_split number
+        cc = ''
+        1.upto(3) do |i|
+          cc << number.slice!(0..0)
+          country = countries[i][cc]
+          return [country, cc, number] if country
+        end
+        # This line is never reached as CCs are in prefix code.
+      end
+      
+      # Adds the country code to the front
+      # if it does not already start with it.
+      #
+      # Note: This won't be correct in some cases, but it is the best we can do.
+      #
+      def countrify number, cc
+        countrify!(number, cc) || number
+      end
+      def countrify! number, cc
+        number.sub!(/\A/, cc) # @countrify_regex, @cc
+      end
+
   end
 
 end

data/lib/phony/trunk_code.rb

@@ -14,6 +14,7 @@ module Phony
       @trunk_code_replacement = /\A#{code.gsub(%r{%s}, '')}/
       @normalize = options[:normalize] || options[:normalize].nil?
       @split     = options[:split]
+      @format    = options[:format] || options[:format].nil?
     end
     
     # Prepends itself to the other codes.
@@ -28,13 +29,21 @@ module Phony
     #
     def split national_number
       national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @split
-      return [@code, national_number]
+      return [self, national_number]
     end
     
+    # Normalize normalizes the given national number.
+    #
     def normalize national_number
       national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @normalize
       return national_number
     end
+    
+    # Format the trunk code using the spaces given.
+    #
+    def format space, force = nil
+      @code.size > 1 ? @code % space : @code if force || @format
+    end
   
   end
 

data/spec/functional/format_spec.rb

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+# This is a very helpful page for phone number formatting:
+# http://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers 
+#
 describe 'Phony#format' do
 
   describe 'cases' do
@@ -26,7 +29,7 @@ describe 'Phony#format' do
         Phony.format('71234567890', :format => '+%{cc} (%{trunk}%{ndc}) %{local}', :local_spaces => '-').should eql '+7 (8123) 45-67890'
       end
       it 'handles an American example correctly' do
-        Phony.format('13015550100', :format => '+%{cc} %{trunk}%{ndc} %{local}', :local_spaces => '-').should eql '+1 1 301 555-0100'
+        Phony.format('13015550100', :format => '+%{cc} %{trunk}%{ndc} %{local}', :local_spaces => '-').should eql '+1 301 555-0100'
       end
     end
     
@@ -86,19 +89,26 @@ describe 'Phony#format' do
       it { Phony.format('4233841148', :format => :international_relative, :spaces => :-).should eql '00423-384-11-48' }
     end
     describe 'NANP' do
-      it { Phony.format('18705551122').should eql '+1 870 555 1122' }
-      it { Phony.format('18091231234', :format => :international).should eql '+1 809 123 1234' }
-      it { Phony.format('18091231234', :format => :international, :spaces => '').should eql '+18091231234' }
+      it { Phony.format('18705551122').should eql '+1 (870) 555-1122' }
+      it { Phony.format('18091231234', :format => :international).should eql '+1 (809) 123-1234' }
+      it { Phony.format('18091231234', :format => :international, :spaces => '').should eql '+1(809)123-1234' }
       # Gets a trunk code.
-      it { Phony.format('14152223333', :format => :national).should eql '1 415 222 3333' }
+      it { Phony.format('14152223333', :format => :national).should eql '(415) 222-3333' }
       # Does not show a trunk code.
-      it { Phony.format('14152223333', :format => :national, :trunk => false).should eql '415 222 3333' }
-      it { Phony.format('18091231234', :format => :international, :spaces => :-).should eql '+1-809-123-1234' }
-      # leading trunk
-      it { Phony.format('14159224711', :format => :national).should eql '1 415 922 4711' }
+      it { Phony.format('14152223333', :format => :national).should eql '(415) 222-3333' }
+      it { Phony.format('18091231234', :format => :international, :spaces => :-).should eql '+1-(809)-123-1234' }
+      it { Phony.format('14159224711', :format => :national).should eql '(415) 922-4711' }
+      # With forced trunk.
+      it { Phony.format('14159224711', :format => :national, :trunk => true).should eql '1 (415) 922-4711' }
+      it { Phony.format('14159224711', :format => :national, :trunk => false).should eql '(415) 922-4711' }
+      # With forced parentheses.
+      it { Phony.format('14159224711', :format => :national, :parentheses => true).should eql '(415) 922-4711' }
+      it { Phony.format('14159224711', :format => :national, :parentheses => false).should eql '415 922-4711' }
     end
     describe 'Netherlands' do
       it { Phony.format('311012341234', :format => :national).should eql '010 123 41234' }
+      # With forced trunk.
+      it { Phony.format('311012341234', :format => :national, :trunk => true).should eql '010 123 41234' }
     end
     describe 'New Zealand' do
       it { Phony.format('6421123456').should eql '+64 21 123 456' }

data/spec/lib/phony/country_codes_spec.rb

@@ -6,54 +6,6 @@ describe Phony::CountryCodes do
     @countries = Phony::CountryCodes.instance
   end
 
-  describe 'international_absolute_format=' do
-    it 'formats correctly' do
-      @countries.formatted('41443643532', :format => :international).should eql '+41 44 364 35 32'
-    end
-    it 'formats correctly' do
-      old_format = @countries.international_absolute_format
-      @countries.international_absolute_format = '!!! %s%s%s%s%s'
-
-      @countries.formatted('41443643532', :format => :international).should eql '!!! 41 44 364 35 32'
-
-      @countries.international_absolute_format = old_format
-    end
-  end
-  describe 'international_relative_format=' do
-    it 'formats correctly' do
-      @countries.formatted('41443643532', :format => :international_relative).should eql '0041 44 364 35 32'
-    end
-    it 'formats correctly' do
-      old_format = @countries.international_relative_format
-      @countries.international_relative_format = '000 %s%s%s%s%s'
-
-      @countries.formatted('41443643532', :format => :international_relative).should eql '000 41 44 364 35 32'
-
-      @countries.international_relative_format = old_format
-    end
-  end
-  describe 'national_format=' do
-    it 'formats correctly' do
-      @countries.formatted('41443643532', :format => :international_relative).should eql '0041 44 364 35 32'
-    end
-    it 'formats correctly' do
-      old_format = @countries.national_format
-      @countries.national_format = '%s%s%s%s'
-
-      # Removes CC 1, but adds national call prefix 1.
-      #
-      @countries.formatted('11231231234', :format => :national).should eql '1 123 123 1234'
-
-      @countries.national_format = old_format
-    end
-  end
-
-  describe 'split' do
-    it 'splits correctly' do
-      @countries.split('41443643532').should eql ['41', '0', '44', '364', '35', '32']
-    end
-  end
-
   describe 'formatted' do
     it 'formats correctly' do
       @countries.formatted('41443643532', :format => :international, :spaces => :-).should eql '+41-44-364-35-32'
@@ -78,7 +30,10 @@ describe Phony::CountryCodes do
         @countries.formatted('85512239123', :format => :national).should eql '012 239 123'
       end
       it 'formats the US correctly' do
-        @countries.formatted('18005551212', :format => :national, :spaces => :-).should eql '1-800-555-1212'
+        @countries.formatted('18005551212', :format => :national, :spaces => :-).should eql '(800)-555-1212'
+      end
+      it 'formats the US correctly' do
+        @countries.formatted('18005551212', :format => :national, :spaces => :-).should eql '(800)-555-1212'
       end
     end
     context 'default' do
@@ -92,7 +47,7 @@ describe Phony::CountryCodes do
         @countries.formatted('43198110').should eql '+43 1 98110'
       end
       it "should format american numbers" do
-        @countries.formatted('18705551122').should eql '+1 870 555 1122'
+        @countries.formatted('18705551122').should eql '+1 (870) 555-1122'
       end
       it "should format irish numbers" do
         @countries.formatted('35311234567').should eql '+353 1 123 4567'
@@ -100,7 +55,7 @@ describe Phony::CountryCodes do
     end
     describe "international" do
       it "should format north american numbers" do
-        @countries.formatted('18091231234', :format => :international).should eql '+1 809 123 1234'
+        @countries.formatted('18091231234', :format => :international).should eql '+1 (809) 123-1234'
       end
       it "should format austrian numbers" do
         @countries.formatted('43198110', :format => :international).should eql '+43 1 98110'
@@ -149,7 +104,7 @@ describe Phony::CountryCodes do
       end
       context 'with no spaces' do
         it "should format north american numbers" do
-          Phony.formatted('18091231234', :format => :international, :spaces => '').should eql '+18091231234'
+          Phony.formatted('18091231234', :format => :international, :spaces => '').should eql '+1(809)123-1234'
         end
         it "should format austrian numbers" do
           Phony.formatted('43198110', :format => :international, :spaces => '').should eql '+43198110'
@@ -172,7 +127,7 @@ describe Phony::CountryCodes do
           Phony.formatted('41443643532', :format => :international).should eql '+41 44 364 35 32'
         end
         it "should format north american numbers" do
-          Phony.formatted('18091231234', :format => :international, :spaces => :-).should eql '+1-809-123-1234'
+          Phony.formatted('18091231234', :format => :international, :spaces => :-).should eql '+1-(809)-123-1234'
         end
         it "should format austrian numbers" do
           Phony.formatted('43198110', :format => :international, :spaces => :-).should eql '+43-1-98110'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phony
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies: []
 description: 'Fast international phone number (E164 standard) normalizing, splitting
   and formatting. Lots of formatting options: International (+.., 00..), national