mini_phone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f62c6d5370c3066ee7a24d8fbb4b6297f3382708f2492ffde4a4637239134064
+  data.tar.gz: ed947cb56dc592a7aa2be638ca1d59f608ff2ac5b3fab52e573c0ad3bde99306
+SHA512:
+  metadata.gz: d32d5ee76afd3d7ccd526f5854725ab718f45c5c9c0cb03be318e895b87c0fd33af8fefe2f6797320e15bd09e8134c900a783e0354e716e94e3b0d8228bab561
+  data.tar.gz: e8612f26f40ab9ad5fbbf50d36201f1b2d2411728ef31bf005608029af1cbc4ee427802c68e6a583b0f089ca5fc3306115c5ebae28776ddbc630c35069b7b8dc

data/.clang-format

@@ -0,0 +1,3 @@
+---
+BasedOnStyle: LLVM
+ColumnLimit: 120

data/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+---
+name: CI
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-16.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.5", "2.6", "2.7"]
+        os: [ubuntu-latest, macos-latest]
+        experimental: [false]
+        include:
+          - ruby: "truffleruby"
+            os: ubuntu-latest
+            experimental: true
+          - ruby: "truffleruby"
+            os: macos-latest
+            experimental: true
+    name: ${{ matrix.ruby }} on ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    env:
+      CI_EXPERIMENTAL: ${{ matrix.experimental }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies (system)
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: sudo apt-get -yqq install libphonenumber-dev
+
+      - name: Install dependencies (system)
+        if: ${{ matrix.os == 'macos-latest' }}
+        run: brew install --build-from-source libphonenumber && brew link libphonenumber
+
+      - name: Install dependencies (ruby)
+        run: gem install bundler && bundle install --jobs 4 --retry 3
+
+      - name: Compile
+        run: bundle exec rake compile
+
+      - name: RSpec
+        run: bundle exec rspec --format RSpec::Github::Formatter --format documentation
+
+      - name: Rubocop
+        run: bundle exec rubocop --format github

data/.gitignore

@@ -0,0 +1,19 @@
+.bundle/
+.yardoc
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+vendor/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at i.kerseymer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mini_phone.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rake-compiler', github: 'larskanis/rake-compiler', branch: 'fix-native-version'
+gem 'rspec', '~> 3.0'
+gem 'rspec-github', require: false
+gem 'rubocop'
+
+group :bench do
+  gem 'benchmark-ips'
+  gem 'phonelib'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ian Ker-Seymer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# MiniPhone
+
+A Ruby gem which 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. On
+average, most methods are 40x t0 50x faster than other Ruby phone number
+libraries.
+
+## Usage
+
+### Checking if a phone number is valid
+
+```ruby
+MiniPhone.valid?('+14043841399')                     # true
+MiniPhone.valid_for_country?('(404) 384-1399', 'US') # true
+MiniPhone.valid_for_country?('(404) 384-1399', 'GB') # false
+```
+
+### Formatting a number
+
+```ruby
+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
+```
+
+### Checking if a phone number is possible
+
+```ruby
+phone_number = MiniPhone.parse('-12')
+
+phone_number.possible? # false
+```
+
+### Getting the type of a phone number
+
+```ruby
+MiniPhone.parse('+12423570000').type # :mobile
+MiniPhone.parse['+12423651234').type # :fixed_line
+```
+
+The possible types are directly mapped from [this
+enum](https://github.com/google/libphonenumber/blob/4e9954edea7cf263532c5dd3861a801104c3f012/cpp/src/phonenumbers/phonenumberutil.h#L91):
+
+```ruby
+:fixed_line
+:mobile
+:fixed_line_or_mobile
+:toll_free
+:premium_rate
+:shared_cost
+:voip
+:personal_number
+:pager
+:uan
+:voicemail
+:unknown
+```
+
+## 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
+an issue and we will try to support it.
+
+## Benchmarks
+
+On average, most methods are 40x t0 50x faster than other libraries. To run
+the benchmarks locally, execute: `bundle exec rake bench`
+
+```
+Comparison:
+   MiniPhone: valid?:    23111.4 i/s
+    Phonelib: valid?:      482.3 i/s - 47.92x  (± 0.00) slower
+```
+
+```
+Comparison:
+     MiniPhone: e164:    31567.0 i/s
+      Phonelib: e164:      652.3 i/s - 48.39x  (± 0.00) slower
+```
+
+## Installation
+
+1. Install libphonenumber
+
+   ```sh
+   brew install libphonenumber # mac
+   ```
+
+   ```sh
+   apt-get install -y libphonenumber # debian / ubuntu
+   ```
+
+2. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem 'mini_phone'
+   ```
+
+3. And then execute:
+
+   ```sh
+   bundle install
+   ```
+
+   Or install it yourself as:
+
+   ```sh
+   gem install mini_phone
+   ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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).

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+require 'rake/extensiontask'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task build: :compile
+
+task default: %i[clobber compile spec]
+
+spec = Gem::Specification::load(File.expand_path('../mini_phone.gemspec', __FILE__))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+Rake::ExtensionTask.new('mini_phone', spec) do |ext|
+  ext.lib_dir = 'lib/mini_phone'
+end
+
+task bench: %i[clobber compile] do
+  Dir['bench/**/*'].each do |f|
+    require_relative f
+  end
+end

data/ext/mini_phone/extconf.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/GlobalVars
+
+require 'mkmf'
+
+LIBDIR      = RbConfig::CONFIG['libdir']
+
+INCLUDEDIR  = RbConfig::CONFIG['includedir']
+
+header_dirs = [
+  # First search /opt/local for macports
+  '/opt/local/include',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/include',
+
+  # Check the ruby install locations
+  INCLUDEDIR,
+
+  # Finally fall back to /usr
+  '/usr/include'
+]
+
+lib_dirs = [
+  # First search /opt/local for macports
+  '/opt/local/lib',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/lib',
+
+  # Check the ruby install locations
+  LIBDIR,
+
+  # Finally fall back to /usr
+  '/usr/lib'
+]
+
+# Detect homebrew installs
+if find_executable('brew')
+  brew_prefix = `brew --prefix`.strip
+  header_dirs.unshift "#{brew_prefix}/include"
+  lib_dirs.unshift "#{brew_prefix}/lib"
+end
+
+dir_config('mini_phone', header_dirs, lib_dirs)
+
+unless have_library('phonenumber')
+  abort <<~MSG
+
+    ,----------------------------------------------------------------------,
+    |                                                                      |
+    | Hey there, sorry for the inconvenience!                              |
+    |                                                                      |
+    | It looks like libphonenumber is not installed on this system. Don't  |
+    | worry, this should be easy to fix:                                   |
+    |                                                                      |
+    | 1. Install the lib                                                   |
+    |                                                                      |
+    |  On Mac:                                                             |
+    |    brew install libphonenumber                                       |
+    |                                                                      |
+    |  On Debian / Ubuntu:                                                 |
+    |    apt-get install -y libphonenumber                                 |
+    |                                                                      |
+    | 2. Retry installing the gem (i.e `bundle install`)                   |
+    |                                                                      |
+    '----------------------------------------------------------------------'
+
+  MSG
+end
+
+$CXXFLAGS += ' -std=c++11 '
+
+create_makefile('mini_phone/mini_phone')
+
+# rubocop:enable Style/GlobalVars

data/ext/mini_phone/mini_phone.cc

@@ -0,0 +1,377 @@
+#include "mini_phone.h"
+#include "phonenumbers/phonenumberutil.h"
+
+using namespace ::i18n::phonenumbers;
+
+static VALUE rb_mMiniPhone;
+
+static VALUE rb_cPhoneNumber;
+
+extern "C" struct PhoneNumberInfo {
+  PhoneNumber phone_number;
+  std::string raw_phone_number;
+  std::string raw_country_code;
+};
+
+static inline VALUE is_phone_number_valid(VALUE self, VALUE str, VALUE cc) {
+  PhoneNumber parsed_number;
+  PhoneNumberUtil *phone_util = PhoneNumberUtil::GetInstance();
+
+  std::string phone_number(RSTRING_PTR(str), RSTRING_LEN(str));
+  std::string country_code(RSTRING_PTR(cc), RSTRING_LEN(cc));
+
+  auto result = phone_util->ParseAndKeepRawInput(phone_number, country_code, &parsed_number);
+
+  if (result == PhoneNumberUtil::NO_PARSING_ERROR && phone_util->IsValidNumber(parsed_number)) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+extern "C" VALUE rb_is_phone_number_valid(VALUE self, VALUE str) {
+  VALUE def_cc = rb_iv_get(rb_mMiniPhone, "@default_country_code");
+
+  return is_phone_number_valid(self, str, def_cc);
+}
+
+extern "C" VALUE rb_is_phone_number_valid_for_country(VALUE self, VALUE str, VALUE cc) {
+  return is_phone_number_valid(self, str, cc);
+}
+
+extern "C" VALUE rb_is_phone_number_invalid(VALUE self, VALUE str) {
+  return rb_is_phone_number_valid(self, str) == Qtrue ? Qfalse : Qtrue;
+}
+
+extern "C" VALUE rb_is_phone_number_invalid_for_country(VALUE self, VALUE str, VALUE cc) {
+  return is_phone_number_valid(self, str, cc) == Qtrue ? Qfalse : Qtrue;
+}
+
+extern "C" VALUE rb_is_phone_number_possible(VALUE self, VALUE str) {
+  PhoneNumber parsed_number;
+  PhoneNumberUtil *phone_util = PhoneNumberUtil::GetInstance();
+
+  VALUE def_cc = rb_iv_get(rb_mMiniPhone, "@default_country_code");
+  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 && phone_util->IsPossibleNumber(parsed_number)) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+extern "C" VALUE rb_is_phone_number_impossible(VALUE self, VALUE str) {
+  return rb_is_phone_number_possible(self, str) == Qtrue ? Qfalse : Qtrue;
+}
+
+extern "C" VALUE rb_set_default_country_code(VALUE self, VALUE str_code) {
+  return rb_iv_set(self, "@default_country_code", str_code);
+}
+
+extern "C" VALUE rb_get_default_country_code(VALUE self) { return rb_iv_get(self, "@default_country_code"); }
+
+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();
+
+  /* wrap */
+  return Data_Wrap_Struct(self, NULL, &rb_phone_number_dealloc, phone_number_info);
+}
+
+static inline VALUE rb_phone_number_nullify_ivars(VALUE self) {
+  rb_iv_set(self, "@national", Qnil);
+  rb_iv_set(self, "@international", Qnil);
+  rb_iv_set(self, "@e164", Qnil);
+  rb_iv_set(self, "@country_code", Qnil);
+  rb_iv_set(self, "@region_code", Qnil);
+  rb_iv_set(self, "@rfc3966", Qnil);
+  rb_iv_set(self, "@type", Qnil);
+  rb_iv_set(self, "@valid", Qfalse);
+  rb_iv_set(self, "@possible", Qfalse);
+
+  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_code");
+  }
+
+  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);
+
+  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);
+
+  PhoneNumberUtil *phone_util = PhoneNumberUtil::GetInstance();
+  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());
+}
+
+extern "C" VALUE rb_phone_number_e164(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@e164"))) {
+    return rb_iv_get(self, "@e164");
+  }
+
+  return rb_iv_set(self, "@e164", rb_phone_number_format(self, PhoneNumberUtil::PhoneNumberFormat::E164));
+}
+
+extern "C" VALUE rb_phone_number_national(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@national"))) {
+    return rb_iv_get(self, "@national");
+  }
+
+  return rb_iv_set(self, "@national", rb_phone_number_format(self, PhoneNumberUtil::PhoneNumberFormat::NATIONAL));
+}
+
+extern "C" VALUE rb_phone_number_international(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@international"))) {
+    return rb_iv_get(self, "@international");
+  }
+
+  return rb_iv_set(self, "@international",
+                   rb_phone_number_format(self, PhoneNumberUtil::PhoneNumberFormat::INTERNATIONAL));
+}
+
+extern "C" VALUE rb_phone_number_rfc3966(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@rfc3966"))) {
+    return rb_iv_get(self, "@rfc3966");
+  }
+
+  return rb_iv_set(self, "@rfc3966", rb_phone_number_format(self, PhoneNumberUtil::PhoneNumberFormat::RFC3966));
+}
+
+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;
+  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+
+  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");
+  }
+
+  std::string formatted_number;
+  PhoneNumberInfo *phone_number_info;
+  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+
+  PhoneNumberUtil *phone_util = PhoneNumberUtil::GetInstance();
+
+  if (phone_util->IsPossibleNumber(phone_number_info->phone_number)) {
+    return rb_iv_set(self, "@possible", Qtrue);
+  } else {
+    return rb_iv_set(self, "@possible", Qfalse);
+  }
+}
+
+extern "C" VALUE rb_phone_number_impossible_eh(VALUE self) {
+  return rb_phone_number_possible_eh(self) == Qtrue ? Qfalse : Qtrue;
+}
+
+extern "C" VALUE rb_phone_number_region_code(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@region_code"))) {
+    return rb_iv_get(self, "@region_code");
+  }
+
+  PhoneNumberInfo *phone_number_info;
+  std::string code;
+  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  PhoneNumberUtil *phone_util = PhoneNumberUtil::GetInstance();
+
+  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");
+  }
+
+  PhoneNumberInfo *phone_number_info;
+  Data_Get_Struct(self, PhoneNumberInfo, 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_eql_eh(VALUE self, VALUE other) {
+  if (!rb_obj_is_instance_of(other, rb_cPhoneNumber)) {
+    return Qfalse;
+  }
+
+  PhoneNumberUtil *phone_util = PhoneNumberUtil::GetInstance();
+
+  PhoneNumberInfo *self_phone_number_info;
+  Data_Get_Struct(self, PhoneNumberInfo, self_phone_number_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)) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+extern "C" VALUE rb_phone_number_type(VALUE self) {
+  if (rb_ivar_defined(self, rb_intern("@type"))) {
+    return rb_iv_get(self, "@type");
+  }
+
+  PhoneNumberInfo *phone_number_info;
+  Data_Get_Struct(self, PhoneNumberInfo, phone_number_info);
+  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)) {
+  case PhoneNumberUtil::PREMIUM_RATE:
+    result = rb_intern("premium_rate");
+    break;
+  case PhoneNumberUtil::TOLL_FREE:
+    result = rb_intern("toll_free");
+    break;
+  case PhoneNumberUtil::MOBILE:
+    result = rb_intern("mobile");
+    break;
+  case PhoneNumberUtil::FIXED_LINE:
+    result = rb_intern("fixed_line");
+    break;
+  case PhoneNumberUtil::FIXED_LINE_OR_MOBILE:
+    result = rb_intern("fixed_line_or_mobile");
+    break;
+  case PhoneNumberUtil::SHARED_COST:
+    result = rb_intern("shared_cost");
+    break;
+  case PhoneNumberUtil::VOIP:
+    result = rb_intern("voip");
+    break;
+  case PhoneNumberUtil::PERSONAL_NUMBER:
+    result = rb_intern("personal_number");
+    break;
+  case PhoneNumberUtil::PAGER:
+    result = rb_intern("pager");
+    break;
+  case PhoneNumberUtil::UAN:
+    result = rb_intern("uan");
+    break;
+  case PhoneNumberUtil::VOICEMAIL:
+    result = rb_intern("voicemail");
+    break;
+  default:
+    result = rb_intern("unknown");
+    break;
+  }
+
+  return rb_iv_set(self, "@type", ID2SYM(result));
+}
+
+extern "C" void Init_mini_phone(void) {
+  rb_mMiniPhone = rb_define_module("MiniPhone");
+
+  // Unknown
+  rb_iv_set(rb_mMiniPhone, "@default_country_code", rb_str_new("ZZ", 2));
+
+  rb_define_module_function(rb_mMiniPhone, "valid?", reinterpret_cast<VALUE (*)(...)>(rb_is_phone_number_valid), 1);
+  rb_define_module_function(rb_mMiniPhone, "valid_for_country?",
+                            reinterpret_cast<VALUE (*)(...)>(rb_is_phone_number_valid_for_country), 2);
+  rb_define_module_function(rb_mMiniPhone, "invalid?", reinterpret_cast<VALUE (*)(...)>(rb_is_phone_number_invalid), 1);
+  rb_define_module_function(rb_mMiniPhone, "invalid_for_country?",
+                            reinterpret_cast<VALUE (*)(...)>(rb_is_phone_number_invalid_for_country), 2);
+  rb_define_module_function(rb_mMiniPhone, "possible?", reinterpret_cast<VALUE (*)(...)>(rb_is_phone_number_valid), 1);
+  rb_define_module_function(rb_mMiniPhone, "impossible?", reinterpret_cast<VALUE (*)(...)>(rb_is_phone_number_invalid),
+                            1);
+  rb_define_module_function(rb_mMiniPhone,
+                            "default_country_code=", reinterpret_cast<VALUE (*)(...)>(rb_set_default_country_code), 1);
+  rb_define_module_function(rb_mMiniPhone, "default_country_code",
+                            reinterpret_cast<VALUE (*)(...)>(rb_get_default_country_code), 0);
+  rb_define_module_function(rb_mMiniPhone, "parse", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_parse), -1);
+
+  rb_cPhoneNumber = rb_define_class_under(rb_mMiniPhone, "PhoneNumber", rb_cObject);
+
+  rb_define_singleton_method(rb_cPhoneNumber, "parse", reinterpret_cast<VALUE (*)(...)>(rb_class_new_instance), -1);
+  rb_define_alloc_func(rb_cPhoneNumber, rb_phone_number_alloc);
+  rb_define_method(rb_cPhoneNumber, "initialize", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_initialize), -1);
+  rb_define_method(rb_cPhoneNumber, "valid?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_valid_eh), 0);
+  rb_define_method(rb_cPhoneNumber, "invalid?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_invalid_eh), 0);
+  rb_define_method(rb_cPhoneNumber, "possible?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_possible_eh), 0);
+  rb_define_method(rb_cPhoneNumber, "impossible?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_impossible_eh), 0);
+  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);
+  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);
+  rb_define_method(rb_cPhoneNumber, "region_code", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_region_code), 0);
+  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, "eql?", reinterpret_cast<VALUE (*)(...)>(rb_phone_number_eql_eh), 1);
+}

