nameable 0.5.1 → 1.0.0

data/lib/nameable/latin/patterns.rb

@@ -0,0 +1,34 @@
+module Nameable
+  class Latin
+    ##
+    # Regex's to match the detritus that people add to their names
+    module Patterns
+      PREFIX = {
+        "Mr."    => /^\(*(mr\.*|mister)\)*$/i,
+        "Mrs."   => /^\(*(mrs\.*|misses)\)*$/i,
+        "Ms."    => /^\(*(ms\.*|miss)\)*$/i,
+        "Dr."    => /^\(*(dr\.*|doctor)\)*$/i,
+        "Rev."   => /^\(*(rev\.*|reverand)\)*$/i,
+        "Fr."    => /^\(*(fr\.*|friar)\)*$/i,
+        "Master" => /^\(*(master)\)*$/i,
+        "Sir"    => /^\(*(sir)\)*$/i
+      }
+
+      SUFFIX = {
+        "Sr."   => /^\(*(sr\.?|senior)\)*$/i,
+        "Jr."   => /^\(*(jr\.?|junior)\)*$/i,
+        "Esq."  => /^\(*(esq\.?|esquire)\)*$/i,
+        "Ph.D." => /^\(*(p\.?h\.?d\.?)\)*$/i
+      }
+
+      SUFFIX_GENERATIONAL_ROMAN = /^\(*[IVX.]+\)*$/i
+      SUFFIX_ACADEMIC = /^(APR|RPh|MD|MA|DMD|DDS|PharmD|EngD|DPhil|JD|DD|DO|BA|BS|BSc|BE|BFA|MA|MS|MSc|MFA|MLA|MBA)$/i
+      SUFFIX_PROFESSIONAL = /^(PE|CSA|CPA|CPL|CME|CEng|OFM|CSV|Douchebag)$/i
+      SUFFIX_ABBREVIATION = /^[A-Z.]+[A-Z.]+$/  # It should be at least 2 letters
+
+      # http://www.onlineaspect.com/2009/08/17/splitting-names/
+      LAST_NAME_PRE_DANGLERS = /^(mc|vere|von|van|da|de|del|della|di|da|pietro|vanden|du|st|la|ter|ten)$/i
+      O_LAST_NAME_PRE_CONCATS = /^(o'|o`|o")$/i
+    end
+  end
+end

data/lib/nameable/version.rb

@@ -0,0 +1,3 @@
+module Nameable
+  VERSION = "1.0.0"
+end

data/nameable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nameable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nameable'
+  spec.version       = Nameable::VERSION
+  spec.authors       = ['Chris Horn']
+  spec.email         = ['chorn@chorn.com']
+  spec.summary       = 'Parse names into components.'
+  spec.description   = 'A library that provides parsing and output of person names.'
+  spec.homepage      = 'https://github.com/chorn/nameable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '>= 1.6.2'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+end

data/spec/nameable/latin_spec.rb

@@ -0,0 +1,284 @@
+require 'spec_helper'
+
+describe '.new' do
+  it "doesn't raise" do
+    expect { Nameable::Latin.new }.to_not raise_error
+  end
+end
+
+context('with a single word name') do
+  subject(:n) { Nameable::Latin.new.parse("Chris") }
+  it '.parse' do
+    expect(n.prefix).to be_nil
+    expect(n.first).to eq('Chris')
+    expect(n.middle).to be_nil
+    expect(n.last).to be_nil
+    expect(n.suffix).to be_nil
+  end
+end
+
+context('with a simple name') do
+  subject(:n) { Nameable::Latin.new.parse("Chris Horn") }
+  it '.prefix' do
+    expect(n.prefix).to be_nil
+  end
+  it '.first' do
+    expect(n.first).to eq('Chris')
+  end
+  it '.middle' do
+    expect(n.middle).to be_nil
+  end
+  it '.last' do
+    expect(n.last).to eq('Horn')
+  end
+  it '.suffix' do
+    expect(n.suffix).to be_nil
+  end
+end
+
+context('with an all uppercase name') do
+  subject(:n) { Nameable::Latin.new.parse("CHRIS HORN") }
+  it '.first' do
+    expect(n.first).to eq('Chris')
+  end
+  it '.last' do
+    expect(n.last).to eq('Horn')
+  end
+end
+
+context('with an all lowercase name') do
+  subject(:n) { Nameable::Latin.new.parse("chris horn") }
+  it '.first' do
+    expect(n.first).to eq('Chris')
+  end
+  it '.last' do
+    expect(n.last).to eq('Horn')
+  end
+end
+
+context('with a mixed case name') do
+  subject(:n) { Nameable::Latin.new.parse("DeChris HORN") }
+  it '.first' do
+    expect(n.first).to eq('DeChris')
+  end
+end
+
+context('with a simple middle name') do
+  subject(:n) { Nameable::Latin.new.parse("Chris Derp Horn") }
+  it '.prefix' do
+    expect(n.prefix).to be_nil
+  end
+  it '.first' do
+    expect(n.first).to eq('Chris')
+  end
+  it '.middle' do
+    expect(n.middle).to eq('Derp')
+  end
+  it '.last' do
+    expect(n.last).to eq('Horn')
+  end
+  it '.suffix' do
+    expect(n.suffix).to be_nil
+  end
+end
+
+context('with a simple prefix') do
+  subject(:n) { Nameable::Latin.new.parse("Sir Chris Horn") }
+  it '.prefix' do
+    expect(n.prefix).to eq('Sir')
+  end
+  it '.first' do
+    expect(n.first).to eq('Chris')
+  end
+  it '.middle' do
+    expect(n.middle).to be_nil
+  end
+  it '.last' do
+    expect(n.last).to eq('Horn')
+  end
+  it '.suffix' do
+    expect(n.suffix).to be_nil
+  end
+end
+
+context('with a simple suffix') do
+  subject(:n) { Nameable::Latin.new.parse("Chris Horn PhD") }
+  it '.prefix' do
+    expect(n.prefix).to be_nil
+  end
+  it '.first' do
+    expect(n.first).to eq('Chris')
+  end
+  it '.middle' do
+    expect(n.middle).to be_nil
+  end
+  it '.last' do
+    expect(n.last).to eq('Horn')
+  end
+  it '.suffix' do
+    expect(n.suffix).to eq('Ph.D.')
+  end
+end
+
+context('prefix patterns') do
+  %w{Mr Mr. Mister}.each do |prefix|
+    it prefix do
+     expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq('Mr.')
+    end
+  end
+
+  %w{Mrs Mrs. Misses}.each do |prefix|
+    it prefix do
+      expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq('Mrs.')
+    end
+  end
+
+  %w{Ms Ms. Miss}.each do |prefix|
+    it prefix do
+      expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq('Ms.')
+    end
+  end
+
+  %w{Dr Dr. Doctor}.each do |prefix|
+    it prefix do
+      expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq('Dr.')
+    end
+  end
+
+  %w{Rev Rev. Reverand}.each do |prefix|
+    it prefix do
+      expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq('Rev.')
+    end
+  end
+
+  %w{Fr Fr. Friar}.each do |prefix|
+    it prefix do
+      expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq('Fr.')
+    end
+  end
+
+  %w{Master Sir}.each do |prefix|
+    it prefix do
+      expect(Nameable::Latin.new.parse("#{prefix} Chris Horn").prefix).to eq(prefix)
+    end
+  end
+
+end
+
+context('suffix patterns (formatted)') do
+  %w{Sr Sr. Senior}.each do |suffix|
+    it suffix do
+      expect(Nameable::Latin.new.parse("Chris Horn #{suffix}").suffix).to eq('Sr.')
+    end
+  end
+
+  %w{Jr Jr. Junior}.each do |suffix|
+    it suffix do
+      expect(Nameable::Latin.new.parse("Chris Horn #{suffix}").suffix).to eq('Jr.')
+    end
+  end
+
+  %w{Esq Esq. Esquire}.each do |suffix|
+    it suffix do
+      expect(Nameable::Latin.new.parse("Chris Horn #{suffix}").suffix).to eq('Esq.')
+    end
+  end
+
+  %w{PHD PhD Ph.D Ph.D. P.H.D.}.each do |suffix|
+    it suffix do
+      expect(Nameable::Latin.new.parse("Chris Horn #{suffix}").suffix).to eq('Ph.D.')
+    end
+  end
+
+end
+
+context('suffix patterns (generational)') do
+  %w{ii III iv V VI ix Xiii}.each do |suffix|
+    it suffix do
+      expect(Nameable::Latin.new.parse("Chris Horn #{suffix}").suffix).to eq(suffix.upcase)
+    end
+  end
+end
+
+context('suffix patterns (common)') do
+  %w{APR RPh MD MA DMD DDS PharmD EngD DPhil JD DD DO BA BS BSc BE BFA MA MS MSc MFA MLA MBA PE CSA CPA CPL CME CEng OFM CSV}.each do |suffix|
+    it suffix do
+      expect(Nameable::Latin.new.parse("Chris Horn #{suffix}").suffix).to eq(suffix.upcase)
+    end
+  end
+end
+
+context('suffix patterns (generic uppercase)') do
+  it 'generic DERP suffix' do
+    expect(Nameable::Latin.new.parse("Chris Horn DERP").suffix).to eq('DERP')
+  end
+
+  it 'no generic DERP suffix when all uppercase name' do
+    expect(Nameable::Latin.new.parse("CHRIS HORN DERP").suffix).to be_nil
+  end
+end
+
+context('multi word last names') do
+  %w{mc vere von van da de del della di da pietro vanden du st la ter ten}.each do |prefix|
+    it "#{prefix} Last" do
+      expect(Nameable::Latin.new.parse("Chris #{prefix} Last").last).to eq("#{prefix.downcase.capitalize} Last")
+    end
+  end
+end
+
+context("o'last-name") do
+  it "O'Horn" do
+    expect(Nameable::Latin.new.parse("Chris O'Horn").last).to eq("O'Horn")
+  end
+
+  it "O`Horn" do
+    expect(Nameable::Latin.new.parse("Chris O`Horn").last).to eq("O'Horn")
+  end
+
+  it "O' Horn" do
+    expect(Nameable::Latin.new.parse("Chris O' Horn").last).to eq("O'Horn")
+  end
+end
+
+context("hyphenated last names") do
+  it "Horn - Derp" do
+    expect(Nameable::Latin.new.parse("Chris Horn - Derp").last).to eq("Horn-Derp")
+  end
+
+  it "Horn-Derp" do
+    expect(Nameable::Latin.new.parse("Chris Horn-Derp").last).to eq("Horn-Derp")
+  end
+
+  it "Horn--Derp" do
+    expect(Nameable::Latin.new.parse("Chris Horn--Derp").last).to eq("Horn-Derp")
+  end
+
+  it "Horn -- Derp" do
+    expect(Nameable::Latin.new.parse("Chris Horn--Derp").last).to eq("Horn-Derp")
+  end
+end
+
+context("gender") do
+  it "Chris is more likely to be male" do
+    expect(Nameable::Latin.new.parse("Chris Horn").male?).to be true
+  end
+
+  it "Janine is more likely to be female" do
+    expect(Nameable::Latin.new.parse("Janine Horn").female?).to be true
+  end
+
+  it "Derp has :unknown gender" do
+    expect(Nameable::Latin.new.parse("Derp Horn").gender).to eq(:unknown)
+  end
+end
+
+context("ethnicity") do
+  it "Horn has a hash of ethnicity results" do
+    expect(Nameable::Latin.new.parse("Chris Horn").ethnicity).to be_a Hash
+  end
+
+  it "Horn's census :percent_white > 80% " do
+    expect(Nameable::Latin.new.parse("Chris Horn").ethnicity[:percent_white]).to be >= 80
+  end
+end
+

data/spec/nameable_spec.rb

@@ -1,21 +1,9 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe Nameable::Latin do
-  describe "with 'Mr. Chris Horn PhD" do
-    subject { Nameable::Latin.new.parse("Mr. Chris Horn PhD") }
-
-    it("should extract prefix") { subject.prefix.should == "Mr." }
-    it("should extract first name") { subject.first.should == "Chris" }
-    it("should extract last name") { subject.last.should == "Horn" }
-    it("should extract and normalize suffix") { subject.suffix.should == "Ph.D." }
+context("convenience") do
+  it 'to_s' do
+    expect(Nameable("Chris Horn")).to be_a(String)
   end
 
-  describe "with 'Chris Old Biscuit Barrel Horn'" do
-    subject { Nameable::Latin.new.parse("Chris Old Biscuit Barrel Horn") }
-
-    it("should extract first name") { subject.first.should == "Chris" }
-    it("should extract middle name") { subject.middle.should == "Old Biscuit Barrel" }
-    it("should extract last name") { subject.last.should == "Horn" }
+  it 'parse' do
+    expect(Nameable.parse("Chris Horn")).to be_a(Nameable::Latin)
   end
-
 end

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
-$LOAD_PATH.push File.join(File.dirname(__FILE__), '..', 'lib')
-
-require "rubygems"
-require "spec"
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "bundler/setup"
+Bundler.require(:test)
 require "nameable"
 
-Spec::Runner.configure do |config|
-  # config.mock_with :mocha
+RSpec.configure do |config|
 end

metadata

@@ -1,97 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: nameable
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Horn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A gem that provides parsing and output of person names.
-email: chorn@chorn.com
-executables: []
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A library that provides parsing and output of person names.
+email:
+- chorn@chorn.com
+executables:
+- nameable_web_service
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
-- TODO
+extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
-- History.txt
-- LICENSE
-- README.rdoc
+- LICENSE.txt
+- README.md
 - Rakefile
-- TODO
-- VERSION
-- examples/nameable_web_service.rb
-- examples/test.rb
+- bin/nameable_web_service
+- data/app_c.csv
+- data/yob2013.txt
 - lib/nameable.rb
+- lib/nameable/error.rb
+- lib/nameable/extensions.rb
+- lib/nameable/latin.rb
+- lib/nameable/latin/patterns.rb
+- lib/nameable/version.rb
+- nameable.gemspec
+- spec/nameable/latin_spec.rb
 - spec/nameable_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 homepage: https://github.com/chorn/nameable
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -172521366074820921
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: Provides parsing and output of person names.
-test_files: []
+specification_version: 4
+summary: Parse names into components.
+test_files:
+- spec/nameable/latin_spec.rb
+- spec/nameable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb