mini_phone 1.1.1 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb40430cfcb4a6d8cc44557e7fb84622fe20cf14819c14f10a919dc5b9880e7
-  data.tar.gz: 5ad868da4e69d3b0ef3b91687863547ea876ec01e0bd2d7ae2e9bea1c8e16668
+  metadata.gz: 48fbcbb306ad72fdcbd33b68c46e1c3bc586d24a7ba931f8c4a059e22f65b3a7
+  data.tar.gz: cbdc2cadfa4c1438312de09177b2c54d476f68e5fc585248eeb046212d71025a
 SHA512:
-  metadata.gz: df02fd332486b4b1c2775420377d2b478324b1b25de950268279ce6dd1875373dd4c7bc798300b0446cee72d7581d7338f4a0725d811a0ff317b7209bdebb4a7
-  data.tar.gz: a4130f908c91d8369665ec31174857ab6a2e7dc07b85f97008560a3d057db23a49dc39b85e53d0f61a290e0f89c8b320b2f5023041b0b19704bf66f9363ed672
+  metadata.gz: 0cb7432992d4c61aaa8ccb0774e48aad98a61a575555dc6e4d509560938fd4fb4267bd62d90cdd2f589d93ed1eb5ded12503fe213023f10972ed399ded5f863c
+  data.tar.gz: 4dd9e4ae33cde41d27e308fc1d5249cc7676274162ecc20d79e1088f029b6aab330bfe1dc424fb74515fbb42ab744c375fd60ef6078ad6c9ba6e315ca07a71f8

data/Dockerfile.dev

@@ -6,4 +6,4 @@ WORKDiR /app
 RUN apk add --no-cache libphonenumber-dev valgrind git make libffi-dev build-base
 COPY Gemfile Gemfile.lock mini_phone.gemspec ./
 COPY lib/mini_phone/version.rb ./lib/mini_phone/version.rb
-RUN bundle install -j4
+RUN bundle install -j4

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 gem 'rake', require: false
 # https://github.com/rake-compiler/rake-compiler/pull/166
 gem 'get_process_mem', require: false
+gem 'pry', require: false
 gem 'rake-compiler', github: 'larskanis/rake-compiler', branch: 'fix-native-version'
 gem 'rspec', '~> 3.0', require: false
 gem 'rspec-github', require: false
@@ -16,4 +17,5 @@ gem 'rubocop', require: false
 group :bench do
   gem 'benchmark-ips'
   gem 'phonelib'
+  gem 'telephone_number'
 end

data/README.md

