stanford-mods 1.3.4 → 1.4.0

data/lib/stanford-mods/searchworks.rb

@@ -223,6 +223,7 @@ module Stanford
       #   http://searchworks-solr-lb.stanford.edu:8983/solr/select?facet.field=format&rows=0&facet.sort=index
       # @return <Array[String]> value in the SearchWorks controlled vocabulary
       # @deprecated - kept for backwards compatibility but not part of SW UI redesign work Summer 2014
+      # @deprecated:  this is no longer used in SW, Revs or Spotlight Jan 2016
       def format
         val = []
         types = self.term_values(:typeOfResource)

data/lib/stanford-mods/version.rb

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

data/spec/date_parsing_spec.rb

@@ -378,6 +378,15 @@ describe "date parsing methods" do
     '75 B.C.' => '-925',
     '8 B.C.' => '-992'
   }
+  bc_dates_to_int = {
+    '801 B.C.' => -801,
+    '800 B.C.' => -800,
+    '750 B.C.' => -750,
+    '700 B.C.' => -700,
+    '699 B.C.' => -699,
+    '75 B.C.' => -75,
+    '8 B.C.' => -8
+  }
 
   context '*facet_string_from_date_str' do
     it 'calls instance method facet_string_from_date_str' do
@@ -391,6 +400,12 @@ describe "date parsing methods" do
       Stanford::Mods::DateParsing.sortable_year_string_from_date_str('1666')
     end
   end
+  context '*year_int_from_date_str' do
+    it 'calls instance method year_int_from_date_str' do
+      expect_any_instance_of(Stanford::Mods::DateParsing).to receive(:year_int_from_date_str)
+      Stanford::Mods::DateParsing.year_int_from_date_str('1666')
+    end
+  end
 
   context '#facet_string_from_date_str' do
     single_year
@@ -442,7 +457,8 @@ describe "date parsing methods" do
     [ # bad dates
       '9999',
       '2035',
-      '0000-00-00'
+      '0000-00-00',
+      'uuuu'
     ].each do |example|
       it "nil for #{example}" do
         expect(Stanford::Mods::DateParsing.new(example).facet_string_from_date_str).to eq nil
@@ -450,6 +466,61 @@ describe "date parsing methods" do
     end
   end
 
+  context '#year_int_from_date_str' do
+    single_year
+      .merge(specific_month)
+      .merge(specific_day)
+      .merge(specific_day_2_digit_year)
+      .merge(bc_dates_to_int)
+      .merge(specific_day_ruby_parse_fail)
+      .merge(brackets_in_middle_of_year)
+      .merge(invalid_but_can_get_year).each do |example, expected|
+      it "#{expected} for single value #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).year_int_from_date_str).to eq expected.to_i
+      end
+    end
+
+    multiple_years
+      .merge(multiple_years_4_digits_once)
+      .merge(decade_only)
+      .merge(decade_only_4_digits).each do |example, expected|
+      it "#{expected.first} for multi-value #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).year_int_from_date_str).to eq expected.first.to_i
+      end
+    end
+
+    century_only.keys.each do |example|
+      it "1700 from #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).year_int_from_date_str).to eq 1700
+      end
+    end
+
+    early_numeric_dates.each do |example, _expected|
+      it "#{example} for #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).year_int_from_date_str).to eq example.to_i
+      end
+    end
+
+    it 'nil for -1666' do
+      skip("code broken for -yyyy dates but no existing data for this yet")
+      expect(Stanford::Mods::DateParsing.new('-1666').year_int_from_date_str).to eq nil
+    end
+    it '-1666 for 1666 B.C.' do
+      expect(Stanford::Mods::DateParsing.new('1666 B.C.').year_int_from_date_str).to eq(-1666)
+    end
+
+    [ # bad dates
+      '9999',
+      '2035',
+      '0000-00-00',
+      'uuuu'
+    ].each do |example|
+      it "nil for #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).year_int_from_date_str).to eq nil
+      end
+    end
+  end
+
   context '#sortable_year_string_from_date_str' do
     single_year
       .merge(specific_month)
