sixarm_ruby_person_name 1.0.4 → 1.1.0

data/README.md

@@ -0,0 +1,129 @@
+# SixArm.com » Ruby » <br> PersonName gem accesses a person's name from ActiveRecord fields
+
+* Docs: <http://sixarm.com/sixarm_ruby_person_name/doc>
+* Repo: <http://github.com/sixarm/sixarm_ruby_person_name>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+Our user models typically have accessors like these:
+
+   user.first_name => "Martin"
+   user.middle_name => "Luther"
+   user.last_name => "King"
+
+This gem is a utility to concatenate the user's name various common ways:
+
+   user.full_name => "Martin Luther King"
+   user.list_name => "King, Martin Luther"
+   user.initials => "MLK"
+
+It's fine if the model doesn't have a middle_name field, or if any of the values of any of the fields are nil or blank; this gem will do the right thing.
+
+For docs go to <http://sixarm.com/sixarm_ruby_person_name/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Install quickstart
+
+Install:
+
+    gem install sixarm_ruby_person_name
+
+Bundler:
+
+    gem "sixarm_ruby_person_name", "~>1.0.4"
+
+Require:
+
+    require "sixarm_ruby_person_name"
+
+
+## Install with security (optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_person_name --test --trust-policy HighSecurity
+
+
+## Example
+
+Create a typical user class, include this mixin, the use it:
+
+    require "sixarm_ruby_person_name"
+
+    class User < ActiveRecord::Base
+      include PersonName
+    end
+
+    user=User.new(
+      first_name => 'Martin',
+      middle_name => 'Luther',
+      last_name => 'King'
+    )
+
+    user.full_name => "Martin Luther King"
+    user.list_name => "King, Martin Luther"
+    user.initials => "MLK"
+    user.first_name_middle_name => "Martin Luther"
+    user.first_name_middle_initial => "Martin L"
+    user.first_name_middle_initial_last_name => "Martin L King"
+
+
+## Performance Tip
+
+To make these very fast in Rails, you can use memoize:
+
+    class User < ActiveRecord::Base
+      extend ActiveSupport::Memoizable
+      include PersonName
+      memoize :full_name,
+              :list_name,
+              :initials,
+              :first_name_middle_name,
+              :first_name_middle_initial,
+              :first_name_middle_initial_last_name,
+              :first_name_last_name
+    end
+
+
+## Changes
+
+* 2012-03-14 1.0.4 Update docs, tests
+* 2012-01-24 1.0.4 Add #initals method. Add CHANGELOG.txt file. Update examples.
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+The software is provided "as is", without warranty of any kind, 
+express or implied, including but not limited to the warranties of 
+merchantability, fitness for a particular purpose and noninfringement. 
+
+In no event shall the authors or copyright holders be liable for any 
+claim, damages or other liability, whether in an action of contract, 
+tort or otherwise, arising from, out of or in connection with the 
+software or the use or other dealings in the software.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2013 Joel Parker Henderson

data/lib/sixarm_ruby_person_name.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 =begin rdoc
-Please see README.rdoc
+Please see README
 =end
 
 

data/test/sixarm_ruby_person_name_test.rb

@@ -1,122 +1,214 @@
 # -*- coding: utf-8 -*-
-require 'test/unit'
+require 'minitest/autorun'
 require 'simplecov'
 SimpleCov.start
 require 'sixarm_ruby_person_name'
 
-class PersonNameTest < Test::Unit::TestCase
+describe PersonName do
 
- def test_first_name_middle_name
-  assert_equal("abc def",p("abc","def","ghi").first_name_middle_name)
-  assert_equal("abc"    ,p("abc",nil  ,"ghi").first_name_middle_name)
-  assert_equal("def"    ,p(nil ,"def" ,"ghi").first_name_middle_name)
-  assert_equal(""       ,p(nil ,nil   ,"ghi").first_name_middle_name)
- end
+  include PersonName
 
- def test_first_name_middle_initial
-  assert_equal("abc d",p("abc","def","ghi").first_name_middle_initial)
-  assert_equal("abc"  ,p("abc",nil  ,"ghi").first_name_middle_initial)
-  assert_equal("d"    ,p(nil ,"def" ,"ghi").first_name_middle_initial)
-  assert_equal(""     ,p(nil ,nil   ,"ghi").first_name_middle_initial)
- end
+  before do
+    F   ||= Person.new("abc",   nil,   nil)  # First name
+    M   ||= Person.new(  nil, "def",   nil)  # Middle name
+    L   ||= Person.new(  nil,   nil, "ghi")  # Last name
+    FM  ||= Person.new("abc", "def",   nil)  # First name & Middle name
+    FL  ||= Person.new("abc",   nil, "ghi")  # First name & Last name
+    ML  ||= Person.new(  nil, "def", "ghi")  # Middle name & Last name
+    FML ||= Person.new("abc", "def", "ghi")  # First name & Middle name & Last name
+  end
 