@@ -3,7 +3,7 @@
 A Ruby gem which plugs directly into Google's native C++
 [libphonenumber](https://github.com/google/libphonenumber) for extremely
 _fast_ and _robust_ phone number parsing, validation, and formatting. On
-average, most methods are 40x to 50x faster than other Ruby phone number
+average, most methods are 70x to 80x faster than other Ruby phone number
 libraries.
 
 ## Usage
@@ -77,16 +77,18 @@ an issue and we will try to support it.
 On average, most methods are 40x to 50x faster than other libraries. To run
 the benchmarks locally, execute: `bundle exec rake bench`
 
+### Results from my Linux (5.10.6-arch1-10)
+
 ```
 Comparison:
-   MiniPhone: valid?:    23111.4 i/s
-    Phonelib: valid?:      482.3 i/s - 47.92x  (± 0.00) slower
-```
+   MiniPhone:    valid?:    33382.0 i/s
+    Phonelib:    valid?:      422.8 i/s - 78.95x  (± 0.00) slower
+TelephoneNumber: valid?:      164.3 i/s - 203.13x  (± 0.00) slower
 
-```
 Comparison:
-     MiniPhone: e164:    31567.0 i/s
-      Phonelib: e164:      652.3 i/s - 48.39x  (± 0.00) slower
+     MiniPhone:  e164:    41187.5 i/s
+      Phonelib:  e164:      579.0 i/s - 71.14x  (± 0.00) slower
+TelephoneNumber: e164:      228.8 i/s - 179.99x  (± 0.00) slower
 ```
 
 ## Installation
@@ -98,7 +100,7 @@ Comparison:
    ```
 
    ```sh
-   apt-get install -y libphonenumber # debian / ubuntu
+   apt-get install -y libphonenumber-dev # debian / ubuntu
    ```
 
 2. Add this line to your application's Gemfile:

data/ext/mini_phone/extconf.rb

@@ -20,7 +20,7 @@ unless have_library('phonenumber')
     |    brew install libphonenumber                                       |
     |                                                                      |
     |  On Debian / Ubuntu:                                                 |
-    |    apt-get install -y libphonenumber                                 |
+    |    apt-get install -y libphonenumber-dev                             |
     |                                                                      |
     | 2. Retry installing the gem (i.e `bundle install`)                   |
     |                                                                      |

data/ext/mini_phone/mini_phone.cc

@@ -16,7 +16,7 @@ static RepeatedPtrField<NumberFormat> dasherized_national_format;
 
 extern "C" struct PhoneNumberInfo { PhoneNumber *phone_number; };
 
-extern "C" size_t phone_number_info_size(const void *data) { return sizeof(PhoneNumberInfo) + sizeof(PhoneNumber); }
+extern "C" size_t phone_number_info_size(const void *data) { return sizeof(PhoneNumberInfo); }
 
 extern "C" void phone_number_info_free(void *data) {
   PhoneNumberInfo *phone_number_info = static_cast<PhoneNumberInfo *>(data);
@@ -52,7 +52,13 @@ static inline VALUE is_phone_number_valid(VALUE self, VALUE str, VALUE cc) {
 
   auto result = phone_util.ParseAndKeepRawInput(phone_number, country_code, &parsed_number);
 
-  if (result == PhoneNumberUtil::NO_PARSING_ERROR && phone_util.IsValidNumber(parsed_number)) {
+  if (result != PhoneNumberUtil::NO_PARSING_ERROR) {
+    return Qfalse;
+  }
+
+  if (country_code == "ZZ" && phone_util.IsValidNumber(parsed_number)) {
+    return Qtrue;
+  } else if (phone_util.IsValidNumberForRegion(parsed_number, country_code)) {
     return Qtrue;
   } else {
     return Qfalse;
@@ -60,9 +66,9 @@ static inline VALUE is_phone_number_valid(VALUE self, VALUE str, VALUE cc) {
 }
 
 extern "C" VALUE rb_is_phone_number_valid(VALUE self, VALUE str) {
-  VALUE def_cc = rb_iv_get(rb_mMiniPhone, "@default_country");
+  VALUE input_region_code = rb_iv_get(rb_mMiniPhone, "@default_country");
 
-  return is_phone_number_valid(self, str, def_cc);
+  return is_phone_number_valid(self, str, input_region_code);
 }
 
 extern "C" VALUE rb_normalize_digits_only(VALUE self, VALUE str) {
@@ -99,9 +105,9 @@ extern "C" VALUE rb_is_phone_number_possible(VALUE self, VALUE str) {
   PhoneNumber parsed_number;
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
 
-  VALUE def_cc = rb_iv_get(rb_mMiniPhone, "@default_country");
+  VALUE input_region_code = rb_iv_get(rb_mMiniPhone, "@default_country");
   std::string phone_number(RSTRING_PTR(str), RSTRING_LEN(str));
-  std::string country_code(RSTRING_PTR(def_cc), RSTRING_LEN(def_cc));
+  std::string country_code(RSTRING_PTR(input_region_code), RSTRING_LEN(input_region_code));
 
   auto result = phone_util.Parse(phone_number, country_code, &parsed_number);
 
@@ -159,45 +165,6 @@ static inline VALUE rb_phone_number_nullify_ivars(VALUE self) {
   return Qtrue;
 }
 
-extern "C" VALUE rb_phone_number_initialize(int argc, VALUE *argv, VALUE self) {
-  VALUE str;
-  VALUE def_cc;
-
-  rb_scan_args(argc, argv, "11", &str, &def_cc);
-
-  if (NIL_P(def_cc)) {
-    def_cc = rb_iv_get(rb_mMiniPhone, "@default_country");
-  }
-
-  rb_iv_set(self, "@input", str);
-
-  if (FIXNUM_P(str)) {
-    str = rb_fix2str(str, 10);
-  } else if (!RB_TYPE_P(str, T_STRING)) {
-    return rb_phone_number_nullify_ivars(self);
-  }
-
-  PhoneNumberInfo *phone_number_info;
-  PhoneNumber parsed_number;
-
-  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
-
-  const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
-
-  std::string phone_number(RSTRING_PTR(str), RSTRING_LEN(str));
-  std::string country_code(RSTRING_PTR(def_cc), RSTRING_LEN(def_cc));
-
-  auto result = phone_util.Parse(phone_number, country_code, &parsed_number);
-
-  if (result != PhoneNumberUtil::NO_PARSING_ERROR) {
-    rb_phone_number_nullify_ivars(self);
-  } else {
-    phone_number_info->phone_number->Swap(&parsed_number);
-  }
-
-  return self;
-}
-
 static inline VALUE rb_phone_number_format(VALUE self, PhoneNumberUtil::PhoneNumberFormat fmt) {
   std::string formatted_number;
   PhoneNumberInfo *phone_number_info;
@@ -315,28 +282,6 @@ extern "C" VALUE rb_phone_number_raw_international(VALUE self) {
   return rb_iv_set(self, "@raw_international", result);
 }
 
-extern "C" VALUE rb_phone_number_valid_eh(VALUE self) {
-  if (rb_ivar_defined(self, rb_intern("@valid"))) {
-    return rb_iv_get(self, "@valid");
-  }
-
-  std::string formatted_number;
-  PhoneNumberInfo *phone_number_info;
-  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
-
-  const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
-
-  if (phone_util.IsValidNumber(*phone_number_info->phone_number)) {
-    return rb_iv_set(self, "@valid", Qtrue);
-  } else {
-    return rb_iv_set(self, "@valid", Qfalse);
-  }
-}
-
-extern "C" VALUE rb_phone_number_invalid_eh(VALUE self) {
-  return rb_phone_number_valid_eh(self) == Qtrue ? Qfalse : Qtrue;
-}
-
 extern "C" VALUE rb_phone_number_possible_eh(VALUE self) {
   if (rb_ivar_defined(self, rb_intern("@possible"))) {
     return rb_iv_get(self, "@possible");
@@ -376,20 +321,24 @@ extern "C" VALUE rb_phone_number_region_code(VALUE self) {
   return rb_iv_set(self, "@region_code", result);
 }
 
-extern "C" VALUE rb_phone_number_eql_eh(VALUE self, VALUE other) {
-  if (!rb_obj_is_instance_of(other, rb_cPhoneNumber)) {
+extern "C" VALUE rb_phone_number_match_eh(VALUE self, VALUE other) {
+  if (!rb_obj_is_kind_of(other, rb_cPhoneNumber)) {
     return Qfalse;
   }
 
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
 
-  PhoneNumberInfo *self_phone_number_info;
-  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, self_phone_number_info);
+  PhoneNumberInfo *self_info;
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, self_info);
+
+  PhoneNumberInfo *other_info;
+  TypedData_Get_Struct(other, PhoneNumberInfo, &phone_number_info_type, other_info);
 
-  PhoneNumberInfo *other_phone_number_info;
-  TypedData_Get_Struct(other, PhoneNumberInfo, &phone_number_info_type, other_phone_number_info);
+  if (self_info->phone_number->raw_input() == other_info->phone_number->raw_input()) {
+    return Qtrue;
+  }
 
-  if (phone_util.IsNumberMatch(*other_phone_number_info->phone_number, *self_phone_number_info->phone_number)) {
+  if (phone_util.IsNumberMatch(*other_info->phone_number, *self_info->phone_number) == PhoneNumberUtil::EXACT_MATCH) {
     return Qtrue;
   } else {
     return Qfalse;
@@ -480,7 +429,19 @@ extern "C" VALUE rb_phone_number_area_code(VALUE self) {
   return rb_iv_set(self, "@area_code", result);
 }
 
-extern "C" VALUE rb_phone_number_to_s(VALUE self) { return rb_iv_get(self, "@input"); }
+extern "C" VALUE rb_phone_number_to_s(VALUE self) {
+  PhoneNumberInfo *phone_number_info;
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
+  PhoneNumber *phone_number = phone_number_info->phone_number;
+
+  if (phone_number == NULL) {
+    return Qnil;
+  }
+
+  std::string raw_input = phone_number->raw_input();
+
+  return rb_str_new(raw_input.c_str(), raw_input.size());
+}
 
 static inline void setup_formats() {
   // Raw
@@ -494,6 +455,76 @@ static inline void setup_formats() {
   dsh_fmt->set_format("$1-$2-$3");
 }
 
+extern "C" VALUE rb_phone_number_valid_eh(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@valid"))) {
+    return rb_iv_get(self, "@valid");
+  }
+
+  std::string formatted_number;
+  PhoneNumberInfo *phone_number_info;
+  VALUE input_region_code = rb_iv_get(self, "@input_region_code");
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
+
+  if (NIL_P(input_region_code)) {
+    input_region_code = rb_iv_get(rb_mMiniPhone, "@default_country");
+  }
+
+  const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
+
+  if (!rb_str_equal(input_region_code, rb_str_new_literal("ZZ")) &&
+      !rb_str_equal(rb_phone_number_region_code(self), input_region_code)) {
+    return rb_iv_set(self, "@valid", Qfalse);
+  }
+
+  if (phone_util.IsValidNumber(*phone_number_info->phone_number)) {
+    return rb_iv_set(self, "@valid", Qtrue);
+  } else {
+    return rb_iv_set(self, "@valid", Qfalse);
+  }
+}
+
+extern "C" VALUE rb_phone_number_invalid_eh(VALUE self) {
+  return rb_phone_number_valid_eh(self) == Qtrue ? Qfalse : Qtrue;
+}
+
+extern "C" VALUE rb_phone_number_initialize(int argc, VALUE *argv, VALUE self) {
+  VALUE str;
+  VALUE input_region_code;
+
+  rb_scan_args(argc, argv, "11", &str, &input_region_code);
+  rb_iv_set(self, "@input_region_code", input_region_code);
+
+  if (NIL_P(input_region_code)) {
+    input_region_code = rb_iv_get(rb_mMiniPhone, "@default_country");
+  }
+
+  if (FIXNUM_P(str)) {
+    str = rb_fix2str(str, 10);
+  } else if (!RB_TYPE_P(str, T_STRING)) {
+    return rb_phone_number_nullify_ivars(self);
+  }
+
+  PhoneNumberInfo *phone_number_info;
+  PhoneNumber parsed_number;
+
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
+
+  const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
+
+  std::string phone_number(RSTRING_PTR(str), RSTRING_LEN(str));
+  std::string country_code(RSTRING_PTR(input_region_code), RSTRING_LEN(input_region_code));
+
+  auto result = phone_util.ParseAndKeepRawInput(phone_number, country_code, &parsed_number);
+
+  if (result != PhoneNumberUtil::NO_PARSING_ERROR) {
+    rb_phone_number_nullify_ivars(self);
+  }
+
+  phone_number_info->phone_number->Swap(&parsed_number);
+
+  return self;
+}
+
 extern "C" void Init_mini_phone(void) {
   setup_formats();
 
@@ -547,5 +578,5 @@ extern "C" void Init_mini_phone(void) {
   rb_define_method(rb_cPhoneNumber, "type", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_type), 0);
   rb_define_method(rb_cPhoneNumber, "area_code", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_area_code), 0);
   rb_define_method(rb_cPhoneNumber, "to_s", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_to_s), 0);
-  rb_define_method(rb_cPhoneNumber, "eql?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_eql_eh), 1);
+  rb_define_method(rb_cPhoneNumber, "==", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_match_eh), 1);
 }

data/lib/mini_phone/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniPhone
-  VERSION = '1.1.1'
+  VERSION = '1.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_phone
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.6
 platform: ruby
 authors:
 - Ian Ker-Seymer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies: []
 description: Plugs directly in the the Google's native C++ [libphonenumber](https://github.com/google/libphonenumber)
   for extemely _fast_ and _robust_ phone number parsing, validation, and formatting.
@@ -43,7 +43,7 @@ metadata:
   homepage_uri: https://github.com/ianks/mini_phone
   source_code_uri: https://github.com/ianks/mini_phone
   changelog_uri: https://github.com/ianks/mini_phone/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Uses the Google libphonenumber C lib to parse, validate, and format phone
   numbers