hydra-pbcore 1.0.0 → 1.1.0

data/spec/deprecated/instantiation_spec.rb

@@ -0,0 +1,214 @@
+require "spec_helper"
+
+describe HydraPbcore::Datastream::Deprecated::Instantiation do
+
+  before(:each) do
+    @object_ds = HydraPbcore::Datastream::Deprecated::Instantiation.new(nil, nil)
+  end
+
+  describe ".update_indexed_attributes" do
+    it "should update all of the fields in #xml_template and fields not requiring additional inserted nodes" do
+      [
+        [:name],
+        [:location],
+        [:date],
+        [:generation],
+        [:media_type],
+        [:file_format],
+        [:size],
+        [:size_units],
+        [:colors],
+        [:duration],
+        [:rights_summary],
+        [:note],
+        [:checksum_type],
+        [:checksum_value],
+        [:device],
+        [:capture_soft],
+        [:trans_soft],
+        [:operator],
+        [:trans_note],
+        [:vendor],
+        [:condition],
+        [:cleaning],
+        [:color_space],
+        [:chroma],
+        [:video_standard],
+        [:video_encoding],
+        [:video_bit_rate],
+        [:video_bit_rate_units],
+        [:frame_rate],
+        [:frame_size],
+        [:video_bit_depth],
+        [:aspect_ratio],
+        [:audio_standard],
+        [:audio_encoding],
+        [:audio_bit_rate],
+        [:audio_bit_rate_units],
+        [:audio_sample_rate],
+        [:audio_sample_rate_units],
+        [:audio_bit_depth],
+        [:audio_channels],
+      ].each do |pointer|
+        test_val = "#{pointer.last.to_s} value"
+        @object_ds.update_indexed_attributes( {pointer=>{"0"=>test_val}} )
+        @object_ds.get_values(pointer).first.should == test_val
+        @object_ds.get_values(pointer).length.should == 1
+      end
+    end
+  end
+
+  describe "default fields" do
+
+    it "like media type should be 'Moving image'" do
+      @object_ds.get_values([:media_type]).first.should == "Moving image"
+    end
+
+    it "like colors should be 'Color'" do
+      @object_ds.get_values([:colors]).first.should == "Color"
+    end
+
+  end
+
+  describe "#xml_template" do
+    it "should return an empty xml document matching an exmplar" do
+
+      # insert optional fields
+      @object_ds.update_indexed_attributes({ [:checksum_type] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:note] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:checksum_value] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:device] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:capture_soft] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:trans_soft] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:operator] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:trans_note] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:vendor] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:condition] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:cleaning] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:color_space] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:chroma] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:standard] => { 0 => "inserted" }} )
+      @object_ds.update_indexed_attributes({ [:language] => { 0 => "inserted" }} )
+
+      # insert optional nodes using sample values
+      @object_ds.insert_next("inserted")
+      @object_ds.insert_previous("inserted")
+
+      # Load example deprecated_fixture
+      f = deprecated_fixture "pbcore_instantiation_template.xml"
+      ref_node = Nokogiri::XML(f)
+      f.close
+
+      # Nokogiri-fy our sample document and add in namespace
+      sample_node = Nokogiri::XML(@object_ds.to_xml)
+      with_namespace = HydraPbcore::Behaviors.insert_pbcore_namespace(sample_node)
+
+      # Save this for later...
+      out = File.new("tmp/pbcore_instantiation_sample.xml", "w")
+      out.write(with_namespace.to_s)
+      out.close
+
+      EquivalentXml.equivalent?(ref_node, with_namespace, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
+
+      # TODO: reorder nodes on the instantiaion
+      #Rockhall::Pbcore.validate(with_namespace).should be_empty
+    end
+  end
+
+  describe "essence fields" do
+
+    it "shoud have different essenceTrackStandard nodes" do
+
+      # Standard
+      @object_ds.update_indexed_attributes({ [:video_standard] => { 0 => "video standard" }} )
+      @object_ds.update_indexed_attributes({ [:audio_standard] => { 0 => "audio standard" }} )
+      @object_ds.get_values([{:pbcoreInstantiation=>0}, {:instantiationEssenceTrack=>0}, :essenceTrackStandard]).first.should == "video standard"
+      @object_ds.get_values([{:pbcoreInstantiation=>0}, {:instantiationEssenceTrack=>1}, :essenceTrackStandard]).first.should == "audio standard"
+
+    end
+
+  end
+
+  describe ".to_solr" do
+
+    before(:each) do
+      [
+        "name",
+        "location",
+        "generation",
+        "media_type",
+        "file_format",
+        "size",
+        "size_units",
+        "colors",
+        "duration",
+        "rights_summary",
+        "note",
+        "checksum_type",
+        "checksum_value",
+        "device",
+        "capture_soft",
+        "trans_soft",
+        "operator",
+        "trans_note",
+        "vendor",
+        "condition",
+        "cleaning",
+        "color_space",
+        "chroma",
+        "video_standard",
+        "video_encoding",
+        "video_bit_rate",
+        "video_bit_rate_units",
+        "frame_rate",
+        "frame_size",
+        "video_bit_depth",
+        "aspect_ratio",
+        "audio_standard",
+        "audio_encoding",
+        "audio_bit_rate",
+        "audio_bit_rate_units",
+        "audio_sample_rate",
+        "audio_sample_rate_units",
+        "audio_bit_depth",
+        "audio_channels"
+      ].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
+      # Load example deprecated_fixture
+      f = deprecated_fixture "pbcore_solr_instantiation_template.xml"
+      ref_node = Nokogiri::XML(f)
+      f.close
+
+      # Nokogiri-fy our sample document
+      sample_node = Nokogiri::XML(@object_ds.to_solr.to_xml)
+
+      # Save this for later...
+      out = File.new("tmp/pbcore_solr_instantation_sample.xml", "w")
+      out.write(sample_node.to_s)
+      out.close
+
+      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
+
+    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

data/spec/document_spec.rb

@@ -6,8 +6,15 @@ describe HydraPbcore::Datastream::Document do
     @object_ds = HydraPbcore::Datastream::Document.new(nil, nil)
   end
 
-  describe ".update_indexed_attributes" do
-    it "should update all of the fields in #xml_template and fields not requiring additional inserted nodes" do
+  describe "::xml_template" do
+    it "should match an exmplar" do
+      save_template @object_ds.to_xml, "document_template.xml"
+      equivalent_xml_files("document_template.xml").should be_true
+    end
+  end
+
+  describe "#update_indexed_attributes" do
+    it "should update the intitial fields" do
       [
         [:pbc_id],
         [:main_title],
@@ -28,36 +35,25 @@ describe HydraPbcore::Datastream::Document do
         [:lc_genre],
         [:lc_subject_genre],
         [:event_series],
-        [:event_place],
         [:contributor_name],
         [:contributor_role],
         [:publisher_name],
         [:publisher_role],
         [:note],
-        [:barcode],
-        [:repository],
-        [:format],
-        [:standard],
-        [:media_type],
-        [:generation],
-        [:language],
-        [:colors],
+        [:rights_summary],
         [:archival_collection],
         [:archival_series],
         [:collection_number],
         [:accession_number],
-        [:usage],
-        [:condition_note],
-        [:cleaning_note]
       ].each do |pointer|
-        test_val = "#{pointer.last.to_s} value"
+        test_val = random_string
         @object_ds.update_values( {pointer=>{"0"=>test_val}} )
         @object_ds.get_values(pointer).first.should == test_val
         @object_ds.get_values(pointer).length.should == 1
       end
     end
 
-    it "should work for fields that require added xml nodes" do
+    it "should update fields requiring inserted nodes" do
       @object_ds.insert_publisher
       @object_ds.insert_contributor
       [
@@ -86,74 +82,9 @@ describe HydraPbcore::Datastream::Document do
       @object_ds.get_values(:contributor_role)[0].should == "first contributor role"
       @object_ds.get_values(:contributor_role)[1].should == "second contributor role"
     end
-
-  end
-
-  describe "#xml_template" do
-    it "should return an empty xml document matching a valid exmplar" do
-      # insert additional nodes
-      @object_ds.insert_publisher("inserted", "inserted")
-      @object_ds.insert_contributor("inserted", "inserted")
-      @object_ds.insert_publisher("inserted")
-      @object_ds.insert_contributor("inserted")
-      @object_ds.insert_contributor
-
-      # update additional nodes that OM will insert automatically
-      @object_ds.update_indexed_attributes({ [:alternative_title] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:chapter] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:episode] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:label] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:segment] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:subtitle] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:track] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:translation] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_subject] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_name] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:rh_subject] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:getty_genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_subject_genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:subject] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:condition_note] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:cleaning_note] => { 0 => "inserted" }} )
-
-      # Load example fixture
-      f = fixture "pbcore_document_template.xml"
-      ref_node = Nokogiri::XML(f)
-      f.close
-
-      # Nokogiri-fy our sample document and reorder nodes
-      sample_node = Nokogiri::XML(@object_ds.to_xml)
-      reordered = HydraPbcore::Behaviors.reorder_document(sample_node)
-
-      # Save this for later...
-      out = File.new("tmp/pbcore_document_sample.xml", "w")
-      out.write(reordered.to_s)
-      out.close
-
-      EquivalentXml.equivalent?(ref_node, reordered, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
-      HydraPbcore::Behaviors.validate(reordered).should be_empty
-
-    end
-  end
-
-  describe ".insert_node" do
-    
-    it "should return a node and index for a given template type" do
-      pending "Don't need?"
-      ["publisher", "contributor"].each do |type|
-        node, index = @object_ds.insert_node(type.to_s)
-        index.should == 0
-        @object_ds.dirty?.should be_true
-        node, index = @object_ds.insert_node(type.to_s)
-        index.should == 1
-      end
-    end
-
   end
 
-  describe ".remove_node" do
+  describe "#remove_node" do
     it "should remove a node a given type and index" do
       ["publisher", "contributor"].each do |type|
         @object_ds.send("insert_"+type)
@@ -165,133 +96,79 @@ describe HydraPbcore::Datastream::Document do
         @object_ds.find_by_terms(type.to_sym).count.should == 0
       end
     end
-
-  end
-
-  describe "default fields" do
-
-    it "such as media type should be 'Moving image'" do
-      @object_ds.get_values([:media_type]).first.should == "Moving image"
-    end
-
-    it "such as colors should be 'Color'" do
-      @object_ds.get_values([:colors]).first.should == "Color"
-    end
-
-    it "such as generation should be 'Original'" do
-      @object_ds.get_values([:generation]).first.should == "Original"
-    end
-
   end
 
-  describe ".to_solr" do
+  describe "sample" do
 
     before(:each) do
       # insert additional nodes
-      @object_ds.insert_publisher
+      @object_ds.insert_publisher("inserted", "inserted")
+      @object_ds.insert_contributor("inserted", "inserted")
+      @object_ds.insert_publisher("inserted")
+      @object_ds.insert_contributor("inserted")
       @object_ds.insert_contributor
-      [
-        "main_title",
-        "alternative_title",
-        "chapter",
-        "episode",
-        "label",
-        "segment",
-        "subtitle",
-        "track",
-        "translation",
-        "summary",
-        "parts_list",
-        "lc_subject",
-        "lc_name",
-        "rh_subject",
-        "getty_genre",
-        "lc_genre",
-        "lc_subject_genre",
-        "event_series",
-        "event_place",
-        "event_date",
-        "contributor_name",
-        "contributor_role",
-        "publisher_name",
-        "publisher_role",
-        "note",
-        "creation_date",
-        "barcode",
-        "repository",
-        "format",
-        "standard",
-        "media_type",
-        "generation",
-        "language",
-        "colors",
-        "archival_collection",
-        "archival_series",
-        "collection_number",
-        "accession_number",
-        "usage",
-        "condition_note",
-        "cleaning_note"
-      ].each do |field|
-        @object_ds.send("#{field}=".to_sym, field)
-      end
-      # update additional nodes that OM will insert automatically
-      @object_ds.update_indexed_attributes({ [:alternative_title] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:chapter] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:episode] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:label] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:segment] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:subtitle] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:track] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:translation] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_subject] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_name] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:rh_subject] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:getty_genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:lc_subject_genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:subject] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:genre] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:condition_note] => { 0 => "inserted" }} )
-      @object_ds.update_indexed_attributes({ [:cleaning_note] => { 0 => "inserted" }} )
-
-      # Use ISO 8601 dates
-      @object_ds.event_date    = "2012-11-11"
-      @object_ds.creation_date = "2012"
+      @object_ds.insert_place("inserted")
+      @object_ds.insert_date("2012-11-11")
+
+      @object_ds.pbc_id               = "inserted"
+      @object_ds.main_title           = "inserted"
+      @object_ds.alternative_title    = "inserted"
+      @object_ds.chapter              = "inserted"
+      @object_ds.episode              = "inserted"
+      @object_ds.label                = "inserted"
+      @object_ds.segment              = "inserted"
+      @object_ds.subtitle             = "inserted"
+      @object_ds.track                = "inserted"
+      @object_ds.translation          = "inserted"
+      @object_ds.summary              = "inserted"
+      @object_ds.parts_list           = "inserted"
+      @object_ds.lc_subject           = "inserted"
+      @object_ds.lc_name              = "inserted"
+      @object_ds.rh_subject           = "inserted"
+      @object_ds.getty_genre          = "inserted"
+      @object_ds.lc_genre             = "inserted"
+      @object_ds.lc_subject_genre     = "inserted"
+      @object_ds.event_series         = "inserted"
+      @object_ds.contributor_name     = "inserted"
+      @object_ds.contributor_role     = "inserted"
+      @object_ds.publisher_name       = "inserted"
+      @object_ds.publisher_role       = "inserted"
+      @object_ds.note                 = "inserted"
+      @object_ds.rights_summary       = "inserted"
+      @object_ds.archival_collection  = "inserted"
+      @object_ds.archival_series      = "inserted"
+      @object_ds.collection_number    = "inserted"
+      @object_ds.accession_number     = "inserted"
     end
 