- def test_first_name_middle_initial_last_name_with_first_name
-  assert_equal("abc",p("abc",nil,nil).first_name_middle_initial_last_name)
- end
+  describe "#first_name_middle_name" do 
 
- def test_first_name_middle_initial_last_name_with_middle_name
-  assert_equal("d", p(nil,"def",nil).first_name_middle_initial_last_name)
- end
+    it "with first" do
+      F.first_name_middle_name.must_equal("abc")
+    end
 
- def test_first_name_middle_initial_last_name_with_last_name
-  assert_equal("ghi",p(nil,nil,"ghi").first_name_middle_initial_last_name)
- end
+    it "with middle" do
+      M.first_name_middle_name.must_equal("def")
+    end
 
- def test_first_name_middle_initial_last_name_with_first_name_and_middle_name
-  assert_equal("abc d",p("abc","def",nil).first_name_middle_initial_last_name)
- end
+    it "with last" do
+      L.first_name_middle_name.must_equal("")
+    end
+    
+    it "with first & middle" do
+      FM.first_name_middle_name.must_equal("abc def")
+    end
 
- def test_first_name_middle_initial_last_name_with_first_name_and_last_name
-  assert_equal("abc ghi",p("abc",nil,"ghi").first_name_middle_initial_last_name)
- end
+    it "with first & last" do
+      FL.first_name_middle_name.must_equal("abc")
+    end
 
- def test_first_name_middle_initial_last_name
-  p=Person.new("abc","def","ghi")
-  assert_equal("abc d ghi",p.first_name_middle_initial_last_name)
- end
+    it "with middle & last" do
+      ML.first_name_middle_name.must_equal("def")
+    end
 
- def test_full_name_with_first_name
-  assert_equal("abc",p("abc",nil,nil).full_name)
- end
+    it "with first & middle & last" do
+      FML.first_name_middle_name.must_equal("abc def")
+    end
 
- def test_full_name_with_middle_name
-  assert_equal("def",p(nil,"def",nil).full_name)
- end
+  end
 
- def test_full_name_with_last_name
-  assert_equal("ghi",p(nil,nil,"ghi").full_name)
- end
+  describe "#first_name_middle_initial" do
 
- def test_full_name_with_first_name_and_middle_name
-  assert_equal("abc def",p("abc","def",nil).full_name)
- end
+    it "with first" do 
+      F.first_name_middle_initial.must_equal("abc")
+    end
 
- def test_full_name_with_first_name_and_last_name
-  assert_equal("abc ghi",p("abc",nil,"ghi").full_name)
- end
+    it "with middle" do 
+      M.first_name_middle_initial.must_equal("d")
+    end
 
- def test_full_name_with_middle_name_and_last_name
-  assert_equal("def ghi",p(nil,"def","ghi").full_name)
- end
+    it "with last" do
+      L.first_name_middle_initial.must_equal("")
+    end
 
- def test_full_name
-  assert_equal("abc def ghi",p("abc","def","ghi").full_name)
- end
+    it "with first & middle" do 
+      FM.first_name_middle_initial.must_equal("abc d")
+    end
 
- def test_list_name_with_first_name
-  assert_equal("abc",p("abc",nil,nil).list_name)
- end
+    it "with first & last" do
+      FL.first_name_middle_initial.must_equal("abc")
+    end
 
- def test_list_name_with_middle_name
-  assert_equal("def", p(nil,"def",nil).list_name)
- end
+    it "with middle & last" do
+      ML.first_name_middle_initial.must_equal("d")
+    end
 
- def test_list_name_with_last_name
-  assert_equal("ghi",p(nil,nil,"ghi").list_name)
- end
+    it "with first & middle & last" do 
+      FML.first_name_middle_initial.must_equal("abc d")
+    end
+    
+  end
+  
+  describe "#first_name_middle_initial_last_name" do
 
- def test_list_name_with_first_name_and_middle_name
-  assert_equal("abc def",p("abc","def",nil).list_name)
- end
+    it "with first" do
+      F.first_name_middle_initial_last_name.must_equal("abc")
+    end
 
