hydra-pbcore 2.2.3 → 2.3.0

data/README.md

@@ -48,6 +48,23 @@ validate against the PBCore XML v.2 schema.  Additionally, there are several tem
 to insert additional terms into your xml documents, such as contributors, publishers, as well as next and previous
 fields that specify which files come before and after one another in a multi-part born-digital video.
 
+### Dates
+
+Date fields in solr have to be in ISO8601 format, as opposed to text fields which may contain dates, but are treated differently.
+The difference is with the former, solr is treating the value of the field as an actual date, and as such, it can do time-based
+querying.  The latter, is just a string and solr would search it accordingly.  Currently, two types of date fields are provided:
+"_dt" for single-valued date fields, and "_dts" for multi-valued date fields.  Solr cannot sort on multi-valued date fields;
+otherwise, the two functionally identical.  By indexing your date fields as:
+
+    :index_as => [:displayable, :converted_date]
+    :index_as => [:displayable, :converted_multi_date]
+
+the content of your date fields will be converted to ISO8601 dates, and the original content will be preserved for display.
+So you could enter a date such as "2001" or "2004-10", and each will be stored for display as such, but will also be 
+indexed as a date in Solr with the value "2001-01-01T00:00:00Z" and "2004-10-01T00:00:00Z"
+
+Note: these functions will likely change with the upgrade to Solrizer 3.0.
+
 ## Testing
 
 To run all the rspec tests, use:

data/lib/hydra_pbcore/datastream/document.rb

@@ -120,7 +120,7 @@ class Document < ActiveFedora::OmDatastream
     )
     t.event_date(:path=>"pbcoreCoverage/coverage", 
       :attributes => {:annotation=>"Event Date"},
-      :index_as => [:not_searchable, :converted_date, :displayable]
+      :index_as => [:not_searchable, :converted_multi_date, :displayable]
     )
 
     # Creator names and roles

data/lib/hydra_pbcore/mapper.rb

@@ -3,7 +3,8 @@ class HydraPbcore::Mapper < Solrizer::FieldMapper
   id_field 'id'
   index_as :searchable do |t|
     t.default :suffix => '_t'
-    t.date    :suffix => '_dt'
+    t.date    :suffix => '_dt'  # single-valued solr date fields
+    t.dates   :suffix => '_dts' # multi-valued solr date fields
     t.string  :suffix => '_t'
     t.text    :suffix => '_t'
     t.symbol  :suffix => '_s'
@@ -22,6 +23,11 @@ class HydraPbcore::Mapper < Solrizer::FieldMapper
       pbcore_date(value)
     end
   end
+  index_as :converted_multi_date do |t|
+    t.default :suffix => '_dts' do |value|
+      pbcore_date(value)
+    end
+  end
 
   # We assume that all dates are in ISO 8601 format, but sometimes users may only
   # specify a year or a year and month.  This method adds a -01-01 or -01 respectively

data/lib/hydra_pbcore/version.rb

@@ -1,3 +1,3 @@
 module HydraPbcore
-  VERSION = "2.2.3"
+  VERSION = "2.3.0"
 end

data/spec/document_spec.rb

@@ -127,6 +127,7 @@ describe HydraPbcore::Datastream::Document do
       @object_ds.insert_contributor
       @object_ds.insert_place("inserted")
       @object_ds.insert_date("2012-11-11")
+      @object_ds.insert_date("2012-11-12")
 
       @object_ds.insert_relation("inserted", 'Archival Collection')
       @object_ds.insert_relation("inserted", 'Event Series')
@@ -169,11 +170,11 @@ describe HydraPbcore::Datastream::Document do
 
     describe "solr dates" do
       it "should be indexed for display" do
-        @object_ds.to_solr["event_date_display"].should == ["2012-11-11"]
+        @object_ds.to_solr["event_date_display"].should == ["2012-11-11", "2012-11-12"]
       end
 
       it "should be converted to ISO 8601" do
-        @object_ds.to_solr["event_date_dt"].should == ["2012-11-11T00:00:00Z"]
+        @object_ds.to_solr["event_date_dts"].should == ["2012-11-11T00:00:00Z", "2012-11-12T00:00:00Z"]
       end
 
       it "should not be searchable as strings" do
@@ -223,6 +224,13 @@ describe HydraPbcore::Datastream::Document do
       ds.to_solr["creator_name_facet"].should == ["foo"]
     end
 
