phony 2.17.3 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9810cd0d0649b6a41d966bb912e67b7a47ef2ec0c803a8858478e254b2cdcc6a
-  data.tar.gz: 56adabaa45b11c6e361e95db92873290fa64c0ea552ce074f1fc197c3d4b5355
+  metadata.gz: 7060b3843f748b526a0242338501d1aabd32e12302a3c995b8dcfe7d7e51083b
+  data.tar.gz: d688a27ee525838a92a6d257809f32bc65129bac8d69624ac637e6e3a8e6042a
 SHA512:
-  metadata.gz: 26da96f0c82807ff18ab0d408dffcecc9286d14fe63402297f9de9416c9b3eeb70790f6c75ad14f995dacb6ca0afac44e3c3be65ef89dd91f35ba7d0f4e221ce
-  data.tar.gz: 75cad2fd973fd52e84fb66e65fe712f0d8f62cc1045141d64468d2c28047b9d6d7f7cc810878a5ad29bdd5e4f7491cbaab5cceadcec2665f7b467e208b5493ba
+  metadata.gz: e2b6963e048c2de9a2d30f9b5a5df655149058345a22d13ec354e2737f4d23b8009f48afcdaf92f4062183dabce3013d82c37a9c1122c52e6c7f40622e70a7f0
+  data.tar.gz: '094d6b09c3aa9b7db89d3eddfc27e5019c6a624df85bf9264eb8dc8aad1a7a99742302743c4c3dfbe49d5898f2157874d9615dfbbfc39d3b6e1917137e7de2bb'

data/README.textile

@@ -11,10 +11,10 @@ The (admittedly crazy) goal of this Gem is to be able to normalize/format/split
 
 Used in: "airbnb.com":http://airbnb.com, "socialcam.com":http://socialcam.com, "zendesk.com":http://www.zendesk.com/ (and many, many others).
 
