Refactor tests and add better coverage

Update the Code Climate test reporter, which requires running SimpleCov
locally and posting the results.

I've also added a simple .rubocop.yml, added more rubies to
the Travis CI config, and cleaned up a bunch of cruft.

The README now has to-dos, which is pretty much a list of things I don't
like about this code.

Author: chorn

.rubocop.yml

@@ -0,0 +1,17 @@
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodName:
+  Exclude:
+    - lib/nameable/extensions.rb
+
+Metrics/LineLength:
+  Max: 132
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*/**

.travis.yml

@@ -2,8 +2,13 @@ language: ruby
 cache: bundler
 script: bundle exec rspec
 rvm:
-- 2.4.1
-- 2.3.4
+- 1.9.3-p551
+- 2.0.0-p648
+- 2.1.10
 - 2.2.7
+- 2.3.0
+- 2.3.4
+- 2.4.0
+- 2.4.1
 dd:
   secure: fzItORKaVrevTjQQu85FYgqgSVkRGG8PtOfNTCYY0meyP1+hF/lH6i5ZAb35VAuwi9InqaYnPx09dREBlfEqkzY/Ypxglq+EosAfqOgiKFu44JlM4vhxSdwn2mywCJpYZ0IbH5OnkF6rUULL/AoRQPlIV77eRqhB9LGfLNlYMfU=

Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec

Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    nameable (1.1.3)
+    nameable (1.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
     diff-lcs (1.3)
     docile (1.1.5)
     json (2.1.0)
     json (2.1.0-java)
-    rake (10.5.0)
+    rake (12.0.0)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -26,7 +26,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
-    simplecov (0.14.1)
+    simplecov (0.13.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -37,11 +37,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.6)
-  codeclimate-test-reporter (~> 0.4)
+  bundler
+  codeclimate-test-reporter
   nameable!
-  rake (~> 10.4)
-  rspec (~> 3.3)
+  rake
+  rspec (~> 3.6)
+  simplecov
 
 BUNDLED WITH
    1.14.6

Guardfile

@@ -23,12 +23,14 @@ puts n
 # 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 pick the most likely gender for a name.
 
 ```ruby
@@ -37,7 +39,9 @@ Nameable::Latin.new('Chris').gender
 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}
@@ -56,8 +60,8 @@ By inspiration, I should really say "other projects from which I yanked their co
 As of version `1.1.1`., the nameable gem is cryptographically signed. To be sure the gem you install hasn’t been tampered with, add my public key as a trusted certificate, and verify that nameable and any dependencies it has are also signed:
 
 ```
-gem cert --add <(curl -Ls https://raw.github.com/chorn/nameable/master/certs/chorn.pem)
-gem install nameable -P HighSecurity
+$ gem cert --add <(curl -Ls https://raw.github.com/chorn/nameable/master/certs/chorn.pem)
+$ gem install nameable -P HighSecurity
 ```
 
 # References
@@ -69,14 +73,12 @@ gem install nameable -P HighSecurity
 * [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.
-
-I don't like that the Ethnicity data is just a Hash.
+# To-do
 
-Oh, and github, pull request, workflow, yada yada.
+1. Extract all of the US Census / Ethnicity / Asset stuff out of `Latin`. Yuck, that's ugly why did I ever do that?
+2. Rename `Latin` to be `US` or `English` because it's looks like I really only support English, and probably US English.
+3. Use named captures for all the regexs.
+4. Refactor the Ethnicity stuff into a class.
+5. Refactor parsing into a class.
 
 -chorn

README.md

@@ -3,11 +3,10 @@ require 'digest/sha2'
 
 task default: %w[build]
 
-desc "Update checksums for gems in ./pkg"
+desc 'Update checksums for gems in ./pkg'
 task :checksums do
   Dir.glob('pkg/*.gem').each do |gem|
     checksum = Digest::SHA512.new.hexdigest(File.read(gem))
-    File.open("#{gem.gsub(/pkg/, 'checksums')}.sha512", 'w' ) {|f| f.write(checksum) }
+    File.open("#{gem.gsub(/pkg/, 'checksums')}.sha512", 'w') { |f| f.write(checksum) }
   end
 end
-

Rakefile

@@ -2,16 +2,16 @@
 
 # I use this with OpenRefine: http://openrefine.org/
 
-require "rubygems"
-require "json"
-require "sinatra"
-require "nameable"
+require 'rubygems'
+require 'json'
+require 'sinatra'
+require 'nameable'
 
 get '/*/*.*' do |raw_name, function, type|
   begin
     name = Nameable(raw_name)
   rescue Nameable::Latin::InvalidNameError
-    ""
+    ''
   end
 
   if type.to_sym == :json

bin/nameable_web_service

@@ -1 +1 @@
-3da59e4a80b73488ec9745fcb9ca31b08db3e603df7b1ac0c572c4740f29b703563e47b3fff879a9e1cd5f103fcbf2883c8cfa146193924e0d351c7fe719ce38
+20c36413799bce5ac2fff4d2655449f3c53eaf9e88225fa4c61e88d5c5ee275224343294115e52a6be22f0dcd3328a9346f81836739371299e527b7e9307730b

checksums/nameable-1.1.1.gem.sha512

@@ -0,0 +1 @@
+b5b26ab87ee234cbfb4c75e83f35bf765ab2afef12f72742be74725a652231ec103e85a1811821acc59e221bcf5c7b0910b0466b2f4cdee506d5b9befe27dcf0

checksums/nameable-1.1.3.gem.sha512

@@ -0,0 +1 @@
+071de8a4206e62e689131fd00f35a1d8d98d535ca574449baf92e3ffe207e6ed6f5a843c5cd8f040b148b8a2cfa918251621bd97482153084a7cd46d81961e9f

checksums/nameable-1.1.4.gem.sha512

@@ -1,8 +1,8 @@
-require "nameable/version"
-require "nameable/assets"
-require "nameable/error"
-require "nameable/latin"
-require "nameable/extensions"
+require 'nameable/version'
+require 'nameable/error'
+require 'nameable/assets'
+require 'nameable/latin'
+require 'nameable/extensions'
 
 module Nameable
   def self.parse(name)

lib/nameable.rb

@@ -1,4 +1,6 @@
-module Nameable::Assets
-  GENDER_TABLE    = File.expand_path(File.join('..', '..', '..', 'data', 'yob2016.txt'), __FILE__)
-  ETHNICITY_TABLE = File.expand_path(File.join('..', '..', '..', 'data', 'app_c.csv'), __FILE__)
+module Nameable
+  module Assets
+    GENDER_TABLE    = File.expand_path(File.join('..', '..', '..', 'data', 'yob2016.txt'), __FILE__)
+    ETHNICITY_TABLE = File.expand_path(File.join('..', '..', '..', 'data', 'app_c.csv'), __FILE__)
+  end
 end

lib/nameable/assets.rb

@@ -1,5 +1,4 @@
 module Nameable
-  # Raised if something other than a valid Name is supplied
   class InvalidNameError < StandardError
   end
 end