phonelib 0.6.54 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14b66f811632e1127f59129e7ae723e5414578f1d792a9bdbb7b56322e542d7
-  data.tar.gz: 9869b24e806b4452e793fe11b4f99ce1cfdbf245479ef6c132fe6ab622f658e8
+  metadata.gz: 2cc35b2b49e08abb5a2da2075e9ff6a33398b9e07a97fdc1e377ccb273eb3114
+  data.tar.gz: fee9d2ac1700bbe33c056f0d658e8a260408acf320e76e62b4f993efe31fe940
 SHA512:
-  metadata.gz: 457f7d9ed48b836d75f595ffee60cffc50ba5191ea86e1c0f0dc2600aa98bb1a7d6f2a56e7784323916635c6927f4231cf4ae552c7b343a471e1067e2dcb7608
-  data.tar.gz: eb5396872ae956a2b6611b7d6df5f7f2d05f8d965d27368eacd9efb5c38627c312eef8582d0894908e06e5944a43f8fd880e6346fe3fefe5ada6ef4e1499f85b
+  metadata.gz: 0f24a98ff377ab4eda20f1c8c0a3c68a608b103ff90009933ef5094aa68bf019a4fb17b65ea734f17364682666802cddf06906f3850299538b908f9781696f01
+  data.tar.gz: 7e80f05ab5f94310250700eaea3f8bac83842dba84fca847cb7d6e93cf7da38eb27001af69550417d74f41dc888dbd4781fb5d73ae7ca8bb30912d411f21ee53

data/README.md

