humanname 0.5.0-x86_64-linux → 0.8.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3f99bab76bffdb26ff72cd3c475517405269d649
-  data.tar.gz: 13357f87774d98b84d2cb52f575a5cc1429b9682
+SHA256:
+  metadata.gz: 4f09cc8706ffe6d100443c3b1424e268559eb5ad95816cf8db9a49d92f247c41
+  data.tar.gz: 318f6bf3ea00aa09f7c6a503182351ea491ae7854a26b96a0ac8ea9386cca4e4
 SHA512:
-  metadata.gz: c62247c3fa7549d90882e78ddb7aa98ebe0349cf6edaf8108aa27163541eb58ae7177f330bb4be81d4aa389ce3911ea694a4e081b4d0e7e0d8517e2989afc1d5
-  data.tar.gz: e48eb89f3c6e9634858a12d5ac745deb5945c02cd6bece657035b02ae9a1f6d38158d54b25f9e3b927774fae3a5b88c9443311c457e71bdada875989f2664d1e
+  metadata.gz: c9c480c75130da9fbd194d500407fb5855344d4989157f133483045b461a3a1c84586217bd4242b07a8d04219f51300917b25741e2013986cf4f551158e8f036
+  data.tar.gz: 675a2825eaf398d8ea6dde01e8bf8d6c80b3a596e5423552720a56da1065e548bbd4f44652b246455b720e059f320990665c3eab4c49dc85e7da95dad1f62f93

data/README.md

