phony 1.2.11 → 1.3.0

data/lib/phony/country_codes.rb

@@ -4,6 +4,12 @@ module Phony
   #
   class CountryCodes
     
+    attr_reader :mapping
+    
+    def self.instance
+      @instance ||= new
+    end
+    
     def normalize number
       # Remove non-digit chars.
       #
@@ -44,6 +50,8 @@ module Phony
       parts_ary.join space.to_s
     end
     
+    #
+    #
     def service? number
       national_handler, cc, rest = split_cc number
       national_handler.service? rest
@@ -80,10 +88,22 @@ module Phony
       # This line is never reached as CCs are in prefix code.
     end
     
-    # Cached mapping of all countries.
+    # # 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.
     #
-    def mapping
-      @mapping ||= Phony::Countries.mapping
+    def add country_code, country
+      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
     end
     
   end

data/lib/phony/dsl.rb

@@ -0,0 +1,78 @@
+# # Ideas for a DSL:
+# #
+# 
+# # Switzerland
+# #
+# country('41', fixed(2) >> local([3,2,2]))
+# country(match(/^1.*$/) >> [3,3] || none >> [2,2,2,2])
+# 
+# # Germany. Too big.
+# #
+# country('49', Countries::Germany)
+# #
+# # … and in Germany:
+# #
+# include Phony::DSL
+# Countries::Germany = match(...) >> split([...]) ||
+#                      one_of([...], :max_length => 5) >> split([...])
+# 
+# # Denmark.
+# #
+# country('45', none >> split([2,2,2,2])) # Denmark.
+# 
+# # Hungary.
+# # 
+# country('36',
+#         match(/^104|105|107|112/) >> split([3,3]) ||
+#         one_of([1], :max_length => 2) >> split([3,4])
+# )
+
+module Phony
+  
+  module DSL
+
+    # 
+    #
+    def country country_code, country
+      Phony::CountryCodes.instance.add country_code, country
+    end
+
+    # National matcher & splitters.
+    #
+    
+    # 
+    #
+    def fixed size
+      NationalSplitters::Fixed.instance_for size
+    end
+    def none
+      NationalSplitters::None.instance_for
+    end
+    def one_of *ndcs
+      options = Hash === ndcs.last ? ndcs.pop : {}
+      
+      # Ruby 1.8 compatibility mode.
+      #
+      ndcs = ndcs.first if Array === ndcs.first
+      
+      NationalSplitters::Variable.new options[:max_length], ndcs
+    end
+    def match regex, options = {}
+      NationalSplitters::Regex.instance_for regex, options[:on_fail_take]
+    end
+    
+    # Local splitters.
+    #
+    
+    #
+    #
+    def split *local
+      LocalSplitters::Fixed.instance_for local
+    end
+    def matched_split options = {}
+      Phony::LocalSplitters::Regex.instance_for options
+    end
+    
+  end
+  
+end

data/lib/phony/national_code.rb

@@ -1,7 +1,5 @@
 module Phony
   
-  # This is the superclass of all special national number handlers.
-  #
   # NationalCodes have a special numbers splitter, a national code splitter and a local code splitter.
   #
   class NationalCode
@@ -11,7 +9,7 @@ module Phony
     def initialize national_splitter, local_splitter, normalize = nil
       @national_splitter = national_splitter
       @local_splitter    = local_splitter
-      @normalize         = !(normalize == false) # if nil, true (default), if false, false, if true, true.
+      @normalize         = normalize != false
     end
     
     # Split gets a number without country code and splits it into
@@ -20,8 +18,7 @@ module Phony
     def split national_number
       ndc, rest = @national_splitter.split national_number.dup
       return ndc unless rest
-      local = @local_splitter.split rest
-      ndc ? [ndc, *local] : local
+      [ndc, *@local_splitter.split(rest)]
     end
     
     # Split gets a number without country code and removes a relative zero.

data/lib/phony/national_splitters/dsl.rb

@@ -0,0 +1,20 @@
+module Phony
+  
+  module NationalSplitters
+    
+    # TODO
+    #
+    class DSL
+      
+      # TODO normalize option!
+      #
+      def >> local_splitter
+        national_code = Phony::NationalCode.new self, local_splitter
+        Phony::Country.new national_code
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/phony/national_splitters/fixed.rb

@@ -4,7 +4,7 @@ module Phony
     
     # TODO
     #
-    class Fixed < Experimental
+    class Fixed < DSL
       
       attr_writer :special_splitter
       

