hydra-pbcore 0.0.3 → 0.1.0

data/lib/custom_mapper.rb

@@ -1,11 +1,9 @@
 class Solrizer::FieldMapper::Default
 
   id_field 'id'
-  index_as :searchable, :default => true do |t|
+  index_as :searchable do |t|
     t.default :suffix => '_t'
-    t.date :suffix => '_dt' do |value|
-      DateTime.parse(pbcore_date(value)).to_time.utc.iso8601
-    end
+    t.date    :suffix => '_dt'
     t.string  :suffix => '_t'
     t.text    :suffix => '_t'
     t.symbol  :suffix => '_s'
@@ -19,6 +17,11 @@ class Solrizer::FieldMapper::Default
   index_as :facetable,            :suffix => '_facet'
   index_as :sortable,             :suffix => '_sort'
   index_as :unstemmed_searchable, :suffix => '_unstem_search'
+  index_as :converted_date do |t|
+    t.default :suffix => '_dt' 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
@@ -27,6 +30,7 @@ class Solrizer::FieldMapper::Default
   # NOTE: This only applies to the date as it is stored in solr.  The original value
   # as entered by the user is still maintained in the xml.
   def self.pbcore_date(date, value = String.new)
+    return date if date.empty?
     if date.match(/^[0-9]{4,4}$/)
       value = date + "-01-01"
     elsif date.match(/^[0-9]{4,4}-[0-9]{2,2}$/)
@@ -34,7 +38,7 @@ class Solrizer::FieldMapper::Default
     else 
       value = date  
     end
-    return value
+    return DateTime.parse(value).to_time.utc.iso8601
   end
 
 end

data/lib/hydra-pbcore/datastream/document.rb

@@ -108,8 +108,7 @@ class Document < ActiveFedora::NokogiriDatastream
     )
     t.event_date(:path=>"pbcoreCoverage/coverage", 
       :attributes => {:annotation=>"Event Date"},
-      :type => :date,
-      :index_as => [:searchable]
+      :index_as => [:not_searchable, :converted_date, :displayable]
     )
 
     # Contributor names and roles
@@ -174,7 +173,7 @@ class Document < ActiveFedora::NokogiriDatastream
       )
     end
     # Individual field names:
-    t.creation_date(:ref=>[:pbcoreInstantiation, :instantiationDate], :type => :date, :index_as => [:searchable])
+    t.creation_date(:ref=>[:pbcoreInstantiation, :instantiationDate], :index_as => [:not_searchable, :converted_date, :displayable])
     t.barcode(:ref=>[:pbcoreInstantiation, :instantiationIdentifier], :index_as => [:searchable, :displayable])
     t.repository(:ref=>[:pbcoreInstantiation, :instantiationLocation], :index_as => [:searchable, :displayable])
     t.format(:ref=>[:pbcoreInstantiation, :instantiationPhysical], :index_as => [:searchable, :facetable])

data/lib/hydra-pbcore/datastream/instantiation.rb