@@ -491,7 +562,8 @@ describe "date parsing methods" do
     [ # bad dates
       '9999',
       '2035',
-      '0000-00-00'
+      '0000-00-00',
+      'uuuu'
     ].each do |example|
       it "nil for #{example}" do
         expect(Stanford::Mods::DateParsing.new(example).sortable_year_string_from_date_str).to eq nil
@@ -524,6 +596,33 @@ describe "date parsing methods" do
     end
   end
 
+  context '*year_int_valid?' do
+    { # example int as key, expected result as value
+      -1666 => false,
+      -999 => true,
+      -35 => true,
+      -3 => true,
+      0 => true,
+      5 => true,
+      33 => true,
+      150 => true,
+      (Date.today.year + 1) => true, # current year + 1
+      (Date.today.year + 2) => false, # current year + 2
+      9999 => false,
+      '165x' => false,
+      '198-' => false,
+      'random text' => false,
+      nil => false
+    }.each do |example, expected|
+        it "#{expected} for #{example}" do
+          expect(Stanford::Mods::DateParsing.year_int_valid?(example)).to eq expected
+        end
+    end
+    it 'true for 0000' do
+      expect(Stanford::Mods::DateParsing.year_int_valid?(0000)).to eq true
+    end
+  end
+
   context '#sortable_year_for_yyyy' do
     single_year
       .merge(specific_month)
@@ -640,10 +739,18 @@ describe "date parsing methods" do
     end
   end
 
-  context '#sortable_year_for_early_numeric' do
+  context '#sortable_year_int_for_early_numeric' do
+    early_numeric_dates.each do |example, _expected|
+      it "#{example} for #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).sortable_year_int_for_early_numeric).to eq example.to_i
+      end
+    end
+  end
+
+  context '#sortable_year_str_for_early_numeric' do
     early_numeric_dates.each do |example, expected|
       it "#{expected} for #{example}" do
-        expect(Stanford::Mods::DateParsing.new(example).sortable_year_for_early_numeric).to eq expected
+        expect(Stanford::Mods::DateParsing.new(example).sortable_year_str_for_early_numeric).to eq expected
       end
     end
   end
@@ -664,10 +771,18 @@ describe "date parsing methods" do
     end
   end
 
-  context '#sortable_year_for_bc' do
+  context '#sortable_year_int_for_bc' do
+    bc_dates_to_int.each do |example, expected|
+      it "#{expected} for #{example}" do
+        expect(Stanford::Mods::DateParsing.new(example).sortable_year_int_for_bc).to eq expected
+      end
+    end
+  end
+
+  context '#sortable_year_str_for_bc' do
     bc_dates.each do |example, expected|
       it "#{expected} for #{example}" do
-        expect(Stanford::Mods::DateParsing.new(example).sortable_year_for_bc).to eq expected
+        expect(Stanford::Mods::DateParsing.new(example).sortable_year_str_for_bc).to eq expected
       end
     end
   end

data/spec/origin_info_spec.rb

@@ -24,7 +24,7 @@ describe "computations from /originInfo field" do
           <dateCreated>1999</dateCreated>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym)).to eq '2005'
+      expect(smods_rec.send(method_sym)).to eq method_sym.to_s.match(/int/) ? 2005 : '2005'
     end
     it 'respects ignore_approximate param' do
       mods_str = mods_origin_info_start_str +
@@ -32,8 +32,8 @@ describe "computations from /originInfo field" do
         '<dateCreated point="end">1599</dateCreated>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, true)).to eq '1599'
-      expect(smods_rec.send(method_sym, false)).to eq '1000'
+      expect(smods_rec.send(method_sym, true)).to eq method_sym.to_s.match(/int/) ? 1599 : '1599'
+      expect(smods_rec.send(method_sym, false)).to eq method_sym.to_s.match(/int/) ? 1000 : '1000'
     end
     it 'nil if ignore_approximate and all dates are approximate' do
       mods_str = mods_origin_info_start_str +