-h2. Runtime Memory Usage
+h2(#memory). Runtime Memory Usage
 
-According to "memory_profiler":https://github.com/SamSaffron/memory_profiler, the Phony gem uses roughly 2 MBs of memory per Ruby process.
-Usage was generated using: @ruby -e 'require "memory_profiler"; MemoryProfiler.report(allow_files: "phony"){ require "phony" }.pretty_print'@
+According to "memory_profiler":https://github.com/SamSaffron/memory_profiler, the Phony gem uses roughly 1.2 MBs of memory per Ruby process.
+Usage was generated using (look for @Total retained@): @ruby -e 'require "memory_profiler"; MemoryProfiler.report(allow_files: "phony"){ require "phony" }.pretty_print'@
 
 h2. Description
 
@@ -78,6 +78,30 @@ NB If a country does not have an NDC, @#split@ will return @false@ in the NDC po
 
 @Phony.split('4512121212').assert == ['45', false, '12', '12', '12', '12']@
 
+h3(#loading). Loading only a country subset (Phony 2.18.0+).
+
+Use this in case you'd like to save "memory":#memory that is used by Phony's CC rules.
+
+"Phony::Config.load docs":./qed/config.md
+
+First, @require 'phony/config'@.
+Then, one of the following, which will load the rest of Phony.
+
+Load only these CCs:
+@Phony::Config.load(only: ['41', '44'])@
+
+Loads everything except these CCs:
+@Phony::Config.load(except: ['41', '44'])@
+
+Convenience form of @only@:
+@Phony::Config.load('41', '44')@
+
+Each of these loads the rest of Phony.
+
+Memory usage can be checked using (look for @Total retained@):
+@ruby -e 'require "memory_profiler"; MemoryProfiler.report(allow_files: "phony"){ require "phony/config"; Phony::Config.load("1") }.pretty_print'@
+For example, when just loading the NANP CC, the retained memory usage is ~63kB.
+
 h2. List of Handled Countries
 
 Mildly unmaintained list: Abhas, Afghan, Algerian, Argentina, Austrian, Australian, Azerbaijani, Belgian, Brazilian, Cambodian, Chilean, Chinese, Croatian, Cuban, Cypriot, Czech, Danish, Dutch, Egyptian, El Salvadorian, Estonian, French, German, Ghanan, Gibraltar, Greek, Haiti, Hong Kong, Hungarian, Indian, Iran, Irish, Israel, Italian, Kazakh, Liberian, Lithuanian, Luxembourgian, Malaysian, Malta, Mexican, Monaco, Morocco, New Zealand, Nigerian, Norwegian, Peruvian, Polish, Romanian, Russian, Rwandan, Seychelles, Singapore, Slovakian, South African, South Korean, South Osetian, Spanish, Sri Lankan, Sudan, Swedish, Swiss, Thailand, Tunisian, Turkish, Liechtenstein, UK, US, Venezuelan, Vietnamese, and Zambian numbers.

data/lib/phony.rb

@@ -1,70 +1,72 @@
+# 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/saudi_arabia', __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/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.

data/lib/phony/config.rb

@@ -0,0 +1,89 @@
+module Phony
+  
+  # Add config.
+  class << self
+    attr_writer :config
+    
+    def config
+      # Default config includes all CCs.
+      @config ||= Config.new([], [])
+    end
+  end
+  
+  # The Config class is only used to configure Phony and to load specific
+  # subsets of CCs.
+  #
+  class Config
+    
+    attr_reader :included_ccs, :excluded_ccs
+    
+    def initialize included_ccs, excluded_ccs
+      @included_ccs = included_ccs || []
+      @excluded_ccs = excluded_ccs || []
+    end
+    
+    def load? cc
+      return false if has_excluded? && excluded_ccs.include?(cc)
+      
+      if has_included?
+        # We have to check the included_ccs, otherwise false.
+        return true if included_ccs.include?(cc)
+        
+        false
+      else
+        # It's not in excluded and no included was given.
+        true
+      end
+    end
+    def has_included?
+      !included_ccs.empty?
+    end
+    def has_excluded?
+      !excluded_ccs.empty?
+    end
+    
+    # Use as follows:
+    #
+    #   require 'phony/config'
+    #   
+    #   # Load only these:
+    #   Phony::Config.load(only: ['41', '44'])
+    #   # or all except these:
+    #   Phony::Config.load(except: ['41', '44'])
+    #   # or "only", in short form.
+    #   Phony::Config.load('41', '44')
+    #   # or even shorter form:
+    #   Phony::Config.load(41, 44)
+    #
+    def self.load *options
+      # Extract options.
+      last = options.last
+      only, except = if last.respond_to?(:to_hash)
+        # We have the explicit form.
+        [last[:only], last[:except]]
+      elsif options.respond_to?(:to_ary)
+        # We have the convenience short forms.
+        [options, []]
+      end
+      
+      # Set defaults.
+      only, except = [only || [], except || []]
+      # Convert to expected format if possible.
+      only, except = [only.map(&:to_s), except.map(&:to_s)]
+      
+      # Check params.
+      raise "Params given to Phony::Config.load must be Array-like. The one given was: #{only}" unless only.respond_to?(:to_ary)
+      raise "Params given to Phony::Config.load must be Array-like. The one given was: #{except}" unless except.respond_to?(:to_ary)
+      
+      # Configure Phony.
+      Phony.config = new(only, except)
+      
+      # Load phony.
+      Kernel.load File.expand_path('../../phony.rb', __FILE__)
+      
+      # Return the stored config data.
+      Phony.config
+    end
+    
+  end
+end

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.
   #

data/lib/phony/dsl.rb

@@ -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

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

data/spec/lib/phony/dsl_spec.rb

@@ -16,8 +16,8 @@ describe Phony::DSL do
     it 'checks for ( in regex' do
       expect { dsl.match(/123/) }.to raise_error("Regexp /123/ needs a group in it that defines which digits belong to the NDC.")
     end
-    it 'checks for ( in regex' do
-      dsl.match(/(123)/).should be_kind_of(Phony::NationalSplitters::Regex)
+    it 'should return a Phony::NationalSplitters::Regex' do
+      dsl.match(/(123)/).class.name.should == Phony::NationalSplitters::Regex.name
     end
   end
 

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

@@ -1,7 +1,14 @@
 require 'spec_helper'
 
+main = self
+
 describe Phony::LocalSplitters::Regex do
   
+  before do
+    load 'spec_helper_extensions.rb'
+    main.send :include, SpecHelperExtensions
+  end
+  
   describe 'instance_for' do
     it 'does not cache' do
       described_class.instance_for({}).should_not equal(described_class.instance_for({}))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phony
 version: !ruby/object:Gem::Version
-  version: 2.17.3
+  version: 2.18.0
 platform: ruby
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies: []
 description: 'Fast international phone number (E164 standard) normalizing, splitting
   and formatting. Lots of formatting options: International (+.., 00..), national
@@ -21,6 +21,7 @@ extra_rdoc_files:
 files:
 - README.textile
 - lib/phony.rb
+- lib/phony/config.rb
 - lib/phony/countries.rb
 - lib/phony/countries/austria.rb
 - lib/phony/countries/bangladesh.rb
@@ -77,6 +78,7 @@ files:
 - lib/phony/national_splitters/variable.rb
 - lib/phony/trunk_code.rb
 - lib/phony/vanity.rb
+- spec/functional/config_spec.rb
 - spec/functional/plausibility_spec.rb
 - spec/lib/phony/countries_spec.rb
 - spec/lib/phony/country_codes_spec.rb
@@ -132,4 +134,5 @@ test_files:
 - spec/lib/phony/local_splitters/regex_spec.rb
 - spec/lib/phony/local_splitters/fixed_spec.rb
 - spec/lib/phony/vanity_spec.rb
+- spec/functional/config_spec.rb
 - spec/functional/plausibility_spec.rb