namae 0.11.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 38015b86433c64bc9ded35a70231226b881dd702
-  data.tar.gz: b4c881fc0559ea65832a4bcdd076120dd7b0dbdb
+SHA256:
+  metadata.gz: 971aa03b31c2c4b0c853f777fbb103a8e15eb7c39a5be6c3e8c2bfbeb1825946
+  data.tar.gz: ffc6a59e69d7654f346c3b5e568b48bcb1bd537a83d1ee543eefc0f32db65119
 SHA512:
-  metadata.gz: 586693fa30423a848cdaf22a1f70354739e2ee44f5ae939b3d15ac46088f18db914109a76901c7faceac83ca75b526b10e1573e12e258d718d30656a9c3db4cc
-  data.tar.gz: 88f7c29520d82cda8034b3445828c67836381df26a0c5bfaf51fa4d527208a8241a01622f6823c33f89c3632ae49b953eaa5c1a21bcfdf73e1501fe100682b35
+  metadata.gz: 31e652932c388fc6c80429a9206682d1478b4470f5d338cd0564a19c31e785ce57bf9c4b333386d8803cb8f9e0235b624e9dca71aa3260b1f55444f25911b9af
+  data.tar.gz: c03466d1e028fa84e07ae994fe53a6c7c3ea66ea8344018e4ae5795f1cc9206a54f7df67b73e3cf8ae67043eece2929a7c27be7d194966f93cac86fd73867ada

data/.travis.yml

@@ -6,26 +6,25 @@ cache: bundler
 matrix:
   fast_finish: true
   include:
-  - rvm: 2.3.1
+  - rvm: 3.0
     env: WITH_COVERALLS=true
-  - rvm: 2.2
+  - rvm: 2.7
     env: WITH_COVERALLS=false
-  - rvm: 2.1
+  - rvm: 2.6
     env: WITH_COVERALLS=false
-  - rvm: 2.0
-    env: WITH_COVERALLS=false
-  - rvm: 1.9.3
+  - rvm: 2.5
     env: WITH_COVERALLS=false
   - rvm: jruby-19mode
     env: WITH_COVERALLS=false
-  - rvm: rbx-2
-    env: WITH_COVERALLS=false
+
+before_install:
+  - gem update --system
 
 install:
   - if [[ $WITH_COVERALLS = "true" ]]; then
-      bundle install --without debug osx optional;
+      bundle install --without debug optional;
     else
-      bundle install --without debug osx optional coverage;
+      bundle install --without debug optional coverage;
     fi
 
 script:

data/BSDL

@@ -1,6 +1,6 @@
 Namae. A personal name parser.
 Copyright (C) 2012 President and Fellows of Harvard College
-Copyright (C) 2013-2014 Sylvester Keil
+Copyright (C) 2013-2020 Sylvester Keil
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

data/Gemfile

@@ -1,40 +1,26 @@
 source 'https://rubygems.org'
 
 group :test do
-  gem 'rspec', '~>3.0'
-  gem 'rake', '~>10.1'
-  gem 'cucumber', '~>1.3'
+  gem 'rspec', '~> 3.7'
+  gem 'rake'
+  gem 'cucumber', '~> 3.1'
 end
 
-
 group :development do
-  gem 'racc', '1.4.9', :platform => :ruby
+  gem 'racc', '~> 1.4', :platform => :ruby
 end
 
 group :coverage do
-  gem 'simplecov', '~>0.8', :require => false, :platforms => :ruby
-  gem 'rubinius-coverage', '~>2.0', :platform => :rbx
-  gem 'coveralls', '~>0.7', :require => false
+  gem 'simplecov', :require => false, :platforms => :ruby
+  gem 'coveralls', :require => false if ENV['CI']
 end
 
 group :optional do
-  gem 'ZenTest', '~>4.9'
-  gem 'jeweler', '~> 2.0'
-  gem 'yard', '~>0.8'
+  gem 'jeweler'
+  gem 'yard'
 end
 
 group :debug do
-  gem 'debugger', '~>1.6', :platform => [:mri_19]
-  gem 'byebug', '~>3.5', :platform => :mri if RUBY_VERSION > '2.0'
-  gem 'rubinius-compiler', '~>2.0', :platform => :rbx
-  gem 'rubinius-debugger', '~>2.0', :platform => :rbx
-end
-
-group :osx do
-  gem 'autotest-fsevent'
-end
-
-group :rbx do
-  gem 'rubysl', '~>2.0', :platform => :rbx
-  gem 'json', '~>1.8', :platform => :rbx
+  gem 'debugger', :platform => [:mri_19]
+  gem 'byebug', :platform => :mri if RUBY_VERSION > '2.0'
 end

data/README.md

@@ -4,9 +4,9 @@ Namae is a parser for human names. It recognizes personal names of various
 cultural backgrounds and tries to split them into their component parts
 (e.g., given and family names, honorifics etc.).
 
-[![Build Status](https://secure.travis-ci.org/inukshuk/namae.png)](http://travis-ci.org/inukshuk/namae)
-[![Coverage Status](https://coveralls.io/repos/inukshuk/namae/badge.png)](https://coveralls.io/r/inukshuk/namae)
-[![Gem Version](https://badge.fury.io/rb/namae.png)](http://badge.fury.io/rb/namae)
+[![Build Status](https://travis-ci.org/berkmancenter/namae.svg?branch=master)](https://travis-ci.org/berkmancenter/namae)
+[![Coverage Status](https://coveralls.io/repos/github/berkmancenter/namae/badge.svg?branch=master)](https://coveralls.io/github/berkmancenter/namae?branch=master)
+[![Gem Version](https://badge.fury.io/rb/namae.svg)](http://badge.fury.io/rb/namae)
 [![Code Climate](https://codeclimate.com/github/berkmancenter/namae/badges/gpa.svg)](https://codeclimate.com/github/berkmancenter/namae)
 
 Quickstart
@@ -121,6 +121,23 @@ ambiguous. For example, multiple family names are always possible in sort-order:
 Whilst in display-order, multiple family names are only supported when the
 name contains a particle or a nickname.
 
+Configuration
+-------------
+You can tweak some of Namae's parse rules by configuring the parser's
+options. Take a look at `Namae.options` to see your current settings.
+If you want to change the default settings for all parsers, you can run
+`Namae.configure` which will yield the default options (make sure to
+change the configuration before using the parser).
+
+A Note On Thread Safety
+-----------------------
+When using the top-level parse functions, Namae will re-use a thread-local
+parser instance (`Namae::Parser.instance`); the instance is created, using
+the current default options (`Namae::Parser.defaults`). If you need more
+control, you are encouraged to create individual parser instances using
+`Namae::Parser.new`.
+
+
 Rationale
 ---------
 Parsing human names is at once too easy and too hard. When working in the
@@ -170,7 +187,8 @@ Namae was written as a part of a Google Summer of Code project. Thanks Google!
 
 Copyright
 ---------
+Copyright (c) 2013-2020 Sylvester Keil
+
 Copyright (c) 2012 President and Fellows of Harvard College.
-Copyright (c) 2013-2014 Sylvester Keil
 
 Namae is dual licensed under the AGPL and a BSD-style license.

data/features/lists.feature

@@ -126,3 +126,11 @@ Feature: Parse a list of names
       | given | family     |
       | M     | Di Proctor |
       | P     | Cooper     |
+
+  Scenario: A list of names with two consecutive accented characters
+    Given a parser that prefers commas as separators
+    When I parse the names "Çakıroğlu, Ü., Başıbüyük, B."
+    Then the names should be:
+      | given | family     |
+      | Ü.    | Çakıroğlu  |
+      | B.    | Başıbüyük  |

data/features/support/env.rb

@@ -1,12 +1,3 @@
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
 begin
   require 'simplecov'
   require 'coveralls' if ENV['CI']

data/lib/namae/parser.rb

@@ -1,34 +1,41 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.9
-# from Racc grammer file "".
+# This file is automatically generated by Racc 1.4.16
+# from Racc grammar file "".
 #
 
 require 'racc/parser.rb'
 
-require 'singleton'
 require 'strscan'
 
 module Namae
   class Parser < Racc::Parser
 
-module_eval(<<'...end parser.y/module_eval...', 'parser.y', 107)
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 106)
 
-  include Singleton
+  @defaults = {
+    :debug => false,
+    :prefer_comma_as_separator => false,
+    :comma => ',',
+    :stops => ',;',
+    :separator => /\s*(\band\b|\&|;)\s*/i,
+    :title => /\s*\b(sir|lord|count(ess)?|(gen|adm|col|maj|capt|cmdr|lt|sgt|cpl|pvt|pastor|pr|reverend|rev|elder|deacon|deaconess|father|fr|rabbi|cantor|vicar|prof|dr|md|ph\.?d)\.?)(\s+|$)/i,
+    :suffix => /\s*\b(JR|Jr|jr|SR|Sr|sr|[IVX]{2,})(\.|\b)/,
+    :appellation => /\s*\b((mrs?|ms|fr|hr)\.?|miss|herr|frau)(\s+|$)/i
+  }
+
+  class << self
+    attr_reader :defaults
+
+    def instance
+      Thread.current[:namae] ||= new
+    end
+  end
 
   attr_reader :options, :input
 
-  def initialize
-    @input, @options = StringScanner.new(''), {
-      :debug => false,
-      :prefer_comma_as_separator => false,
-      :comma => ',',
-      :stops => ',;',
-      :separator => /\s*(\band\b|\&|;)\s*/i,
-      :title => /\s*\b(sir|lord|count(ess)?|(gen|adm|col|maj|capt|cmdr|lt|sgt|cpl|pvt|pastor|pr|reverend|rev|elder|deacon|deaconess|father|fr|vicar|prof|dr|md|ph\.?d)\.?)(\s+|$)/i,
-      :suffix => /\s*\b(JR|Jr|jr|SR|Sr|sr|[IVX]{2,})(\.|\b)/,
-      :appellation => /\s*\b((mrs?|ms|fr|hr)\.?|miss|herr|frau)(\s+|$)/i
-    }
+  def initialize(options = {})
+    @options = self.class.defaults.merge(options)
   end
 
   def debug?
@@ -63,22 +70,21 @@ module_eval(<<'...end parser.y/module_eval...', 'parser.y', 107)
     options[:prefer_comma_as_separator]
   end
 
-  def parse(input)
-    parse!(input)
+  def parse(string)
+    parse!(string)
   rescue => e
     warn e.message if debug?
     []
   end
 
   def parse!(string)
-    input.string = normalize(string)
+    @input = StringScanner.new(normalize(string))
     reset
     do_parse
   end
 
   def normalize(string)
-    string = string.match(/\D*/).to_s.strip
-    string
+    string.scrub.strip
   end
 
   def reset
@@ -129,11 +135,11 @@ module_eval(<<'...end parser.y/module_eval...', 'parser.y', 107)
   end
 
   def will_see_suffix?
-    input.peek(8).to_s.strip.split(/\s+/)[0] =~ suffix
+    input.rest.strip.split(/\s+/)[0] =~ suffix
   end
 
   def will_see_initial?
-    input.peek(6).to_s.strip.split(/\s+/)[0] =~ /^[[:upper:]]+\b/
+    input.rest.strip.split(/\s+/)[0] =~ /^[[:upper:]]+\b/
   end
 
   def seen_full_name?

data/lib/namae/parser.y

@@ -100,26 +100,33 @@ rule
          | titles TITLE { result = val.join(' ') }
 
 ---- header
-require 'singleton'
 require 'strscan'
 
 ---- inner
 
-  include Singleton
+  @defaults = {
+    :debug => false,
+    :prefer_comma_as_separator => false,
+    :comma => ',',
+    :stops => ',;',
+    :separator => /\s*(\band\b|\&|;)\s*/i,
+    :title => /\s*\b(sir|lord|count(ess)?|(gen|adm|col|maj|capt|cmdr|lt|sgt|cpl|pvt|pastor|pr|reverend|rev|elder|deacon|deaconess|father|fr|rabbi|cantor|vicar|prof|dr|md|ph\.?d)\.?)(\s+|$)/i,
+    :suffix => /\s*\b(JR|Jr|jr|SR|Sr|sr|[IVX]{2,})(\.|\b)/,
+    :appellation => /\s*\b((mrs?|ms|fr|hr)\.?|miss|herr|frau)(\s+|$)/i
+  }
+
+  class << self
+    attr_reader :defaults
+
+    def instance
+      Thread.current[:namae] ||= new
+    end
+  end
 
   attr_reader :options, :input
 
-  def initialize
-    @input, @options = StringScanner.new(''), {
-      :debug => false,
-      :prefer_comma_as_separator => false,
-      :comma => ',',
-      :stops => ',;',
-      :separator => /\s*(\band\b|\&|;)\s*/i,
-      :title => /\s*\b(sir|lord|count(ess)?|(gen|adm|col|maj|capt|cmdr|lt|sgt|cpl|pvt|pastor|pr|reverend|rev|elder|deacon|deaconess|father|fr|vicar|prof|dr|md|ph\.?d)\.?)(\s+|$)/i,
-      :suffix => /\s*\b(JR|Jr|jr|SR|Sr|sr|[IVX]{2,})(\.|\b)/,
-      :appellation => /\s*\b((mrs?|ms|fr|hr)\.?|miss|herr|frau)(\s+|$)/i
-    }
+  def initialize(options = {})
+    @options = self.class.defaults.merge(options)
   end
 
   def debug?
@@ -154,22 +161,21 @@ require 'strscan'
     options[:prefer_comma_as_separator]
   end
 
-  def parse(input)
-    parse!(input)
+  def parse(string)
+    parse!(string)
   rescue => e
     warn e.message if debug?
     []
   end
 
   def parse!(string)
-    input.string = normalize(string)
+    @input = StringScanner.new(normalize(string))
     reset
     do_parse
   end
 
   def normalize(string)
-    string = string.strip
-    string
+    string.scrub.strip
   end
 
   def reset
@@ -220,11 +226,11 @@ require 'strscan'
   end
 
   def will_see_suffix?
-    input.peek(8).to_s.strip.split(/\s+/)[0] =~ suffix
+    input.rest.strip.split(/\s+/)[0] =~ suffix
   end
 
   def will_see_initial?
-    input.peek(6).to_s.strip.split(/\s+/)[0] =~ /^[[:upper:]]+\b/
+    input.rest.strip.split(/\s+/)[0] =~ /^[[:upper:]]+\b/
   end
 
   def seen_full_name?

data/lib/namae/utility.rb

@@ -44,4 +44,8 @@ module Namae
     Parser.instance.options
   end
 
+  # @yield [Hash] the parser's default configuration.
+  def configure
+    yield Parser.defaults
+  end
 end

data/lib/namae/version.rb

@@ -1,8 +1,8 @@
 module Namae
   module Version
-    MAJOR = 0
-    MINOR = 11
-    PATCH = 1
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 2
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.').freeze

data/namae.gemspec

@@ -2,23 +2,22 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: namae 0.11.1 ruby lib
+# stub: namae 1.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "namae".freeze
-  s.version = "0.11.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sylvester Keil".freeze, "Dan Collis-Puro".freeze]
-  s.date = "2016-11-10"
-  s.description = " Namae (\u{540d}\u{524d}) is a parser for human names. It recognizes personal names of various cultural backgrounds and tries to split them into their component parts (e.g., given and family names, honorifics etc.). ".freeze
+  s.date = "2021-01-07"
+  s.description = " Namae (\u540D\u524D) is a parser for human names. It recognizes personal names of various cultural backgrounds and tries to split them into their component parts (e.g., given and family names, honorifics etc.). ".freeze
   s.email = ["sylvester@keil.or.at".freeze, "dan@collispuro.com".freeze]
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
-    ".autotest",
     ".codeclimate.yml",
     ".coveralls.yml",
     ".document",
@@ -50,23 +49,22 @@ Gem::Specification.new do |s|
     "spec/namae/name_spec.rb",
     "spec/namae/parser_spec.rb",
     "spec/namae/utility_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/thread_safety_spec.rb"
   ]
   s.homepage = "https://github.com/berkmancenter/namae".freeze
   s.licenses = ["AGPL-3.0".freeze]
-  s.rubygems_version = "2.6.3".freeze
-  s.summary = "Namae (\u{540d}\u{524d}) parses personal names and splits them into their component parts.".freeze
+  s.rubygems_version = "3.2.3".freeze
+  s.summary = "Namae (\u540D\u524D) parses personal names and splits them into their component parts.".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<racc>.freeze, ["= 1.4.9"])
-    else
-      s.add_dependency(%q<racc>.freeze, ["= 1.4.9"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<racc>.freeze, ["~> 1.4"])
   else
-    s.add_dependency(%q<racc>.freeze, ["= 1.4.9"])
+    s.add_dependency(%q<racc>.freeze, ["~> 1.4"])
   end
 end
 

data/spec/namae/parser_spec.rb

@@ -1,10 +1,5 @@
 module Namae
   describe 'Parser' do
-
-    it 'does not respond to .new' do
-      expect(Parser).not_to respond_to(:new)
-    end
-
     describe '.instance' do
       let(:parser) { Parser.instance }
 
@@ -120,7 +115,7 @@ module Namae
           end
         end
 
-        %w{Pastor Pr. Reverend Rev. Elder Deacon Deaconess Father Fr. Vicar}.each do |title|
+        %w{Pastor Pr. Reverend Rev. Elder Deacon Deaconess Father Fr. Vicar Rabbi Cantor}.each do |title|
           describe "the next token is #{title.inspect}" do
             before { parser.send(:input).string = title }
             it 'returns a TITLE token' do
@@ -149,10 +144,6 @@ module Namae
             expect(parser.parse!('Ichiro')[0].given).to eq('Ichiro')
           end
 
-          it 'removes numbers' do
-            expect(parser.parse!('Ichiro 20156')[0].given).to eq('Ichiro')
-          end
-
           it 'treats "Lord Byron" as a title and family name' do
             expect(parser.parse!('Lord Byron')[0].values_at(:family, :title)).to eq(['Byron', 'Lord'])
           end

data/spec/thread_safety_spec.rb

@@ -0,0 +1,25 @@
+module Namae
+  describe 'Parser using threads' do
+    let(:name_1_str) { "Foo Bar" }
+    let(:name_2_str) { "Baz" }
+    let(:name_1) { Namae.parse(name_1_str).first }
+    let(:name_2) { Namae.parse(name_2_str).first }
+
+    def compare(string, expectation)
+      name = Namae.parse(string).first
+      given_name_match = expectation.given == name.given
+      family_name_match = expectation.family == name.family
+      raise unless given_name_match && family_name_match
+    end
+
+    it 'has no conflicts' do
+      [[name_1_str, name_1], [name_2_str, name_2]].map do |string, expectation|
+        Thread.new do
+          1000.times do
+            compare(string, expectation)
+          end
+        end
+      end.each(&:join)
+    end
+  end
+end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: namae
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sylvester Keil
 - Dan Collis-Puro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.9
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.9
+        version: '1.4'
 description: " Namae (名前) is a parser for human names. It recognizes personal names
   of various cultural backgrounds and tries to split them into their component parts
   (e.g., given and family names, honorifics etc.). "
@@ -36,7 +36,6 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".autotest"
 - ".codeclimate.yml"
 - ".coveralls.yml"
 - ".document"
@@ -69,11 +68,12 @@ files:
 - spec/namae/parser_spec.rb
 - spec/namae/utility_spec.rb
 - spec/spec_helper.rb
+- spec/thread_safety_spec.rb
 homepage: https://github.com/berkmancenter/namae
 licenses:
 - AGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Namae (名前) parses personal names and splits them into their component parts.
 test_files: []

data/.autotest

@@ -1,21 +0,0 @@
-require 'bundler'
-begin
-  if RUBY_PLATFORM =~ /darwin/
-    Bundler.setup(:default, :development, :debug, :test, :osx)
-    require 'autotest/fsevent'  
-  else
-    Bundler.setup(:default, :development, :debug, :test)
-  end
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-
-Autotest.add_hook :initialize do |at|
-  at.add_mapping(/.+\.y$/) do |f,_|
-    system 'rake clean racc'
-  end
-end
-