stanford-mods 0.0.6 → 0.0.7

data/README.rdoc

@@ -1,6 +1,6 @@
 = Stanford::Mods
 
-{<img src="https://secure.travis-ci.org/sul-dlss/stanford-mods.png?branch=master" alt="Build Status" />}[http://travis-ci.org/sul-dlss/stanford-mods]
+{<img src="https://secure.travis-ci.org/sul-dlss/stanford-mods.png?branch=master" alt="Build Status" />}[http://travis-ci.org/sul-dlss/stanford-mods] {<img src="https://gemnasium.com/sul-dlss/stanford-mods.png" alt="Dependency Status" />}[https://gemnasium.com/sul-dlss/stanford-mods]
 
 A Gem with Stanford specific wranglings of MODS (Metadata Object Description Schema) metadata from DOR, the Stanford Digital Object Repository.
 
@@ -60,6 +60,7 @@ Example Using SearchWorks Mixins:
 
 == Releases
 
+* <b>0.0.7</b> added sw_geographic_search to searchworks mixin
 * <b>0.0.6</b> various title methods added to searchworks mixin
 * <b>0.0.5</b> main_author_w_date, additional_authors_w_dates added to Stanford::Mods::Record; various author methods added to searchworks mixin
 * <b>0.0.4</b> KolbRecord started

data/lib/stanford-mods.rb

@@ -1,4 +1,3 @@
-require "stanford-mods/mappings"
 require "stanford-mods/version"
 require 'mods'
 

data/lib/stanford-mods/{mappings.rb → old_mappings_4_ref.rb}

@@ -1,3 +1,5 @@
+# This file is for reference as I implement the searchworks.rb mixin file
+#  it is a bunch of methods from the old dor-sw-ingest code 
 module Stanford
   module Mods
 

data/lib/stanford-mods/searchworks.rb

@@ -7,11 +7,6 @@ module Stanford
 
     class Record < ::Mods::Record
       
-      # if it's coming from DOR, then it is available online
-      def sw_access_facet
-        ['Online']
-      end
-      
       # include langagues known to SearchWorks; try to error correct when possible (e.g. when ISO-639 disagrees with MARC standard)
       def sw_language_facet
         result = []
@@ -119,6 +114,37 @@ module Stanford
         val = '' + ( sort_title ? sort_title : '')
         val.gsub(/[[:punct:]]*/, '').strip
       end
+      
+      # ---- SUBJECT ----
+      
+      # Values are the contents of:
+      #   subject/geographic
+      #   subject/hierarchicalGeographic
+      #   subject/geographicCode  (only include the translated value if it isn't already present from other mods geo fields)
+      # @param [String] sep - the separator string for joining hierarchicalGeographic sub elements
+      # @return [Array<String>] values for geographic_search Solr field for this document or nil if none
+      def sw_geographic_search(sep = ' ')
+        result = term_values([:subject, :geographic]) || []
+        
+        # hierarchicalGeographic has sub elements
+        @mods_ng_xml.subject.hierarchicalGeographic.each { |hg_node|  
+          hg_vals = []
+          hg_node.element_children.each { |e| 
+            hg_vals << e.text unless e.text.empty?
+          }
+          result << hg_vals.join(sep) unless hg_vals.empty?
+        }
+
+        trans_code_vals = @mods_ng_xml.subject.geographicCode.translated_value
+        if trans_code_vals
+          trans_code_vals.each { |val|  
+            result << val if !result.include?(val)
+          }
+        end
+
+        return nil if result.empty?
+        result    
+      end
             
     end # class Record
   end # Module Mods

data/lib/stanford-mods/version.rb

@@ -1,5 +1,5 @@
 module Stanford
   module Mods
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/spec/{values_for_req_sw_spec.rb → ignore_me_sw_required_flds_spec.rb}

@@ -39,9 +39,7 @@ describe "Values for SearchWorks Solr" do
   end
   
   context "strongly recommended fields" do
-    it "access_facet" do
-      Stanford::Mods::Record.new.sw_access_facet.should == ['Online']
-    end
+    # access_facet has nothing to do with mods
     # title convenience methods are implemented in the Mods gem; no special work here
     context "title fields" do
       context "for display" do

data/spec/kolb_spec.rb

@@ -94,9 +94,7 @@ describe "Kolb Collection Mods Record" do
     end
   
     context "strongly recommended" do
-      it "access_facet" do
-        @krec.sw_access_facet.should == ['Online']
-      end
+      # access_facet has nothing to do with mods
       context "title" do
         context "for display and searching" do
           it "short title" do

data/spec/searchworks_spec.rb

@@ -9,10 +9,6 @@ describe "Searchworks mixin for Stanford::Mods::Record" do
     @ns_decl = "xmlns='#{Mods::MODS_NS}'"
   end
 
-  it "sw_access_facet" do
-    @smods_rec.sw_access_facet.should == ['Online']
-  end
-  
   context "languages" do
     it "should use the SearchWorks controlled vocabulary" do
       m = "<mods #{@ns_decl}><language><languageTerm authority='iso639-2b' type='code'>per ara, dut</languageTerm></language></mods>"
@@ -180,5 +176,197 @@ describe "Searchworks mixin for Stanford::Mods::Record" do
         r.sw_sort_title.should =~ /^Jerk$/
       end
     end
-  end
+  end # content sw title methods
+
+  context "sw subject methods" do
+    before(:all) do
+      @genre = 'genre top level'
+      @cart_coord = '6 00 S, 71 30 E'
+      @s_genre = 'genre in subject'
+      @geo = 'Somewhere'
+      @geo_code = 'us'
+      @hier_geo_country = 'France'
+      @s_name = 'name in subject'
+      @occupation = 'worker bee'
+      @temporal = 'temporal'
+      @s_title = 'title in subject'
+      @topic = 'topic'
+      m = "<mods #{@ns_decl}>
+        <genre>#{@genre}</genre>
+        <subject><cartographics><coordinates>#{@cart_coord}</coordinates></cartographics></subject>
+        <subject><genre>#{@s_genre}</genre></subject>
+        <subject><geographic>#{@geo}</geographic></subject>
+        <subject><geographicCode authority='iso3166'>#{@geo_code}</geographicCode></subject>
+        <subject><hierarchicalGeographic><country>#{@hier_geo_country}</country></hierarchicalGeographic></subject>
+        <subject><name><namePart>#{@s_name}</namePart></name></subject>
+        <subject><occupation>#{@occupation}</occupation></subject>
+        <subject><temporal>#{@temporal}</temporal></subject>
+        <subject><titleInfo><title>#{@s_title}</title></titleInfo></subject>
+        <subject><topic>#{@topic}</topic></subject>      
+      </mods>"
+      @smods_rec.from_str m
+      @sw_geographic_search = @smods_rec.sw_geographic_search   
+    end
+    
+    context "sw_geographic_search" do
+      it "should contain subject <geographic> subelement data" do
+        @sw_geographic_search.should include(@geo)
+      end
+      it "should contain subject <hierarchicalGeographic> subelement data" do
+        @sw_geographic_search.should include(@hier_geo_country)
+      end
+      it "should contain translation of <geographicCode> subelement data with translated authorities" do
+        m = "<mods #{@ns_decl}><subject><geographicCode authority='marcgac'>e-er</geographicCode></subject></mods>"
+        @smods_rec.from_str m
+        @smods_rec.sw_geographic_search.should include('Estonia')
+      end
+      it "should not contain other subject element data" do
+        @sw_geographic_search.should_not include(@genre)
+        @sw_geographic_search.should_not include(@cart_coord)
+        @sw_geographic_search.should_not include(@s_genre)
+        @sw_geographic_search.should_not include(@s_name)
+        @sw_geographic_search.should_not include(@occupation)
+        @sw_geographic_search.should_not include(@temporal)
+        @sw_geographic_search.should_not include(@topic)
+        @sw_geographic_search.should_not include(@s_title)
+      end
+      it "should be nil if there are no values in the MODS" do
+        m = "<mods #{@ns_decl}><note>notit</note></mods>"
+        @smods_rec.from_str m
+        @smods_rec.sw_geographic_search.should == nil
+      end
+      it "should not be nil if there are only subject/geographic elements" do
+        m = "<mods #{@ns_decl}><subject><geographic>#{@geo}</geographic></subject></mods>"
+        @smods_rec.from_str m
+        @smods_rec.sw_geographic_search.should == [@geo]
+      end
+      it "should not be nil if there are only subject/hierarchicalGeographic" do
+        m = "<mods #{@ns_decl}><subject><hierarchicalGeographic><country>#{@hier_geo_country}</country></hierarchicalGeographic></subject></mods>"
+        @smods_rec.from_str m
+        @smods_rec.sw_geographic_search.should == [@hier_geo_country]
+      end
+      it "should not be nil if there are only subject/geographicCode elements" do
+        m = "<mods #{@ns_decl}><subject><geographicCode authority='marcgac'>e-er</geographicCode></subject></mods>"
+        @smods_rec.from_str m
+        @smods_rec.sw_geographic_search.should == ['Estonia']
+      end
+      context "geographic subelement" do
+        it "should have a separate value for each geographic element" do
+          m = "<mods #{@ns_decl}>
+                <subject>
+                <geographic>Mississippi</geographic>
+                <geographic>Tippah County</geographic>
+                </subject>
+                <subject><geographic>Washington (D.C.)</geographic></subject>
+              </mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.should == ['Mississippi', 'Tippah County', 'Washington (D.C.)']
+        end
+        it "should be nil if there are only empty values in the MODS" do
+          m = "<mods #{@ns_decl}><subject><geographic/></subject><note>notit</note></mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.should == nil
+        end
+      end
+      context "hierarchicalGeographic subelement" do
+        it "should have a separate value for each hierarchicalGeographic element" do
+          m = "<mods #{@ns_decl}>
+                <subject>
+                  <hierarchicalGeographic><area>first</area></hierarchicalGeographic>
+                  <hierarchicalGeographic><area>second</area></hierarchicalGeographic>
+                </subject>
+                <subject><hierarchicalGeographic><area>third</area></hierarchicalGeographic></subject>
+              </mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.should == ['first', 'second', 'third']
+        end
+        it "should be nil if there are only empty values in the MODS" do
+          m = "<mods #{@ns_decl}><subject><hierarchicalGeographic/></subject><note>notit</note></mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.should == nil
+        end
+        context "combining subelements" do
+          before(:all) do
+            m = "<mods #{@ns_decl}>
+            <subject>
+              <hierarchicalGeographic>
+              	<country>Canada</country>
+              	<province>British Columbia</province>
+              	<city>Vancouver</city>
+              </hierarchicalGeographic>
+            </subject></mods>"
+            @smods_rec.from_str m
+          end
+          it "uses a space as the separator by default" do
+            @smods_rec.sw_geographic_search.should == ['Canada British Columbia Vancouver']
+          end          
+          it "honors any string value passed in for the separator" do
+            @smods_rec.sw_geographic_search(' --').should == ['Canada --British Columbia --Vancouver']
+          end
+        end
+      end # hierarchicalGeographic
+      context "geographicCode subelement" do
+        before(:all) do
+          m = "<mods #{@ns_decl}>
+            <subject><geographicCode authority='marcgac'>n-us-md</geographicCode></subject>
+            <subject><geographicCode authority='marcgac'>e-er</geographicCode></subject>
+            <subject><geographicCode authority='marccountry'>mg</geographicCode></subject>
+            <subject><geographicCode authority='iso3166'>us</geographicCode></subject>
+          </mods>"
+          @smods_rec.from_str m
+          @geo_search_from_codes = @smods_rec.sw_geographic_search   
+        end
+        it "should not add untranslated values" do
+          @geo_search_from_codes.should_not include('n-us-md')
+          @geo_search_from_codes.should_not include('e-er')
+          @geo_search_from_codes.should_not include('mg')
+          @geo_search_from_codes.should_not include('us')
+        end
+        it "should translate marcgac codes" do
+          @geo_search_from_codes.should include('Estonia')
+        end
+        it "should translate marccountry codes" do
+          @geo_search_from_codes.should include('Madagascar')
+        end
+        it "should not translate other codes" do
+          @geo_search_from_codes.should_not include('United States')
+        end
+        it "should have a separate value for each geographicCode element" do
+          m = "<mods #{@ns_decl}>
+                <subject>
+                  <geographicCode authority='marcgac'>e-er</geographicCode>
+                	<geographicCode authority='marccountry'>mg</geographicCode>
+                </subject>
+                <subject><geographicCode authority='marcgac'>n-us-md</geographicCode></subject>
+              </mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.should == ['Estonia', 'Madagascar', 'Maryland']
+        end
+        it "should be nil if there are only empty values in the MODS" do
+          m = "<mods #{@ns_decl}><subject><geographicCode/></subject><note>notit</note></mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.should == nil
+        end
+        it "should add the translated value if it wasn't present already" do
+          m = "<mods #{@ns_decl}>
+            <subject><geographic>Somewhere</geographic></subject>
+            <subject><geographicCode authority='marcgac'>e-er</geographicCode></subject>
+          </mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.size.should == 2
+          @smods_rec.sw_geographic_search.should include('Estonia')
+        end
+        it "should not add the translated value if it was already present" do
+          m = "<mods #{@ns_decl}>
+            <subject><geographic>Estonia</geographic></subject>
+            <subject><geographicCode authority='marcgac'>e-er</geographicCode></subject>
+          </mods>"
+          @smods_rec.from_str m
+          @smods_rec.sw_geographic_search.size.should == 1
+          @smods_rec.sw_geographic_search.should == ['Estonia']
+        end
+      end
+    end # sw_geographic_search
+  end # context sw subject methods
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stanford-mods
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mods
@@ -146,15 +146,15 @@ files:
 - config/mappings_hash.rb
 - lib/stanford-mods.rb
 - lib/stanford-mods/kolb.rb
-- lib/stanford-mods/mappings.rb
+- lib/stanford-mods/old_mappings_4_ref.rb
 - lib/stanford-mods/searchworks.rb
 - lib/stanford-mods/searchworks_languages.rb
 - lib/stanford-mods/version.rb
+- spec/ignore_me_sw_required_flds_spec.rb
 - spec/kolb_spec.rb
 - spec/name_spec.rb
 - spec/searchworks_spec.rb
 - spec/spec_helper.rb
-- spec/values_for_req_sw_spec.rb
 - stanford-mods.gemspec
 homepage: https://github.com/sul-dlss/stanford-mods
 licenses: []
@@ -170,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1154889881956546953
+      hash: -1663649951940663346
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1154889881956546953
+      hash: -1663649951940663346
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -187,9 +187,9 @@ signing_key:
 specification_version: 3
 summary: Stanford specific wrangling of MODS metadata
 test_files:
+- spec/ignore_me_sw_required_flds_spec.rb
 - spec/kolb_spec.rb
 - spec/name_spec.rb
 - spec/searchworks_spec.rb
 - spec/spec_helper.rb
-- spec/values_for_req_sw_spec.rb
 has_rdoc: