mods 0.0.16 → 0.0.17

data/lib/mods/record.rb

@@ -78,19 +78,19 @@ module Mods
       @mods_ng_xml.title_info.sort_title.find { |n| !n.nil? }
     end
     
-    # use the displayForm of a personal name if present
-    #   if no displayForm, try to make a string from family name and given name "family_name, given_name"
-    #   otherwise, return all nameParts concatenated together
-    # @return Array of Strings, each containing the above described string
+    # @return Array of Strings, each containing the computed display value of a personal name
+    #   (see nom_terminology for algorithm)
     def personal_names
       @mods_ng_xml.personal_name.map { |n|
-        if n.displayForm.size > 0
-          n.displayForm.text
-        elsif n.family_name.size > 0
-          n.given_name.size > 0 ? n.family_name.text + ', ' + n.given_name.text : n.family_name.text
-        else
-          n.namePart.text
-        end
+        n.display_value
+      }
+    end
+
+    # @return Array of Strings, each containing the computed display value of a personal name
+    #   (see nom_terminology for algorithm)
+    def personal_names_w_dates
+      @mods_ng_xml.personal_name.map { |n|
+        n.display_value_w_date
       }
     end
 
@@ -99,11 +99,7 @@ module Mods
     # @return Array of Strings, each containing the above described string
     def corporate_names
       @mods_ng_xml.corporate_name.map { |n|
-        if n.displayForm.size > 0
-          n.displayForm.text
-        else
-          n.namePart.text 
-        end
+        n.display_value
       }
     end
     

data/lib/mods/version.rb

@@ -1,4 +1,4 @@
 module Mods
   # this is the Ruby Gem version
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

data/spec/name_spec.rb

@@ -74,7 +74,7 @@ describe "Mods <name> Element" do
           @mods_rec.personal_name.role.roleTerm.authority.should == ["marcrelator"]
         end
       end # roles
-    end # WITH namespaces
+    end # WITH namespaces (personal name)
     
     context "WITHOUT namespaces" do
       it "should recognize child elements" do
@@ -215,7 +215,7 @@ describe "Mods <name> Element" do
         end
       end
       
-    end # context WITH namespaces
+    end # context WITH namespaces (plain_name)
 
     context "WITHOUT namespaces" do
       it "should recognize child elements" do
@@ -266,6 +266,260 @@ describe "Mods <name> Element" do
     MARC_RELATOR['drt'].should == "Director"
   end
   
