phony 2.15.0 → 2.20.1

data/lib/phony/country_codes.rb

@@ -1,6 +1,6 @@
 module Phony
 
-  EMPTY_STRING = ''
+  EMPTY_STRING = '' unless defined?(EMPTY_STRING)
 
   # Handles determining the correct national code handler.
   #
@@ -66,7 +66,7 @@ module Phony
         country, cc, number = partial_split number
         country
       end
-      number = country.normalize number
+      number = country.normalize number, cc: cc
       countrify! number, cc
     end
 
@@ -77,7 +77,7 @@ module Phony
       country, cc, national_number = partial_split number
       
       # Split the national number into ndc and local part.
-      trunk, ndc, *local = country.split national_number
+      _, ndc, *local = country.split national_number
       
       [cc, ndc, *local]
     end
@@ -97,9 +97,20 @@ module Phony
 
       # False if it fails the basic check.
       #
-      return false unless (4..15) === normalized.size
+      return false unless (4..16) === normalized.size # unless hints[:check_length] == false
 
       country, cc, rest = partial_split normalized
+      
+      # Was a country calling code given?
+      #
+      if ccc = hints[:ccc]
+        cc, ndc, *local = split ccc
+        
+        raise ArgumentError.new("The provided ccc option is too long and includes more than a cc ('#{cc}') and ndc ('#{ndc}'). It also includes '#{local.join}'.") unless local.size == 1 && local[0].empty?
+        
+        hints[:cc] = cc
+        hints[:ndc] = ndc
+      end
 
       # Country code plausible?
       #
@@ -109,6 +120,8 @@ module Phony
       # Country specific tests.
       #
       country.plausible? rest, hints
+    rescue ArgumentError
+      raise
     rescue StandardError
       return false
     end

data/lib/phony/dsl.rb

@@ -12,9 +12,9 @@ module Phony
   #
   # Phony.define.country ...
   #
-  def self.define
+  def self.define(&block)
     dsl = DSL.new
-    dsl.instance_eval(&Proc.new) if block_given?
+    dsl.instance_eval(&block) if block_given?
     dsl
   end
 
@@ -41,6 +41,8 @@ module Phony
     #   country '27', # CC, followed by rules, for example fixed(2) >> ...
     #
     def country country_code, definition, options = {}
+      return unless Phony.config.load?(country_code)
+      
       definition.with country_code, options
       Phony::CountryCodes.instance.add country_code, definition
     end
@@ -139,7 +141,7 @@ module Phony
       #
       ndcs = ndcs.first if Array === ndcs.first
 
-      NationalSplitters::Variable.new options[:max_length], ndcs
+      NationalSplitters::Variable.new options[:max_length], ndcs.map(&:freeze)
     end
     
     # If you have a number of (possibly) variable length NDCs

data/lib/phony/local_splitters/fixed.rb

@@ -62,6 +62,8 @@ module Phony
       #
       #
       def plausible? rest, hints = {}
+        return true if hints[:check_length] == false
+        
         @length === rest.inject(0) { |total, part| total + part.size }
       end
       

data/lib/phony/national_code.rb

@@ -26,7 +26,7 @@ module Phony
     #
     # Note: Some cases, like Italy, don't remove the relative zero.
     #
-    def normalize national_number
+    def normalize national_number, options = {}
       national_number.gsub(/\A0+/, EMPTY_STRING)
     end
 

data/lib/phony/national_splitters/none.rb

@@ -31,9 +31,7 @@ module Phony
       # since using nil is dangerous and breaks
       # abstraction)
       #
-      # Note: Actually, it might stay in.
-      #
-      # TODO Flip nil/false?
+      # Note: Decided it stays in. When formatting, it's turned into nil.
       #
       def split national_number
         [nil, false, national_number]

data/lib/phony/trunk_code.rb

@@ -6,8 +6,9 @@ module Phony
     #  * 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).
+    #  * normalize: [true (default), false] Remove the trunk code when normalizing (only use if number scheme is defined unambiguously).
+    #  * split: [true, false (default)] Remove the trunk code when splitting (only use if number scheme is defined unambiguously).
+    #  * format: [true (default), false] Add the trunk code when formatting (passing `false` will not add it).
     #
     def initialize code, options = {}
       @code = code
