mini_phone 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6635c4a695331ec847d69f21e79578f5f9ebdddf2752a7f1074fabd33ccfac
-  data.tar.gz: 51aae23c0a2330a9599ee0336ad591e8fa4548c041b0a6aa1710f5834791b5f7
+  metadata.gz: e442f98e547a4059112a40d4a28d79b7438ded4ec9d697ed7a59e03447e073f3
+  data.tar.gz: b7ff1d3b6c32564197471098acb0654f214a035df703382500a5c7c825b80d9f
 SHA512:
-  metadata.gz: 19540acad836a3102e52aab746c530c8f78613e4d3ac98ba3844c24e156d1a994aa92c5dcfaa3fd831ffe7d0a8ba26aa036a8e23f982545a81a08fac2e0cab6c
-  data.tar.gz: 747484c1f84802be42523c762f213eaa5044257d78546ac8a30c554c101053d6764e264c892fe29df74f265b44afa7829172a697f23996d1443835203266705b
+  metadata.gz: 90e2db831e7edf8ccbe083f3daad5830d8d65d6945598441a4b7bc38c0b191d5aec85c7356b9549375add822e3e6b8d27d550ed647d1721d29fb4113e50e6fc3
+  data.tar.gz: adc1643314e3f781e9c427ff6540ba406995c14e9429fa4c520b681375459a73711fa1cbf8072c51c7f2b79f781a44fd81d219e79c6388e0d6c25f3e56e0e781

data/README.md

@@ -1,9 +1,9 @@
 # MiniPhone
 