+    it "should accept partial dates" do
+      ds = HydraPbcore::Datastream::Document.new(nil, nil)
+      ds.insert_date("2001")
+      ds.insert_date("2004-10")
+      ds.to_solr["event_date_dts"].should == ["2001-01-01T00:00:00Z", "2004-10-01T00:00:00Z"]
+    end
+
   end  
 
 end

data/spec/fixtures/document.xml

@@ -35,6 +35,10 @@
     <coverage annotation="Event Date">2012-11-11</coverage>
     <coverageType>Temporal</coverageType>
   </pbcoreCoverage>
+  <pbcoreCoverage>
+    <coverage annotation="Event Date">2012-11-12</coverage>
+    <coverageType>Temporal</coverageType>
+  </pbcoreCoverage>
   <pbcoreRelation>
     <pbcoreRelationType source="PBCore relationType" ref="http://pbcore.org/vocabularies/relationType#is-part-of">Is Part Of</pbcoreRelationType>
     <pbcoreRelationIdentifier annotation="Archival Collection">inserted</pbcoreRelationIdentifier>

data/spec/fixtures/document_solr.xml

@@ -212,17 +212,21 @@
   <pbcoreDescriptionDocument-0-event-place-display type="array">
     <pbcoreDescriptionDocument-0-event-place-display>inserted</pbcoreDescriptionDocument-0-event-place-display>
   </pbcoreDescriptionDocument-0-event-place-display>
-  <pbcoreDescriptionDocument-event-date-dt type="array">
+  <pbcoreDescriptionDocument-event-date-dts type="array">
     <pbcoreDescriptionDocument-event-date-dt>2012-11-11T00:00:00Z</pbcoreDescriptionDocument-event-date-dt>
-  </pbcoreDescriptionDocument-event-date-dt>
+    <pbcoreDescriptionDocument-event-date-dt>2012-11-12T00:00:00Z</pbcoreDescriptionDocument-event-date-dt>
+  </pbcoreDescriptionDocument-event-date-dts>
   <pbcoreDescriptionDocument-event-date-display type="array">
     <pbcoreDescriptionDocument-event-date-display>2012-11-11</pbcoreDescriptionDocument-event-date-display>
+    <pbcoreDescriptionDocument-event-date-display>2012-11-12</pbcoreDescriptionDocument-event-date-display>
   </pbcoreDescriptionDocument-event-date-display>
-  <pbcoreDescriptionDocument-0-event-date-dt type="array">
+  <pbcoreDescriptionDocument-0-event-date-dts type="array">
     <pbcoreDescriptionDocument-0-event-date-dt>2012-11-11T00:00:00Z</pbcoreDescriptionDocument-0-event-date-dt>
-  </pbcoreDescriptionDocument-0-event-date-dt>
+    <pbcoreDescriptionDocument-0-event-date-dt>2012-11-12T00:00:00Z</pbcoreDescriptionDocument-0-event-date-dt>
+  </pbcoreDescriptionDocument-0-event-date-dts>
   <pbcoreDescriptionDocument-0-event-date-display type="array">
     <pbcoreDescriptionDocument-0-event-date-display>2012-11-11</pbcoreDescriptionDocument-0-event-date-display>
+    <pbcoreDescriptionDocument-0-event-date-display>2012-11-12</pbcoreDescriptionDocument-0-event-date-display>
   </pbcoreDescriptionDocument-0-event-date-display>
   <pbcoreDescriptionDocument-note-t type="array">
     <pbcoreDescriptionDocument-note-t>inserted</pbcoreDescriptionDocument-note-t>
@@ -378,11 +382,13 @@
   <event-place-display type="array">
     <event-place-display>inserted</event-place-display>
   </event-place-display>
-  <event-date-dt type="array">
+  <event-date-dts type="array">
     <event-date-dt>2012-11-11T00:00:00Z</event-date-dt>
-  </event-date-dt>
+    <event-date-dt>2012-11-12T00:00:00Z</event-date-dt>
+  </event-date-dts>
   <event-date-display type="array">
     <event-date-display>2012-11-11</event-date-display>
+    <event-date-display>2012-11-12</event-date-display>
   </event-date-display>
   <contributor-name-t type="array">
     <contributor-name-t>inserted</contributor-name-t>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pbcore
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -217,12 +217,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3539419655098167212
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3539419655098167212
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23