- def test_list_name_with_first_name_and_last_name
-  assert_equal("ghi, abc",p("abc",nil,"ghi").list_name)
- end
+    it "with middle" do
+      M.first_name_middle_initial_last_name.must_equal("d")
+    end
 
- def test_list_name_with_middle_name_and_last_name
-  assert_equal("ghi, def",p(nil,"def","ghi").list_name)
- end
+    it "with last" do
+      L.first_name_middle_initial_last_name.must_equal("ghi")
+    end
 
- def test_list_name
-  assert_equal("ghi, abc def",p("abc","def","ghi").list_name)
- end
+    it "with first &_middle" do
+      FM.first_name_middle_initial_last_name.must_equal("abc d")
+    end
 
- def test_initials
-  assert_equal("adg",p("abc","def","ghi").initials)
- end
+    it "with first &_last" do
+      FL.first_name_middle_initial_last_name.must_equal("abc ghi")
+    end
 
- def test_initials_with_first_name_and_middle_name
-  assert_equal("ad",p("abc","def",nil).initials)
- end
+    it "with middle &_last" do
+      ML.first_name_middle_initial_last_name.must_equal("d ghi")
+    end
 
- def test_initials_with_first_name_and_last_name
-  assert_equal("ag",p("abc",nil,"ghi").initials)
- end
+    it "with first & middle &_last" do
+      FML.first_name_middle_initial_last_name.must_equal("abc d ghi")
+    end
 