-A Ruby gem which plugs directly in the the Google's native C++
-[libphonenumber](https://github.com/google/libphonenumber) for extemely
+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 t0 50x faster than other Ruby phone number
+average, most methods are 40x to 50x faster than other Ruby phone number
 libraries.
 
 ## Usage
@@ -23,10 +23,12 @@ MiniPhone.default_country = 'US'
 
 phone_number = MiniPhone.parse('404-384-1399')
 
-phone_number.e164          # +14043841399
-phone_number.national      # (404) 384-1399
-phone_number.international # +1 404-384-1399
-phone_number.rfc3966       # tel:+1-404-384-1384
+phone_number.e164                 # +14043841399
+phone_number.national             # (404) 384-1399
+phone_number.raw_national         # 4043841399
+phone_number.dasherized_national  # 404-384-1399
+phone_number.international        # +1 404-384-1399
+phone_number.rfc3966              # tel:+1-404-384-1384
 ```
 
 ### Checking if a phone number is possible
@@ -41,7 +43,7 @@ phone_number.possible? # false
 
 ```ruby
 MiniPhone.parse('+12423570000').type # :mobile
-MiniPhone.parse['+12423651234').type # :fixed_line
+MiniPhone.parse('+12423651234').type # :fixed_line
 ```
 
 The possible types are directly mapped from [this
@@ -65,14 +67,14 @@ enum](https://github.com/google/libphonenumber/blob/4e9954edea7cf263532c5dd3861a
 ## Compatibility with PhoneLib
 
 MiniPhone aims to be compatible with
-[Phonelib](https://github.com/daddyz/phonelib) so in many cases it can be a
-drop in replacement. It has a smaller feature set, so if you need it it not a
-drop in replacement for every use case. If there is a feature you need, open
+[Phonelib](https://github.com/daddyz/phonelib). In many cases it can be a
+drop in replacement. It has a smaller feature set, so it is not a
+replacement for every use case. If there is a feature you need, open
 an issue and we will try to support it.
 
 ## Benchmarks
 
-On average, most methods are 40x t0 50x faster than other libraries. To run
+On average, most methods are 40x to 50x faster than other libraries. To run
 the benchmarks locally, execute: `bundle exec rake bench`
 
 ```
@@ -132,10 +134,10 @@ push git commits and tags, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/[USERNAME]/mini_phone. This project is intended to be a
+https://github.com/ianks/mini_phone. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected to
 adhere to the [code of
-conduct](https://github.com/[USERNAME]/mini_phone/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/ianks/mini_phone/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -146,4 +148,4 @@ License](https://opensource.org/licenses/MIT).
 
 Everyone interacting in the MiniPhone project's codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/[USERNAME]/mini_phone/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/ianks/mini_phone/blob/master/CODE_OF_CONDUCT.md).

data/ext/mini_phone/mini_phone.cc

@@ -12,6 +12,7 @@ static VALUE rb_mMiniPhone;
 static VALUE rb_cPhoneNumber;
 
 static RepeatedPtrField<NumberFormat> raw_national_format;
+static RepeatedPtrField<NumberFormat> dasherized_national_format;
 
 extern "C" struct PhoneNumberInfo {
   PhoneNumber phone_number;
@@ -122,6 +123,7 @@ extern "C" VALUE rb_phone_number_alloc(VALUE self) {
 static inline VALUE rb_phone_number_nullify_ivars(VALUE self) {
   rb_iv_set(self, "@national", Qnil);
   rb_iv_set(self, "@raw_national", Qnil);
+  rb_iv_set(self, "@dasherized_national", Qnil);
   rb_iv_set(self, "@international", Qnil);
   rb_iv_set(self, "@e164", Qnil);
   rb_iv_set(self, "@country_code", Qnil);
@@ -219,24 +221,37 @@ extern "C" VALUE rb_phone_number_rfc3966(VALUE self) {
   return rb_iv_set(self, "@rfc3966", rb_phone_number_format(self, PhoneNumberUtil::PhoneNumberFormat::RFC3966));
 }
 
-extern "C" VALUE rb_phone_number_raw_national(VALUE self) {
-  if (rb_ivar_defined(self, rb_intern("@raw_national"))) {
-    return rb_iv_get(self, "@raw_national");
-  }
-
+VALUE format_by_pattern_national(VALUE self, RepeatedPtrField<NumberFormat> format) {
   std::string formatted_number;
   PhoneNumberInfo *phone_number_info;
   const PhoneNumberUtil &phone_util(*PhoneNumberUtil::GetInstance());
   Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
 
-  phone_util.FormatByPattern(phone_number_info->phone_number, PhoneNumberUtil::NATIONAL, raw_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());
+}
 
-  VALUE result = rb_str_new(formatted_number.c_str(), formatted_number.size());
+extern "C" VALUE rb_phone_number_raw_national(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@raw_national"))) {
+    return rb_iv_get(self, "@raw_national");
+  }
+
+  VALUE result = format_by_pattern_national(self, raw_national_format);
 
   return rb_iv_set(self, "@raw_national", result);
 }
 
+extern "C" VALUE rb_phone_number_dasherized_national(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@dasherized_national"))) {
+    return rb_iv_get(self, "@dasherized_national");
+  }
+
+  VALUE result = format_by_pattern_national(self, dasherized_national_format);
+
+  return rb_iv_set(self, "@dasherized_national", 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");
@@ -416,7 +431,21 @@ extern "C" VALUE rb_phone_number_area_code(VALUE self) {
   return rb_iv_set(self, "@area_code", result);
 }
 
+static inline void setup_formats() {
+  // Raw
+  NumberFormat *raw_fmt = raw_national_format.Add();
+  raw_fmt->set_pattern("(\\d{3})(\\d{3})(\\d{4})");
+  raw_fmt->set_format("$1$2$3");
+
+  // Dasherized
+  NumberFormat *dsh_fmt = dasherized_national_format.Add();
+  dsh_fmt->set_pattern("(\\d{3})(\\d{3})(\\d{4})");
+  dsh_fmt->set_format("$1-$2-$3");
+}
+
 extern "C" void Init_mini_phone(void) {
+  setup_formats();
+
   rb_mMiniPhone = rb_define_module("MiniPhone");
 
   // Unknown
@@ -451,10 +480,9 @@ extern "C" void Init_mini_phone(void) {
   rb_define_method(rb_cPhoneNumber, "e164", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_e164), 0);
   rb_define_method(rb_cPhoneNumber, "national", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_national), 0);
 
-  // Raw National
-  raw_national_format.Add()->set_format("$1$2$3");
-
   rb_define_method(rb_cPhoneNumber, "raw_national", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_raw_national), 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),
                    0);
   rb_define_method(rb_cPhoneNumber, "rfc3966", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_rfc3966), 0);

data/lib/mini_phone/version.rb

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

metadata

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