data/lib/phony/national_splitters/none.rb

@@ -5,7 +5,7 @@ module Phony
     # This is a national splitter for countries
     # which have no NDC / Area Code.
     #
-    class None < Experimental
+    class None < DSL
       
       # Get a splitter. Caches.
       #

data/lib/phony/national_splitters/regex.rb

@@ -0,0 +1,49 @@
+module Phony
+  
+  module NationalSplitters
+    
+    # National splitter class to split the ndc-local part of a number.
+    #
+    # Countries can create new instances according to their needs.
+    #
+    # Note: Countries should use instance_for
+    #       to avoid getting new local splitter instances.
+    #
+    class Regex < Fixed
+      
+      attr_reader :on_fail_take, :regex
+      
+      # Get a splitter for the given format.
+      #
+      # Note: Not cached.
+      #
+      def self.instance_for regex, on_fail_take = nil
+        new regex, on_fail_take
+      end
+
+      def initialize regex, on_fail_take = nil
+        super on_fail_take
+
+        @regex = regex
+      end
+    
+      # Split a local number according to an assumed country specific format.
+      #
+      # Examples
+      # * split '3643533' # => ['364', '35', '33'] # (Switzerland)
+      #
+      def split number
+        # Improve matching.
+        #
+        return [number.slice!(0..$1.size-1), number] if number =~ regex
+        
+        # Not found.
+        #
+        super number
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/phony/national_splitters/variable.rb

@@ -6,9 +6,9 @@ module Phony
       
       #
       #
-      def initialize fallback, ndc_map
+      def initialize fallback, ndcs
         super fallback
-        @ndcs = restructure ndc_map
+        @ndcs = optimize ndcs
       end
       
       # Takes a national number and splits it into ndc and rest.
@@ -34,14 +34,14 @@ module Phony
         
         # Not found.
         #
-        return super(fallback_number)
+        super fallback_number
       end
       
       private
         
-        def restructure ndc_map
-          optimize ndc_map.values.flatten
-        end
+        # def restructure ndc_map
+        #   optimize ndc_map.values.flatten
+        # end
         
         # Optimizes and restructures the given ndcs array.
         #

data/lib/phony/vanity.rb

@@ -1,4 +1,7 @@
 module Phony
+  
+  # Helper module that maps vanity numbers to digit numbers.
+  #
   module Vanity
     
     # Returns a char to number mapping string for the String#tr method.

data/spec/lib/phony/country_codes_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Phony::CountryCodes do
   
   before(:all) do
-    @countries = Phony::CountryCodes.new
+    @countries = Phony::CountryCodes.instance
   end
   
   describe 'split' do

data/spec/lib/phony/country_spec.rb

@@ -2,57 +2,24 @@ require 'spec_helper'
 
 describe Phony::Country do
   
-  describe "configured" do
-    context "with variable ndcs" do
+  context 'regression' do
+    describe 'iceland' do
       before(:each) do
-        @country = Phony::Country.configured :local_format         => [3, 2, 2],
-                                             :service_local_format => [3, 3],
-                                             :mobile_local_format  => [1, 2, 4],
-                                             :ndc_fallback_length  => 4,
-                                             :ndc_mapping => {
-                                               :normal  => ['44'],
-                                               :service => ['800'],
-                                               :mobile  => ['76']
-                                             }
-      end
-      it 'works for normal numbers' do
-        @country.split('443643532').should == ['44', '364', '35', '32']
-      end
-      it 'works with service numbers' do
-        @country.split('800333666').should == ['800', '333', '666']
-      end
-      it 'works with mobile numbers' do
-        @country.split('764333532').should == ['76', '4', '33', '3532']
-      end
-      it 'uses the fallback if it is not in the mapping' do
-        @country.split('123456789').should == ['1234', '567', '89']
-      end
-    end
-    context "with fixed ndcs" do
-      before(:each) do
-        @country = Phony::Country.fixed :ndc_length           => 2,
-                                        :local_format         => [3, 2, 2],
-                                        :service_local_format => [3, 3],
-                                        :service_ndcs         => ['800']
-      end
-      it 'works for non-service numbers' do
-        @country.split('443643532').should == ['44', '364', '35', '32']
-      end
-      it 'works for service numbers' do
-        @country.split('800333666').should == ['800', '333', '666']
-      end
-      it 'works with mobile numbers' do
-        @country.split('764333532').should == ['76', '433', '35', '32']
+        national_splitter = Phony::NationalSplitters::None.instance_for
+        local_splitter    = Phony::LocalSplitters::Fixed.instance_for [3, 4]
+
+        national_code     = Phony::NationalCode.new national_splitter, local_splitter
+        @iceland          = described_class.new national_code
       end
