mini_phone 1.0.6 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f7c87533de0643b9af5d9394d62a238208c34fa34e16effbb9064e9fd3578d7
-  data.tar.gz: 5868d8b76184925da0ba875fa0a5df7c3bb61f920b51f5d9391fd2d742335ddc
+  metadata.gz: 8267c89cf237c4baf3e8dfe8718e0c0fe453b4919f6e38d00dc70cc557ed8cf0
+  data.tar.gz: 2b537745421bbb9fe70000c3707c6f20c052f0770fd156ac4d915bb92e33c736
 SHA512:
-  metadata.gz: 6bdb02eee2405855e49defd3e27d9eccd8934ec1bc1c02977b69d17026d32500969b443b053b1eece4ca7f72294a2d57349c19cfe14f6993c02dab6d21ec9d21
-  data.tar.gz: e57f59c8c2b75a1e4983d8a7fc3941fa1c641bd1c55eb13185bc9c8b35347b39a3ce301e65e021887f5bfc403ee8b0b5e5bad60d20e3604900418c0b6d46511e
+  metadata.gz: 0db1af779c2b9564dedc09eee290359b5d3bb53bfb8e53180b1d56225cd054d1bddc37b87ff7da794cc2686c04ccbfcaed0285cebea170e4f5b5f594ee841091
+  data.tar.gz: 9e94872e27a229014cc754fe349e5d9f536baef87e26aee5b6bd9205604c553fcd392fa8ec4c658f9e5fedb0f958217e3b839337559200cded15b36442f2ab45

data/Dockerfile.dev

@@ -0,0 +1,9 @@
+FROM ruby:2.7-alpine
+
+WORKDiR /app
+
+# RUN apt-get update -y && apt-get install -y valgrind libphonenumber
+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

data/Gemfile

@@ -7,6 +7,8 @@ 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/Rakefile

@@ -76,3 +76,21 @@ namespace :publish do
     push_to_github_registry(g)
   end
 end
+
+desc 'Run valgrind test'
+
+namespace :debug do
+  desc 'Plot memory'
+  task :memory do
+    sh 'debug/memory_plot/plot.sh'
+  end
+
+  task :valgrind do
+    sh 'docker build --tag mini_phone_dev -f Dockerfile.dev .'
+    args = '--tool=memcheck --num-callers=15 --partial-loads-ok=yes --undef-value-errors=no'
+    script = 'ruby debug/memory_plot/memory.rb --once'
+    cmd = "docker run -it --rm -v #{Dir.pwd}:/app -w /app mini_phone_dev valgrind #{args} #{script}"
+    puts cmd
+    system cmd
+  end
+end

data/debug/memory_plot/memory.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mini_phone'
+require 'get_process_mem'
+
+10.times do
+  GC.start
+  GC.compact
+end
+
+$stdout.sync = true
+
+loop do
+  10_000.times do
+    pn = MiniPhone::PhoneNumber.new('+1 404 388 1299')
+    pn.e164
+    pn.valid?
+    pn.possible?
+    pn.raw_national
+    pn.international
+    pn.country_code
+    pn.area_code
+  end
+
+  4.times { GC.start }
+
+  memory_mb = GetProcessMem.new.mb
+
+  $stdout.puts memory_mb
+
+  break if ARGV.first == '--once'
+end

data/debug/memory_plot/plot.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -euo pipefail
+
+bundle exec rake compile
+exec ruby "$(dirname "$0")/memory.rb" | ttyplot

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

@@ -14,10 +14,29 @@ static VALUE rb_cPhoneNumber;
 static RepeatedPtrField<NumberFormat> raw_national_format;
 static RepeatedPtrField<NumberFormat> dasherized_national_format;
 
