hydra-pbcore 1.0.0 → 1.1.0

data/spec/fixtures/physical_instantiation_template.xml

@@ -0,0 +1,18 @@
+<pbcoreInstantiation>
+  <instantiationIdentifier annotation="Barcode" source="Rock and Roll Hall of Fame and Museum"/>
+  <instantiationDate dateType="created"/>
+  <instantiationPhysical source="PBCore instantiationPhysical"/>
+  <instantiationStandard/>
+  <instantiationLocation>Rock and Roll Hall of Fame and Museum,
+2809 Woodland Ave.,
+Cleveland, OH, 44115
+216-515-1956
+library@rockhall.org</instantiationLocation>
+  <instantiationMediaType source="PBCore instantiationMediaType">Moving image</instantiationMediaType>
+  <instantiationGenerations source="PBCore instantiationGenerations">Original</instantiationGenerations>
+  <instantiationColors source="PBCore instantiationColors">Color</instantiationColors>
+  <instantiationLanguage source="ISO 639.2" ref="http://www.loc.gov/standards/iso639-2/php/code_list.php">eng</instantiationLanguage>
+  <instantiationRights>
+    <rightsSummary/>
+  </instantiationRights>
+</pbcoreInstantiation>

data/spec/instantiation_spec.rb

@@ -3,11 +3,20 @@ require "spec_helper"
 describe HydraPbcore::Datastream::Instantiation do
 
   before(:each) do
-    @object_ds = HydraPbcore::Datastream::Instantiation.new(nil, nil)
+    @digital  = HydraPbcore::Datastream::Instantiation.new(nil, nil)
+    @digital.define :digital
+    @physical = HydraPbcore::Datastream::Instantiation.new(nil, nil)
+    @physical.define :physical
   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 have a blank default xml template" do
+      HydraPbcore::Datastream::Instantiation.xml_template.text.should be_empty
+    end
+  end
+
+  describe "digital instantiaions" do
+    it "should have these fields defined" do
       [
         [:name],
         [:location],
@@ -50,165 +59,204 @@ describe HydraPbcore::Datastream::Instantiation do
         [: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
+        test_val = random_string
+        @digital.update_indexed_attributes( {pointer=>{"0"=>test_val}} )
+        @digital.get_values(pointer).first.should == test_val
+        @digital.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"
+    it "should have default values for fields" do
+      @digital.media_type.first.should == "Moving image"
+      @digital.colors.first.should == "Color"
     end
 
-    it "like colors should be 'Color'" do
-      @object_ds.get_values([:colors]).first.should == "Color"
+    it "should have a file format and no format" do
+      @digital.file_format.should == [""]
+      @digital.format.should      == []
     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" }} )
+    it "should match an exmplar with all fields shown" do
+      @digital.checksum_type  = "inserted"
+      @digital.note           = "inserted"
+      @digital.checksum_value = "inserted"
+      @digital.device         = "inserted"
+      @digital.capture_soft   = "inserted"
+      @digital.trans_soft     = "inserted"
+      @digital.operator       = "inserted"
+      @digital.trans_note     = "inserted"
+      @digital.vendor         = "inserted"
+      @digital.condition      = "inserted"
+      @digital.cleaning       = "inserted"
+      @digital.color_space    = "inserted"
+      @digital.chroma         = "inserted"
+      @digital.standard       = "inserted"
+      @digital.language       = "inserted"
 
       # insert optional nodes using sample values
-      @object_ds.insert_next("inserted")
-      @object_ds.insert_previous("inserted")
-
-      # Load example fixture
-      f = 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
+      @digital.insert_next("inserted")
+      @digital.insert_previous("inserted")
 
-      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
+      save_template @digital.to_xml, "digital_instantiation.xml"
+      equivalent_xml_files("digital_instantiation.xml").should be_true
     end
-  end
+ 
+    it "should have different essenceTrackStandard nodes" do
+      @digital.video_standard = "video standard"
+      @digital.audio_standard = "audio standard"
+      @digital.get_values([{:pbcoreInstantiation=>0}, {:instantiationEssenceTrack=>0}, :essenceTrackStandard]).first.should == "video standard"
+      @digital.get_values([{:pbcoreInstantiation=>0}, {:instantiationEssenceTrack=>1}, :essenceTrackStandard]).first.should == "audio standard"
+    end
+
+    describe "solr documents" 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|
+          @digital.send("#{field}=".to_sym, field)
+        end
+        # Use a real date
+        @digital.date = "2012-11"
+      end
 
-  describe "essence fields" do
+      it "should match an exmplar" do
+        save_template @digital.to_solr.to_xml, "digital_instantiation_solr.xml"
+        equivalent_xml_files("digital_instantiation_solr.xml").should be_true
+      end
 
-    it "shoud have different essenceTrackStandard nodes" do
+      it "should display dates as they were entered" do
+        @digital.to_solr["date_display"].should == ["2012-11"]
+      end
 
-      # 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"
+      it "should have dates converted to ISO 8601" do
+        @digital.to_solr["date_dt"].should == ["2012-11-01T00:00:00Z"]
+      end
 
+      it "should not index dates as text" do
+        @digital.to_solr["date_t"].should be_nil
+      end
     end
-
+  
   end
 
-  describe ".to_solr" do
-
-    before(:each) do
+  describe "physical instantiaions" do
+    it "should have these fields defined" 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)
+        [:date],
+        [:barcode],
+        [:location],
+        [:format],
+        [:standard],
+        [:media_type],
+        [:generation],
+        [:language],
+        [:colors],
+        [:rights_summary],
+        [:condition_note],
+        [:cleaning_note]        
+      ].each do |pointer|
+        test_val = random_string
+        @physical.update_indexed_attributes( {pointer=>{"0"=>test_val}} )
+        @physical.get_values(pointer).first.should == test_val
+        @physical.get_values(pointer).length.should == 1
       end