+  context "display_value and display_value_w_date" do
+    before(:all) do
+      @disp_form = 'q'
+      @pname1_xml = "<mods #{@ns_decl}><name type='personal'>
+              <namePart type='given'>John</namePart>
+              <namePart type='family'>Huston</namePart>
+              <displayForm>#{@disp_form}</displayForm>
+         </name></mods>"
+      @cname_xml = "<mods #{@ns_decl}><name type='corporate'>
+              <namePart>Watchful Eye</namePart>
+          </name></mods>"
+      @affl = 'affliation'
+      @desc = 'description'
+      @role = 'role'
+      @name_xml = "<mods #{@ns_decl}><name>
+                <namePart>Exciting Prints</namePart>
+                <affiliation>#{@affl}</affiliation>
+                <description>#{@desc}</description>
+                <role><roleTerm type='text'>#{@role}</roleTerm></role>
+            </name></mods>"
+      @namepart_xml = "<mods #{@ns_decl}><name>
+                <namePart>Suzy</namePart>
+                <namePart type='date'>1920-</namePart>
+            </name></mods>"
+    end
+    context "WITH namespaces" do
+      before(:all) do
+        @mods_pname1 = Mods::Record.new.from_str(@pname1_xml)
+        @mods_cname = Mods::Record.new.from_str(@cname_xml)
+        @mods_name = Mods::Record.new.from_str(@name_xml)
+        @mods_namepart_date = Mods::Record.new.from_str(@namepart_xml)        
+      end
+      it "should be a string value for each name, not an Array" do
+        @mods_name.plain_name.first.display_value.should be_an_instance_of(String)
+        @mods_name.plain_name.first.display_value_w_date.should be_an_instance_of(String)
+      end
+      it "should return nil when there is no display_value" do
+        x = "<mods #{@ns_decl}><name>
+                  <namePart></namePart>
+              </name></mods>"
+        r = Mods::Record.new.from_str(x)
+        r.plain_name.first.display_value.should == nil
+      end
+      it "should be applicable to all name term flavors (plain_name, personal_name, corporate_name ...)" do
+        @mods_name.plain_name.first.display_value.should_not == nil
+        @mods_name.plain_name.first.display_value_w_date.should_not == nil
+        @mods_pname1.personal_name.first.display_value.should_not == nil
+        @mods_pname1.personal_name.first.display_value_w_date.should_not == nil
+        @mods_cname.corporate_name.first.display_value.should_not == nil
+        @mods_cname.corporate_name.first.display_value_w_date.should_not == nil
+      end
+      it "should not include <affiliation> text" do
+        @mods_name.plain_name.first.display_value.should_not =~ Regexp.new(@affl)
+      end
+      it "should not include <description> text" do
+        @mods_name.plain_name.first.display_value.should_not =~  Regexp.new(@desc)
+      end
+      it "should not include <role> info" do
+        @mods_name.plain_name.first.display_value.should_not =~  Regexp.new(@role)
+      end
+      it "should be the value of the <displayForm> subelement if it exists" do
+        @mods_pname1.plain_name.first.display_value.should == @disp_form
+        x = "<mods #{@ns_decl}><name type='personal'>
+              	  <namePart>Alterman, Eric</namePart>
+              	  <displayForm>Eric Alterman</displayForm>
+              </name><mods>"
+        r = Mods::Record.new.from_str(x)         
+        r.plain_name.first.display_value.should == 'Eric Alterman'
+      end
+      it "display_value should not include <namePart type='date'>" do
+        @mods_namepart_date.plain_name.first.display_value.should == 'Suzy'
+      end
+      it "date text should be added to display_value_w_date when it is available" do
+        @mods_namepart_date.plain_name.first.display_value_w_date.should == 'Suzy, 1920-'
+      end
+      it "date text should not be added to display_value_w_dates if dates are already included" do
+        x = "<mods #{@ns_decl}><name>
+                  <namePart>Woolf, Virginia</namePart>
+  	              <namePart type='date'>1882-1941</namePart>
+                  <displayForm>Woolf, Virginia, 1882-1941</namePart>
+              </name></mods>"
+        r = Mods::Record.new.from_str(x) 
+        r.plain_name.first.display_value_w_date.should == 'Woolf, Virginia, 1882-1941'
+      end
+      context "personal names" do
+        before(:all) do
+          @d = '1920-2005'
+          x = "<mods #{@ns_decl}><name type='personal'>
+                	<namePart type='given'>John Paul</namePart>
+                	<namePart type='termsOfAddress'>II</namePart>
+                	<namePart type='termsOfAddress'>Pope</namePart>
+                	<namePart type='date'>#{@d}</namePart>
+              </name></mods>"
+          @pope = Mods::Record.new.from_str(x) 
+          x = "<mods #{@ns_decl}><name type='personal'>
+                    <namePart>Crusty</namePart>
+                    <namePart>The Clown</namePart>
+                    <namePart type='date'>#{@d}</namePart>
+                </name></mods>"
+          @pname2 = Mods::Record.new.from_str(x)
+        end
+        # use the displayForm of a personal name if present
+        #   if no displayForm, try to make a string from family name and given name "family_name, given_name"
+        #   otherwise, return all nameParts concatenated together
+        # @return Array of Strings, each containing the above described string
+        it "should be [family name], [given name] if they are present" do
+          x = "<mods #{@ns_decl}><name type='personal'>
+                  <namePart type='given'>John</namePart>
+                  <namePart type='family'>Huston</namePart>
+             </name></mods>"
+          r = Mods::Record.new.from_str(x)
+          r.personal_name.first.display_value.should == 'Huston, John'
+          @pope.personal_name.first.display_value.should == 'John Paul II, Pope'
+        end
+        it "should be concatenation of untyped <namePart> elements if there is no family or given name" do
+          @pname2.personal_name.first.display_value.should == 'Crusty The Clown'
+        end
+        it "should include <termOfAddress> elements, in order, comma separated" do
+          @pope.personal_name.first.display_value.should == 'John Paul II, Pope'
+        end
+        it "display_value should not include date" do
+          @pope.personal_name.first.display_value.should_not =~ Regexp.new(@d)
+        end
+        it "date should be included in display_value_w_date" do
+          @pope.personal_name.first.display_value_w_date.should == "John Paul II, Pope, #{@d}"
+        end
+      end
+      context "not personal name (e.g. corporate)" do
+        it "should be the value of non-date nameParts concatenated" do
+          x = "<mods #{@ns_decl}><name type='corporate'>
+            	<namePart>United States</namePart>
+            	<namePart>Court of Appeals (2nd Circuit)</namePart>
+          </name></mods>"
+          r = Mods::Record.new.from_str(x)
+          r.corporate_name.first.display_value.should == 'United States Court of Appeals (2nd Circuit)'
+        end
+      end
+    end # WITH namespaces
+
+    context "WITHOUT namespaces" do
+      before(:all) do
+        @mods_pname1 = Mods::Record.new.from_str(@pname1_xml.sub(" #{@ns_decl}", ''), false)
+        @mods_cname = Mods::Record.new.from_str(@cname_xml.sub(" #{@ns_decl}", ''), false)
+        @mods_name = Mods::Record.new.from_str(@name_xml.sub(" #{@ns_decl}", ''), false)
+        @mods_namepart_date = Mods::Record.new.from_str(@namepart_xml.sub(" #{@ns_decl}", ''), false)
+      end
+      it "should be a string value for each name, not an Array" do
+        @mods_name.plain_name.first.display_value.should be_an_instance_of(String)
+        @mods_name.plain_name.first.display_value_w_date.should be_an_instance_of(String)
+      end
+      it "should return nil when there is no display_value" do
+        x = "<mods><name>
+                  <namePart></namePart>
+              </name></mods>"
+        r = Mods::Record.new.from_str(x, false)
+        r.plain_name.first.display_value.should == nil
+      end
+      it "should be applicable to all name term flavors (plain_name, personal_name, corporate_name ...)" do
+        @mods_name.plain_name.first.display_value.should_not == nil
+        @mods_name.plain_name.first.display_value_w_date.should_not == nil
+        @mods_pname1.personal_name.first.display_value.should_not == nil
+        @mods_pname1.personal_name.first.display_value_w_date.should_not == nil
+        @mods_cname.corporate_name.first.display_value.should_not == nil
+        @mods_cname.corporate_name.first.display_value_w_date.should_not == nil
+      end
+      it "should not include <affiliation> text" do
+        @mods_name.plain_name.first.display_value.should_not =~ Regexp.new(@affl)
+      end
+      it "should not include <description> text" do
+        @mods_name.plain_name.first.display_value.should_not =~  Regexp.new(@desc)
+      end
+      it "should not include <role> info" do
+        @mods_name.plain_name.first.display_value.should_not =~  Regexp.new(@role)
+      end
+      it "should be the value of the <displayForm> subelement if it exists" do
+        @mods_pname1.plain_name.first.display_value.should == @disp_form
+        x = "<mods><name type='personal'>
+              	  <namePart>Alterman, Eric</namePart>
+              	  <displayForm>Eric Alterman</displayForm>
+              </name><mods>"
+        r = Mods::Record.new.from_str(x, false)         
+        r.plain_name.first.display_value.should == 'Eric Alterman'
+      end
+      it "display_value should not include <namePart type='date'>" do
+        @mods_namepart_date.plain_name.first.display_value.should == 'Suzy'
+      end
+      it "date text should be added to display_value_w_date when it is available" do
+        @mods_namepart_date.plain_name.first.display_value_w_date.should == 'Suzy, 1920-'
+      end
+      it "date text should not be added to display_value_w_dates if dates are already included" do
+        x = "<mods><name>
+                  <namePart>Woolf, Virginia</namePart>
+  	              <namePart type='date'>1882-1941</namePart>
+                  <displayForm>Woolf, Virginia, 1882-1941</namePart>
+              </name></mods>"
+        r = Mods::Record.new.from_str(x, false) 
+        r.plain_name.first.display_value_w_date.should == 'Woolf, Virginia, 1882-1941'
+      end
+      context "personal names" do
+        before(:all) do
+          @d = '1920-2005'
+          x = "<mods><name type='personal'>
+                	<namePart type='given'>John Paul</namePart>
+                	<namePart type='termsOfAddress'>II</namePart>
+                	<namePart type='termsOfAddress'>Pope</namePart>
+                	<namePart type='date'>#{@d}</namePart>
+              </name></mods>"
+          @pope = Mods::Record.new.from_str(x, false) 
+          x = "<mods><name type='personal'>
+                    <namePart>Crusty</namePart>
+                    <namePart>The Clown</namePart>
+                    <namePart type='date'>#{@d}</namePart>
+                </name></mods>"
+          @pname2 = Mods::Record.new.from_str(x, false)
+        end
+        # use the displayForm of a personal name if present
+        #   if no displayForm, try to make a string from family name and given name "family_name, given_name"
+        #   otherwise, return all nameParts concatenated together
+        # @return Array of Strings, each containing the above described string
+        it "should be [family name], [given name] if they are present" do
+          x = "<mods><name type='personal'>
+                  <namePart type='given'>John</namePart>
+                  <namePart type='family'>Huston</namePart>
+             </name></mods>"
+          r = Mods::Record.new.from_str(x, false)
+          r.personal_name.first.display_value.should == 'Huston, John'
+          @pope.personal_name.first.display_value.should == 'John Paul II, Pope'
+        end
+        it "should be concatenation of untyped <namePart> elements if there is no family or given name" do
+          @pname2.personal_name.first.display_value.should == 'Crusty The Clown'
+        end
+        it "should include <termOfAddress> elements, in order, comma separated" do
+          @pope.personal_name.first.display_value.should == 'John Paul II, Pope'
+        end
+        it "display_value should not include date" do
+          @pope.personal_name.first.display_value.should_not =~ Regexp.new(@d)
+        end
+        it "date should be included in display_value_w_date" do
+          @pope.personal_name.first.display_value_w_date.should == "John Paul II, Pope, #{@d}"
+        end
+      end
+      context "not personal name (e.g. corporate)" do
+        it "should be the value of non-date nameParts concatenated" do
+          x = "<mods><name type='corporate'>
+            	<namePart>United States</namePart>
+            	<namePart>Court of Appeals (2nd Circuit)</namePart>
+          </name></mods>"
+          r = Mods::Record.new.from_str(x, false)
+          r.corporate_name.first.display_value.should == 'United States Court of Appeals (2nd Circuit)'
+        end
+      end
+    end # WITHOUT namespaces
+  end # display_value and display_value_w_date
+  
   context "roles" do
     before(:all) do
       @xml_w_code = "<mods #{@ns_decl}><name><namePart>Alfred Hitchock</namePart>