-extern "C" struct PhoneNumberInfo {
-  PhoneNumber phone_number;
-  std::string raw_phone_number;
-  std::string raw_country_code;
+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" void phone_number_info_free(void *data) {
+  PhoneNumberInfo *phone_number_info = static_cast<PhoneNumberInfo *>(data);
+  phone_number_info->phone_number->~PhoneNumber();
+  xfree(phone_number_info->phone_number);
+  phone_number_info->~PhoneNumberInfo();
+  xfree(data);
+}
+
+extern "C" const rb_data_type_t phone_number_info_type = {
+    .wrap_struct_name = "MiniPhone/PhoneNumberInfo",
+    .function =
+        {
+            .dmark = NULL,
+            .dfree = phone_number_info_free,
+            .dsize = phone_number_info_size,
+        },
+    .parent = NULL,
+    .data = NULL,
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY,
 };
 
 static inline VALUE is_phone_number_valid(VALUE self, VALUE str, VALUE cc) {
@@ -33,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;
@@ -107,17 +132,18 @@ extern "C" VALUE rb_set_default_country(VALUE self, VALUE str_code) {
 
 extern "C" VALUE rb_get_default_country(VALUE self) { return rb_iv_get(self, "@default_country"); }
 
-extern "C" void rb_phone_number_dealloc(PhoneNumberInfo *phone_number_info) { delete phone_number_info; }
-
 extern "C" VALUE rb_phone_number_parse(int argc, VALUE *argv, VALUE self) {
   return rb_class_new_instance(argc, argv, rb_cPhoneNumber);
 }
 
 extern "C" VALUE rb_phone_number_alloc(VALUE self) {
-  PhoneNumberInfo *phone_number_info = new PhoneNumberInfo();
+  void *phone_number_data = ALLOC(PhoneNumber);
+  void *data = ALLOC(PhoneNumberInfo);
+  PhoneNumberInfo *phone_number_info = new (data) PhoneNumberInfo();
+  PhoneNumber *phone_number = new (phone_number_data) PhoneNumber();
+  phone_number_info->phone_number = phone_number;
 
-  /* wrap */
-  return Data_Wrap_Struct(self, NULL, &rb_phone_number_dealloc, phone_number_info);
+  return TypedData_Wrap_Struct(self, &phone_number_info_type, phone_number_info);
 }
 
 static inline VALUE rb_phone_number_nullify_ivars(VALUE self) {
@@ -139,53 +165,14 @@ 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;
-
-  Data_Get_Struct(self, PhoneNumberInfo, 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 = parsed_number;
-  }
-
-  return self;
-}
-
 static inline VALUE rb_phone_number_format(VALUE self, PhoneNumberUtil::PhoneNumberFormat fmt) {
   std::string formatted_number;
   PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
 
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
-  PhoneNumber parsed_number = phone_number_info->phone_number;
-  phone_util.Format(parsed_number, fmt, &formatted_number);
+  PhoneNumber *parsed_number = phone_number_info->phone_number;
+  phone_util.Format(*parsed_number, fmt, &formatted_number);
 
   return rb_str_new(formatted_number.c_str(), formatted_number.size());
 }
@@ -227,9 +214,9 @@ VALUE format_by_pattern_national(VALUE self, RepeatedPtrField<NumberFormat> form
   std::string formatted_number;
   PhoneNumberInfo *phone_number_info;
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
 
-  phone_util.FormatByPattern(phone_number_info->phone_number, PhoneNumberUtil::NATIONAL, format, &formatted_number);
+  phone_util.FormatByPattern(*phone_number_info->phone_number, PhoneNumberUtil::NATIONAL, format, &formatted_number);
 
   return rb_str_new(formatted_number.c_str(), formatted_number.size());
 }
@@ -260,9 +247,9 @@ extern "C" VALUE rb_phone_number_country_code(VALUE self) {
   }
 
   PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
 
-  int code = phone_number_info->phone_number.country_code();
+  int code = phone_number_info->phone_number->country_code();
 
   VALUE result = INT2NUM(code);
 
@@ -302,11 +289,11 @@ extern "C" VALUE rb_phone_number_valid_eh(VALUE self) {
 
   std::string formatted_number;
   PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, 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)) {
+  if (phone_util.IsValidNumber(*phone_number_info->phone_number)) {
     return rb_iv_set(self, "@valid", Qtrue);
   } else {
     return rb_iv_set(self, "@valid", Qfalse);
@@ -324,11 +311,11 @@ extern "C" VALUE rb_phone_number_possible_eh(VALUE self) {
 
   std::string formatted_number;
   PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, 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.IsPossibleNumber(phone_number_info->phone_number)) {
+  if (phone_util.IsPossibleNumber(*phone_number_info->phone_number)) {
     return rb_iv_set(self, "@possible", Qtrue);
   } else {
     return rb_iv_set(self, "@possible", Qfalse);
@@ -346,29 +333,38 @@ extern "C" VALUE rb_phone_number_region_code(VALUE self) {
 
   PhoneNumberInfo *phone_number_info;
   std::string code;
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
 
-  phone_util.GetRegionCodeForCountryCode(phone_number_info->phone_number.country_code(), &code);
+  phone_util.GetRegionCodeForCountryCode(phone_number_info->phone_number->country_code(), &code);
 
   VALUE result = rb_str_new(code.c_str(), code.size());
 
   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;
   }
 
+  VALUE self_input = rb_iv_get(self, "@input");
+  VALUE other_input = rb_iv_get(other, "@input");
+
+  // If inputs are the exact same, the result is as well
+  if (rb_eql(self_input, other_input)) {
+    return Qtrue;
+  }
+
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
 
-  PhoneNumberInfo *self_phone_number_info;
-  Data_Get_Struct(self, PhoneNumberInfo, 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;
-  Data_Get_Struct(other, PhoneNumberInfo, other_phone_number_info);
-  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;
@@ -381,14 +377,14 @@ extern "C" VALUE rb_phone_number_type(VALUE self) {
   }
 
   PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
 
   VALUE result;
 
   // @see
   // https://github.com/google/libphonenumber/blob/4e9954edea7cf263532c5dd3861a801104c3f012/cpp/src/phonenumbers/phonenumberutil.h#L91
-  switch (phone_util.GetNumberType(phone_number_info->phone_number)) {
+  switch (phone_util.GetNumberType(*phone_number_info->phone_number)) {
   case PhoneNumberUtil::PREMIUM_RATE:
     result = rb_intern("premium_rate");
     break;
@@ -437,15 +433,15 @@ extern "C" VALUE rb_phone_number_area_code(VALUE self) {
 
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
   PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  TypedData_Get_Struct(self, PhoneNumberInfo, &phone_number_info_type, phone_number_info);
 
-  PhoneNumber number = phone_number_info->phone_number;
+  PhoneNumber *number = phone_number_info->phone_number;
   string national_significant_number;
-  phone_util.GetNationalSignificantNumber(number, &national_significant_number);
+  phone_util.GetNationalSignificantNumber(*number, &national_significant_number);
   string area_code;
   string subscriber_number;
 
-  int area_code_length = phone_util.GetLengthOfGeographicalAreaCode(number);
+  int area_code_length = phone_util.GetLengthOfGeographicalAreaCode(*number);
   if (area_code_length > 0) {
     area_code = national_significant_number.substr(0, area_code_length);
     subscriber_number = national_significant_number.substr(area_code_length, string::npos);
@@ -459,6 +455,8 @@ 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"); }
+
 static inline void setup_formats() {
   // Raw
   NumberFormat *raw_fmt = raw_national_format.Add();
@@ -471,6 +469,49 @@ static inline void setup_formats() {
   dsh_fmt->set_format("$1-$2-$3");
 }
 
+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);
+  }
+
+  if (country_code != "ZZ" && !rb_str_equal(rb_phone_number_region_code(self), def_cc)) {
+    rb_phone_number_nullify_ivars(self);
+  }
+
+  return self;
+}
+
 extern "C" void Init_mini_phone(void) {
   setup_formats();
 
@@ -523,5 +564,6 @@ 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, "==", 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.0.6'
+  VERSION = '1.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_phone
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.4
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-11 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.
@@ -22,10 +22,13 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile.dev
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- debug/memory_plot/memory.rb
+- debug/memory_plot/plot.sh
 - ext/mini_phone/extconf.rb
 - ext/mini_phone/mini_phone.cc
 - ext/mini_phone/mini_phone.h