@@ -2,7 +2,7 @@
 
 [![Built in integration with JetBrains RubyMine](https://github.com/daddyz/phonelib/blob/master/icon_RubyMine.png?raw=true)](https://www.jetbrains.com/ruby/)
 [![Gem Version](https://badge.fury.io/rb/phonelib.svg)](http://badge.fury.io/rb/phonelib)
-[![Build Status](https://travis-ci.com/daddyz/phonelib.svg?branch=master)](http://travis-ci.com/daddyz/phonelib)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/daddyz/phonelib/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/daddyz/phonelib/tree/master)
 [![](https://codeclimate.com/github/daddyz/phonelib/badges/coverage.svg)](https://codeclimate.com/github/daddyz/phonelib/coverage)
 [![](https://codeclimate.com/github/daddyz/phonelib/badges/gpa.svg)](https://codeclimate.com/github/daddyz/phonelib)
 [![Inline docs](http://inch-ci.org/github/daddyz/phonelib.svg?branch=master)](http://inch-ci.org/github/daddyz/phonelib)
@@ -11,6 +11,11 @@ Phonelib is a gem allowing you to validate phone number. All validations are bas
 Currently it can make basic validations and formatting to e164 international number format and national number format with prefix.
 But it still doesn't include all Google's library functionality.
 
+## Incorrect parsing or validation
+
+In case your phone number is incorrectly parsed, you can check original libphonenumber for result [here](https://rawgit.com/googlei18n/libphonenumber/master/javascript/i18n/phonenumbers/demo-compiled.html) and in case of same parse result [open an issue for them](https://issuetracker.google.com/issues/new?component=192347&template=829703). This gem's data is based on it.
+If you can't wait for libphonenumber to resolve the issue, try to use ```Phonelib.add_additional_regex``` and ```Phonelib.additional_regexes``` methods.
+
 ## Information
 
 ### Change Log
@@ -37,10 +42,11 @@ gem 'phonelib'
 
 Run the bundle command to install it.
 
-To set the default country (country names are [ISO 3166-1 Alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes), create a initializer in <tt>config/initializers/phonelib.rb</tt>:
+To set the default country or several default countries for parsing (country names are [ISO 3166-1 Alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes), create a initializer in <tt>config/initializers/phonelib.rb</tt>:
 
 ``` ruby
 Phonelib.default_country = "CN"
+Phonelib.default_country = ['CN', 'FR']
 ```
 
 To use the ability to parse special numbers (Short Codes, Emergency etc.) you can set ```Phonelib.parse_special```. This is disabled by default
@@ -61,6 +67,12 @@ To disable sanitizing of passed phone number (keeping digits only)
 Phonelib.strict_check = true
 ```
 
+To disable country reset during parsing in case phone starts with + sign and country specified but country phone prefix doesn't match phone's prefix
+
+``` ruby
+Phonelib.ignore_plus = true
+```
+
 To change sanitized symbols on parsed number, so non-specified symbols won't be wiped and will fail the parsing
 
 ``` ruby
@@ -252,7 +264,7 @@ phone.full_e164          # returns e164 phone representation with extension
 phone.full_international # returns formatted international number with extension
 ```
 
-You can pass <tt>false</tt> to <tt>national</tt> and <tt>international</tt> methods in order to get unformatted representaions
+You can pass <tt>false</tt> to <tt>national</tt> and <tt>international</tt> methods in order to get unformatted representations
 
 ``` ruby
 phone.international(false) # returns unformatted international phone

data/lib/phonelib/core.rb

@@ -4,12 +4,35 @@ module Phonelib
     # @private variable will include hash with data for validation
     @@phone_data = nil
 
+    # eagerly initialize the gem, loads data into memory. not required, initialization is done lazily otherwise, but
+    # may be desirable in production enviroments to avoid initialization time on first use.
+    def eager_load!
+      return if @@skip_eager_loading
+      phone_data
+      phone_ext_data
+    end
+
+    @@skip_eager_loading = false
+    def skip_eager_loading!
+      @@skip_eager_loading = true
+    end
+
     # getter for phone data for other modules of gem, can be used outside
     # @return [Hash] all data for phone parsing
     def phone_data
       @@phone_data ||= load_data.freeze
     end
 
+    # @private getter for phone data indexed by country code (internal use only)
+    def data_by_country_codes
+      @@data_by_country_codes ||= phone_data.each_value.group_by { |d| d[COUNTRY_CODE] }.freeze
+    end
+
+    # @private getter for all international prefixes in phone_data
+    def phone_data_int_prefixes
+      @@all_int_prefixes ||= phone_data.map {|k,v| v[:international_prefix] }.select { |v| v != '' }.compact.uniq.join('|').freeze
+    end
+
     # @private used to cache frequently-used regular expressions
     @@phone_regexp_cache = {}
 
@@ -30,14 +53,14 @@ module Phonelib
     @@default_country = nil
 
     # getter method for default_country variable
-    # @return [String|nil] Default country set for parsing or nil
+    # @return [String,Symbol,Array<String,Symbol>,nil] Default country ISO2 code or codes used for parsing
     def default_country
       @@default_country
     end
 
     # setter method for default_country variable
-    # @param country [String|Symbol] default country ISO2 code used for parsing
-    # @return [String|nil] Default country set for parsing or nil
+    # @param country [String,Symbol,Array<String,Symbol>] Default country ISO2 code or codes used for parsing
+    # @return [String,Symbol,Array<String,Symbol>] Default country ISO2 code or codes used for parsing
     def default_country=(country)
       @@default_country = country
     end
@@ -107,6 +130,22 @@ module Phonelib
       @@strict_check = strict
     end
 
+    # @private don't use plus sign for automatic country change
+    @@ignore_plus = false
+
+    # getter for ignore plus flag
+    # @return [Boolean] Flag defines whether to reset country in case number has + and country prefix doesn't match
+    def ignore_plus
+      @@ignore_plus
+    end
+
+    # setter for ignore plus flag
+    # @param ignore_plus [Boolean] ignore plus sign or not
+    # @return [Boolean] Flag defines whether to ignore plus for country reset during validations in case country prefix doesn't match
+    def ignore_plus=(ignore_plus)
+      @@ignore_plus = ignore_plus
+    end
+
     # @private sanitizing regex, matching symbols will get removed from parsed number, must be string
     @@sanitize_regex = '[^0-9]+'
 
@@ -163,7 +202,7 @@ module Phonelib
     def add_additional_regex(country, type, national_regex)
       return unless Phonelib::Core::TYPES_DESC.keys.include?(type.to_sym)
       return unless national_regex.is_a?(String)
-      @@phone_data = nil
+      @@phone_data = @@data_by_country_codes = nil
       @@additional_regexes[country.to_s.upcase] ||= {}
       @@additional_regexes[country.to_s.upcase][type] ||= []
       @@additional_regexes[country.to_s.upcase][type] << national_regex

data/lib/phonelib/data_importer.rb

@@ -19,6 +19,48 @@ module Phonelib
 
       # countries that can have double country prefix in number
       DOUBLE_COUNTRY_CODES_COUNTRIES = %w(IN DE BR IT NO PL CU VN)
+      FORMAT_SHARING = {
+        'CA' => 'US',
+        'CC' => 'AU',
+        'CX' => 'AU',
+        'DM' => 'US',
+        'DO' => 'US',
+        'EH' => 'MA',
+        'GD' => 'US',
+        'GG' => 'GB',
+        'GU' => 'US',
+        'IM' => 'GB',
+        'JE' => 'GB',
+        'JM' => 'US',
+        'KN' => 'US',
+        'KY' => 'US',
+        'KZ' => 'RU',
+        'LC' => 'US',
+        'MF' => 'GP',
+        'MP' => 'US',
+        'MS' => 'US',
+        'PR' => 'US',
+        'SJ' => 'NO',
+        'SX' => 'US',
+        'TA' => 'SH',
+        'TC' => 'US',
+        'TT' => 'US',
+        'UM' => 'US',
+        'VA' => 'IT',
+        'VC' => 'US',
+        'VG' => 'US',
+        'VI' => 'US',
+        'YT' => 'RE',
+        'AG' => 'US',
+        'AI' => 'US',
+        'AS' => 'US',
+        'AX' => 'FI',
+        'BB' => 'US',
+        'BL' => 'GP',
+        'BM' => 'US',
+        'BQ' => 'CW',
+        'BS' => 'US',
+      }
 
       # main data file in repo
       MAIN_FILE = 'resources/PhoneNumberMetadata.xml'
@@ -55,6 +97,7 @@ module Phonelib
         import_main_data
         import_short_data
         import_alternate_formats
+        process_format_links
         import_geocoding_data
         import_timezone_data
         import_carrier_data
@@ -115,6 +158,15 @@ module Phonelib
         end
       end
 
+      # some countries missing formats, and are linking them to another countries
+      def process_format_links
+        FORMAT_SHARING.each do |destination, source|
+          next unless @data[destination]
+          @data[destination][:formats] ||= []
+          @data[destination][:formats] = @data[destination][:formats] + @data[source][:formats]
+        end
+      end
+
       # method parses geocoding data dir
       def import_geocoding_data
         puts 'IMPORTING GEOCODING DATA'
@@ -145,7 +197,7 @@ module Phonelib
 
         require 'open-uri'
         require 'csv'
-        io = open('http://api.geonames.org/countryInfoCSV?username=demo&style=full')
+        io = URI.open('http://download.geonames.org/export/dump/countryInfo.txt')
         csv = CSV.new(io, {col_sep: "\t"})
         csv.each do |row|
           next if row[0].nil? || row[0].start_with?('#') || row[0].empty? || row[0].size != 2

data/lib/phonelib/phone.rb

@@ -178,6 +178,8 @@ module Phonelib
 
     # @private extracts extension from passed phone number if provided
     def separate_extension(original)
+      return [original, ''] unless Phonelib.extension_separate_symbols
+
       regex = if Phonelib.extension_separate_symbols.is_a?(Array)
                 cr("#{Phonelib.extension_separate_symbols.join('|')}")
               else

data/lib/phonelib/phone_analyzer.rb

@@ -16,8 +16,31 @@ module Phonelib
     # * +passed_country+ - Country provided for parsing. Must be ISO code of
     #   country (2 letters) like 'US', 'us' or :us for United States
     def analyze(phone, passed_country)
-      country = country_or_default_country passed_country
+      countries = country_or_default_country passed_country
 
+      return analyze_single_country(phone, countries.first, passed_country) if countries.size == 1
+
+      results = {}
+      countries.map do |country|
+        results.merge! analyze_single_country(phone, country, passed_country)
+      end
+
+      pick_results(results)
+    end
+
+    private
+
+    # pick best result when several countries specified
+    def pick_results(results)
+      [:valid, :possible].each do |key|
+        final = results.select { |_k, v| v[key].any? }
+        return decorate_analyze_result(final) if final.size > 0
+      end
+
+      decorate_analyze_result(results)
+    end
+
+    def analyze_single_country(phone, country, passed_country)
       result = parse_country(phone, country)
       d_result = case
                  when result && result.values.find { |e| e[:valid].any? }
@@ -32,8 +55,6 @@ module Phonelib
       better_result(result, d_result)
     end
 
-    private
-
     # method checks which result is better to return
     def better_result(base_result, result = nil)
       base_result ||= {}
@@ -49,10 +70,11 @@ module Phonelib
     # replacing national prefix to simplified format
     def with_replaced_national_prefix(phone, data)
       return phone unless data[Core::NATIONAL_PREFIX_TRANSFORM_RULE]
+      phone = phone.gsub(/^#{data[Core::COUNTRY_CODE]}/, '') if phone.start_with?(data[Core::COUNTRY_CODE])
       pattern = cr("^(?:#{data[Core::NATIONAL_PREFIX_FOR_PARSING]})")
       match = phone.match pattern
       if match && match.captures.compact.size > 0
-        phone.gsub(pattern, data[Core::NATIONAL_PREFIX_TRANSFORM_RULE])
+        data[Core::COUNTRY_CODE] + phone.gsub(pattern, data[Core::NATIONAL_PREFIX_TRANSFORM_RULE])
       else
         phone
       end
@@ -103,15 +125,22 @@ module Phonelib
     #
     # * +phone+ - phone number for parsing
     def detect_and_parse(phone, country)
-      result = {}
-      Phonelib.phone_data.each do |key, data|
+      countries_data = country_code_candidates_for(phone).flat_map { |code|
+        Phonelib.data_by_country_codes[code] || []
+      }
+      countries_data.each_with_object({}) do |data, result|
+        key = data[:id]
         parsed = parse_single_country(phone, data)
         if (!Phonelib.strict_double_prefix_check || key == country) && double_prefix_allowed?(data, phone, parsed && parsed[key])
           parsed = parse_single_country(changed_dp_phone(key, phone), data)
         end
         result.merge!(parsed) unless parsed.nil?
-      end
-      result
+      end.compact
+    end
+
+    def country_code_candidates_for(phone)
+      stripped_phone = phone.gsub(/^(#{Phonelib.phone_data_int_prefixes})/, '')
+      ((1..3).map { |length| phone[0, length] } + (1..3).map { |length| stripped_phone[0, length] }).uniq
     end
 
     # Create phone representation in e164 format

data/lib/phonelib/phone_analyzer_helper.rb

@@ -3,6 +3,17 @@ module Phonelib
   module PhoneAnalyzerHelper
     private
 
+    def decorate_analyze_result(result)
+      if result.size == 1
+        result
+      else
+        matched_countries = country_or_default_country(nil) & result.keys
+        matched_countries = result.keys.take(1) if matched_countries.size == 0
+        result = result.keep_if {|k, _v| matched_countries.include?(k) } if matched_countries
+        Hash[result.take(1)]
+      end
+    end
+
     def original_starts_with_plus?
       original_s[0] == Core::PLUS_SIGN
     end
@@ -24,7 +35,7 @@ module Phonelib
     # defines if to validate against single country or not
     def passed_country(country)
       code = country_prefix(country)
-      if Core::PLUS_SIGN == @original[0] && code && !sanitized.start_with?(code)
+      if !Phonelib.ignore_plus && Core::PLUS_SIGN == @original[0] && code && !sanitized.start_with?(code)
         # in case number passed with + but it doesn't start with passed
         # country prefix
         country = nil
@@ -48,7 +59,7 @@ module Phonelib
     def country_can_dp?(country)
       Phonelib.phone_data[country] &&
         Phonelib.phone_data[country][Core::DOUBLE_COUNTRY_PREFIX_FLAG] &&
-        !original_starts_with_plus?
+        !original_starts_with_plus? && original_s.start_with?(Phonelib.phone_data[country][Core::COUNTRY_CODE])
     end
 
     # changes phone to with/without double country prefix
@@ -58,6 +69,7 @@ module Phonelib
 
       country_code = Phonelib.phone_data[country][Core::COUNTRY_CODE]
       if phone.start_with? country_code * 2
+        # remove double prefix in case it is there
         phone.gsub(cr("^#{country_code}"), '')
       else
         "#{country_code}#{phone}"
@@ -90,7 +102,11 @@ module Phonelib
     # * +country+ - country passed for parsing
     def country_or_default_country(country)
       country ||= (original_starts_with_plus? ? nil : Phonelib.default_country)
-      country && country.to_s.upcase
+      if country.is_a?(Array)
+        country.compact.map { |e| e.to_s.upcase }
+      else
+        [country && country.to_s.upcase]
+      end
     end
 
     # constructs full regex for phone validation for provided phone data

data/lib/phonelib/phone_formatter.rb

@@ -5,7 +5,7 @@ module Phonelib
     # @param formatted [Boolean] whether to return numbers only or formatted
     # @return [String] formatted national number
     def national(formatted = true)
-      return @national_number unless valid?
+      return @national_number unless possible?
       format_match, format_string = formatting_data
 
       if format_match
@@ -22,8 +22,8 @@ module Phonelib
       return nil if sanitized.nil? || sanitized.empty?
       if valid?
         @national_number
-      elsif country_code && sanitized.start_with?(country_code)
-        sanitized[country_code.size..-1]
+      elsif data_country_code && sanitized.start_with?(data_country_code)
+        sanitized[data_country_code.size..-1]
       else
         sanitized
       end
@@ -32,8 +32,17 @@ module Phonelib
     # Returns the country code from the original phone number.
     # @return [String] matched country phone code
     def country_code
-      @country_code ||= Phonelib.phone_data[country] && \
-                        Phonelib.phone_data[country][Core::COUNTRY_CODE]
+      return @country_code if @country_code
+
+      code = Phonelib.phone_data[country] && Phonelib.phone_data[country][Core::COUNTRY_CODE]
+      return @country_code = code unless code == '1' && Phonelib.phone_data[country][Core::LEADING_DIGITS]
+
+      match = e164.match(/\A\+(1(#{Phonelib.phone_data[country][Core::LEADING_DIGITS]}))/)
+      if match
+        @country_code = match[1]
+      else
+        @country_code = '1'
+      end
     end
 
     # Returns e164 formatted phone number. Method can receive single string parameter that will be defined as prefix
@@ -43,8 +52,8 @@ module Phonelib
     def international(formatted = true, prefix = '+')
       prefix = formatted if formatted.is_a?(String)
       return nil if sanitized.empty?
-      return "#{prefix}#{country_prefix_or_not}#{sanitized}" unless valid?
-      return "#{prefix}#{country_code}#{@national_number}" unless formatted
+      return "#{prefix}#{country_prefix_or_not}#{sanitized}" unless possible?
+      return "#{prefix}#{data_country_code}#{@national_number}" unless formatted
 
       fmt = @data[country][:format]
       national = @national_number
@@ -53,7 +62,7 @@ module Phonelib
         national = fmt.gsub(/\$\d/) { |el| matches[el[1].to_i] } unless fmt == 'NA'
       end
 
-      "#{prefix}#{country_code} #{national}"
+      "#{prefix}#{data_country_code} #{national}"
     end
 
     # returns national formatted number with extension added
@@ -109,6 +118,10 @@ module Phonelib
 
     private
 
+    def data_country_code
+      @data_country_code ||= Phonelib.phone_data[country] && Phonelib.phone_data[country][Core::COUNTRY_CODE]
+    end
+
     # @private defines if phone can have area code
     def area_code_possible?
       return false if impossible?
@@ -124,8 +137,8 @@ module Phonelib
 
     # @private defines whether to put country prefix or not
     def country_prefix_or_not
-      return '' unless country_code
-      sanitized.start_with?(country_code) ? '' : country_code
+      return '' unless data_country_code
+      sanitized.start_with?(data_country_code) ? '' : data_country_code
     end
 
     # @private returns extension with separator defined

data/lib/phonelib/version.rb

@@ -1,4 +1,4 @@
 module Phonelib
   # @private
-  VERSION = '0.6.54'
+  VERSION = '0.9.1'
 end

data/lib/phonelib.rb

@@ -17,4 +17,12 @@ if defined?(ActiveModel) || defined?(Rails)
   else
     autoload :PhoneValidator, 'validators/phone_validator'
   end
+
+  if defined?(Rails)
+    class Phonelib::Railtie < Rails::Railtie
+      initializer 'phonelib' do |app|
+        app.config.eager_load_namespaces << Phonelib
+      end
+    end
+  end
 end

data/lib/validators/phone_validator.rb

@@ -62,7 +62,7 @@ class PhoneValidator < ActiveModel::EachValidator
     @phone = parse(value, specified_country(record))
     valid = phone_valid? && valid_types? && valid_country? && valid_extensions?
 
-    record.errors.add(attribute, message, options) unless valid
+    record.errors.add(attribute, message, **options) unless valid
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phonelib
 version: !ruby/object:Gem::Version
-  version: 0.6.54
+  version: 0.9.1
 platform: ruby
 authors:
 - Vadim Senderovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.9
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: benchmark-memory
+  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: rack-cache
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Gem validates phone numbers with Google libphonenumber database