-      it 'uses a fixed length' do
-        @country.split('123456789').should == ['12', '345', '67', '89']
+      it 'splits correctly' do
+        @iceland.split('112').should == ['112']
       end
     end
   end
   
   context "without special cases" do
     before(:each) do
-      national_splitter = Phony::NationalSplitters::Variable.new 4, { :normal => ['44'] }
+      national_splitter = Phony::NationalSplitters::Variable.new 4, ['44']
       local_splitter    = Phony::LocalSplitters::Fixed.instance_for [3, 2, 2]
       national_code     = Phony::NationalCode.new national_splitter, local_splitter
       
@@ -73,11 +40,11 @@ describe Phony::Country do
   
   context "without special cases" do
     before(:each) do
-      special_national_splitter = Phony::NationalSplitters::Variable.new nil, { :service => ['800'] }
+      special_national_splitter = Phony::NationalSplitters::Variable.new nil, ['800']
       special_local_splitter    = Phony::LocalSplitters::Fixed.instance_for [3, 3]
       special_code              = Phony::NationalCode.new special_national_splitter, special_local_splitter
       
-      national_splitter         = Phony::NationalSplitters::Variable.new 4, { :normal => ['44'] }
+      national_splitter         = Phony::NationalSplitters::Variable.new 4, ['44']
       local_splitter            = Phony::LocalSplitters::Fixed.instance_for [3, 2, 2]
       national_code             = Phony::NationalCode.new national_splitter, local_splitter
       

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

@@ -43,6 +43,14 @@ describe Phony::LocalSplitters::Fixed do
         @splitter.split('364353').should == ['364','35','3']
       end
     end
+    context "with hard number (iceland regression)" do
+      before(:each) do
+        @splitter = described_class.new [3, 4]
+      end
+      it 'splits correctly' do
+        @splitter.split('112').should == ['112']
+      end
+    end
   end
   
 end

data/spec/lib/phony/national_code_spec.rb

@@ -3,6 +3,19 @@ require 'spec_helper'
 describe Phony::NationalCode do
   
   describe 'split' do
+    context 'regression' do
+      describe 'iceland' do
+        before(:each) do
+          national_splitter = Phony::NationalSplitters::None.instance_for
+          local_splitter    = Phony::LocalSplitters::Fixed.instance_for [3, 4]
+
+          @national         = Phony::NationalCode.new national_splitter, local_splitter
+        end
+        it 'splits correctly' do
+          @national.split('112').should == [nil, '112']
+        end
+      end
+    end
     context 'with fixed ndc (Swiss)' do
       before(:each) do
         national_splitter = Phony::NationalSplitters::Fixed.instance_for 2

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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Phony::NationalSplitters::Regex do
+  
+  describe 'instance_for' do
+    it 'caches correctly (not)' do
+      described_class.instance_for(//).should_not equal(described_class.instance_for(//))
+    end
+  end
+  
+  describe 'split' do
+    context 'without on_fail' do
+      let(:splitter) { described_class.instance_for(/^(123)\d+$/) }
+    end
+    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 == ['23', '456789']
+      end
+    end
+  end
+  
+end

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

@@ -5,9 +5,7 @@ describe Phony::NationalSplitters::Variable do
   describe 'split' do
     context 'normal' do
       before(:each) do
-        @splitter = Phony::NationalSplitters::Variable.new 4, :normal  => ['1', '316'],
-                                                              :mobile  => ['67', '68',],
-                                                              :service => ['669', '711']
+        @splitter = Phony::NationalSplitters::Variable.new 4, ['1', '316', '67', '68', '669', '711']
       end
       it "handles Vienna" do
         @splitter.split('198110').should == ['1', '98110']
@@ -24,7 +22,7 @@ describe Phony::NationalSplitters::Variable do
     end
     context 'special handling for using the variable size splitter for Swiss service numbers' do
       before(:each) do
-        @splitter = Phony::NationalSplitters::Variable.new 2, :service => ['800']
+        @splitter = Phony::NationalSplitters::Variable.new 2, ['800']
       end
       it "should handle swiss service numbers" do
         @splitter.split('800223344').should == ['800', '223344']