data/spec/record_spec.rb

@@ -158,7 +158,7 @@ describe "Mods::Record" do
       end
       it "should include a comma when there is both a family and a given name" do
         @mods_rec.from_str(@all_name_parts)
-        @mods_rec.personal_names.should include("Family, Given")
+        @mods_rec.personal_names.should include("Family, Given Mr.")
       end
       it "should include multiple words in a namePart" do
         @mods_rec.from_str(@given_family)
@@ -170,11 +170,39 @@ describe "Mods::Record" do
           @mods_rec.personal_names.first.should_not match(/,/)
         }
       end
-      it "should not include terms of address" do
+      it "should include terms of address" do
         @mods_rec.from_str(@all_name_parts)
-        @mods_rec.personal_names.first.should_not match(/Mr./)
+        @mods_rec.personal_names.first.should match(/Mr./)
       end      
     end # personal_names 
+    
+    context "personal_names_w_dates" do
+      before(:all) do
+        @given_family = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Jorge Luis</namePart>
+                                <namePart type="family">Borges</namePart></name></mods>'        
+        @given_family_date = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Zaphod</namePart>
+                                <namePart type="family">Beeblebrox</namePart>
+                                <namePart type="date">1912-2362</namePart></name></mods>'
+        @all_name_parts = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Given</namePart>
+                                <namePart type="family">Family</namePart>
+                                <namePart type="termsOfAddress">Mr.</namePart>
+                                <namePart type="date">date</namePart></name></mods>'
+      end
+      it "should return an Array of Strings" do
+        @mods_rec.from_str(@given_family_date)
+        @mods_rec.personal_names_w_dates.should be_an_instance_of(Array)
+      end
+      it "should include the date when it is available" do
+        @mods_rec.from_str(@given_family_date)
+        @mods_rec.personal_names_w_dates.first.should match(/, 1912-2362$/)
+        @mods_rec.from_str(@all_name_parts)
+        @mods_rec.personal_names_w_dates.first.should match(/, date$/)
+      end      
+      it "should be just the personal_name if no date is available" do
+        @mods_rec.from_str(@given_family)
+        @mods_rec.personal_names_w_dates.first.should == 'Borges, Jorge Luis'
+      end
+    end
       
     context "corporate_names" do
       before(:all) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mods
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2012-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -230,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1181909657495840648
+      hash: 3977666186634091349
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1181909657495840648
+      hash: 3977666186634091349
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24