mini_phone 1.0.5 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e442f98e547a4059112a40d4a28d79b7438ded4ec9d697ed7a59e03447e073f3
-  data.tar.gz: b7ff1d3b6c32564197471098acb0654f214a035df703382500a5c7c825b80d9f
+  metadata.gz: d2296363b27632d0846ce32acc99c60a16e12f1670fc1aa6e2e5f6430505701e
+  data.tar.gz: 2c251bbabbec98c9a87e003dad1464a8cb7310d312ca7902791236a1b963f58e
 SHA512:
-  metadata.gz: 90e2db831e7edf8ccbe083f3daad5830d8d65d6945598441a4b7bc38c0b191d5aec85c7356b9549375add822e3e6b8d27d550ed647d1721d29fb4113e50e6fc3
-  data.tar.gz: adc1643314e3f781e9c427ff6540ba406995c14e9429fa4c520b681375459a73711fa1cbf8072c51c7f2b79f781a44fd81d219e79c6388e0d6c25f3e56e0e781
+  metadata.gz: e9e80a337c5dc554d13e512f43f097de370c32f623d9d4ec6a4ccf0149352ab0ef726a5ac3e8155873f4bc67b9ebe054d0d935833dcc60a33c72171c7d2ed962
+  data.tar.gz: edbf05d8f841b3fcb144714958dc219134d35615f3d1eff5365affb9d94a6d7aa28e8419189179c4d10f84a57d201badb4147442f05070d42f7ed4779c82dbce

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

@@ -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) {
@@ -107,17 +126,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) {
@@ -125,6 +145,8 @@ static inline VALUE rb_phone_number_nullify_ivars(VALUE self) {
   rb_iv_set(self, "@raw_national", Qnil);
   rb_iv_set(self, "@dasherized_national", Qnil);
   rb_iv_set(self, "@international", Qnil);
+  rb_iv_set(self, "@raw_international", Qnil);
+  rb_iv_set(self, "@dasherized_international", Qnil);
   rb_iv_set(self, "@e164", Qnil);
   rb_iv_set(self, "@country_code", Qnil);
   rb_iv_set(self, "@region_code", Qnil);
@@ -158,7 +180,7 @@ extern "C" VALUE rb_phone_number_initialize(int argc, VALUE *argv, VALUE self) {
   PhoneNumberInfo *phone_number_info;
   PhoneNumber parsed_number;
 
-  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());
 
@@ -170,7 +192,7 @@ extern "C" VALUE rb_phone_number_initialize(int argc, VALUE *argv, VALUE self) {
   if (result != PhoneNumberUtil::NO_PARSING_ERROR) {
     rb_phone_number_nullify_ivars(self);
   } else {
-    phone_number_info->phone_number = parsed_number;
+    phone_number_info->phone_number->Swap(&parsed_number);
   }
 
   return self;
@@ -179,11 +201,11 @@ extern "C" VALUE rb_phone_number_initialize(int argc, VALUE *argv, VALUE 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());
 }
@@ -225,9 +247,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());
 }
@@ -252,6 +274,47 @@ extern "C" VALUE rb_phone_number_dasherized_national(VALUE self) {
   return rb_iv_set(self, "@dasherized_national", result);
 }
 
+extern "C" VALUE rb_phone_number_country_code(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@country_code"))) {
+    return rb_iv_get(self, "@country_code");
+  }
+
+  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();
+
+  VALUE result = INT2NUM(code);
+
+  return rb_iv_set(self, "@country_code", result);
+}
+
+extern "C" VALUE rb_phone_number_dasherized_international(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@dasherized_international"))) {
+    return rb_iv_get(self, "@dasherized_international");
+  }
+
+  VALUE national = rb_phone_number_dasherized_national(self);
+  VALUE cc = rb_fix2str(rb_phone_number_country_code(self), 10);
+  VALUE dash = rb_str_new("-", 1);
+  VALUE prefix = rb_str_concat(cc, dash);
+  VALUE result = rb_str_concat(prefix, national);
+
+  return rb_iv_set(self, "@dasherized_international", result);
+}
+
+extern "C" VALUE rb_phone_number_raw_international(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@raw_international"))) {
+    return rb_iv_get(self, "@raw_international");
+  }
+
+  VALUE national = rb_phone_number_raw_national(self);
+  VALUE cc = rb_fix2str(rb_phone_number_country_code(self), 10);
+  VALUE result = rb_str_concat(cc, national);
+
+  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");
@@ -259,11 +322,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);
@@ -281,11 +344,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);
@@ -303,44 +366,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_country_code(VALUE self) {
-  if (rb_ivar_defined(self, rb_intern("@country_code"))) {
-    return rb_iv_get(self, "@country_code");
+extern "C" VALUE rb_phone_number_match_eh(VALUE self, VALUE other) {
+  if (!rb_obj_is_kind_of(other, rb_cPhoneNumber)) {
+    return Qfalse;
   }
 
-  PhoneNumberInfo *phone_number_info;
-  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
-
-  int code = phone_number_info->phone_number.country_code();
+  VALUE self_input = rb_iv_get(self, "@input");
+  VALUE other_input = rb_iv_get(other, "@input");
 
-  VALUE result = INT2NUM(code);
-
-  return rb_iv_set(self, "@country_code", result);
-}
-
-extern "C" VALUE rb_phone_number_eql_eh(VALUE self, VALUE other) {
-  if (!rb_obj_is_instance_of(other, rb_cPhoneNumber)) {
-    return Qfalse;
+  // 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_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)) {
+  PhoneNumberInfo *other_info;
+  TypedData_Get_Struct(other, PhoneNumberInfo, &phone_number_info_type, other_info);
+
+  if (phone_util.IsNumberMatch(*other_info->phone_number, *self_info->phone_number) == PhoneNumberUtil::EXACT_MATCH) {
     return Qtrue;
   } else {
     return Qfalse;
@@ -353,14 +410,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;
@@ -409,15 +466,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);
@@ -431,6 +488,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();
@@ -481,6 +540,10 @@ extern "C" void Init_mini_phone(void) {
   rb_define_method(rb_cPhoneNumber, "national", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_national), 0);
 
   rb_define_method(rb_cPhoneNumber, "raw_national", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_raw_national), 0);
+  rb_define_method(rb_cPhoneNumber, "raw_international",
+                   reinterpret_cast<VALUE (*)(...)>(rb_phone_number_raw_international), 0);
+  rb_define_method(rb_cPhoneNumber, "dasherized_international",
+                   reinterpret_cast<VALUE (*)(...)>(rb_phone_number_dasherized_international), 0);
   rb_define_method(rb_cPhoneNumber, "dasherized_national",
                    reinterpret_cast<VALUE (*)(...)>(rb_phone_number_dasherized_national), 0);
   rb_define_method(rb_cPhoneNumber, "international", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_international),
@@ -491,5 +554,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.5'
+  VERSION = '1.1.3'
 end

metadata

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