mini_phone 1.1.0 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89fa88b742202101e6bb0204bad2fd20545946a19447d227f61312dd1f9e251c
-  data.tar.gz: 49a1d96d9a61aa00c24b88c7e6d3b51dab2929f9ec12043ce2508fc6af374da2
+  metadata.gz: c3a42ec155de4fb7b2a8ea675ac0380274f23b38795c0eb0e73c0efb3ed4d8a5
+  data.tar.gz: aaec470245e26e61d277a329340833eef93fa22939395273eabba719f977408e
 SHA512:
-  metadata.gz: 5e719bb7cade41a127cd601f06ca5f2529dae2994112c89bf56ace37202230a2c4a3fae7c0738632d78d032cae0f6b7d1e20365a48f57f0ff046bc0241b2f023
-  data.tar.gz: f4ba0f376645bea9b1c25c94f5ba696d744988a1e11a44ff4081af0435165b7a573e24f3101b12dd652add2dccf2e23596bf75ed21b43a5e2fd0a44b1772ef35
+  metadata.gz: 99128e918a87c4e875191b47177507da77be675aafb7a7bec430457ab420c4b5081872407b31d07de04fc24233e57d14e711a019f49939d3db89e757eeeab1a1
+  data.tar.gz: a9676a2d17fd3a5e0d178159ed9b413ea73469790e5219040cfa80e5679fce578ac0e80e95b60366cdd23f4961744eba65740464e6bd05bb1549805547862b1f

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

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
@@ -78,15 +78,15 @@ 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
-```
+    Phonelib: valid?:      426.0 i/s
+   MiniPhone: valid?:    34707.9 i/s - 81.47x faster
 
-```
 Comparison:
-     MiniPhone: e164:    31567.0 i/s
-      Phonelib: e164:      652.3 i/s - 48.39x  (± 0.00) slower
+      Phonelib: e164:      580.3 i/s
+     MiniPhone: e164:    43385.9 i/s - 74.76x faster
 ```
 
 ## Installation
@@ -98,7 +98,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,6 +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) {
+  PhoneNumberInfo *phone_number_info;
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
+  PhoneNumber *phone_number = phone_number_info->phone_number;
+  std::string raw_input = phone_number->raw_input();
+
+  if (raw_input == "") {
+    return Qnil;
+  } else {
+    return rb_str_new(raw_input.c_str(), raw_input.size());
+  }
+}
+
 static inline void setup_formats() {
   // Raw
   NumberFormat *raw_fmt = raw_national_format.Add();
@@ -492,6 +454,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);
+  } else {
+    phone_number_info->phone_number->Swap(&parsed_number);
+  }
+
+  return self;
+}
+
 extern "C" void Init_mini_phone(void) {
   setup_formats();
 
@@ -544,5 +576,7 @@ extern "C" void Init_mini_phone(void) {
   rb_define_method(rb_cPhoneNumber, "country_code", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_country_code), 0);
   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, "eql?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_eql_eh), 1);
+  rb_define_method(rb_cPhoneNumber, "to_s", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_to_s), 0);
+  rb_define_method(rb_cPhoneNumber, "raw_input", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_to_s), 0);
+  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.0'
+  VERSION = '1.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_phone
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.5
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-02-11 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.