Lots of new better nicer tests, and a few tweaks based on failed tests.

Author: chorn

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 *.gem
+.idea

Gemfile

@@ -1,10 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-group :development do
-  gem "bundler"
-  gem "jeweler"
-end
-
-group :test do
-  gem "rspec"
-end
+gemspec

Gemfile.lock

@@ -1,64 +1,31 @@
+PATH
+  remote: .
+  specs:
+    nameable (1.0.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
-    builder (3.2.2)
-    descendants_tracker (0.0.3)
     diff-lcs (1.2.5)
-    faraday (0.9.0)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.6)
-    github_api (0.11.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
-      oauth2
-    hashie (2.0.5)
-    highline (1.6.20)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.1)
-    jwt (0.1.11)
-      multi_json (>= 1.5)
-    mini_portile (0.5.2)
-    multi_json (1.8.4)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.1)
-      mini_portile (~> 0.5.0)
-    oauth2 (0.9.3)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 0.1.8)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
     rake (10.1.1)
-    rdoc (4.1.1)
-      json (~> 1.4)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  jeweler
-  rspec
+  bundler (>= 1.6.2)
+  nameable!
+  rake
+  rspec (~> 3.0.0)

History.txt

@@ -1,5 +1,7 @@
 Copyright (c) 2008 Chris Horn http://chorn.com/
 
+MIT License
+
 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

LICENSE LICENSE.txt

@@ -0,0 +1,68 @@
+# nameable
+
+A library that provides parsing and normalization of people's names.
+
+```ruby
+require 'nameable'
+n = Nameable::Latin.new.parse('Mr. Chris K Horn Esquire')
+puts "#{n.prefix} #{n.first} #{n.middle} #{n.last} #{n.suffix}"
+#=> Mr. Chris K Horn Esq.
+puts n.to_fullname
+#=> Mr. Chris K. Horn, Esq.
+n = Nameable::Latin.new('CHRIS', 'HORN')
+puts n.to_nameable
+#=> Chris Horn
+n = Nameable::Latin.new(prefix:'Sir', last:'Horn')
+puts n
+#=> Sir Horn
+```
+
+# Features
+
+Convenience methods:
+```ruby
+puts Nameable('chris horn, iii')
+#=> "Chris Horn, III."
+puts Nameable.parse('chris horn, iii')
+#=> #<Nameable::Latin:0x007f8470e01b08 @first="Chris", @last="Horn", @middle=nil, @prefix=nil, @suffix="III.">
+```
+Using a database of first names from the U.S. Social Security Administration, Nameable will make a guess at the gender of a name.
+
+```ruby
+Nameable::Latin.new('Chris').gender
+#=> :male
+Nameable::Latin.new('Janine').female?
+#=> true
+```
+Using a database of last names from the U.S. Census, Nameable will return the ethnicity breakdown as a Hash. 
+```ruby
+Nameable::Latin.new('Chris', 'Horn').ethnicity
+#=> {:rank=>593, :count=>51380, :percent_white=>86.75, :percent_black=>8.31, :percent_asian_pacific_islander=>0.84, :percent_american_indian_alaska_native=>1.16, :percent_two_or_more_races=>1.46, :percent_hispanic=>1.48}
+```
+
+# Other uses
+
+I've included a little web service, which should be installed as "nameable_web_service" that requires sinatra.  It's been handy when paired with OpenRefine, if I'm working with a file and I am not going to be parsing with Ruby.  If you're reading this, that's probably not an issue for you, but I do think it's a nice way to show someone how to use OpenRefine in a more advanced way.
+
+# Inspiration
+
+By inspiration, I should really say "other projects from which I yanked their code, ideas, examples and data." At worst I'll make sure the other projects I looked at and borrowed from are credited here.
+
+# References
+
+* [Open Refine](http://openrefine.org/) formerly [Google Refine](https://code.google.com/p/google-refine/)
+* [Help with splitting names](http://www.onlineaspect.com/2009/08/17/splitting-names/)
+* [First Names from the U.S. SSA](http://www.ssa.gov/oact/babynames/limits.html)
+* [Last Names from the Census](http://www.census.gov/genealogy/www/data/2000surnames/index.html)
+* [Data Science Toolkit](https://github.com/petewarden/dstk)
+* [Addressable](https://github.com/sporkmonger/addressable)
+
+# Issues
+
+Thus far I've gone long stretches where this project did exactly what I needed it to, until it did not.  I don't use it to validate or massage names with code connected to some kind of UI, I use it to clean up names I am parsing in volume.  Hopefully I'm balancing speed and quality.  Anything you don't like, change, you can have the commit bit easy-peasy.
+
+The first time an instance of Nameable uses the gender method, the database of first names shipped with the gem will be parsed.  The same is true for the last name data which is quite a bit larger.  They aren't huge, and it only happens the first time, which is why I opted to leave the data in the gem, and not split it up into a different thing.  If you hate that more than you hate gems that require extra steps to be useable let me know.
+
+Oh, and github, pull request, workflow, yada yada.
+
+-chorn

README.md

@@ -1,39 +1,2 @@
-# encoding: utf-8
-
-require 'rubygems'
-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
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name        = "nameable"
-  gem.homepage    = "https://github.com/chorn/nameable"
-  gem.license     = "MIT"
-  gem.summary     = %Q{Provides parsing and output of person names.}
-  gem.description = %Q{A gem that provides parsing and output of person names.}
-  gem.email       = "[email protected]"
-  gem.authors     = ["Chris Horn"]
-  gem.files       = FileList['lib/**/*.rb', 'Gemfile*', '[A-Z]*', 'Rakefile', 'spec/*', 'examples/*'].to_a
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
+require "bundler/gem_tasks"
 

README.rdoc

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# I use this with OpenRefine: http://openrefine.org/
+
 require "rubygems"
 require "json"
 require "sinatra"
@@ -8,7 +10,7 @@
 get '/*/*.*' do |raw_name, function, type|
   begin
     name = Nameable::Latin.new.parse(raw_name)
-  rescue Nameable::Latin::InvalidNameError => e
+  rescue Nameable::Latin::InvalidNameError
     ""
   end