stanford-mods 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263c241c3db2224132441cf57740be7ac0c73495
-  data.tar.gz: 735eb6fe63c5227159a69b271ce5af61024f2f83
+  metadata.gz: 209b8e1644beeed8c28948b1acdba20b7d63a414
+  data.tar.gz: d3f4b45f2d6f990c3084a67e4eca651a83ecd7e0
 SHA512:
-  metadata.gz: 38de7ce352621e92605efb02bbccf6c79200779e7648a766e72592eb334236cead01a7470dcc2cd7e3846ba5fc5a299f8a5c836977784b4a87eaf638ae4beb28
-  data.tar.gz: b2380744c02745e5a545350a39fa904cbc531367018f1b2054d3346dd17053c928be1cc9382ac5e1f1a234f01e115b6aac02f7e221d1fc3a59188b84a2da18c9
+  metadata.gz: 00b048ecb711ea342bb7071bf5422f06c48f40bf81b7b67590211d9eb0a59774d28991396dfc1c0aa54c7cbe354407183fbd87f28c318517c0a7d08c12bceca4
+  data.tar.gz: a9b70f9cf519fae69b9e557281b156913735d465e83044ab6286caafeac0ca5ce2dde623cbdac58d91522e547041c175c602f5cb3cd39b5b68aed38fcc3ba772

data/README.md