@@ -42,7 +42,7 @@ describe "computations from /originInfo field" do
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
       expect(smods_rec.send(method_sym, true)).to eq nil
-      expect(smods_rec.send(method_sym, false)).to eq '1000'
+      expect(smods_rec.send(method_sym, false)).to eq method_sym.to_s.match(/int/) ? 1000 : '1000'
     end
     it 'respects ignore_approximate even for keyDate' do
       mods_str = mods_origin_info_start_str +
@@ -50,8 +50,8 @@ describe "computations from /originInfo field" do
         '<dateCreated point="end">1599</dateCreated>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, true)).to eq '1599'
-      expect(smods_rec.send(method_sym, false)).to eq '1000'
+      expect(smods_rec.send(method_sym, true)).to eq method_sym.to_s.match(/int/) ? 1599 : '1599'
+      expect(smods_rec.send(method_sym, false)).to eq method_sym.to_s.match(/int/) ? 1000 : '1000'
     end
     it 'uses dateCaptured if no dateIssued or dateCreated' do
       # for web archive seed files
@@ -60,16 +60,19 @@ describe "computations from /originInfo field" do
         '<dateCaptured encoding="w3cdtf" point="end">20151218111111</dateCaptured>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym)).to eq '2015'
+      expect(smods_rec.send(method_sym)).to eq method_sym.to_s.match(/int/) ? 2015 : '2015'
     end
     context 'spotlight actual data' do
       require 'fixtures/spotlight_pub_date_data'
       SPOTLIGHT_PUB_DATE_DATA.each_pair.each do |coll_name, coll_data|
-        coll_data.each_pair do |mods_str, exp_vals|
-          expected = exp_vals[exp_val_position]
-          it "#{expected} for rec in #{coll_name}" do
-            smods_rec.from_str(mods_str)
-            expect(smods_rec.send(method_sym)).to eq expected
+        # papyri - the only Spotlight data with BC dates
+        unless coll_name == 'papyri' && method_sym == :pub_year_int
+          coll_data.each_pair do |mods_str, exp_vals|
+            expected = exp_vals[exp_val_position]
+            it "#{expected} for rec in #{coll_name}" do
+              smods_rec.from_str(mods_str)
+              expect(smods_rec.send(method_sym)).to eq((method_sym.to_s.match(/int/) ? expected.to_i : expected)) if expected
+            end
           end
         end
       end
@@ -80,11 +83,34 @@ describe "computations from /originInfo field" do
     it_behaves_like "single pub date value", :pub_date_facet_single_value, 1
   end
 
-  context '#pub_date_sortable_string' do
-    it_behaves_like "single pub date value", :pub_date_sortable_string, 0
+  context '#pub_year_sort_str' do
+    it_behaves_like "single pub date value", :pub_year_sort_str, 0
   end
 
-  context '*earliest_date' do
+  context '#pub_year_int' do
+    it_behaves_like "single pub date value", :pub_year_int, 0
+    # papyri - the only Spotlight data with BC dates
+    it '-200 for 200 B.C.' do
+      # hd778hw9236
+      mods_str = mods_origin_info_start_str +
+        '<dateCreated encoding="w3cdtf" keyDate="yes" point="start" qualifier="approximate">200 B.C.</dateCreated>' +
+        '<dateCreated encoding="w3cdtf" keyDate="yes" point="end" qualifier="approximate">180 B.C.</dateCreated>' +
+        mods_origin_info_end_str
+      smods_rec.from_str(mods_str)
+      expect(smods_rec.pub_year_int).to eq(-200)
+    end
+    it '-211 for 211 B.C.' do
+      # ww728rz0477
+      mods_str = mods_origin_info_start_str +
+        '<dateCreated encoding="w3cdtf" keyDate="yes" point="start" qualifier="approximate">211 B.C.</dateCreated>' +
+        '<dateCreated encoding="w3cdtf" keyDate="yes" point="end" qualifier="approximate">150 B.C.</dateCreated>' +
+        mods_origin_info_end_str
+      smods_rec.from_str(mods_str)
+      expect(smods_rec.pub_year_int).to eq(-211)
+    end
+  end
+
+  context '*earliest_year_str' do
     it 'selects earliest (valid) parseable date from multiple options' do
       mods_str = mods_origin_info_start_str +
         '<dateIssued point="start" qualifier="questionable">1758</dateIssued>' +
