countries-phone_numbers 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d299eda3bc0d2e84c08d735a501c4c47398964c
-  data.tar.gz: b33baf81c54d96734b71fc0f82383d35704e4b12
+  metadata.gz: 86db77726a2eb98b11c2aef026b1d121d3dcd184
+  data.tar.gz: b0083df537fe9839eb25f25a1a19148d4b581e2d
 SHA512:
-  metadata.gz: 68f5972c6d39e1106b576408360cbdb69c4cdcd81c56af2e7a85193b41edc22dc6af128ae05c6a4d519f96b124bc8b90c30a0bd58e2081431cf28cf44cc79c65
-  data.tar.gz: 42d5ee3f67a0874ec07b5a303be69a1a172b590e7c724e45c67e988b3073f4a672e3ebadd8afc1f65d0d1900fa763766ff8539ac88ce2d0dd2b6576a82851a17
+  metadata.gz: db79a2bdc029e69156295bc0790c4034e4c213dc72d60ed70bff13ff3a972541dfbf7b94f6effc150f3d946774143ca3202fdcb57c908dbdc058d0917f41e8d9
+  data.tar.gz: 2058fb544e19f9da9b3f9734f6112ec8043fa78e51513c9db3b6a524873ef705aa7f1ad7b842100498b21998f45c43c780bb54177f25dbb92196e3732848e837

data/countries-phone_numbers.gemspec

@@ -24,4 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "simplecov"
+  
 end

data/lib/countries/iso3166.rb

@@ -8,7 +8,7 @@ class ISO3166::Country
   end
 
   def self.tokenize_phone_number( number )
-    Phony.split( Phony.normalize( number ) )
+    Phony.split( normalize_phone_number( number ) )
   end
 
   ##
@@ -23,15 +23,16 @@ class ISO3166::Country
   # Generally we try to eliminate duplicates by using country code specific detectors.
   def self.find_all_by_phone_number( number )
     normalised_number = tokenize_phone_number( number )
+    country_code = normalised_number.first
     
     # Is this a detector country?
-    detector = phone_number_detectors[normalised_number.first]
+    detector = phone_number_detector_factory.detector_for( country_code )
     if detector
       return detector.find_all_by_phone_number( normalised_number )
      
     # Otherwise ask the general code base for the number
     else
-      return self.find_all_by_country_code( normalised_number.first )
+      return find_all_by_country_code( country_code )
     end
 
   rescue
@@ -50,33 +51,22 @@ class ISO3166::Country
   # Generally we try to eliminate duplicates by using country code specific detectors.
   def self.find_all_countries_by_phone_number( number )
     normalised_number = tokenize_phone_number( number )
+    country_code = normalised_number.first
     
     # Is this a detector country?
-    detector = phone_number_detector_for normalised_number.first
+    detector = phone_number_detector_factory.detector_for( country_code )
     if detector
       return detector.find_all_countries_by_phone_number( normalised_number )
      
     # Otherwise ask the general code base for the number
     else
-      return self.find_all_countries_by_country_code( normalised_number.first )
+      return find_all_countries_by_country_code( country_code )
     end
 
   rescue
    return nil
   end
 
-  ##
-  # Get the requested phone number detector based on the phone number's prefix.
-  def self.phone_number_detector_for( prefix )
-    prefix = prefix.to_s
-    detector = phone_number_detectors[ prefix ]
-    if detector.is_a? Hash
-      detector = Countries::PhoneNumbers::CountryDetector.build( detector )
-      phone_number_detectors[ prefix ] = detector
-    end
-    detector
-  end
-  
   ##
   # Find all countries with shared country codes.
   def self.shared_country_codes
@@ -89,28 +79,13 @@ class ISO3166::Country
   ##
   # Find all countries with shared country codes and do not have a dedicated detector.
   def self.unresolved_country_codes
-    self.shared_country_codes.reject{ |key,value| self.phone_number_detectors.keys.include? key or key == '' }
+    self.shared_country_codes.reject{ |key,value| self.phone_number_detector_factory.detector_for? key or key == '' }
   end
   
 protected
 