-    it "should match an exmplar" do
-      # Load example fixture
-      f = fixture "pbcore_solr_document_template.xml"
-      ref_node = Nokogiri::XML(f)
-      f.close
-
-      # Nokogiri-fy our sample document
-      sample_node = Nokogiri::XML(@object_ds.to_solr.to_xml)
+    it "solr document should match an exmplar" do
+      save_template @object_ds.to_solr.to_xml, "document_solr.xml"
+      equivalent_xml_files("document_solr.xml").should be_true
+    end
 
-      # Save this for later...
-      out = File.new("tmp/pbcore_solr_document_sample.xml", "w")
-      out.write(sample_node.to_s)
-      out.close
+    describe "solr dates" do
+      it "should be indexed for display" do
+        @object_ds.to_solr["event_date_display"].should == ["2012-11-11"]
+      end
 
-      EquivalentXml.equivalent?(ref_node, sample_node, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
-    end
+      it "should be converted to ISO 8601" do
+        @object_ds.to_solr["event_date_dt"].should == ["2012-11-11T00:00:00Z"]
+      end
 
-    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"]
+      it "should not be searchable as strings" do
+        @object_ds.to_solr["event_date_t"].should be_nil
+      end
     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"]
+    it "xml document should match an exmplar" do
+      save_template @object_ds.to_xml, "document.xml"
+      equivalent_xml_files("document.xml").should be_true
     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
+    it "xml document should validate against the PBCore schema" do
+      save_template @object_ds.to_pbcore_xml, "document_valid.xml"
+      @object_ds.valid?.should == []
     end
-
-  end
+  end  
 
 end