phony 1.0.1 → 1.1.0

data/lib/phony/country_codes.rb

@@ -0,0 +1,102 @@
+module Phony
+  
+  # Handles determining the correct national code handler.
+  #
+  class CountryCodes
+    
+    def normalize number
+      # Remove non-digit chars.
+      #
+      number.gsub! /\D*/, ''
+      remove_relative_zeros! number
+    end
+    
+    # Splits this number into cc, ndc and locally split number parts.
+    #
+    def split number
+      national_handler, cc, rest = split_cc number
+      [cc, *national_handler.split(rest)]
+    end
+    
+    def formatted number, options = {}
+      format_cc_ndc_local options[:format], options[:spaces] || ' ', *split(number)
+    end
+    # Formats country code and national destination code.
+    #
+    def format_cc_ndc_local format, space, cc, ndc, *parts
+      "#{format_cc_ndc(format, space, cc, ndc)}#{format_local(space, parts)}"
+    end
+    def format_cc_ndc format, space, cc, ndc
+      format, split_phone_number = case format
+      when nil, :international_absolute, :international, :+
+        [ndc.blank? ? '+%s%s' : '+%s%s%s%s', [cc, space, ndc, space]]
+      when :international_relative
+        [ndc.blank? ? '00%s%s' : '00%s%s%s%s', [cc, space, ndc, space]]
+      when :national
+        [ndc.blank? ? '' : '0%s%s', [ndc, space]]
+      when :local
+        ['', []]
+      end
+      format % split_phone_number
+    end
+    def format_local space, parts_ary
+      parts_ary.join space.to_s
+    end
+    
+    # TODO Speed these methods up.
+    #
+    def service? number
+      national_handler, cc, rest = split_cc number
+      national_handler.service? rest
+    end
+    def mobile? number
+      national_handler, cc, rest = split_cc number
+      national_handler.mobile? rest
+    end
+    def landline? number
+      national_handler, cc, rest = split_cc number
+      national_handler.landline? rest
+    end
+    
+    # Is the given number a vanity number?
+    #
+    def vanity? number
+      national_handler, _, rest = split_cc number
+      national_handler.vanity? rest
+    end
+    # Converts a vanity number into a normalized E164 number.
+    #
+    def vanity_to_number vanity_number
+      national_handler, cc, rest = split_cc vanity_number
+      "#{cc}#{national_handler.vanity_to_number(rest)}"
+    end
+    
+    def split_cc rest
+      presumed_cc = ''
+      1.upto(3) do |i|
+        presumed_cc << rest.slice!(0..0)
+        national_code_handler = mapping[i][presumed_cc]
+        return [national_code_handler, presumed_cc, rest] if national_code_handler
+      end
+      # TODO raise
+    end
+    
+    # Removes 0s from partially normalized numbers
+    # such as 410443643533.
+    # 
+    # Example:
+    #   410443643533 -> 41443643533
+    def remove_relative_zeros! phone_number
+      _, cc, rest = split_cc phone_number
+      '%s%s' % [cc, rest].collect! { |code| code.gsub(/^0+/, '') }
+    end
+    
+    # Cached mapping of all countries.
+    #
+    def mapping
+      @mapping ||= Phony::Countries.mapping
+    end
+    
+  end
+  
+end

data/lib/phony/local_splitter.rb

@@ -0,0 +1,46 @@
+module Phony
+  
+  # Local splitter class to split the last part of
+  # a number, i.e. minus cc or ndc.
+  #
+  # Countries can create new instances according to their needs.
+  #
+  # Note: Countries should use instance_for
+  #       to avoid getting new local splitter instances.
+  #
+  class LocalSplitter
+    
+    @mapping = {}
+    
+    # Get a splitter for the given format.
+    #
+    # Caches the created splitter for the given format.
+    #
+    def self.instance_for format = nil
+      @mapping[format] ||= new(format)
+    end
+    
+    # Initialize with a local format, like [3, 2, 2] (also the default).
+    #
+    # The format [3, 2, 2] splits a number like '3332222' into ['333', '22', '22'].
+    #
+    def initialize format = nil
+      @format = format || [3, 2, 2]
+    end
+    
+    # Split a local number according to an assumed country specific format.
+    #
+    # Examples
+    # * split '3643533' # => ['364', '35', '33'] # (Switzerland)
+    #
+    def split number
+      @format.inject([]) do |result, size|
+        result << number.slice!(0..size-1)
+        return result if number.empty?
+        result
+      end
+    end
+    
+  end
+  
+end

data/lib/phony/national_code.rb

@@ -0,0 +1,27 @@
+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
+    
+    #
+    #
+    def initialize national_splitter, local_splitter
+      @national_splitter = national_splitter
+      @local_splitter    = local_splitter
+    end
+    
+    # Split gets a number without country code and splits it into
+    # its parts.
+    #
+    def split national_number
+      ndc, rest = @national_splitter.split national_number.dup
+      return ndc unless rest
+      [ndc, *@local_splitter.split(rest)]
+    end
+    
+  end
+  
+end

data/lib/phony/national_splitters/fixed.rb

@@ -0,0 +1,36 @@
+module Phony
+  
+  module NationalSplitters
+    
+    # TODO
+    #
+    class Fixed
+      
+      attr_writer :special_splitter
+      
+      @mapping = {}
+      
+      # Get a splitter for the given format.
+      #
+      # Caches the created splitter for the given format.
+      #
+      def self.instance_for size
+        @mapping[size] ||= new(size)
+      end
+      
+      def initialize size
+        @size = size
+      end
+      
+      # Takes a national number and splits it into ndc and rest.
+      #
+      def split national_number
+        return [national_number] unless @size
+        [national_number.slice!(0...@size), national_number]
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/phony/national_splitters/variable.rb