- # Factory
- def p(first,middle,last)
-  Person.new(first,middle,last)
- end
+  end
+
+  describe "#full_name" do
+
+    it "with first" do
+      F.full_name.must_equal("abc")
+    end
+
+    it "with middle" do
+      M.full_name.must_equal("def")
+    end
+    
+    it "with last" do
+      L.full_name.must_equal("ghi")
+    end
+
+    it "with first & middle" do
+      FM.full_name.must_equal("abc def")
+    end
+
+    it "with first & last" do
+      FL.full_name.must_equal("abc ghi")
+    end
+
+    it "with middle & last" do
+      ML.full_name.must_equal("def ghi")
+    end
+
+    it "with first & middle & last" do
+      FML.full_name.must_equal("abc def ghi")
+    end
+
+  end
+
+  describe "#list_name" do
+
+    it "with first" do
+      F.list_name.must_equal("abc")
+    end
+
+    it "with middle" do
+      M.list_name.must_equal("def")
+    end
+
+    it "with last" do
+      L.list_name.must_equal("ghi")
+    end
+
+    it "with first & middle" do 
+      FM.list_name.must_equal("abc def")
+    end
+
+    it "with first & last" do
+      FL.list_name.must_equal("ghi, abc")
+    end
+
+    it "with middle & last" do
+      ML.list_name.must_equal("ghi, def")
+    end
+
+    it "with first & middle & last" do
+      FML.list_name.must_equal("ghi, abc def")
+    end
+
+  end
+
+  describe "#initials" do
+    
+    it "with first" do
+      F.initials.must_equal("a")
+    end
+
+    it "with middle" do
+      M.initials.must_equal("d")
+    end
+
+    it "with last" do
+      L.initials.must_equal("g")
+    end
+
+    it "with first & middle" do
+      FM.initials.must_equal("ad")
+    end
+
+    it "with first & last" do
+      FL.initials.must_equal("ag")
+    end
+
+    it "with middle & last" do
+      ML.initials.must_equal("dg")
+    end
+
+    it "with first & middle & last" do
+      FML.initials.must_equal("adg")
+    end
+
+  end
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_person_name
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,46 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain:
-- !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQW0yZ0F3SUJB
-  Z0lKQUtQd0VFVFU1YkhvTUEwR0NTcUdTSWIzRFFFQkJRVUFNR0F4Q3pBSkJn
-  TlYKQkFZVEFsVlRNUk13RVFZRFZRUUlFd3BEWVd4cFptOXlibWxoTVJZd0ZB
-  WURWUVFIRXcxVFlXNGdSbkpoYm1OcApjMk52TVE4d0RRWURWUVFLRXdaVGFY
-  aEJjbTB4RXpBUkJnTlZCQU1UQ25OcGVHRnliUzVqYjIwd0hoY05NVEF4Ck1q
-  RXpNak15TnpFeldoY05NVE13T1RBNE1qTXlOekV6V2pCZ01Rc3dDUVlEVlFR
-  R0V3SlZVekVUTUJFR0ExVUUKQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFV
-  RUJ4TU5VMkZ1SUVaeVlXNWphWE5qYnpFUE1BMEdBMVVFQ2hNRwpVMmw0UVhK
-  dE1STXdFUVlEVlFRREV3cHphWGhoY20wdVkyOXRNSUdmTUEwR0NTcUdTSWIz
-  RFFFQkFRVUFBNEdOCkFEQ0JpUUtCZ1FDOTRtRDlKRHdCc3Vuc09JMFZSM0NY
-  WGJPV2c5Y1dhV2Npd0Z5Sk5GaU03QTlJOEtQTGZYVXcKUUM0Y3pVZTVadUc0
-  V0h2aW5yV2hrckNLKzFkV0Jxb0VDbHhkRi9Gb0tPNWErdG9uR0Nqam1meTgx
-  Sm1Gamp5eAplVHNqc0h5dncrUWlrOWtwZjlhajYrcG5rTnJWc3dnTkhWZWEy
-  bzl5YWJiRWlTNlZTZUpXb1FJREFRQUJvNEhGCk1JSENNQjBHQTFVZERnUVdC
-  QlF6UEp0cW1TZ2M1M2VETjdhU3pEUXdyOVRBTERDQmtnWURWUjBqQklHS01J
-  R0gKZ0JRelBKdHFtU2djNTNlRE43YVN6RFF3cjlUQUxLRmtwR0l3WURFTE1B
-  a0dBMVVFQmhNQ1ZWTXhFekFSQmdOVgpCQWdUQ2tOaGJHbG1iM0p1YVdFeEZq
-  QVVCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RHpBTkJnTlZCQW9UCkJs
-  TnBlRUZ5YlRFVE1CRUdBMVVFQXhNS2MybDRZWEp0TG1OdmJZSUpBS1B3RUVU
-  VTViSG9NQXdHQTFVZEV3UUYKTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVGQlFB
-  RGdZRUFvb0VleFAvb1BhbTFUUDcxU3l1aHhNYit1VHJaYlNRZQpqVkIrRXhS
-  d1dhZEd3YU5QVUE1NmQzOXF3YXZ3UCtpdSszSnBlb25OTVZ2YldYRjVuYUNY
-  L2RORkllUkVIekVSClpEUlFZTXFydTlURU1uYTZIRDl6cGNzdEY3dndUaEdv
-  dmxPUSszWTZwbFE0bk16aXBYY1o5VEhxczY1UElMMHEKZWFid3BDYkFvcG89
-  Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
-date: 2012-01-25 00:00:00.000000000 Z
+- ! '-----BEGIN CERTIFICATE-----
+
+  MIIDBDCCAm2gAwIBAgIJAKPwEETU5bHoMA0GCSqGSIb3DQEBBQUAMGAxCzAJBgNV
+
+  BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNp
+
+  c2NvMQ8wDQYDVQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb20wHhcNMTAx
+
+  MjEzMjMyNzEzWhcNMTMwOTA4MjMyNzEzWjBgMQswCQYDVQQGEwJVUzETMBEGA1UE
+
+  CBMKQ2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEPMA0GA1UEChMG
+
+  U2l4QXJtMRMwEQYDVQQDEwpzaXhhcm0uY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GN
+
+  ADCBiQKBgQC94mD9JDwBsunsOI0VR3CXXbOWg9cWaWciwFyJNFiM7A9I8KPLfXUw
+
+  QC4czUe5ZuG4WHvinrWhkrCK+1dWBqoEClxdF/FoKO5a+tonGCjjmfy81JmFjjyx
+
+  eTsjsHyvw+Qik9kpf9aj6+pnkNrVswgNHVea2o9yabbEiS6VSeJWoQIDAQABo4HF
+
+  MIHCMB0GA1UdDgQWBBQzPJtqmSgc53eDN7aSzDQwr9TALDCBkgYDVR0jBIGKMIGH
+
+  gBQzPJtqmSgc53eDN7aSzDQwr9TALKFkpGIwYDELMAkGA1UEBhMCVVMxEzARBgNV
+
+  BAgTCkNhbGlmb3JuaWExFjAUBgNVBAcTDVNhbiBGcmFuY2lzY28xDzANBgNVBAoT
+
+  BlNpeEFybTETMBEGA1UEAxMKc2l4YXJtLmNvbYIJAKPwEETU5bHoMAwGA1UdEwQF
+
+  MAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAooEexP/oPam1TP71SyuhxMb+uTrZbSQe
+
+  jVB+ExRwWadGwaNPUA56d39qwavwP+iu+3JpeonNMVvbWXF5naCX/dNFIeREHzER
+
+  ZDRQYMqru9TEMna6HD9zpcstF7vwThGovlOQ+3Y6plQ4nMzipXcZ9THqs65PIL0q
+
+  eabwpCbAopo=
+
+  -----END CERTIFICATE-----
+
+'
+date: 2012-03-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: sixarm@sixarm.com
@@ -44,11 +57,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gemtest
-- CHANGELOG.txt
-- INSTALL.txt
-- LICENSE.txt
 - Rakefile
-- README.rdoc
+- README.md
 - VERSION
 - lib/sixarm_ruby_person_name.rb
 - test/sixarm_ruby_person_name_test.rb
@@ -72,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: SixArm.com » Ruby » PersonName mixin methods to calculate a person's full

data/CHANGELOG.txt

@@ -1,4 +0,0 @@
-CHANGELOG
-
-2012-01-24 1.0.4 Add #initals method. Add CHANGELOG.txt file. Update examples.
-

data/INSTALL.txt

@@ -1,32 +0,0 @@
-
-= SixArm.com Ruby Gem Install
-
-
-First-time users: add our gem certificate and source.
-When you do this once, it works for all our gems.
-
-  sudo wget http://sixarm.com/sixarm.pem
-  sudo gem cert --add sixarm.pem   
-  sudo gem sources --add http://sixarm.com
-
-Install the gem with advanced options.
-
-  sudo gem install sixarm_ruby_person_name --test --trust-policy HighSecurity
-
-
-== Notes
-
-Do you have any questions, comments, suggestions, or feedback?
-Let us know, we're happy to help. Our email is sixarm@sixarm.com
-
-Do you want to create your own high security gems?
-Learn how at http://www.rubygems.org/read/chapter/21
-
-To see your current gem certificate list:
-
-  sudo gem cert --list
-
-Our cert looks like this:
-
-  /C=US/ST=California/L=San Francisco/O=SixArm/CN=sixarm.com
-

data/LICENSE.txt

@@ -1,25 +0,0 @@
-LICENSE
-
-You may choose any of these open source licenses:
-
-  - Apache License
-  - BSD License
-  - CreativeCommons License, Non-commercial Share Alike
-  - GNU General Public License Version 2 (GPL 2)
-  - GNU Lesser General Public License (LGPL)
-  - MIT License
-  - Perl Artistic License
-  - Ruby License
-
-The software is provided "as is", without warranty of any kind, 
-express or implied, including but not limited to the warranties of 
-merchantability, fitness for a particular purpose and noninfringement. 
-
-In no event shall the authors or copyright holders be liable for any 
-claim, damages or other liability, whether in an action of contract, 
-tort or otherwise, arising from, out of or in connection with the 
-software or the use or other dealings in the software.
-
-This license is for the included software that is created by SixArm;
-some of the included software may have its own licenses, copyrights, 
-authors, etc. and these do take precedence over the SixArm license.

data/README.rdoc

@@ -1,52 +0,0 @@
-= SixArm.com » Ruby » PersonName gem accesses a person's name from ActiveRecord fields
-
-Author:: Joel Parker Henderson, joel@joelparkerhenderson.com
-Copyright:: Copyright (c) 2006-2011 Joel Parker Henderson
-License:: See LICENSE.txt file
-
-Access a person's name from the fields of a model in several combinations by using these methods:
-* first_name_middle_name
-* first_name_middle_initial
-* first_name_middle_initial_last_name
-* first_name_last_name
-* full_name
-* list_name
-* initials
-
-*Note* that the model doesn't need attributes called first_name, middle_name, and last_name to call the gem's methods; the methods are protected by testing with respond_to?(name_field).
-
-However all of these fields which are present must be strings.
-
-==Example
-
-  class User < ActiveRecord::Base
-    include PersonName
-  end
-  
-  user=User.create(
-    first_name => 'Martin',
-    middle_name => 'Luther',
-    last_name => 'King'
-  )
-  
-  user.full_name => "Martin Luther King"
-  user.list_name => "King, Martin Luther"
-  user.initials => "MLK"
-
-==Performance Tip
-
-To make these very fast in Rails, you can use memoize:
-
-  class User < ActiveRecord::Base
-    extend ActiveSupport::Memoizable
-    include PersonName
-    memoize :first_name_middle_name,
-            :first_name_middle_initial,
-            :first_name_middle_initial_last_name,
-            :first_name_last_name,
-            :full_name,
-            :list_name,
-	    :initials
-  end
-
-