@@ -34,8 +35,8 @@ module Phony
     
     # Normalize normalizes the given national number.
     #
-    def normalize national_number
-      national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @normalize
+    def normalize national_number, options = {}
+      national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @normalize && options[:cc]
       return national_number
     end
     

data/lib/phony/vanity.rb

@@ -20,7 +20,7 @@ module Phony
     end
     
     # Returns true if there is a character in the number
-    # after the first four numbers.
+    # after the first three numbers.
     #
     @@vanity_regexp = /\A\d{3}[a-zA-Z]{6,12}\Z/
     def self.vanity? number

data/lib/phony.rb

@@ -1,69 +1,75 @@
+# frozen_string_literal: true
+
+# NOTE We use Kernel.load here, as it's possible to redefine Phony via Phony::Config.
+
 # Framework.
 #
-require File.expand_path '../phony/vanity', __FILE__
-require File.expand_path '../phony/local_splitters/fixed', __FILE__
-require File.expand_path '../phony/local_splitters/regex', __FILE__
-require File.expand_path '../phony/national_splitters/dsl', __FILE__
-require File.expand_path '../phony/national_splitters/fixed', __FILE__
-require File.expand_path '../phony/national_splitters/variable', __FILE__
-require File.expand_path '../phony/national_splitters/regex', __FILE__
-require File.expand_path '../phony/national_splitters/default', __FILE__
-require File.expand_path '../phony/national_splitters/none', __FILE__
-require File.expand_path '../phony/national_code', __FILE__
-require File.expand_path '../phony/country', __FILE__
-require File.expand_path '../phony/trunk_code', __FILE__
-require File.expand_path '../phony/country_codes', __FILE__
-
-require File.expand_path '../phony/dsl', __FILE__
+load File.expand_path '../phony/config.rb', __FILE__
+load File.expand_path '../phony/vanity.rb', __FILE__
+load File.expand_path '../phony/local_splitters/fixed.rb', __FILE__
+load File.expand_path '../phony/local_splitters/regex.rb', __FILE__
+load File.expand_path '../phony/national_splitters/dsl.rb', __FILE__
+load File.expand_path '../phony/national_splitters/fixed.rb', __FILE__
+load File.expand_path '../phony/national_splitters/variable.rb', __FILE__
+load File.expand_path '../phony/national_splitters/regex.rb', __FILE__
+load File.expand_path '../phony/national_splitters/default.rb', __FILE__
+load File.expand_path '../phony/national_splitters/none.rb', __FILE__
+load File.expand_path '../phony/national_code.rb', __FILE__
+load File.expand_path '../phony/country.rb', __FILE__
+load File.expand_path '../phony/trunk_code.rb', __FILE__
+load File.expand_path '../phony/country_codes.rb', __FILE__
+load File.expand_path '../phony/dsl.rb', __FILE__
 
 # Countries.
 #
 # The ones that need more space to define.
 #