-  ##
-  # Collection of country detectors. Detectors are instantiated only when first needed.
-  def self.phone_number_detectors
-    @@phone_number_detectors ||= load_phone_number_detector_config
-  end
-  
-  ##
-  # Load phone number detector configuration.
-  def self.load_phone_number_detector_config
-    filename = File.join( 'lib', 'countries', 'phone_numbers', 'country_detectors.yaml' )
-    config = {}
-    File.open( filename ) do |file|
-      YAML.load_documents( file ) do |doc|
-        config[doc['applies_to'].to_s] = doc
-      end
-    end
-    config
+  def self.phone_number_detector_factory
+    @@phone_number_detector_factory ||= Countries::PhoneNumbers::DetectorFactory.new
   end
   
 end

data/lib/countries/phone_numbers/country_detector.rb

@@ -2,18 +2,6 @@ class Countries::PhoneNumbers::CountryDetector
 
   attr_accessor :country_codes, :applies_to, :default
   
-  def self.build config
-    # Build a new config tool based on the given strategy
-    return case
-      when config.include?('start_with')
-        Countries::PhoneNumbers::StartWithCountryDetector.new config
-      when config.include?('one_of')
-        Countries::PhoneNumbers::OneOfCountryDetector.new config
-      else
-        Countries::PhoneNumbers::CountryDetector.new config
-      end
-  end
-  
   def initialize config
     self.applies_to = config['applies_to'].to_s
     self.default = config['default'].to_s

data/lib/countries/phone_numbers/detector_factory.rb

@@ -0,0 +1,49 @@
+class Countries::PhoneNumbers::DetectorFactory
+
+  attr_accessor :config, :detectors
+
+  def initialize( config=Countries::PhoneNumbers::DATA_FILE )
+    @config    = config.is_a?(Hash) ? config : {}
+    @detectors = {}
+    load_config_file( config ) if config.is_a?(String)
+  end
+  
+  def load_config_file( filename )
+    File.open( filename ) do |file|
+      YAML.load_documents( file ) { |doc| add_config( doc ) }
+    end
+  end
+  
+  def add_config( cc )
+    key = cc['applies_to'].to_s
+    config[key] = cc
+    detectors.delete(key)
+  end
+  
+  def detector_for?( prefix )
+    config.include? prefix.to_s
+  end
+  
+  def detector_for( prefix )
+    prefix = prefix.to_s
+    if detector_for? prefix
+      detectors[prefix] = build_detector( config[prefix] ) unless detectors.include? prefix
+    end
+    return detectors[prefix]
+  end
+  
+  protected
+  
+  def build_detector( config )
+    # Build a new config tool based on the given strategy
+    return case
+      when config.include?('start_with')
+        Countries::PhoneNumbers::StartWithCountryDetector.new config
+      when config.include?('one_of')
+        Countries::PhoneNumbers::OneOfCountryDetector.new config
+      else
+        Countries::PhoneNumbers::CountryDetector.new config
+      end
+  end
+
+end

data/lib/countries/phone_numbers/version.rb

@@ -1,5 +1,5 @@
 module Countries
   module PhoneNumbers
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/countries/phone_numbers.rb

@@ -5,6 +5,7 @@ require 'countries'
 require 'phony'
 
 # Country::PhoneNumber
+require 'countries/phone_numbers/detector_factory'
 require 'countries/phone_numbers/country_detector'
 require 'countries/phone_numbers/one_of_country_detector'
 require 'countries/phone_numbers/start_with_country_detector'
@@ -14,5 +15,6 @@ require 'countries/iso3166'
 
 module Countries
   module PhoneNumbers
+    DATA_FILE = File.join( 'lib', 'countries', 'phone_numbers', 'detectors.yaml' )
   end
 end

