people 0.2.0 → 0.2.1

data/LICENSE

@@ -18,3 +18,11 @@ 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.
+
+Parts based on the Perl Lingua-EN-NameParse module by Kim Ryan, which has the following license.
+
+Copyright (c) 2008 Kim Ryan. All rights reserved.
+
+This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.
+
+

data/README.rdoc

@@ -1,6 +1,46 @@
 = people
 
-Parses names into parts.
+Parses names into parts. Loosely based on the Lingua-EN-NameParser Perl module.
+
+= How to install
+
+  sudo gem install people
+
+= How to use
+
+  require 'people'
+
+  np = People::NameParser.new
+
+  name = np.parse( "Matthew E Ericson" )
+  puts name[:parsed]
+  puts name[:orig]
+  puts name[:first]
+  puts name[:last]
+
+If name successfully parses, name[:parsed] is set to true.
+
+Available parts are :title, :first, :middle, :last, :suffix, :first2, :middle2, :title2, :suffix2, :orig, :match_type
+
+By default, it will try to proper case names. If you want to leave the capitalization alone, pass :case_mode => 'leave' or for uppercase, 'upper'.
+
+  np = People::NameParser.new( :case_mode => 'proper' )
+  np = People::NameParser.new( :case_mode => 'leave' )
+  np = People::NameParser.new( :case_mode => 'upper' )
+
+If you have names like "John and Jane Doe", pass :couples => true
+
+  np = People::NameParser.new( :couples => true, :case_mode => 'upper' )
+
+  name = np.parse( "John and Jane Doe" )
+  puts name[:first]
+  puts name[:first2]
+  puts name[:last]
+
+Try it out online at http://people.ericson.net 
+
+Send suggestions to mericson at ericson dot net.
+
 
 == Copyright
 

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
+:build: 
 :major: 0
 :minor: 2
-:patch: 0
+:patch: 1

data/people.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{people}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Ericson"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: people
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Matthew Ericson