@@ -18,7 +18,7 @@ class Instantiation < ActiveFedora::NokogiriDatastream
         :index_as => [:displayable]
       )
       t.instantiationDate(:attributes=>{ :dateType=>"created" },
-        :index_as => [:displayable, :searchable]
+        :index_as => [:not_searchable, :converted_date, :displayable]
       )
       t.instantiationDigital(:attributes=>{ :source=>"EBU file formats" },
         :index_as => [:searchable, :facetable]

data/lib/hydra-pbcore/version.rb

@@ -1,3 +1,3 @@
 module HydraPbcore
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/custom_mapper_spec.rb

@@ -5,8 +5,12 @@ describe Solrizer::FieldMapper::Default do
   describe "#pbcore_date" do
 
     it "should return valid dates from only partial ones" do
-      Solrizer::FieldMapper::Default.pbcore_date('2003').should    == "2003-01-01"
-      Solrizer::FieldMapper::Default.pbcore_date('2009-07').should == "2009-07-01"
+      Solrizer::FieldMapper::Default.pbcore_date('2003').should    == "2003-01-01T00:00:00Z"
+      Solrizer::FieldMapper::Default.pbcore_date('2009-07').should == "2009-07-01T00:00:00Z"
+    end
+
+    it "should return empty strings and not dates" do
+      Solrizer::FieldMapper::Default.pbcore_date('').should be_empty
     end
 
   end

data/spec/digital_document_spec.rb

@@ -245,6 +245,17 @@ describe HydraPbcore::Datastream::DigitalDocument do
       EquivalentXml.equivalent?(ref_node, sample_node, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
     end
 
+    it "should display dates as they were entered" do
+      @object_ds.to_solr["event_date_display"].should    == ["2012-11-11"]
+    end
+
+    it "should have dates converted to ISO 8601" do
+      @object_ds.to_solr["event_date_dt"].should         == ["2012-11-11T00:00:00Z"]
+    end
+
+    it "should not index dates as text" do
+      @object_ds.to_solr["event_date_t"].should be_nil
+    end
 
   end
 

data/spec/document_spec.rb

@@ -257,7 +257,7 @@ describe HydraPbcore::Datastream::Document do
 
       # Use ISO 8601 dates
       @object_ds.event_date    = "2012-11-11"
-      @object_ds.creation_date = "2012-11-11"
+      @object_ds.creation_date = "2012"
     end
 
     it "should match an exmplar" do
@@ -277,11 +277,20 @@ describe HydraPbcore::Datastream::Document do
       EquivalentXml.equivalent?(ref_node, sample_node, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
     end
 
-    it "should use specific solr fields based on type" do
-      @object_ds.to_solr["creation_date_dt"].should == ["2012-11-11T00:00:00Z"]
-      @object_ds.to_solr["event_date_dt"].should    == ["2012-11-11T00:00:00Z"]
+    it "should display dates as they were entered" do
+      @object_ds.to_solr["creation_date_display"].should == ["2012"]
+      @object_ds.to_solr["event_date_display"].should    == ["2012-11-11"]
     end
 
+    it "should have dates converted to ISO 8601" do
+      @object_ds.to_solr["creation_date_dt"].should      == ["2012-01-01T00:00:00Z"]
+      @object_ds.to_solr["event_date_dt"].should         == ["2012-11-11T00:00:00Z"]
+    end
+
+    it "should not index dates as text" do
+      @object_ds.to_solr["creation_date_t"].should be_nil
+      @object_ds.to_solr["event_date_t"].should be_nil
+    end
 
   end
 

data/spec/fixtures/pbcore_solr_digital_document_template.xml

@@ -259,9 +259,15 @@
   <pbcoreDescriptionDocument-event-date-dt type="array">
     <pbcoreDescriptionDocument-event-date-dt>2012-11-11T00:00:00Z</pbcoreDescriptionDocument-event-date-dt>
   </pbcoreDescriptionDocument-event-date-dt>
+  <pbcoreDescriptionDocument-event-date-display type="array">
+    <pbcoreDescriptionDocument-event-date-display>2012-11-11</pbcoreDescriptionDocument-event-date-display>
+  </pbcoreDescriptionDocument-event-date-display>
   <pbcoreDescriptionDocument-0-event-date-dt 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-display type="array">
+    <pbcoreDescriptionDocument-0-event-date-display>2012-11-11</pbcoreDescriptionDocument-0-event-date-display>
+  </pbcoreDescriptionDocument-0-event-date-display>
   <pbcoreDescriptionDocument-contributor-name-t type="array">
     <pbcoreDescriptionDocument-contributor-name-t>contributor_name</pbcoreDescriptionDocument-contributor-name-t>
     <pbcoreDescriptionDocument-contributor-name-t>contributor_name</pbcoreDescriptionDocument-contributor-name-t>
@@ -529,6 +535,9 @@
   <event-date-dt type="array">
     <event-date-dt>2012-11-11T00:00:00Z</event-date-dt>
   </event-date-dt>
+  <event-date-display type="array">
+    <event-date-display>2012-11-11</event-date-display>
+  </event-date-display>
   <contributor-name-t type="array">
     <contributor-name-t>contributor_name</contributor-name-t>
     <contributor-name-t>contributor_name</contributor-name-t>

data/spec/fixtures/pbcore_solr_document_template.xml

@@ -259,9 +259,15 @@
   <pbcoreDescriptionDocument-event-date-dt type="array">
     <pbcoreDescriptionDocument-event-date-dt>2012-11-11T00:00:00Z</pbcoreDescriptionDocument-event-date-dt>
   </pbcoreDescriptionDocument-event-date-dt>
+  <pbcoreDescriptionDocument-event-date-display type="array">
+    <pbcoreDescriptionDocument-event-date-display>2012-11-11</pbcoreDescriptionDocument-event-date-display>
+  </pbcoreDescriptionDocument-event-date-display>
   <pbcoreDescriptionDocument-0-event-date-dt 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-display type="array">
+    <pbcoreDescriptionDocument-0-event-date-display>2012-11-11</pbcoreDescriptionDocument-0-event-date-display>
+  </pbcoreDescriptionDocument-0-event-date-display>
   <pbcoreDescriptionDocument-contributor-name-t type="array">
     <pbcoreDescriptionDocument-contributor-name-t>contributor_name</pbcoreDescriptionDocument-contributor-name-t>
     <pbcoreDescriptionDocument-contributor-name-t>contributor_name</pbcoreDescriptionDocument-contributor-name-t>
@@ -529,6 +535,9 @@
   <event-date-dt type="array">
     <event-date-dt>2012-11-11T00:00:00Z</event-date-dt>
   </event-date-dt>
+  <event-date-display type="array">
+    <event-date-display>2012-11-11</event-date-display>
+  </event-date-display>
   <contributor-name-t type="array">
     <contributor-name-t>contributor_name</contributor-name-t>
     <contributor-name-t>contributor_name</contributor-name-t>
@@ -597,8 +606,11 @@
     <pbcoreInstantiation-0-inst-clean-note-display>inserted</pbcoreInstantiation-0-inst-clean-note-display>
   </pbcoreInstantiation-0-inst-clean-note-display>
   <creation-date-dt type="array">
-    <creation-date-dt>2012-11-11T00:00:00Z</creation-date-dt>
+    <creation-date-dt>2012-01-01T00:00:00Z</creation-date-dt>
   </creation-date-dt>
+  <creation-date-display type="array">
+    <creation-date-display>2012</creation-date-display>
+  </creation-date-display>
   <barcode-t type="array">
     <barcode-t>barcode</barcode-t>
   </barcode-t>

data/spec/fixtures/pbcore_solr_instantiation_template.xml

@@ -12,18 +12,18 @@
   <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationIdentifier-t type="array">
     <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationIdentifier-t>name</pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationIdentifier-t>
   </pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationIdentifier-t>
+  <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-dt type="array">
+    <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-dt>2012-11-01T00:00:00Z</pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-dt>
+  </pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-dt>
   <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-display type="array">
-    <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-display>date</pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-display>
+    <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-display>2012-11</pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-display>
   </pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-display>
-  <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-t type="array">
-    <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-t>date</pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-t>
-  </pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDate-t>
+  <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-dt type="array">
+    <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-dt>2012-11-01T00:00:00Z</pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-dt>
+  </pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-dt>
   <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-display type="array">
-    <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-display>date</pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-display>
+    <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-display>2012-11</pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-display>
   </pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-display>
-  <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-t type="array">
-    <pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-t>date</pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-t>
-  </pbcoreDescriptionDocument-0-pbcoreInstantiation-0-instantiationDate-t>
   <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDigital-t type="array">
     <pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDigital-t>file_format</pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDigital-t>
   </pbcoreDescriptionDocument-pbcoreInstantiation-instantiationDigital-t>
@@ -520,18 +520,18 @@
   <pbcoreDescriptionDocument-0-location-t type="array">
     <pbcoreDescriptionDocument-0-location-t>location</pbcoreDescriptionDocument-0-location-t>
   </pbcoreDescriptionDocument-0-location-t>
+  <pbcoreDescriptionDocument-date-dt type="array">
+    <pbcoreDescriptionDocument-date-dt>2012-11-01T00:00:00Z</pbcoreDescriptionDocument-date-dt>
+  </pbcoreDescriptionDocument-date-dt>
   <pbcoreDescriptionDocument-date-display type="array">
-    <pbcoreDescriptionDocument-date-display>date</pbcoreDescriptionDocument-date-display>
+    <pbcoreDescriptionDocument-date-display>2012-11</pbcoreDescriptionDocument-date-display>
   </pbcoreDescriptionDocument-date-display>
-  <pbcoreDescriptionDocument-date-t type="array">
-    <pbcoreDescriptionDocument-date-t>date</pbcoreDescriptionDocument-date-t>
-  </pbcoreDescriptionDocument-date-t>
+  <pbcoreDescriptionDocument-0-date-dt type="array">
+    <pbcoreDescriptionDocument-0-date-dt>2012-11-01T00:00:00Z</pbcoreDescriptionDocument-0-date-dt>
+  </pbcoreDescriptionDocument-0-date-dt>
   <pbcoreDescriptionDocument-0-date-display type="array">
-    <pbcoreDescriptionDocument-0-date-display>date</pbcoreDescriptionDocument-0-date-display>
+    <pbcoreDescriptionDocument-0-date-display>2012-11</pbcoreDescriptionDocument-0-date-display>
   </pbcoreDescriptionDocument-0-date-display>
-  <pbcoreDescriptionDocument-0-date-t type="array">
-    <pbcoreDescriptionDocument-0-date-t>date</pbcoreDescriptionDocument-0-date-t>
-  </pbcoreDescriptionDocument-0-date-t>
   <pbcoreDescriptionDocument-generation-display type="array">
     <pbcoreDescriptionDocument-generation-display>generation</pbcoreDescriptionDocument-generation-display>
   </pbcoreDescriptionDocument-generation-display>
@@ -832,18 +832,18 @@
   <pbcoreInstantiation-0-instantiationIdentifier-t type="array">
     <pbcoreInstantiation-0-instantiationIdentifier-t>name</pbcoreInstantiation-0-instantiationIdentifier-t>
   </pbcoreInstantiation-0-instantiationIdentifier-t>
+  <pbcoreInstantiation-instantiationDate-dt type="array">
+    <pbcoreInstantiation-instantiationDate-dt>2012-11-01T00:00:00Z</pbcoreInstantiation-instantiationDate-dt>
+  </pbcoreInstantiation-instantiationDate-dt>
   <pbcoreInstantiation-instantiationDate-display type="array">
-    <pbcoreInstantiation-instantiationDate-display>date</pbcoreInstantiation-instantiationDate-display>
+    <pbcoreInstantiation-instantiationDate-display>2012-11</pbcoreInstantiation-instantiationDate-display>
   </pbcoreInstantiation-instantiationDate-display>
-  <pbcoreInstantiation-instantiationDate-t type="array">
-    <pbcoreInstantiation-instantiationDate-t>date</pbcoreInstantiation-instantiationDate-t>
-  </pbcoreInstantiation-instantiationDate-t>
+  <pbcoreInstantiation-0-instantiationDate-dt type="array">
+    <pbcoreInstantiation-0-instantiationDate-dt>2012-11-01T00:00:00Z</pbcoreInstantiation-0-instantiationDate-dt>
+  </pbcoreInstantiation-0-instantiationDate-dt>
   <pbcoreInstantiation-0-instantiationDate-display type="array">
-    <pbcoreInstantiation-0-instantiationDate-display>date</pbcoreInstantiation-0-instantiationDate-display>
+    <pbcoreInstantiation-0-instantiationDate-display>2012-11</pbcoreInstantiation-0-instantiationDate-display>
   </pbcoreInstantiation-0-instantiationDate-display>
-  <pbcoreInstantiation-0-instantiationDate-t type="array">
-    <pbcoreInstantiation-0-instantiationDate-t>date</pbcoreInstantiation-0-instantiationDate-t>
-  </pbcoreInstantiation-0-instantiationDate-t>
   <pbcoreInstantiation-instantiationDigital-t type="array">
     <pbcoreInstantiation-instantiationDigital-t>file_format</pbcoreInstantiation-instantiationDigital-t>
   </pbcoreInstantiation-instantiationDigital-t>
@@ -1328,12 +1328,12 @@
   <location-t type="array">
     <location-t>location</location-t>
   </location-t>
+  <date-dt type="array">
+    <date-dt>2012-11-01T00:00:00Z</date-dt>
+  </date-dt>
   <date-display type="array">
-    <date-display>date</date-display>
+    <date-display>2012-11</date-display>
   </date-display>
-  <date-t type="array">
-    <date-t>date</date-t>
-  </date-t>
   <generation-display type="array">
     <generation-display>generation</generation-display>
   </generation-display>

data/spec/instantiation_spec.rb

@@ -135,7 +135,6 @@ describe HydraPbcore::Datastream::Instantiation do
       [
         "name",
         "location",
-        "date",
         "generation",
         "media_type",
         "file_format",
@@ -176,6 +175,9 @@ describe HydraPbcore::Datastream::Instantiation do
       ].each do |field|
         @object_ds.send("#{field}=".to_sym, field)
       end
+
+      # Use a real date
+       @object_ds.date = "2012-11"
     end
 
     it "should match an exmplar" do
@@ -195,8 +197,18 @@ describe HydraPbcore::Datastream::Instantiation do
       EquivalentXml.equivalent?(ref_node, sample_node, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
     end
 
+    it "should display dates as they were entered" do
+      @object_ds.to_solr["date_display"].should == ["2012-11"]
+    end
 
-  end
+    it "should have dates converted to ISO 8601" do
+      @object_ds.to_solr["date_dt"].should == ["2012-11-01T00:00:00Z"]
+    end
 
+    it "should not index dates as text" do
+      @object_ds.to_solr["date_t"].should be_nil
+    end
+
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pbcore
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors: