sixarm_ruby_person_name 1.0.4

data/CHANGELOG.txt

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

data/INSTALL.txt

@@ -0,0 +1,32 @@
+
+= 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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,52 @@
+= 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
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.4

data/lib/sixarm_ruby_person_name.rb

@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README.rdoc
+=end
+
+
+module PersonName
+
+
+  # Return true iff the person has a first name and its non-blank
+
+  def first_name?
+   respond_to?(:first_name) and first_name and first_name!='' and first_name.strip!=''
+  end
+
+
+  # Return true iff the person has a middle name and its non-blank
+
+  def middle_name?
+   respond_to?(:middle_name) and middle_name and middle_name!='' and middle_name.strip!=''
+  end
+
+
+  # Return true iff the person has a last name and its non-blank
+
+  def last_name?
+   respond_to?(:last_name) and last_name and last_name!='' and last_name.strip!=''
+  end
+
+
+  # Return the person's first name + middle name
+  #
+  # ==Example
+  #   u.first_name_middle_name => "Martin Luther"
+
+  def first_name_middle_name
+    pieces = []
+    (pieces << first_name)    if first_name?
+    (pieces << middle_name)   if middle_name?
+    return pieces.join(' ')
+  end
+
+
+  # Return the person's first name + middle initial
+  #
+  # ==Example
+  #   u.first_name_middle_initial => "Martin N"
+
+  def first_name_middle_initial
+    pieces = []
+    (pieces << first_name)           if first_name?
+    (pieces << middle_name[0...1])   if middle_name?
+    return pieces.join(' ')
+  end
+
+
+  # Return the person's first name + middle initial + last name
+  #
+  # ==Example
+  #   u.first_name_middle_initial_last_name => "Martin N King"
+
+  def first_name_middle_initial_last_name
+   pieces = []
+    (pieces << first_name)           if first_name?
+    (pieces << middle_name[0...1])   if middle_name?
+    (pieces << last_name)            if last_name?
+    return pieces.join(' ')
+  end
+
+
+  # Return the person's full name: first_name middle_name last_name
+  #
+  # ==Example
+  #   u.full_name => "Martin Luther King"
+  #
+  # This method skips any piece of the name that is missing or blank.
+
+  def full_name
+    pieces = []
+    (pieces << first_name)     if first_name?
+    (pieces << middle_name)    if middle_name?
+    (pieces << last_name)      if last_name?
+    return pieces.join(' ')
+  end
+
+
+  # Return the person's list name: last_name, first_name middle_name
+  #
+  # ==Example
+  #   u.list_name => "King, Martin Luther"
+  #
+  # This method skips any piece of the name that is missing or blank.
+
+  def list_name
+    pieces = []
+    (pieces << first_name)  if first_name?
+    (pieces << middle_name) if middle_name?
+    if last_name?
+      comma = pieces.size>0 ? ',' : ''
+      pieces.unshift(last_name+comma)
+    end
+    return pieces.join(' ')
+  end
+
+
+  # Return the person's intials
+  #
+  # ==Example
+  #   u.initials => "MLK"
+  #
+  # This method skips any piece of the name that is missing or blank.
+
+  def initials
+    s = ""
+    (s << first_name[0])  if first_name?
+    (s << middle_name[0]) if middle_name?
+    (s << last_name[0]) if last_name?
+    return s
+  end
+
+
+end

data/test/sixarm_ruby_person_name_test.rb

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'simplecov'
+SimpleCov.start
+require 'sixarm_ruby_person_name'
+
+class PersonNameTest < Test::Unit::TestCase
+
+ 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
+
+ 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
+
+ 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
+
+ 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
+
+ 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
+
+ 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
+
+ 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
+
+ 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
+
+ def test_full_name_with_first_name
+  assert_equal("abc",p("abc",nil,nil).full_name)
+ end
+
+ def test_full_name_with_middle_name
+  assert_equal("def",p(nil,"def",nil).full_name)
+ end
+
+ def test_full_name_with_last_name
+  assert_equal("ghi",p(nil,nil,"ghi").full_name)
+ end
+
+ def test_full_name_with_first_name_and_middle_name
+  assert_equal("abc def",p("abc","def",nil).full_name)
+ end
+
+ def test_full_name_with_first_name_and_last_name
+  assert_equal("abc ghi",p("abc",nil,"ghi").full_name)
+ end
+
+ def test_full_name_with_middle_name_and_last_name
+  assert_equal("def ghi",p(nil,"def","ghi").full_name)
+ end
+
+ def test_full_name
+  assert_equal("abc def ghi",p("abc","def","ghi").full_name)
+ end
+
+ def test_list_name_with_first_name
+  assert_equal("abc",p("abc",nil,nil).list_name)
+ end
+
+ def test_list_name_with_middle_name
+  assert_equal("def", p(nil,"def",nil).list_name)
+ end
+
+ def test_list_name_with_last_name
+  assert_equal("ghi",p(nil,nil,"ghi").list_name)
+ end
+
+ def test_list_name_with_first_name_and_middle_name
+  assert_equal("abc def",p("abc","def",nil).list_name)
+ end
+
+ def test_list_name_with_first_name_and_last_name
+  assert_equal("ghi, abc",p("abc",nil,"ghi").list_name)
+ end
+
+ def test_list_name_with_middle_name_and_last_name
+  assert_equal("ghi, def",p(nil,"def","ghi").list_name)
+ end
+
+ def test_list_name
+  assert_equal("ghi, abc def",p("abc","def","ghi").list_name)
+ end
+
+ def test_initials
+  assert_equal("adg",p("abc","def","ghi").initials)
+ end
+
+ def test_initials_with_first_name_and_middle_name
+  assert_equal("ad",p("abc","def",nil).initials)
+ end
+
+ def test_initials_with_first_name_and_last_name
+  assert_equal("ag",p("abc",nil,"ghi").initials)
+ end
+
+ # Factory
+ def p(first,middle,last)
+  Person.new(first,middle,last)
+ end
+
+end
+
+
+class Person
+
+ attr_accessor :first_name
+ attr_accessor :middle_name
+ attr_accessor :last_name
+
+ include PersonName
+
+ def initialize(first,middle,last)
+  @first_name=first
+  @middle_name=middle
+  @last_name=last
+ end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_person_name
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
+platform: ruby
+authors:
+- SixArm
+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
+dependencies: []
+description: 
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- CHANGELOG.txt
+- INSTALL.txt
+- LICENSE.txt
+- Rakefile
+- README.rdoc
+- VERSION
+- lib/sixarm_ruby_person_name.rb
+- test/sixarm_ruby_person_name_test.rb
+homepage: http://sixarm.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: SixArm.com » Ruby » PersonName mixin methods to calculate a person's full
+  name, list name, initials, etc.
+test_files:
+- test/sixarm_ruby_person_name_test.rb
+has_rdoc: true