data/spec/countries/phone_numbers/detector_factory_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'countries/phone_numbers'
+
+describe Countries::PhoneNumbers::DetectorFactory do
+  subject { Countries::PhoneNumbers::DetectorFactory.new({}) }
+  let(:applies_to)        { '1' }
+  let(:one_of_prefix)     { '222' }
+  let(:start_with_prefix) { '333' }
+  let(:default_country)   { 'US' }
+  let(:alternate_country) { 'GB' }
+
+  let(:default_config)    { { 'applies_to' => applies_to, 'default' => default_country } }
+  let(:one_of_config)     { { 'applies_to' => applies_to, 'default' => default_country, 'one_of' => { alternate_country => [ one_of_prefix ] } } }
+  let(:start_with_config) { { 'applies_to' => applies_to, 'default' => default_country, 'start_with' => { alternate_country => [ start_with_prefix ] } } }
+
+  let(:default_detector)  { Countries::PhoneNumbers::CountryDetector.new(default_config) }
+  
+  describe '.new' do
+
+    context 'using a config file' do
+      subject { Countries::PhoneNumbers::DetectorFactory.new(Countries::PhoneNumbers::DATA_FILE) }
+      it 'loads the config file' do
+        expect( subject.config ).not_to be_empty
+      end
+      it 'starts with no detectors' do
+        expect( subject.detectors ).to be_empty
+      end
+    end
+
+    context 'using a config hash' do
+      let(:config) { { applies_to => default_config } }
+      subject { Countries::PhoneNumbers::DetectorFactory.new(config) }
+      it 'saves the config' do
+        expect( subject.config ).to eq(config)
+      end
+      it 'starts with no detectors' do
+        expect( subject.detectors ).to be_empty
+      end
+    end
+
+  end
+
+  describe '#load_config_file' do
+    it 'loads a config file' do
+      expect{ subject.load_config_file( Countries::PhoneNumbers::DATA_FILE ) }.to change{subject.config.size}.from(0)
+    end
+  end
+  
+  describe '#add_config' do
+    before { subject.detectors[applies_to] = default_detector }
+    
+    it 'adds a new config' do
+      expect{ subject.add_config(default_config) }.to change{subject.config.size}.by(1)
+    end
+    
+    it 'stores config by key' do
+      subject.add_config(default_config)
+      expect( subject.config ).to include(applies_to)
+    end
+    
+    it 'saves config by key' do
+      subject.add_config(default_config)
+      expect( subject.config[applies_to] ).to be default_config
+    end
+    
+    it 'deletes the existing detector' do
+      expect{ subject.add_config(default_config) }.to change{ subject.detectors[applies_to] }.to(nil)
+    end
+  end
+  
+  describe '#detector_for?' do
+    it 'detects config' do
+      expect{ subject.add_config(default_config) }.to change{ subject.detector_for? applies_to }.from(false).to(true)
+    end
+  end
+  
+  describe '#detector_for' do
+    before do
+      subject.add_config( default_config )
+    end
+
+    it 'reuses an existing detector' do
+      subject.detectors[applies_to] = default_detector
+      expect(subject.detector_for(applies_to)).to eq(default_detector)
+    end
+    
+    it 'creates a new detector on demand' do
+      subject.add_config( default_config )
+      expect{ subject.detector_for(applies_to) }.to change{ subject.detectors[applies_to] } 
+    end
+    
+    it 'returns nil when no detector configured' do
+      expect( subject.detector_for('2') ).to be_nil
+    end
+  end
+  
+  describe '#build_detector' do
+    it 'returns a generic detector' do
+      expect( subject.send(:build_detector, default_config) ).to be_a(Countries::PhoneNumbers::CountryDetector)
+    end
+    
+    it 'returns a one-of detector' do
+      expect( subject.send(:build_detector, one_of_config) ).to be_a(Countries::PhoneNumbers::OneOfCountryDetector)
+    end
+    
+    it 'returns a start-with detector' do
+      expect( subject.send(:build_detector, start_with_config) ).to be_a(Countries::PhoneNumbers::StartWithCountryDetector)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'json'
+
+require 'simplecov'
+SimpleCov.start
+
 require 'countries/phone_numbers'
 
 require 'yaml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: countries-phone_numbers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ian Lloyd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: countries
@@ -80,6 +80,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Find countries by phone numbers
 email:
 - ian.w.lloyd@me.com
@@ -97,11 +125,13 @@ files:
 - lib/countries/iso3166.rb
 - lib/countries/phone_numbers.rb
 - lib/countries/phone_numbers/country_detector.rb
-- lib/countries/phone_numbers/country_detectors.yaml
+- lib/countries/phone_numbers/detector_factory.rb
+- lib/countries/phone_numbers/detectors.yaml
 - lib/countries/phone_numbers/one_of_country_detector.rb
 - lib/countries/phone_numbers/start_with_country_detector.rb
 - lib/countries/phone_numbers/version.rb
 - spec/countries/country_spec.rb
+- spec/countries/phone_numbers/detector_factory_spec.rb
 - spec/spec_helper.rb
 - spec/test_data.yaml
 homepage: http://github.com/illoyd/countries-phone_numbers
@@ -130,5 +160,6 @@ specification_version: 4
 summary: Integrate phone number searching into the Country gem using Phony
 test_files:
 - spec/countries/country_spec.rb
+- spec/countries/phone_numbers/detector_factory_spec.rb
 - spec/spec_helper.rb
 - spec/test_data.yaml