@@ -0,0 +1,64 @@
+module Phony
+  
+  module NationalSplitters
+    
+    class Variable < Fixed
+      
+      #
+      #
+      def initialize fallback, ndc_map
+        super fallback
+        @ndcs = restructure ndc_map
+      end
+      
+      # Takes a national number and splits it into ndc and rest.
+      #
+      def split national_number
+        fallback_number = national_number.dup
+        
+        # Extract a starting point.
+        #
+        presumed_code = if @mapped_ndc_min_length > 0
+          national_number.slice!(0..@mapped_ndc_min_length-1)
+        else
+          ''
+        end
+        
+        # Try for all possible mapped.
+        #
+        @mapped_ndc_min_length.upto(@mapped_ndc_max_length) do |i|
+          sized_ndcs = @ndcs[i]
+          return [presumed_code, national_number] unless sized_ndcs && !sized_ndcs.include?(presumed_code)
+          presumed_code << national_number.slice!(0..0)
+        end
+        
+        # Not found.
+        #
+        return super(fallback_number)
+      end
+      
+      private
+        
+        def restructure ndc_map
+          optimize ndc_map.values.flatten
+        end
+        
+        # Optimizes and restructures the given ndcs array.
+        #
+        def optimize(ndc_ary)
+          ndcs = {}
+          ndc_ary.each do |ndc|
+            ndcs[ndc.length] ||= []
+            ndcs[ndc.length] << ndc
+          end
+          keys = ndcs.keys
+          @mapped_ndc_min_length = keys.min # || 1
+          @mapped_ndc_max_length = keys.max
+          ndcs
+        end
+      
+    end
+    
+  end
+  
+end

data/lib/phony/vanity.rb

@@ -0,0 +1,35 @@
+module Phony
+  module Vanity
+    
+    # Returns a char to number mapping string for the String#tr method.
+    #
+    def self.mapping
+      @@mapping ||= [
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'.freeze,
+        '2223334445556667777888999922233344455566677778889999'.freeze
+      ]
+    end
+    
+    # Replaces (and normalizes) vanity characters of passed number with correct digits.
+    #
+    def self.replace number
+      number.tr *mapping
+    end
+    
+    # Returns true if there is a character in the number
+    # after the first four numbers.
+    #
+    @@vanity_regexp = /\A\d{3}[a-zA-Z]{6,12}\Z/
+    def self.vanity? number
+      !(normalized(number) =~ @@vanity_regexp).nil?
+    end
+    
+    # Vanity-Normalized.
+    #
+    @@vanity_normalizing_regexp = /^0*|[^\d\w]/
+    def self.normalized number
+      number.gsub @@vanity_normalizing_regexp, ''
+    end
+    
+  end
+end

data/spec/lib/phony/countries/austria_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Phony::Countries::Austria do
+  
+  before(:each) do
+    @austria = Phony::Countries::Austria
+  end
+  
+  describe "split" do
+    it "should handle Vienna" do
+      @austria.split('198110').should == ['1', '98110']
+    end
+    it "should handle some mobile services" do
+      @austria.split('66914093902').should == ['669', '14093902']
+    end
+    it "should handle Graz" do
+      @austria.split('3161234567891').should == ['316', '1234567891']
+    end
+    it "should handle Rohrau" do
+      @austria.split('2164123456789').should == ['2164', '123456789']
+    end
+  end
+  
+end

data/spec/lib/phony/countries/egypt_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Phony::Countries::Egypt do
+  
+  before(:each) do
+    @egypt = Phony::Countries::Egypt
+  end
+  
+  describe "split" do
+    it "works" do
+      @egypt.split('233453756').should == ['2', '33453756']
+    end
+    it "works" do
+      @egypt.split('921234567').should == ['92', '1234567']
+    end
+  end
+  
+end

data/spec/lib/phony/countries/germany_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Phony::Countries::Germany do
+  
+  before(:each) do
+    @germany = Phony::Countries::Germany
+  end
+  
+  describe "split" do
+    it "should handle Berlin" do
+      @germany.split('3038625454').should == ['30', '386', '25454']
+    end
+    it "should handle Cologne" do
+      @germany.split('22137683323').should == ['221', '376', '83323']
+    end
+    it "should handle Freiburg im Breisgau" do
+      @germany.split('7614767676').should == ['761', '476', '7676']
+    end
+    it "should handle Nettetal-Lobberich" do
+      @germany.split('21535100').should == ['2153', '510', '0']
+    end
+  end
+  
+end

data/spec/lib/phony/countries/greece_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Phony::Countries::Greece do
+  
+  before(:each) do
+    @greece = Phony::Countries::Greece
+  end
+  
+  describe "split" do
+    it 'works' do
+      @greece.split('21123456').should == ['21', '123456']
+    end
+    it 'works' do
+      @greece.split('25941234').should == ['2594', '1234']
+    end
+  end
+  
+end

data/spec/lib/phony/countries/hungary_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Phony::Countries::Hungary do
+  
+  before(:each) do
+    @hungary = Phony::Countries::Hungary
+  end
+  
+  describe "split" do
+    it 'handles Budapest' do
+      @hungary.split('12345678').should == ['1', '234', '5678']
+    end
+    it 'works' do
+      @hungary.split('22123456').should == ['22', '123', '456']
+    end
+  end
+  
+end

data/spec/lib/phony/countries/switzerland_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'Switzerland' do
+  
+  before(:each) do
+    @switzerland = Phony::Countries.with_cc '41'
+  end
+  
+  describe "split" do
+    it "works" do
+      @switzerland.split('443643532').should == ['44', '364', '35', '32']
+    end
+    it "works" do
+      @switzerland.split('800123456').should == ['800', '123', '456']
+    end
+  end
+  
+end