namae 0.2.1 → 0.3.0

data/README.md

@@ -1,5 +1,5 @@
-Namae
-=====
+Namae (名前)
+==========
 Namae is a parser for human names. It recognizes personal names of various
 cultural backgrounds and tries to split them into their component parts
 (e.g., given and family names, honorifics etc.).
@@ -53,13 +53,13 @@ Rails model:
     class Person < ActiveRecord::Base
       attr_accessible :name
 
-    	delegate :family, :initials, :to => :namae
+      delegate :family, :initials, :to => :namae
 
       private
 
-    	def namae
-    		@namae ||= Namae::Name.parse(name)
-    	end
+      def namae
+        @namae ||= Namae::Name.parse(name)
+      end
     end
 
 In this minimal example, we are using the method `Namae::Name.parse` which

data/Rakefile

@@ -26,12 +26,12 @@ begin
     gem.license = 'AGPL'
 
     gem.summary =
-      'Namae parses personal names and splits them into their component parts.'
+      'Namae (名前) parses personal names and splits them into their component parts.'
 
     gem.description = %q{
-      Namae is a parser for human names. It recognizes personal names of various
-      cultural backgrounds and tries to split them into their component parts
-      (e.g., given and family names, honorifics etc.).
+      Namae (名前) is a parser for human names. It recognizes personal names of
+      various cultural backgrounds and tries to split them into their component
+      parts (e.g., given and family names, honorifics etc.).
     }.gsub(/\s+/, ' ')
 
   end

data/lib/namae/name.rb

@@ -52,8 +52,17 @@ module Namae
       super(*attributes.values_at(*Name.parts))
     end
   
+    # @return [String] the name in sort order
+    def sort_order(delimiter = ', ')
+      [family_part, given_part].reject(&:empty?).join(delimiter)
+    end
+
+    # @return [String] the name in display order
+    def display_order
+      [given_part, family_part].reject(&:empty?).join(' ')
+    end
 
-    # True if all the name components are nil.
+    # @return [Boolean] whether or not all the name components are nil.
     def empty?
       values.compact.empty?
     end
@@ -107,11 +116,12 @@ module Namae
     end
     
     
-    # Describe the contents of this name in a string.
+    # @return [String] a string representation of the name
     def inspect
       "#<Name #{each_pair.map { |k,v| [k,v.inspect].join('=') if v }.compact.join(' ')}>"
     end
     
+    alias to_s display_order
 
     private
     

data/lib/namae/version.rb

@@ -1,8 +1,8 @@
 module Namae
   module Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 1
+    MINOR = 3
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.').freeze

data/namae.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "namae"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sylvester Keil", "Dan Collis-Puro"]
-  s.date = "2012-06-24"
-  s.description = " Namae is a parser for human names. It recognizes personal names of various cultural backgrounds and tries to split them into their component parts (e.g., given and family names, honorifics etc.). "
+  s.date = "2012-08-09"
+  s.description = " Namae (\u{540d}\u{524d}) is a parser for human names. It recognizes personal names of various cultural backgrounds and tries to split them into their component parts (e.g., given and family names, honorifics etc.). "
   s.email = ["sylvester@keil.or.at", "dan@collispuro.com"]
   s.extra_rdoc_files = [
     "README.md"
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
   s.licenses = ["AGPL"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.10"
-  s.summary = "Namae parses personal names and splits them into their component parts."
+  s.summary = "Namae (\u{540d}\u{524d}) parses personal names and splits them into their component parts."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/spec/namae/name_spec.rb

@@ -1,12 +1,12 @@
 module Namae
   describe 'Name' do
-    
+
     describe '.new' do
-      
+
       it 'returns an empty name by default' do
         Name.new.should be_empty
       end
-      
+
       it 'sets all passed-in attributes' do
         Name.new(:given => 'Foo').given.should == 'Foo'
       end
@@ -14,20 +14,20 @@ module Namae
       it 'ignores unknown attributes' do
         Name.new(:foo => 'bar').should be_empty
       end
-      
+
     end
-    
+
     describe '.parse' do
       it 'returns an empty name for an empty string' do
         Name.parse('').should be_empty
         Name.parse('').should be_a(Name)
       end
-      
+
       it 'returns a single name object if there is more than one name' do
         Name.parse('Plato and Sokrates').given.should == 'Plato'
       end
     end
-    
+
     describe '#values_at' do
       it 'returns an array with the given values' do
         Name.new(:family => 'foo').values_at(:family).should == ['foo']
@@ -37,7 +37,7 @@ module Namae
         Name.new(:family => 'foo').values_at(:family).should == ['foo']
       end
     end
-    
+
     describe '#initials' do
       it "returns the name's initials" do
         Name.new(:family => 'Poe', :given => 'Edgar A.').initials.should == 'E.A.P.'
@@ -47,7 +47,7 @@ module Namae
         Name.new(:family => 'Poe', :given => 'Edgar A.').initials(:expand => true).should == 'E.A. Poe'
       end
     end
-    
+
     describe '#merge' do
       it 'merges the attributes in the given hash into the name' do
         Name.new.merge(:family => 'foo').family.should == 'foo'
@@ -56,21 +56,57 @@ module Namae
       it 'merges the attributes in the given name into the name' do
         Name.new.merge(Name.new(:family => 'foo')).family.should == 'foo'
       end
-      
+
       it 'ignores unknown attributes' do
         Name.new.merge(:foo => 'bar').should be_empty
       end
-      
+
       it 'ignores nil values' do
         Name.new(:family => 'foo').merge(:family => nil).family.should == 'foo'
       end
     end
-    
+
     describe '#inspect' do
       it 'returns the name as a string' do
         Name.new(:given => 'Ichiro').inspect.should == '#<Name given="Ichiro">'
       end
     end
-    
+
+    describe '#sort_order' do
+      it 'returns an empty string by default' do
+        Name.new.sort_order.should == ''
+      end
+
+      it 'returns the name in sort order' do
+        Name.new(:given => 'Ichiro', :family => 'Suzuki').sort_order.should == 'Suzuki, Ichiro'
+      end
+
+      it 'returns only the given if there is no family name' do
+        Name.new(:given => 'Ichiro').sort_order.should == 'Ichiro'
+      end
+
+      it 'returns only the family if there is no given name' do
+        Name.new(:family => 'Suzuki').sort_order.should == 'Suzuki'
+      end
+    end
+
+    describe '#display_order' do
+      it 'returns an empty string by default' do
+        Name.new.display_order.should == ''
+      end
+
+      it 'returns the name in display order' do
+        Name.new(:given => 'Ichiro', :family => 'Suzuki').display_order.should == 'Ichiro Suzuki'
+      end
+
+      it 'returns only the given if there is no family name' do
+        Name.new(:given => 'Ichiro').display_order.should == 'Ichiro'
+      end
+
+      it 'returns only the family if there is no given name' do
+        Name.new(:family => 'Suzuki').display_order.should == 'Suzuki'
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namae
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-24 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
-  requirement: &70303877856980 !ruby/object:Gem::Requirement
+  requirement: &70302785391320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.4.8
   type: :development
   prerelease: false
-  version_requirements: *70303877856980
+  version_requirements: *70302785391320
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70303877872020 !ruby/object:Gem::Requirement
+  requirement: &70302785414780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70303877872020
+  version_requirements: *70302785414780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70303877871300 !ruby/object:Gem::Requirement
+  requirement: &70302785413280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70303877871300
+  version_requirements: *70302785413280
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70303877870540 !ruby/object:Gem::Requirement
+  requirement: &70302785412480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70303877870540
+  version_requirements: *70302785412480
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70303877869820 !ruby/object:Gem::Requirement
+  requirement: &70302785410780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 4.8.0
   type: :development
   prerelease: false
-  version_requirements: *70303877869820
+  version_requirements: *70302785410780
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70303877869300 !ruby/object:Gem::Requirement
+  requirement: &70302785408660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,9 +77,9 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70303877869300
-description: ! ' Namae is a parser for human names. It recognizes personal names of
-  various cultural backgrounds and tries to split them into their component parts
+  version_requirements: *70302785408660
+description: ! ' Namae (名前) is a parser for human names. It recognizes personal names
+  of various cultural backgrounds and tries to split them into their component parts
   (e.g., given and family names, honorifics etc.). '
 email:
 - sylvester@keil.or.at
@@ -131,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 212543173299856896
+      hash: 1701548579686909699
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,5 +143,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Namae parses personal names and splits them into their component parts.
+summary: Namae (名前) parses personal names and splits them into their component parts.
 test_files: []