-require File.expand_path '../phony/countries/austria', __FILE__
-require File.expand_path '../phony/countries/bangladesh', __FILE__
-require File.expand_path '../phony/countries/belarus', __FILE__
-require File.expand_path '../phony/countries/brazil', __FILE__
-require File.expand_path '../phony/countries/cambodia', __FILE__
-require File.expand_path '../phony/countries/croatia', __FILE__
-require File.expand_path '../phony/countries/china', __FILE__
-require File.expand_path '../phony/countries/georgia', __FILE__
-require File.expand_path '../phony/countries/germany', __FILE__
-require File.expand_path '../phony/countries/guinea', __FILE__
-require File.expand_path '../phony/countries/india', __FILE__
-require File.expand_path '../phony/countries/indonesia', __FILE__
-require File.expand_path '../phony/countries/ireland', __FILE__
-require File.expand_path '../phony/countries/italy', __FILE__
-require File.expand_path '../phony/countries/japan', __FILE__
-require File.expand_path '../phony/countries/kyrgyzstan', __FILE__
-require File.expand_path '../phony/countries/latvia', __FILE__
-require File.expand_path '../phony/countries/libya', __FILE__
-require File.expand_path '../phony/countries/malaysia', __FILE__
-require File.expand_path '../phony/countries/moldova', __FILE__
-require File.expand_path '../phony/countries/montenegro', __FILE__
-require File.expand_path '../phony/countries/myanmar', __FILE__
-require File.expand_path '../phony/countries/namibia', __FILE__
-require File.expand_path '../phony/countries/nepal', __FILE__
-require File.expand_path '../phony/countries/netherlands', __FILE__
-require File.expand_path '../phony/countries/pakistan', __FILE__
-require File.expand_path '../phony/countries/paraguay', __FILE__
-require File.expand_path '../phony/countries/russia_kazakhstan_abkhasia_south_ossetia', __FILE__
-require File.expand_path '../phony/countries/serbia', __FILE__
-require File.expand_path '../phony/countries/somalia', __FILE__
-require File.expand_path '../phony/countries/south_korea', __FILE__
-require File.expand_path '../phony/countries/sweden', __FILE__
-require File.expand_path '../phony/countries/taiwan', __FILE__
-require File.expand_path '../phony/countries/tajikistan', __FILE__
-require File.expand_path '../phony/countries/turkmenistan', __FILE__
-require File.expand_path '../phony/countries/vietnam', __FILE__
-require File.expand_path '../phony/countries/ukraine', __FILE__
-require File.expand_path '../phony/countries/united_kingdom', __FILE__
-require File.expand_path '../phony/countries/uruguay', __FILE__
-require File.expand_path '../phony/countries/zimbabwe', __FILE__
+load File.expand_path '../phony/countries/argentina.rb', __FILE__
+load File.expand_path '../phony/countries/austria.rb', __FILE__
+load File.expand_path '../phony/countries/bangladesh.rb', __FILE__
+load File.expand_path '../phony/countries/belarus.rb', __FILE__
+load File.expand_path '../phony/countries/brazil.rb', __FILE__
+load File.expand_path '../phony/countries/cambodia.rb', __FILE__
+load File.expand_path '../phony/countries/croatia.rb', __FILE__
+load File.expand_path '../phony/countries/china.rb', __FILE__
+load File.expand_path '../phony/countries/georgia.rb', __FILE__
+load File.expand_path '../phony/countries/germany.rb', __FILE__
+load File.expand_path '../phony/countries/guinea.rb', __FILE__
+load File.expand_path '../phony/countries/india.rb', __FILE__
+load File.expand_path '../phony/countries/indonesia.rb', __FILE__
+load File.expand_path '../phony/countries/ireland.rb', __FILE__
+load File.expand_path '../phony/countries/italy.rb', __FILE__
+load File.expand_path '../phony/countries/japan.rb', __FILE__
+load File.expand_path '../phony/countries/kyrgyzstan.rb', __FILE__
+load File.expand_path '../phony/countries/latvia.rb', __FILE__
+load File.expand_path '../phony/countries/libya.rb', __FILE__
+load File.expand_path '../phony/countries/malaysia.rb', __FILE__
+load File.expand_path '../phony/countries/moldova.rb', __FILE__
+load File.expand_path '../phony/countries/montenegro.rb', __FILE__
+load File.expand_path '../phony/countries/myanmar.rb', __FILE__
+load File.expand_path '../phony/countries/namibia.rb', __FILE__
+load File.expand_path '../phony/countries/nepal.rb', __FILE__
+load File.expand_path '../phony/countries/netherlands.rb', __FILE__
+load File.expand_path '../phony/countries/pakistan.rb', __FILE__
+load File.expand_path '../phony/countries/paraguay.rb', __FILE__
+load File.expand_path '../phony/countries/russia_kazakhstan_abkhasia_south_ossetia.rb', __FILE__
+load File.expand_path '../phony/countries/saudi_arabia.rb', __FILE__
+load File.expand_path '../phony/countries/serbia.rb', __FILE__
+load File.expand_path '../phony/countries/somalia.rb', __FILE__
+load File.expand_path '../phony/countries/south_korea.rb', __FILE__
+load File.expand_path '../phony/countries/sweden.rb', __FILE__
+load File.expand_path '../phony/countries/taiwan.rb', __FILE__
+load File.expand_path '../phony/countries/tajikistan.rb', __FILE__
+load File.expand_path '../phony/countries/turkmenistan.rb', __FILE__
+load File.expand_path '../phony/countries/vietnam.rb', __FILE__
+load File.expand_path '../phony/countries/ukraine.rb', __FILE__
+load File.expand_path '../phony/countries/united_kingdom.rb', __FILE__
+load File.expand_path '../phony/countries/uruguay.rb', __FILE__
+load File.expand_path '../phony/countries/zimbabwe.rb', __FILE__
 
 # All other countries.
 #