+    end
 
-      # Use a real date
-       @object_ds.date = "2012-11"
+    it "should have default values for fields" do
+      @physical.media_type.first.should == "Moving image"
+      @physical.colors.first.should == "Color"
     end
 
-    it "should match an exmplar" do
-      # Load example fixture
-      f = fixture "pbcore_solr_instantiation_template.xml"
-      ref_node = Nokogiri::XML(f)
-      f.close
+    it "should have a format and no file format" do
+      @physical.file_format.should == []
+      @physical.format.should      == [""]
+    end
 
-      # Nokogiri-fy our sample document
-      sample_node = Nokogiri::XML(@object_ds.to_solr.to_xml)
+    it "should match an exmplar with all fields shown" do
+      @physical.cleaning_note  = "inserted"
+      @physical.condition_note = "inserted"
+      save_template @physical.to_xml, "physical_instantiation.xml"
+      equivalent_xml_files("physical_instantiation.xml").should be_true
+    end
 
-      # Save this for later...
-      out = File.new("tmp/pbcore_solr_instantation_sample.xml", "w")
-      out.write(sample_node.to_s)
-      out.close
+    describe "solr documents" do
+      before :each do
+        [
+          "date",
+          "barcode",
+          "location",
+          "format",
+          "standard",
+          "media_type",
+          "generation",
+          "language",
+          "colors",
+          "rights_summary",
+          "condition_note",
+          "cleaning_note"
+        ].each do |field|
+          @physical.send("#{field}=".to_sym, field)
+        end
+        # Use a real date
+        @physical.date = "2012-11"
+      end
 
-      EquivalentXml.equivalent?(ref_node, sample_node, opts = { :element_order => false, :normalize_whitespace => true }).should be_true
-    end
+      it "should match an exmplar" do
+        save_template @physical.to_solr.to_xml, "physical_instantiation_solr.xml"
+        equivalent_xml_files("physical_instantiation_solr.xml").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 display dates as they were entered" do
+        @physical.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 have dates converted to ISO 8601" do
+        @physical.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
+      it "should not index dates as text" do
+        @physical.to_solr["date_t"].should be_nil
+      end
     end
 
   end
 
-end
+end

data/spec/integration/conversions_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe "Converting" do
+
+  before :all do
+    class FakeDocument
+      include HydraPbcore::Conversions
+    end
+    @fake = FakeDocument.new
+  end
+  
+  describe "HydraPbcore::Datastream::Deprecated::Document to HydraPbcore::Datastream::Document" do
+    it "should return a valid pbcore document" do
+      doc = HydraPbcore::Datastream::Deprecated::Document.from_xml(integration_fixture "document_rrhof_524.xml")
+      doc.to_document
+      save_template doc.to_xml, "converted_rrhof_524.xml"
+      equivalent_xml_files("converted_rrhof_524.xml").should be_true
+    end
+    it "should raise an error with the wrong class" do
+      lambda { @fake.to_document }.should raise_error
+    end
+  end
+
+  describe "HydraPbcore::Datastream::Deprecated::Document to HydraPbcore::Datastream::Instantiation" do
+    it "should return a physical instantation from an existing document" do
+      doc  = HydraPbcore::Datastream::Deprecated::Document.from_xml(integration_fixture "document_rrhof_524.xml")
+      inst = doc.to_physical_instantiation
+      inst.should be_kind_of HydraPbcore::Datastream::Instantiation
+      save_template inst.to_xml, "converted_rrhof_524_instantiation.xml"
+      equivalent_xml_files("converted_rrhof_524_instantiation.xml").should be_true
+    end
+    it "should raise an error with the wrong class" do
+      lambda { @fake.to_document }.should raise_error
+    end
+  end
+
+  describe "HydraPbcore::Datastream::Deprecated::Instantiation to HydraPbcore::Datastream::Instantiation" do
+    it "should return a valid instantation" do
+      inst = HydraPbcore::Datastream::Deprecated::Instantiation.from_xml(integration_fixture "instantiation_rrhof_1184.xml")
+      inst.to_instantiation
+      save_template inst.to_xml, "converted_instantiation_rrhof_1184.xml"
+      equivalent_xml_files("converted_instantiation_rrhof_1184.xml").should be_true
+    end
+    it "should raise an error with the wrong class" do
+      lambda { @fake.to_document }.should raise_error
+    end
+  end
+
+  describe "#clean_document" do
+    it "should correct invalid pbcoreDigitalDocuments" do
+      ["digital_document_rrhof_1904.xml","digital_document_rrhof_2405.xml"].each do |file|
+        doc = HydraPbcore::Datastream::Deprecated::DigitalDocument.from_xml(integration_fixture file)
+        doc.clean_document
+        save_template doc.to_xml, ("converted_"+file)
+        equivalent_xml_files(("converted_"+file)).should be_true
+        save_template doc.to_pbcore_xml, "valid_pbcore.xml"
+        doc.valid?.should == []
+      end
+    end
+    it "should correct invalid pbcoreDocuments" do
+      ["document_rrhof_524.xml","document_rrhof_2439.xml"].each do |file|
+        doc = HydraPbcore::Datastream::Deprecated::Document.from_xml(integration_fixture file)
+        doc.to_document
+        doc.clean_document
+        save_template doc.to_xml, ("converted_"+file)
+        equivalent_xml_files(("converted_"+file)).should be_true
+        save_template doc.to_pbcore_xml, "valid_pbcore.xml"
+        doc.valid?.should == []
+      end
+    end
+  end
+
+end