@@ -1,8 +1,6 @@
 # human-name-rb
 Ruby bindings for the Rust crate [`human_name`](https://github.com/djudd/human-name), a library for parsing and comparing human names.
 
-[![Build Status](https://travis-ci.org/djudd/human-name-rb.svg?branch=master)](https://travis-ci.org/djudd/human-name-rb)
-
 See the [`human_name` docs](http://djudd.github.io/human-name) for details.
 
 # Examples
@@ -36,41 +34,12 @@ See the [`human_name` docs](http://djudd.github.io/human-name) for details.
 
 # Supported environments
 
-With just `bundle`/`gem install`, OS X 10.12+.
-
-If you're willing to do a little more work, anywhere supported by [Helix](https://github.com/tildeio/helix)
-and the nightly Rust compiler:
-```bash
-curl -s https://static.rust-lang.org/rustup.sh | sh -s -- --channel=nightly
-git clone git@github.com:djudd/human-name-rb.git
-cd human-name-rb
-bundle exec rake
-```
-
-That will give you a .gem file in pkg/ which should work in environments similar
-to the one in which it was built.
-
-# Benchmark results
-
-Comparing to [`people`](https://github.com/academia-edu/people), [`namae`](https://github.com/berkmancenter/namae), and [`human_name_parser`](https://github.com/abachman/human_name_parser),
-on 16k real examples taken mostly from PubMed author fields:
-
-```
-$ bundle exec rake benchmark
-people gem:
-  3.010000   0.030000   3.040000 (  3.032075)
-namae gem:
-  3.550000   0.080000   3.630000 (  3.630643)
-human_name_parser gem:
-  1.960000   0.030000   1.990000 (  1.991358)
-this gem:
-  0.100000   0.000000   0.100000 (  0.107794)
-```
-
-Our implementation uses a similar strategy to `people` and `human_name_parser`
-but covers significantly more edge cases, and also supports comparison.
-(`human_name_parser` also covers fewer edge cases than `people`, as of December
-2015, which probably explains its speed advantage.)
+Linux, MacOS, and Windows, as of the versions currently supported by GitHub Actions.
+x86-64 or Apple Silicon. Ruby 2.7 or later.
 
-`namae` uses a formal grammar, unlike this gem, and so probably captures some
-cases this does not, although it certainly also misses some which this captures.
+If you have access to another environment which is supported by the Rust compiler,
+it should be relatively straightforward to fork the library and add support. You'll need
+to build [`human_name`](http://github.com/djudd/human-name), copy the resulting library
+from `target/release/` in that repository to `lib/native/<arch>/` in this one,
+and modify `native_lib_path` appropriately. If this environment is additionally supported
+by GitHub Actions, I'm also happy to accept a PR.

data/humanname.gemspec

@@ -11,10 +11,10 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/djudd/human-name-rb'
   s.license     = 'Apache-2.0'
   s.platform    = Gem::Platform::CURRENT
-  s.required_ruby_version = '>= 2.2.0'
-  s.add_runtime_dependency 'helix_runtime', '~> 0.6.1'
-  s.add_development_dependency 'rake', '~> 10.4.2'
+  s.required_ruby_version = '>= 2.7.0'
+  s.add_runtime_dependency 'ffi', '~> 1.15.1'
+  s.add_development_dependency 'rake', '~> 13.0.6'
   s.add_development_dependency 'rspec', '~> 3.4.0'
-  s.add_development_dependency 'rubygems-tasks', '~> 0.2.4'
-  s.add_development_dependency 'pry', '~> 0.10.3'
+  s.add_development_dependency 'rubygems-tasks', '~> 0.2.5'
+  s.add_development_dependency 'pry', '~> 0.14.2'
 end

data/lib/humanname/version.rb

@@ -1,3 +1,3 @@
 module HumanName
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.8.0'.freeze
 end

data/lib/humanname.rb

@@ -1,24 +1,136 @@
-require 'helix_runtime'
+require 'ffi'
 require 'humanname/version'
-require 'humanname/native'
 
 module HumanName
-  Name = RustHumanName
-
   UTF8 = 'UTF-8'.freeze
+  NAME_PARTS = %w(
+    surname
+    given_name
+    initials
+    first_initial
+    middle_initials
+    middle_names
+    generational_suffix
+    display_first_last
+    display_full
+    display_initial_surname
+  ).freeze
+
+  class UnsupportedPlatform < StandardError
+    def initialize
+      platform = Gem::Platform.local
+      super("Unsupported platform: #{platform.os}-#{platform.cpu}")
+    end
+  end
+
+  module Native
+    extend FFI::Library
+
+    def self.init!
+      path = native_lib_path
+      if File.exist?(path)
+        ffi_lib path
+      else
+        raise UnsupportedPlatform.new
+      end
+
+      attach_function :human_name_parse, [:string], :pointer
+      attach_function :human_name_consistent_with, [:pointer, :pointer], :bool
+      attach_function :human_name_hash, [:pointer], :uint64
+
+      NAME_PARTS.each do |part|
+        attach_function "human_name_#{part}".to_sym, [:pointer], :pointer
+      end
+
+      attach_function :human_name_goes_by_middle_name, [:pointer], :bool
+      attach_function :human_name_byte_len, [:pointer], :uint32
+
+      attach_function :human_name_free_name, [:pointer], :void
+      attach_function :human_name_free_string, [:pointer], :void
+    end
+
+    def self.native_lib_path
+      platform = Gem::Platform.local
+
+      filename = case platform.os
+        when 'darwin'
+          'libhuman_name.dylib'
+        when 'linux'
+          'libhuman_name.so'
+        when /mswin|mingw/
+          'human_name.dll'
+        else
+          raise UnsupportedPlatform.new
+        end
+
+      cpu = platform.cpu
+      cpu = 'x86_64' if cpu == 'x64'
+
+      File.expand_path(
+        File.join('../native/', cpu, filename),
+        __FILE__,
+      )
+    end
+  end
+
+  Native.init!
+  private_constant :Native
+
+  class NativeString < String
+    DESTRUCTOR = Native.method(:human_name_free_string)
+
+    def self.wrap(pointer)
+      new(pointer) unless pointer.null?
+    end
+
+    def initialize(pointer)
+      @pointer = FFI::AutoPointer.new(pointer, DESTRUCTOR)
+      super(@pointer.read_string.force_encoding(UTF8))
+    end
+  end
+
+  private_constant :NativeString
+
+  class Name < FFI::AutoPointer
+    DESTRUCTOR = Native.method(:human_name_free_name)
 
-  class Name
     def self.parse(string)
       string = string.encode(UTF8) unless string.encoding == UTF8
-      parse_utf8(string)
+      pointer = Native.human_name_parse(string)
+      new(pointer) unless pointer.null?
     end
 
-    def matches_slug_or_localpart(string)
-      string = string.encode(UTF8) unless string.encoding == UTF8
-      matches_slug_or_localpart_utf8(string)
+    def initialize(pointer)
+      super(pointer, DESTRUCTOR)
+    end
+
+    def ==(other)
+      other.is_a?(Name) && Native.human_name_consistent_with(self, other)
+    end
+    alias_method :eql?, :==
+
+    def hash
+      Native.human_name_hash(self)
     end
 
-    JSON_PARTS = %w( surname given_name first_initial middle_initials middle_names suffix ).map(&:to_sym)
+    NAME_PARTS.each do |part|
+      native_method = "human_name_#{part}".to_sym
+
+      define_method part do
+        pointer = Native.send(native_method, self)
+        NativeString.wrap(pointer)
+      end
+    end
+
+    def goes_by_middle_name
+      Native.human_name_goes_by_middle_name(self)
+    end
+
+    def length
+      Native.human_name_byte_len(self)
+    end
+
+    JSON_PARTS = %w( surname given_name first_initial middle_initials middle_names generational_suffix ).map(&:to_sym)
 
     def as_json(options = {})
       # We take an "options" argument for minimal compatibility with ActiveSupport,
@@ -36,6 +148,11 @@ module HumanName
         memo
       end
     end
+
+    def inspect
+      "HumanName::Name(#{display_full})"
+    end
+
   end
 
   def self.parse(string)

data/spec/humanname_spec.rb

@@ -9,7 +9,7 @@ describe HumanName do
       expect(n.given_name).to eq('Jane')
       expect(n.surname).to eq('Doe')
       expect(n.middle_names).to be_nil
-      expect(n.suffix).to be_nil
+      expect(n.generational_suffix).to be_nil
       expect(n.display_full).to eq('Jane Doe')
       expect(n.display_first_last).to eq('Jane Doe')
       expect(n.display_initial_surname).to eq('J. Doe')
@@ -22,7 +22,7 @@ describe HumanName do
       expect(n.given_name).to eq('John')
       expect(n.surname).to eq('de la MacDonald')
       expect(n.middle_names).to eq('Allen')
-      expect(n.suffix).to eq('Jr.')
+      expect(n.generational_suffix).to eq('Jr.')
       expect(n.display_full).to eq('John Allen Q. de la MacDonald, Jr.')
       expect(n.display_first_last).to eq('John de la MacDonald')
       expect(n.display_initial_surname).to eq('J. de la MacDonald')
@@ -69,16 +69,6 @@ describe HumanName do
     end
   end
 
-  describe 'matches_slug_or_localpart' do
-    it 'is true given match' do
-      expect(HumanName.parse("Jane Doe").matches_slug_or_localpart('janexdoe')).to be_truthy
-    end
-
-    it 'is false given non-match' do
-      expect(HumanName.parse("Jane Doe").matches_slug_or_localpart('johnxdoe')).to be_falsey
-    end
-  end
-
   it 'implements as_json' do
     n = HumanName.parse("JOHN ALLEN Q DE LA MACDONALD JR")
     expect(n.as_json).to eq({
@@ -87,11 +77,19 @@ describe HumanName do
       middle_names: 'Allen',
       first_initial: 'J',
       middle_initials: 'AQ',
-      suffix: 'Jr.',
+      generational_suffix: 'Jr.',
     })
   end
 
   it 'does not leak memory' do
+    skip unless ['linux', 'darwin'].include?(Gem::Platform.local.os)
+
+    # This is fishy but we either have a memory leak with 3.3 or something has changed
+    # with memory management such that it's harder to write a clean test for one.
+    # I suspect the latter because it's easier to understand why that would change
+    # between Ruby versions, but I'm not sure...
+    skip if RUBY_VERSION >= "3.3"
+
     def rss
       GC.start
       `ps -o rss= -p #{Process.pid}`.chomp.to_i
@@ -106,7 +104,7 @@ describe HumanName do
       first_initial
       middle_initials
       middle_names
-      suffix
+      generational_suffix
       display_first_last
       display_full
       display_initial_surname

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: humanname
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: x86_64-linux
 authors:
 - David Judd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: helix_runtime
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 1.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 1.15.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.2
 description: A library for parsing and comparing human names. Wraps the Rust crate
   `human_name`.
 email: david.a.judd@gmail.com
@@ -92,9 +92,12 @@ files:
 - README.md
 - humanname.gemspec
 - lib/humanname.rb
-- lib/humanname/native.bundle
-- lib/humanname/native.so
 - lib/humanname/version.rb
+- lib/native/arm64/libhuman_name.dylib
+- lib/native/arm64/libhuman_name.so
+- lib/native/x86_64/human_name.dll
+- lib/native/x86_64/libhuman_name.dylib
+- lib/native/x86_64/libhuman_name.so
 - spec/humanname_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/djudd/human-name-rb
@@ -109,15 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: A library for parsing and comparing human names