-require File.expand_path '../phony/countries', __FILE__
+load File.expand_path '../phony/countries.rb', __FILE__
 
 # Phony is the main module and is generally used to process
 # E164 phone numbers directly.
@@ -75,11 +81,33 @@ module Phony
   # @example
   #   Phony.normalize("Fnork!") # Raises a Phony::NormalizationError.
   #
-  class NormalizationError < StandardError
+  class NormalizationError < ArgumentError
     def initialize
       super %Q{Phony could not normalize the given number. Is it a phone number?}
     end
   end
+  
+  # Raised in case Phony can't split a given number.
+  #
+  # @example
+  #   Phony.split("Fnork!") # Raises a Phony::SplittingError.
+  #
+  class SplittingError < ArgumentError
+    def initialize number
+      super %Q{Phony could not split the given number. Is #{(number.nil? || number == '') ? 'it' : number.inspect} a phone number?}
+    end
+  end
+  
+  # Raised in case Phony can't format a given number.
+  #
+  # @example
+  #   Phony.format("Fnork!") # Raises a Phony::FormattingError.
+  #
+  class FormattingError < ArgumentError
+    def initialize
+      super %Q{Phony could not format the given number. Is it a phone number?}
+    end
+  end
 
   # Phony uses a single country codes instance.
   #
@@ -120,6 +148,7 @@ module Phony
     #
     def normalize phone_number, options = {}
       raise ArgumentError, "Phone number cannot be nil. Use e.g. number && Phony.normalize(number)." unless phone_number
+      
       normalize! phone_number.dup, options
     end
     # A destructive version of {#normalize}.
@@ -161,7 +190,8 @@ module Phony
     #
     def split phone_number
       raise ArgumentError, "Phone number cannot be nil. Use e.g. number && Phony.split(number)." unless phone_number
-      split! phone_number.dup
+      
+      split! phone_number.dup, phone_number
     end
     # A destructive version of {#split}.
     #
@@ -177,8 +207,11 @@ module Phony
     # @example Split a NANP number.
     #   Phony.split!("13015550100") # => ["1", "301", "555", "0100"]
     #
-    def split! phone_number
+    def split! phone_number, error_number = nil
       @codes.split phone_number
+    rescue
+      # NB The error_number (reference) is used because phone_number is destructively handled.
+      raise SplittingError.new(error_number)
     end
 
     # Formats a normalized E164 number according to a country's formatting scheme.
@@ -230,6 +263,8 @@ module Phony
     #
     def format! phone_number, options = {}
       @codes.format phone_number, options
+    rescue
+      raise FormattingError.new
     end
     alias formatted  format
     alias formatted! format!

data/spec/functional/config_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+#
+describe 'Phony::Config' do
+  describe 'load' do
+    before do
+      # NOTE We redefine Phony as if it was not loaded for this set of tests.
+      Object.__send__(:remove_const, :Phony) if Object.constants.include?(:Phony)
+      
+      load 'phony/config.rb'
+    end
+    after(:all) do
+      # After running this suite, we load all of Phony for the following tests.
+      load 'phony/config.rb'
+      
+      Phony::Config.load
+    end
+    
+    it 'does not fail when loading all' do
+      Phony::Config.load
+      
+      Phony.split('15551115511').should == ['1', '555', '111', '5511']
+    end
+    it 'raises when a CC is used that has not been loaded.' do
+      Phony::Config.load('41')
+      
+      expect { Phony.split('15551115511') }.to raise_error
+    end
+    it 'raises when a CC is used that has not been loaded.' do
+      Phony::Config.load(only: ['41'])
+      
+      expect { Phony.split('15551115511') }.to raise_error
+    end
+    it 'raises when a CC is used that has not been loaded.' do
+      Phony::Config.load(except: ['1'])
+      
+      expect { Phony.split('15551115511') }.to raise_error
+    end
+    it 'does not raise when a CC is used that has been loaded.' do
+      Phony::Config.load(except: ['41'])
+      
+      Phony.split('15551115511').should == ['1', '555', '111', '5511']
+    end
+  end
+end