@@ -92,7 +118,7 @@ describe "computations from /originInfo field" do
         '<dateIssued>1753]</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(Stanford::Mods::Record.earliest_date(smods_rec.date_issued_elements)).to eq ['1753', '1753]']
+      expect(Stanford::Mods::Record.earliest_year_str(smods_rec.date_issued_elements)).to eq ['1753', '1753]']
     end
     it 'ignores encoding' do
       # encoding matters for choosing display, not for parsing year
@@ -102,21 +128,21 @@ describe "computations from /originInfo field" do
         '<dateIssued encoding="w3cdtf">1300</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(Stanford::Mods::Record.earliest_date(smods_rec.date_issued_elements)).to eq ['1100', '1100']
+      expect(Stanford::Mods::Record.earliest_year_str(smods_rec.date_issued_elements)).to eq ['1100', '1100']
       mods_str = mods_origin_info_start_str +
         '<dateIssued>1200</dateIssued>' +
         '<dateIssued encoding="marc">1300</dateIssued>' +
         '<dateIssued encoding="w3cdtf">1100</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(Stanford::Mods::Record.earliest_date(smods_rec.date_issued_elements)).to eq ['1100', '1100']
+      expect(Stanford::Mods::Record.earliest_year_str(smods_rec.date_issued_elements)).to eq ['1100', '1100']
       mods_str = mods_origin_info_start_str +
         '<dateIssued>1300</dateIssued>' +
         '<dateIssued encoding="marc">1100</dateIssued>' +
         '<dateIssued encoding="w3cdtf">1200</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(Stanford::Mods::Record.earliest_date(smods_rec.date_issued_elements)).to eq ['1100', '1100']
+      expect(Stanford::Mods::Record.earliest_year_str(smods_rec.date_issued_elements)).to eq ['1100', '1100']
     end
     it 'calls DateParsing.sortable_year_string_from_date_str for each element value' do
       mods_str = mods_origin_info_start_str +
@@ -126,7 +152,7 @@ describe "computations from /originInfo field" do
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
       expect(Stanford::Mods::DateParsing).to receive(:sortable_year_string_from_date_str).exactly(3).times
-      Stanford::Mods::Record.earliest_date(smods_rec.date_issued_elements)
+      Stanford::Mods::Record.earliest_year_str(smods_rec.date_issued_elements)
     end
   end
 
@@ -137,7 +163,7 @@ describe "computations from /originInfo field" do
         '<dateIssued keyDate="yes">2014</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq '2014'
+      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq method_sym.to_s.match(/int/) ? 2014 : '2014'
     end
     it 'ignores invalid keyDate value' do
       mods_str = mods_origin_info_start_str +
@@ -145,25 +171,33 @@ describe "computations from /originInfo field" do
         '<dateIssued>1499</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq '1499'
+      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq method_sym.to_s.match(/int/) ? 1499 : '1499'
     end
-    it 'calls earliest_date if multiple keyDates present' do
+    it 'calls earliest_year_str if multiple keyDates present' do
       mods_str = mods_origin_info_start_str +
         '<dateCreated keyDate="yes">2003</dateCreated>' +
         '<dateCreated keyDate="yes">2001</dateCreated>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(Stanford::Mods::Record).to receive(:earliest_date).with(smods_rec.date_created_elements)
+      if method_sym.to_s.match(/int/)
+        expect(Stanford::Mods::Record).to receive(:earliest_year_int).with(smods_rec.date_created_elements)
+      else
+        expect(Stanford::Mods::Record).to receive(:earliest_year_str).with(smods_rec.date_created_elements)
+      end
       expect(smods_rec.send(method_sym, smods_rec.date_created_elements))
     end
-    it 'calls earliest_date if no keyDate' do
+    it 'calls earliest_year_str if no keyDate' do
       mods_str = mods_origin_info_start_str +
         '<dateIssued>1753]</dateIssued>' +
         '<dateIssued point="start" qualifier="questionable">1758</dateIssued>' +
         '<dateIssued point="end" qualifier="questionable">uuuu</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(Stanford::Mods::Record).to receive(:earliest_date).with(smods_rec.date_issued_elements)
+      if method_sym.to_s.match(/int/)
+        expect(Stanford::Mods::Record).to receive(:earliest_year_int).with(smods_rec.date_issued_elements)
+      else
+        expect(Stanford::Mods::Record).to receive(:earliest_year_str).with(smods_rec.date_issued_elements)
+      end
       smods_rec.send(method_sym, smods_rec.date_issued_elements)
     end
     it 'ignores encoding' do
@@ -174,43 +208,54 @@ describe "computations from /originInfo field" do
         '<dateIssued encoding="w3cdtf">1300</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq '1100'
+      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq method_sym.to_s.match(/int/) ? 1100 : '1100'
       mods_str = mods_origin_info_start_str +
         '<dateIssued>1200</dateIssued>' +
         '<dateIssued encoding="marc">1300</dateIssued>' +
         '<dateIssued encoding="w3cdtf" keyDate="yes">1100</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq '1100'
+      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq method_sym.to_s.match(/int/) ? 1100 : '1100'
       mods_str = mods_origin_info_start_str +
         '<dateIssued>1300</dateIssued>' +
         '<dateIssued encoding="marc" keyDate="yes">1100</dateIssued>' +
         '<dateIssued encoding="w3cdtf">1200</dateIssued>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq '1100'
+      expect(smods_rec.send(method_sym, smods_rec.date_issued_elements)).to eq method_sym.to_s.match(/int/) ? 1100 : '1100'
     end
   end
 
-  context '#pub_date_best_single_facet_value' do
-    it_behaves_like "pub date best single value", :pub_date_best_single_facet_value
+  context '#year_facet_str' do
+    it_behaves_like "pub date best single value", :year_facet_str
     it 'uses facet value, not sorting value' do
       mods_str = mods_origin_info_start_str +
         '<dateCreated keyDate="yes">180 B.C.</dateCreated>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(:pub_date_best_single_facet_value, smods_rec.date_created_elements)).to eq '180 B.C.'
+      expect(smods_rec.year_facet_str(smods_rec.date_created_elements)).to eq '180 B.C.'
     end
   end
 
-  context '#pub_date_best_sort_str_value' do
-    it_behaves_like "pub date best single value", :pub_date_best_sort_str_value
+  context '#year_sort_str' do
+    it_behaves_like "pub date best single value", :year_sort_str
     it 'uses string sorting value, not facet value' do
       mods_str = mods_origin_info_start_str +
         '<dateCreated keyDate="yes">180 B.C.</dateCreated>' +
         mods_origin_info_end_str
       smods_rec.from_str(mods_str)
-      expect(smods_rec.send(:pub_date_best_sort_str_value, smods_rec.date_created_elements)).to eq '-820'
+      expect(smods_rec.year_sort_str(smods_rec.date_created_elements)).to eq '-820'
+    end
+  end
+
+  context '#year_int' do
+    it_behaves_like "pub date best single value", :year_int
+    it 'uses integer sorting value, not string or facet value' do
+      mods_str = mods_origin_info_start_str +
+        '<dateCreated keyDate="yes">180 B.C.</dateCreated>' +
+        mods_origin_info_end_str
+      smods_rec.from_str(mods_str)
+      expect(smods_rec.year_int(smods_rec.date_created_elements)).to eq(-180)
     end
   end