data/ext/mini_phone/mini_phone.h

@@ -0,0 +1,6 @@
+#ifndef MINI_PHONE_H
+#define MINI_PHONE_H 1
+
+#include "ruby.h"
+
+#endif /* MINI_PHONE_H */

data/lib/mini_phone.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'mini_phone/version'
+require 'mini_phone/mini_phone'
+
+module MiniPhone
+  class Error < StandardError; end
+end

data/lib/mini_phone/version.rb

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

data/mini_phone.code-workspace

@@ -0,0 +1,12 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"editor.formatOnSave": true,
+		"ruby.format": "rubocop",
+		"ruby.useBundler": true
+	}
+}

data/mini_phone.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mini_phone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mini_phone'
+  spec.version       = MiniPhone::VERSION
+  spec.authors       = ['Ian Ker-Seymer']
+  spec.email         = ['i.kerseymer@gmail.com']
+
+  spec.summary       = 'Uses the Google libphonenumber C lib to parse, validate, and format phone numbers'
+  spec.description   = <<~MSG.strip
+    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. On average, most methods are 40x t0 50x faster than other Ruby phone number libraries.
+  MSG
+  spec.homepage      = 'https://github.com/ianks/mini_phone'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.platform      = Gem::Platform::RUBY
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ianks/mini_phone'
+  spec.metadata['changelog_uri'] = 'https://github.com/ianks/mini_phone/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec|bench)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/mini_phone/extconf.rb']
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: mini_phone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Ker-Seymer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-04 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.
+  On average, most methods are 40x t0 50x faster than other Ruby phone number libraries.
+email:
+- i.kerseymer@gmail.com
+executables: []
+extensions:
+- ext/mini_phone/extconf.rb
+extra_rdoc_files: []
+files:
+- ".clang-format"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/mini_phone/extconf.rb
+- ext/mini_phone/mini_phone.cc
+- ext/mini_phone/mini_phone.h
+- lib/mini_phone.rb
+- lib/mini_phone/version.rb
+- mini_phone.code-workspace
+- mini_phone.gemspec
+homepage: https://github.com/ianks/mini_phone
+licenses:
+- MIT
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Uses the Google libphonenumber C lib to parse, validate, and format phone
+  numbers
+test_files: []