@@ -0,0 +1,91 @@
+# 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://coveralls.io/repos/sul-dlss/stanford-mods/badge.png" alt="Coverage Status"/>](https://coveralls.io/r/sul-dlss/stanford-mods) [<img
+src="https://gemnasium.com/sul-dlss/stanford-mods.png" alt="Dependency Status"/>](https://gemnasium.com/sul-dlss/stanford-mods) [<img
+src="https://badge.fury.io/rb/stanford-mods.svg" alt="Gem Version"/>](http://badge.fury.io/rb/stanford-mods)
+
+A Gem with Stanford specific wranglings of MODS (Metadata Object Description Schema)
+metadata from DOR, the Stanford Digital Object Repository.
+
+Source code at [github](https://github.com/sul-dlss/stanford-mods/).
+
+Generated API docs at [rubydoc.info](http://rubydoc.info/github/sul-dlss/stanford-mods/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stanford-mods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stanford-mods
+
+## Usage
+
+1.  add stanford-mods to your gemfile
+2.  
+```ruby
+require 'stanford-mods'
+m = Stanford::Mods::Record.new
+m.from_str('<mods><genre>ape</genre></mods>')
+m.genre      # <Nokogiri::XML::Element:0x3fe07b48bb24 name="genre" children=[#<Nokogiri::XML::Text:0x3fe07a09a7dc "ape">]>
+m.genre.text # "ape"
+```
+
+Example Using SearchWorks Mixins:
+
+```ruby
+require 'stanford-mods/searchworks'
+m = Stanford::Mods::Record.new
+m.from_str('<mods><language><languageTerm authority="iso639-2b" type="code">dut</languageTerm></language></mods>')
+m.language_facet  # ['Dutch'], from Searchworks mixin
+m.languages       # ['Dutch; Flemish'] from mods gem
+```
+
+## Contributing
+
+1.  Fork it
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+3.  Write code and tests.
+4.  Commit your changes (`git commit -am 'Added some feature'`)
+5.  Push to the branch (`git push origin my-new-feature`)
+6.  Create new Pull Request
+
+## Releases
+*   **1.1.2** Corrected java `Character.MAX_CODE_POINT` value from u{FFFF} to u{10FFFF}
+*   **1.1.1** Minor bug fixes
+*   **1.1.0** Changed mechanism for determining dates for display only and for
+    indexing, sorting, and faceting and removed deprecated pub_date_group method
+*   **1.0.3** `format_main` value 'Article' is now 'Book'
+*   **1.0.2** add `format_main` and `sw_genre` tests to searchworks.rb
+*   **1.0.1** `sw_title_display` keeps appropriate trailing punct more or less per spec in solrmarc-sw `sw_index.properties`
+*   **1.0.0** `sw_full_title` now includes partName and partNumber;
+    `sw_title_display` created to be like `sw_full_title` but without trailing punctuation; sw format for typeOfResource sound recording; genre value is
+    librettos, plural; sw format algorithm accommodates first letter upcase; genre value report does NOT map to a format, genre value 'project report'
+    with ToR text is 'Book'
+*   **0.0.27** add genres 'Issue brief', 'Book chapter' and 'Working paper' to map to searchworks format 'Book'
+*   **0.0.26** map typeOfResource 'sound recording-musical' to searchworks format 'Music - Recording' with spaces
+*   **0.0.25** map typeOfResource 'text' and genre 'report' to searchworks format 'Book'
+*   **0.0.24** Largely cosmetic refactoring for easier maintenance.
+*   **0.0.23** Added logic for dealing with "u-notation" approximate dates, e.g., 198u
+*   **0.0.20** Added mapping for typeOfResource notated music
+*   **0.0.19** Additional mappings, including Hydrus formats (GRYPHONDOR-207)
+*   **0.0.11** escape regex special characters when using short title in a regex
+*   **0.0.10** get rid of `ignore_me` files
+*   **0.0.9** add `sw_subject_names` and `sw_subject_titles` methods to searchworks mixin
+*   **0.0.8** require stanford-mods/searchworks in stanford-mods (top level)
+*   **0.0.7** added `sw_geographic_search` to searchworks mixin
+*   **0.0.6** various title methods added to searchworks mixin
+*   **0.0.5** `main_author_w_date`, `additional_authors_w_dates` added to Stanford::Mods::Record; various author methods added to searchworks mixin
+*   **0.0.4** KolbRecord started
+*   **0.0.3** began SearchWorks mixins with `sw_access_facet` and `sw_language_facet`
+*   **0.0.2** add usage instructions to README
+*   **0.0.1** Initial commit - grab name
+

data/Rakefile

@@ -32,8 +32,8 @@ begin
 
   YARD::Rake::YardocTask.new(:doc) do |yt|
     yt.files = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
-                 [ File.join(project_root, 'README.rdoc') ]
-    yt.options = ['--output-dir', doc_dest_dir, '--readme', 'README.rdoc', '--title', 'Stanford-Mods Documentation']
+                 [ File.join(project_root, 'README.md') ]
+    yt.options = ['--output-dir', doc_dest_dir, '--readme', 'README.md', '--title', 'Stanford-Mods Documentation']
   end
 rescue LoadError
   desc "Generate YARD Documentation"
@@ -41,4 +41,3 @@ rescue LoadError
     abort "Please install the YARD gem to generate rdoc."
   end
 end
-

data/lib/stanford-mods/searchworks.rb

@@ -191,7 +191,7 @@ module Stanford
         end
 
         val = '' + ( sw_full_title ? sw_full_title : '')
-        val.sub!(Regexp.new("^" + nonSort), '') if nonSort
+        val.sub!(Regexp.new("^" + Regexp.escape(nonSort)), '') if nonSort
         val.gsub!(/[[:punct:]]*/, '').strip
         val.squeeze(" ").strip
       end
@@ -425,7 +425,7 @@ module Stanford
           year = []
           pruned_dates = []
           dates.each do |f_date|
-            #remove ? and []  
+            #remove ? and []
             if (f_date.length == 4 && f_date.end_with?('?'))
               pruned_dates << f_date.gsub('?','0')
             else

data/lib/stanford-mods/version.rb

@@ -1,6 +1,6 @@
 module Stanford
   module Mods
     # this is the Ruby Gem version
-    VERSION = "1.1.4"
+    VERSION = "1.1.5"
   end
 end

data/spec/searchworks_pub_dates_spec.rb

@@ -4,7 +4,6 @@ require 'spec_helper'
 describe "Date methods (searchworks.rb)" do
 
   before(:all) do
-    @smods_rec = Stanford::Mods::Record.new
     @ns_decl = "xmlns='#{Mods::MODS_NS}'"
   end
 
@@ -22,11 +21,14 @@ describe "Date methods (searchworks.rb)" do
   end
 
   context "pub_date" do
+    before :each do
+      @smods_rec = Stanford::Mods::Record.new
+    end
+
     it "should choose the first date" do
       m = "<mods #{@ns_decl}><originInfo>
       <dateCreated>1904</dateCreated>
       </originInfo></mods>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1904')
     end
@@ -34,7 +36,6 @@ describe "Date methods (searchworks.rb)" do
       m = "<mods #{@ns_decl}><originInfo>
       <dateCreated>Aug. 3rd, 1886</dateCreated>
       </originInfo></mods>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1886')
     end
@@ -42,7 +43,6 @@ describe "Date methods (searchworks.rb)" do
       m = "<mods #{@ns_decl}><originInfo>
       <dateCreated>Aug. 3rd, [18]86?</dateCreated>
       </originInfo></mods>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1886')
     end
@@ -50,31 +50,26 @@ describe "Date methods (searchworks.rb)" do
       m = "<mods #{@ns_decl}><originInfo>
       <dateCreated>early 1890s</dateCreated>
       </originInfo></mods>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1890')
     end
     it 'should choose a date ending with CE if there are multiple dates' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>7192 AM (li-Adam) / 1684 CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1684')
     end
     it 'should handle hyphenated range dates' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>1282 AH / 1865-6 CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1865')
     end
     it 'should work with multiple 4 digit dates' do
       m = "<mods #{@ns_decl}><originInfo><dateCreated>Text dated June 4, 1594; miniatures added by 1596</dateCreated></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
-       expect(@smods_rec.pub_date).to eq('1594')
+      expect(@smods_rec.pub_date).to eq('1594')
     end
     it 'should work on 3 digit BC dates' do
       m = "<mods #{@ns_decl}><originInfo><dateCreated>300 B.C.</dateCreated></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
        expect(@smods_rec.pub_year).to eq('-700')
        expect(@smods_rec.pub_date).to eq('-700')
@@ -83,7 +78,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should handle century based dates' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>13th century AH / 19th CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date_facet).to eq('19th century')
       expect(@smods_rec.pub_date_sort).to eq('1800')
@@ -91,7 +85,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should handle multiple CE dates' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>6 Dhu al-Hijjah 923 AH / 1517 CE -- 7 Rabi I 924 AH / 1518 CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('1517')
       expect(@smods_rec.pub_date_sort).to eq('1517')
@@ -99,7 +92,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should handle this case from walters' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>Late 14th or early 15th century CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('14--')
       expect(@smods_rec.pub_date_sort).to eq('1400')
@@ -107,7 +99,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should work on 3 digit dates' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>966 CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('966')
       expect(@smods_rec.pub_date_sort).to eq('0966')
@@ -115,7 +106,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should work on 3 digit dates' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>3rd century AH / 9th CE</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date).to eq('8--')
       expect(@smods_rec.pub_date_sort).to eq('0800')
@@ -123,7 +113,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should use the dateIssued without marc encoding for pub_date_display and the one with marc encoding for indexing, sorting and faceting' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>[186-?]</dateIssued><dateIssued encoding=\"marc\">1860</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date_display).to eq('[186-?]')
       expect(@smods_rec.pub_date).to eq('1860')
@@ -132,7 +121,6 @@ describe "Date methods (searchworks.rb)" do
     end
     it 'should use the dateIssued without marc encoding for pub_date_display and the one with marc encoding for indexing, sorting and faceting' do
       m = "<mods #{@ns_decl}><originInfo><dateIssued>1860?]</dateIssued><dateIssued encoding=\"marc\">186?</dateIssued><issuance>monographic</issuance></originInfo>"
-      @smods_rec = Stanford::Mods::Record.new
       @smods_rec.from_str(m)
       expect(@smods_rec.pub_date_display).to eq('1860?]')
       expect(@smods_rec.pub_date).to eq('1860')

data/spec/searchworks_subject_spec.rb

@@ -353,8 +353,9 @@ describe "Subject fields (searchworks.rb)" do
       end
       it "should be like geographic_search with the trailing punctuation (and preceding spaces) removed" do
         m = "<mods #{@ns_decl}><subject>
-        <geographic>comma,</geographic>
-        <geographic>semicolon;</geographic>
+        <geographic>  comma,</geographic>
+        <geographic>
+          semicolon;</geographic>
         <geographic>backslash \\</geographic>
         <geographic>internal, punct;uation</geographic>
         </subject></mods>"

data/spec/searchworks_title_spec.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 require 'spec_helper'
 
-describe "title fields (searchworks.rb)" do
+describe 'title fields (searchworks.rb)' do
   before(:all) do
     @smods_rec = Stanford::Mods::Record.new
     @ns_decl = "xmlns='#{Mods::MODS_NS}'"
@@ -9,18 +9,18 @@ describe "title fields (searchworks.rb)" do
     @smods_rec.from_str m
   end
 
-  context "short title (for title_245a_search, title_245a_display) " do
-    it "should call :short_titles" do
+  context 'short title (for title_245a_search, title_245a_display) ' do
+    it 'should call :short_titles' do
       expect(@smods_rec).to receive(:short_titles) # in Mods gem
       @smods_rec.sw_short_title
     end
-    it "should be a String" do
+    it 'should be a String' do
       expect(@smods_rec.sw_short_title).to eq 'The Jerk'
     end
   end
 
-  context "full title (for title_245_search, title_full_display)" do
-    it "should be a String" do
+  context 'full title (for title_245_search, title_full_display)' do
+    it 'should be a String' do
       expect(@smods_rec.sw_full_title).to eq 'The Jerk : A Tale of Tourettes.'
     end
     it 'should cope with regex chars' do
@@ -31,9 +31,9 @@ describe "title fields (searchworks.rb)" do
       expect(@smods_rec.sw_full_title).to eq 'Pius V. Saint, [Michaele Gisleri),'
     end
 
-    context "punctuation" do
-      context "no subtitle" do
-        it "end title with a period" do
+    context 'punctuation' do
+      context 'no subtitle' do
+        it 'end title with a period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -42,7 +42,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_full_title).to eq 'The Olympics.'
         end
-        it "title already ends in period" do
+        it 'title already ends in period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -51,7 +51,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_full_title).to eq 'The Olympics.'
         end
-        it "title already ends in other punctuation" do
+        it 'title already ends in other punctuation' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -61,8 +61,8 @@ describe "title fields (searchworks.rb)" do
           expect(@smods_rec.sw_full_title).to eq 'The Olympics!'
         end
       end # no subtitle
-      context "subtitle" do
-        it "end title with a colon" do
+      context 'subtitle' do
+        it 'end title with a colon' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -72,7 +72,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_full_title).to eq 'The Olympics : a history.'
         end
-        it "title already ends with colon" do
+        it 'title already ends with colon' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -83,7 +83,7 @@ describe "title fields (searchworks.rb)" do
           expect(@smods_rec.sw_full_title).to eq 'The Olympics : a history.'
         end #
         # "end subtitle with period" - see above
-        it "subtitle already ends with period" do
+        it 'subtitle already ends with period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -93,7 +93,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_full_title).to eq 'The Olympics : a history.'
         end
-        it "subtitle already ends with other punctuation" do
+        it 'subtitle already ends with other punctuation' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -104,9 +104,9 @@ describe "title fields (searchworks.rb)" do
           expect(@smods_rec.sw_full_title).to eq 'The Olympics : a history?'
         end
       end # subtitle
-      context "partName" do
-        context "no partNumber" do
-          it "end partName with period" do
+      context 'partName' do
+        context 'no partNumber' do
+          it 'end partName with period' do
             m = "<mods #{@ns_decl}>
               <titleInfo>
                 <nonSort>The</nonSort>
@@ -124,7 +124,7 @@ describe "title fields (searchworks.rb)" do
             @smods_rec.from_str(m)
             expect(@smods_rec.sw_full_title).to eq 'cfb. Appendix.'
           end
-          it "partName already ends with period" do
+          it 'partName already ends with period' do
             m = "<mods #{@ns_decl}>
               <titleInfo>
                 <nonSort>The</nonSort>
@@ -143,8 +143,8 @@ describe "title fields (searchworks.rb)" do
             expect(@smods_rec.sw_full_title).to eq 'cfb. Appendix.'
           end
         end # no partNumber
-        context "partNumber" do
-          it "end partNumber with comma" do
+        context 'partNumber' do
+          it 'end partNumber with comma' do
             m = "<mods #{@ns_decl}>
               <titleInfo>
                 <nonSort>The</nonSort>
@@ -164,7 +164,7 @@ describe "title fields (searchworks.rb)" do
             @smods_rec.from_str(m)
             expect(@smods_rec.sw_full_title).to eq 'cfb. 1894, Appendix.'
           end
-          it "partNumber already ends with comma" do
+          it 'partNumber already ends with comma' do
             m = "<mods #{@ns_decl}>
               <titleInfo>
                 <nonSort>The</nonSort>
@@ -186,8 +186,8 @@ describe "title fields (searchworks.rb)" do
           end
         end
       end # partName
-      context "no partName, but partNumber" do
-        it "end partNumber with period" do
+      context 'no partName, but partNumber' do
+        it 'end partNumber with period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -205,7 +205,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_full_title).to eq 'cfb. 1894.'
         end
-        it "parNumber already ends in period" do
+        it 'parNumber already ends in period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -223,7 +223,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_full_title).to eq 'cfb. 1894.'
         end
-        it "partNumber already ends with other punctuation" do
+        it 'partNumber already ends with other punctuation' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -245,11 +245,10 @@ describe "title fields (searchworks.rb)" do
     end # punctuation
   end # sw_full_title
 
-  context "sw_title_display removes end punctuation of sw_full_title_display" do
-
+  context 'sw_title_display removes end punctuation of sw_full_title_display' do
     # title_display = custom, removeTrailingPunct(245abdefghijklmnopqrstuvwxyz, [\\\\,/;:], ([A-Za-z]{4}|[0-9]{3}|\\)|\\,))
     context "should remove trailing \,/;:." do
-      it "retains other trailing chars" do
+      it 'retains other trailing chars' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk?</title>
             </titleInfo></mods>"
@@ -261,42 +260,42 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Jerk!'
       end
-      it "removes trailing comma" do
+      it 'removes trailing comma' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk,</title>
             </titleInfo></mods>"
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Jerk'
       end
-      it "removes trailing semicolon" do
+      it 'removes trailing semicolon' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk;</title>
             </titleInfo></mods>"
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Jerk'
       end
-      it "removes trailing colon" do
+      it 'removes trailing colon' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk:</title>
             </titleInfo></mods>"
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Jerk'
       end
-      it "removes trailing slash" do
+      it 'removes trailing slash' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk /</title>
             </titleInfo></mods>"
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Jerk'
       end
-      it "removes trailing backslash" do
+      it 'removes trailing backslash' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk \</title>
             </titleInfo></mods>"
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Jerk'
       end
-      it "removes multiple trailing punctuation" do
+      it 'removes multiple trailing punctuation' do
         m = "<mods #{@ns_decl}><titleInfo>
               <title>The Jerk.,\</title>
             </titleInfo></mods>"
@@ -304,8 +303,8 @@ describe "title fields (searchworks.rb)" do
         expect(@smods_rec.sw_title_display).to eq 'The Jerk'
       end
     end
-    context "no subtitle" do
-      it "end title with a period" do
+    context 'no subtitle' do
+      it 'end title with a period' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -314,7 +313,7 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Olympics'
       end
-      it "title already ends in period" do
+      it 'title already ends in period' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -323,7 +322,7 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Olympics'
       end
-      it "title already ends in other punctuation" do
+      it 'title already ends in other punctuation' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -333,8 +332,8 @@ describe "title fields (searchworks.rb)" do
         expect(@smods_rec.sw_title_display).to eq 'The Olympics!'
       end
     end # no subtitle
-    context "subtitle" do
-      it "end title with a colon" do
+    context 'subtitle' do
+      it 'end title with a colon' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -344,7 +343,7 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Olympics : a history'
       end
-      it "title already ends with colon" do
+      it 'title already ends with colon' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -355,7 +354,7 @@ describe "title fields (searchworks.rb)" do
         expect(@smods_rec.sw_title_display).to eq 'The Olympics : a history'
       end #
       # "end subtitle with period" - see above
-      it "subtitle already ends with period" do
+      it 'subtitle already ends with period' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -365,7 +364,7 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'The Olympics : a history'
       end
-      it "subtitle already ends with other punctuation" do
+      it 'subtitle already ends with other punctuation' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -376,9 +375,9 @@ describe "title fields (searchworks.rb)" do
         expect(@smods_rec.sw_title_display).to eq 'The Olympics : a history?'
       end
     end # subtitle
-    context "partName" do
-      context "no partNumber" do
-        it "end partName with period" do
+    context 'partName' do
+      context 'no partNumber' do
+        it 'end partName with period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -396,7 +395,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_title_display).to eq 'cfb. Appendix'
         end
-        it "partName already ends with period" do
+        it 'partName already ends with period' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -415,8 +414,8 @@ describe "title fields (searchworks.rb)" do
           expect(@smods_rec.sw_title_display).to eq 'cfb. Appendix'
         end
       end # no partNumber
-      context "partNumber" do
-        it "end partNumber with comma" do
+      context 'partNumber' do
+        it 'end partNumber with comma' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -436,7 +435,7 @@ describe "title fields (searchworks.rb)" do
           @smods_rec.from_str(m)
           expect(@smods_rec.sw_title_display).to eq 'cfb. 1894, Appendix'
         end
-        it "partNumber already ends with comma" do
+        it 'partNumber already ends with comma' do
           m = "<mods #{@ns_decl}>
             <titleInfo>
               <nonSort>The</nonSort>
@@ -458,8 +457,8 @@ describe "title fields (searchworks.rb)" do
         end
       end
     end # partName
-    context "no partName, but partNumber" do
-      it "end partNumber with period" do
+    context 'no partName, but partNumber' do
+      it 'end partNumber with period' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -477,7 +476,7 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'cfb. 1894'
       end
-      it "parNumber already ends in period" do
+      it 'parNumber already ends in period' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -495,7 +494,7 @@ describe "title fields (searchworks.rb)" do
         @smods_rec.from_str(m)
         expect(@smods_rec.sw_title_display).to eq 'cfb. 1894'
       end
-      it "partNumber already ends with other punctuation" do
+      it 'partNumber already ends with other punctuation' do
         m = "<mods #{@ns_decl}>
           <titleInfo>
             <nonSort>The</nonSort>
@@ -516,7 +515,7 @@ describe "title fields (searchworks.rb)" do
     end # no partName but partNumber
   end # sw_title_display
 
-  context "additional titles (for title_variant_search)" do
+  context 'additional titles (for title_variant_search)' do
     before(:all) do
       m = "<mods #{@ns_decl}>
         <titleInfo type='alternative'><title>Alternative</title></titleInfo>
@@ -526,14 +525,14 @@ describe "title fields (searchworks.rb)" do
       @smods_rec.from_str(m)
       @addl_titles = @smods_rec.sw_addl_titles
     end
-    it "should not include the main title" do
+    it 'should not include the main title' do
       expect(@addl_titles.size).to eq 2
       expect(@addl_titles).not_to include(@smods_rec.sw_full_title)
     end
-    it "should include any extra main titles" do
+    it 'should include any extra main titles' do
       expect(@addl_titles).to include('Joke')
     end
-    it "should include all alternative titles" do
+    it 'should include all alternative titles' do
       expect(@addl_titles).to include('Alternative')
     end
     it 'should cope with regexp chars in the short title when determining addl titles' do
@@ -547,29 +546,34 @@ describe "title fields (searchworks.rb)" do
     end
   end
 
-  context "sort title" do
-    it "should be a String" do
+  context 'sort title' do
+    it 'should be a String' do
       expect(@smods_rec.sw_sort_title).to be_an_instance_of(String)
     end
-    it "should use the sw_full_title as a starting point" do
+    it 'should use the sw_full_title as a starting point' do
       expect(@smods_rec).to receive(:sw_full_title)
       @smods_rec.sw_sort_title
     end
-    it "should not begin or end with whitespace" do
+    it 'should not begin or end with whitespace' do
       m = "<mods #{@ns_decl}>
         <titleInfo><title>      Jerk     </title></titleInfo>
         </mods>"
       @smods_rec.from_str(m)
       expect(@smods_rec.sw_sort_title).to eq @smods_rec.sw_sort_title.strip
     end
-    it "should not have any punctuation marks" do
+    it 'should not have any punctuation marks' do
       r = Stanford::Mods::Record.new
       r.from_str "<mods #{@ns_decl}><titleInfo><title>J,e.r;;;k</title></titleInfo></mods>"
       expect(r.sw_sort_title).to match /^Jerk$/
     end
+    it 'should properly handle nonSort tags with metacharacters' do
+      r = Stanford::Mods::Record.new
+      r.from_str "<mods #{@ns_decl}><titleInfo><nonSort>[“</nonSort><title>In hat mappa lector... cum enim tota Chilensis regionus...”]</title></titleInfo></mods>"
+      expect(r.sw_sort_title).to match /^In hat mappa lector cum enim tota Chilensis regionus$/
+    end
   end
 
-  context "part number should be in full title and sort title", :jira => ['INDEX-31', 'GRYPHONDOR-372'] do
+  context 'part number should be in full title and sort title', jira: ['INDEX-31', 'GRYPHONDOR-372'] do
     before(:all) do
       @mccarthy_smods_rec = Stanford::Mods::Record.new
       mccarthy = "<mods #{@ns_decl}>
@@ -607,30 +611,29 @@ describe "title fields (searchworks.rb)" do
         </titleInfo></mods>"
       @all_smods_rec.from_str(all)
     end
-    it "short titles" do
+    it 'short titles' do
       expect(@mccarthy_smods_rec.sw_short_title).to eql 'McCarthy, John'
       expect(@insp_general_smods_rec.sw_short_title).to eql 'Semiannual report to Congress'
       expect(@cfb_smods_rec.sw_short_title).to eql 'cfb'
       expect(@all_smods_rec.sw_short_title).to eql 'The Olympics'
     end
-    it "full titles" do
+    it 'full titles' do
       expect(@mccarthy_smods_rec.sw_full_title).to eql 'McCarthy, John. Part 2.'
       expect(@insp_general_smods_rec.sw_full_title).to eql 'Semiannual report to Congress. October 1, 1998 - March 31, 1999.'
       expect(@cfb_smods_rec.sw_full_title).to eql 'cfb. 1894, Appendix.'
       expect(@all_smods_rec.sw_full_title).to eql 'The Olympics : a history. Part 1, Ancient.'
     end
-    it "additional titles" do
+    it 'additional titles' do
       expect(@mccarthy_smods_rec.sw_addl_titles).to eql []
       expect(@insp_general_smods_rec.sw_addl_titles).to eql []
       expect(@cfb_smods_rec.sw_addl_titles).to eql []
       expect(@all_smods_rec.sw_addl_titles).to eql []
     end
-    it "sort title" do
+    it 'sort title' do
       expect(@mccarthy_smods_rec.sw_sort_title).to eql 'McCarthy John Part 2'
       expect(@insp_general_smods_rec.sw_sort_title).to eql 'Semiannual report to Congress October 1 1998 March 31 1999'
       expect(@cfb_smods_rec.sw_sort_title).to eql 'cfb 1894 Appendix'
       expect(@all_smods_rec.sw_sort_title).to eql 'Olympics a history Part 1 Ancient'
     end
   end
-
 end

data/stanford-mods.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.summary       = "Stanford specific wrangling of MODS metadata"
   gem.homepage      = "https://github.com/sul-dlss/stanford-mods"
 
-  gem.extra_rdoc_files = ["LICENSE", "README.rdoc"]
+  gem.extra_rdoc_files = ["LICENSE", "README.md"]
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^spec/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stanford-mods
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Naomi Dushay
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mods
@@ -90,7 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.md
 files:
 - ".coveralls.yml"
 - ".gitignore"
@@ -99,7 +99,7 @@ files:
 - ".yardopts"
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - config/mappings_hash.rb
 - lib/stanford-mods.rb
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Stanford specific wrangling of MODS metadata

data/README.rdoc

@@ -1,85 +0,0 @@
-= 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://coveralls.io/repos/sul-dlss/stanford-mods/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/sul-dlss/stanford-mods] {<img src="https://gemnasium.com/sul-dlss/stanford-mods.png" alt="Dependency Status" />}[https://gemnasium.com/sul-dlss/stanford-mods] {<img src="https://badge.fury.io/rb/stanford-mods.svg" alt="Gem Version" />}[http://badge.fury.io/rb/stanford-mods]
-
-A Gem with Stanford specific wranglings of MODS (Metadata Object Description Schema) metadata from DOR, the Stanford Digital Object Repository.
-
-Source code at https://github.com/sul-dlss/stanford-mods/
-
-Generated API docs at  http://rubydoc.info/github/sul-dlss/stanford-mods/
-
-== Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'stanford-mods'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install stanford-mods
-
-== Usage
-
-1. add stanford-mods to your gemfile
-2. require 'stanford-mods'
-
-  > m = Stanford::Mods::Record.new
-  > m.from_str('<mods><genre>ape</genre></mods>')
-  > m.genre
-  => [#<Nokogiri::XML::Element:0x3fe07b48bb24 name="genre" children=[#<Nokogiri::XML::Text:0x3fe07a09a7dc "ape">]>]
-  > m.genre.text
-  => "ape"
-
-  > m.to_be_removed        <-- method I wrote in stanford-mods for proof of concept
-  in foo!
-  => nil
-
-Example Using SearchWorks Mixins:
-
-  > require 'stanford-mods/searchworks'
-  > m = Stanford::Mods::Record.new
-  > m.from_str('<mods><language><languageTerm authority="iso639-2b" type="code">dut</languageTerm></language></mods>')
-  > m.language_facet    <-- from Searchworks mixin
-  => ['Dutch']
-  > m.languages         <-- from mods gem
-  => ['Dutch; Flemish']
-
-== Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Write code and tests.
-4. Commit your changes (`git commit -am 'Added some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
-
-== Releases
-* <b>1.1.2</b> Corrected java Character.MAX_CODE_POINT value from \u{FFFF} to \u{10FFFF}
-* <b>1.1.1</b> Minor bug fixes
-* <b>1.1.0</b> Changed mechanism for determining dates for display only and for indexing, sorting, and faceting and removed deprecated pub_date_group method
-* <b>1.0.3</b> format_main value 'Article' is now 'Book'
-* <b>1.0.2</b> add format_main and sw_genre tests to searchworks.rb
-* <b>1.0.1</b> sw_title_display keeps appropriate trailing punct more or less per spec in solrmarc-sw sw_index.properties
-* <b>1.0.0</b> sw_full_title now includes partName and partNumber; sw_title_display created to be like sw_full_title but without trailing punctuation; sw format for typeOfResource sound recording; genre value is librettos, plural; sw format algorithm accommodates first letter upcase; genre value report does NOT map to a format, genre value 'project report' with ToR text is 'Book'
-* <b>0.0.27</b> add genres 'Issue brief', 'Book chapter' and 'Working paper' to map to searchworks format 'Book'
-* <b>0.0.26</b> map typeOfResource 'sound recording-musical' to searchworks format 'Music - Recording' with spaces
-* <b>0.0.25</b> map typeOfResource 'text' and genre 'report' to searchworks format 'Book'
-* <b>0.0.24</b> Largely cosmetic refactoring for easier maintenance.
-* <b>0.0.23</b> Added logic for dealing with "u-notation" approximate dates, e.g., 198u
-* <b>0.0.20</b> Added mapping for typeOfResource notated music
-* <b>0.0.19</b> Additional mappings, including Hydrus formats (GRYPHONDOR-207)
-* <b>0.0.11</b> escape regex special characters when using short title in a regex
-* <b>0.0.10</b> get rid of ignore_me files
-* <b>0.0.9</b> add sw_subject_names and sw_subject_titles methods to searchworks mixin
-* <b>0.0.8</b> require stanford-mods/searchworks in stanford-mods (top level)
-* <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
-* <b>0.0.3</b> began SearchWorks mixins with sw_access_facet and sw_language_facet
-* <b>0.0.2</b> add usage instructions to readme
-* <b>0.0.1</b> Initial commit - grab name