hydra-works 0.2.0 → 0.3.0

data/spec/fixtures/pdf_fits.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="0.8.5" timestamp="8/11/15 2:29 PM">
+  <identification>
+    <identity format="Portable Document Format" mimetype="application/pdf" toolname="FITS" toolversion="0.8.5">
+      <tool toolname="Jhove" toolversion="1.5" />
+      <tool toolname="file utility" toolversion="5.14" />
+      <tool toolname="Exiftool" toolversion="9.13" />
+      <tool toolname="NLNZ Metadata Extractor" toolversion="3.4GA" />
+      <tool toolname="ffident" toolversion="0.2" />
+      <tool toolname="Tika" toolversion="1.3" />
+      <version toolname="Jhove" toolversion="1.5">1.3</version>
+    </identity>
+  </identification>
+  <fileinfo>
+    <size toolname="Jhove" toolversion="1.5">7618</size>
+    <creatingApplicationName toolname="Exiftool" toolversion="9.13">Mac OS X 10.10.3 Quartz PDFContext/TextEdit</creatingApplicationName>
+    <lastmodified toolname="Exiftool" toolversion="9.13" status="CONFLICT">2015:08:07 14:49:00-04:00</lastmodified>
+    <lastmodified toolname="Tika" toolversion="1.3" status="CONFLICT">2015-05-14T19:47:31Z</lastmodified>
+    <created toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">2015:05:14 19:47:31Z</created>
+    <filepath toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">/home/grosscol/workspace/hydra-works/spec/fixtures/sample-file.pdf</filepath>
+    <filename toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">sample-file.pdf</filename>
+    <md5checksum toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">3a1735b5b30c4adc3f92c70004ae53ed</md5checksum>
+    <fslastmodified toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">1438973340000</fslastmodified>
+  </fileinfo>
+  <filestatus>
+    <well-formed toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">true</well-formed>
+    <valid toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">true</valid>
+  </filestatus>
+  <metadata>
+    <document>
+      <title toolname="Exiftool" toolversion="9.13">sample-file</title>
+      <pageCount toolname="Jhove" toolversion="1.5">1</pageCount>
+      <isTagged toolname="Jhove" toolversion="1.5">no</isTagged>
+      <hasOutline toolname="Jhove" toolversion="1.5">no</hasOutline>
+      <hasAnnotations toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">no</hasAnnotations>
+      <isRightsManaged toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">no</isRightsManaged>
+      <isProtected toolname="Exiftool" toolversion="9.13">no</isProtected>
+      <hasForms toolname="NLNZ Metadata Extractor" toolversion="3.4GA" status="SINGLE_RESULT">no</hasForms>
+    </document>
+  </metadata>
+  <statistics fitsExecutionTime="890">
+    <tool toolname="OIS Audio Information" toolversion="0.1" status="did not run" />
+    <tool toolname="ADL Tool" toolversion="0.1" status="did not run" />
+    <tool toolname="Jhove" toolversion="1.5" executionTime="654" />
+    <tool toolname="file utility" toolversion="5.14" executionTime="617" />
+    <tool toolname="Exiftool" toolversion="9.13" executionTime="582" />
+    <tool toolname="NLNZ Metadata Extractor" toolversion="3.4GA" executionTime="490" />
+    <tool toolname="OIS File Information" toolversion="0.2" executionTime="107" />
+    <tool toolname="OIS XML Metadata" toolversion="0.2" status="did not run" />
+    <tool toolname="ffident" toolversion="0.2" executionTime="459" />
+    <tool toolname="Tika" toolversion="1.3" executionTime="824" />
+  </statistics>
+</fits>
+

data/spec/hydra/works/models/collection_spec.rb

@@ -8,325 +8,70 @@ describe Hydra::Works::Collection do
   let(:collection3) { described_class.new }
   let(:collection4) { described_class.new }
 
-  let(:generic_work1) { Hydra::Works::GenericWork::Base.new }
-  let(:generic_work2) { Hydra::Works::GenericWork::Base.new }
-  let(:generic_work3) { Hydra::Works::GenericWork::Base.new }
-  let(:generic_work4) { Hydra::Works::GenericWork::Base.new }
+  let(:generic_work1) { Hydra::Works::GenericWork.new }
+  let(:generic_work2) { Hydra::Works::GenericWork.new }
+  let(:generic_work3) { Hydra::Works::GenericWork.new }
+  let(:generic_work4) { Hydra::Works::GenericWork.new }
 
   describe '#collections' do
-    it 'returns empty array when only generic_works are aggregated' do
-      subject.generic_works << generic_work1
-      subject.generic_works << generic_work2
+    it 'returns empty array when only works are aggregated' do
+      subject.ordered_members << generic_work1
+      subject.ordered_members << generic_work2
       expect(subject.collections).to eq []
     end
 
-    context 'with other collections & generic_works' do
+    context 'with other collections & works' do
       before do
-        subject.collections << collection1
-        subject.collections << collection2
-        subject.generic_works << generic_work1
-        subject.generic_works << generic_work2
+        subject.ordered_members << collection1
+        subject.ordered_members << collection2
+        subject.ordered_members << generic_work1
+        subject.ordered_members << generic_work2
       end
 
       it 'returns only collections' do
-        expect(subject.collections).to eq [collection1, collection2]
+        expect(subject.ordered_collections).to eq [collection1, collection2]
       end
     end
   end
 
-  describe '#collections <<' do
-    context 'with acceptable collections' do
-      context 'with collections and generic_works' do
-        before do
-          subject.collections << collection1
-          subject.collections << collection2
-          subject.generic_works << generic_work1
-          subject.generic_works << generic_work2
-        end
-
-        it 'adds an generic_work to collection with collections and generic_works' do
-          subject.collections << collection3
-          expect(subject.collections).to eq [collection1, collection2, collection3]
-        end
-      end
-
-      describe 'aggregates collections that implement Hydra::Works' do
-        before do
-          class Kollection < ActiveFedora::Base
-            include Hydra::Works::CollectionBehavior
-          end
-        end
-        after { Object.send(:remove_const, :Kollection) }
-        let(:kollection1) { Kollection.new }
-
-        it 'accepts implementing collection as a child' do
-          subject.collections << kollection1
-          expect(subject.collections).to eq [kollection1]
-        end
-
-        it 'accepts implementing collection as a parent' do
-          subject.collections << collection1
-          expect(subject.collections).to eq [collection1]
-        end
-      end
-
-      describe 'aggregates collections that extend Hydra::Works' do
-        before do
-          class Cullection < Hydra::Works::Collection
-          end
-        end
-        after { Object.send(:remove_const, :Cullection) }
-        let(:cullection1) { Cullection.new }
-
-        it 'accepts extending collection as a child' do
-          subject.collections << cullection1
-          expect(subject.collections).to eq [cullection1]
-        end
-
-        it 'accepts extending collection as a parent' do
-          subject.collections << collection1
-          expect(subject.collections).to eq [collection1]
-        end
-      end
-    end
-
-    context 'with unacceptable inputs' do
-      before(:all) do
-        @works_collection101  = described_class.new
-        @generic_work101      = Hydra::Works::GenericWork::Base.new
-        @generic_file101      = Hydra::Works::GenericFile::Base.new
-        @pcdm_collection101   = Hydra::PCDM::Collection.new
-        @pcdm_object101       = Hydra::PCDM::Object.new
-        @pcdm_file101         = Hydra::PCDM::File.new
-        @non_pcdm_object      = "I'm not a PCDM object"
-        @af_base_object       = ActiveFedora::Base.new
-      end
-
-      context 'that are unacceptable child collections' do
-        let(:error_type1)    { ArgumentError }
-        let(:error_message1) { /Hydra::Works::Generic(Work|File)::Base with ID:  was expected to works_collection\?, but it was false/ }
-        let(:error_type2)    { NoMethodError }
-        let(:error_message2) { /undefined method `works_collection\?' for .*/ }
-
-        it 'does not aggregate Hydra::Works::GenericWork in collections aggregation' do
-          expect { subject.collections << @generic_work101 }.to raise_error(error_type1, error_message1)
-        end
-
-        it 'does not aggregate Hydra::Works::GenericFile in collections aggregation' do
-          expect { subject.collections << @generic_file101 }.to raise_error(error_type1, error_message1)
-        end
-
-        it 'does not aggregate Hydra::PCDM::Collections in collections aggregation' do
-          expect { subject.collections << @pcdm_collection101 }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate Hydra::PCDM::Objects in collections aggregation' do
-          expect { subject.collections << @pcdm_object101 }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate Hydra::PCDM::Files in collections aggregation' do
-          expect { subject.collections << @pcdm_file101 }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate non-PCDM objects in collections aggregation' do
-          expect { subject.collections << @non_pcdm_object }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate AF::Base objects in collections aggregation' do
-          expect { subject.collections << @af_base_object }.to raise_error(error_type2, error_message2)
-        end
-      end
-    end
-  end
-
-  describe 'collections.delete' do
-    context 'when multiple collections' do
-      before do
-        subject.collections << collection1
-        subject.collections << collection2
-        subject.generic_works << generic_work2
-        subject.collections << collection3
-        subject.generic_works << generic_work1
-        expect(subject.collections).to eq [collection1, collection2, collection3]
-      end
-
-      it 'removes first collection' do
-        expect(subject.collections.delete collection1).to eq [collection1]
-        expect(subject.collections).to eq [collection2, collection3]
-        expect(subject.generic_works).to eq [generic_work2, generic_work1]
-      end
-
-      it 'removes last collection' do
-        expect(subject.collections.delete collection3).to eq [collection3]
-        expect(subject.collections).to eq [collection1, collection2]
-        expect(subject.generic_works). to eq [generic_work2, generic_work1]
-      end
-
-      it 'removes middle collection' do
-        expect(subject.collections.delete collection2).to eq [collection2]
-        expect(subject.collections).to eq [collection1, collection3]
-        expect(subject.generic_works). to eq [generic_work2, generic_work1]
-      end
-    end
-  end
-
-  describe '#generic_works' do
+  describe '#works' do
     it 'returns empty array when only collections are aggregated' do
-      subject.collections << collection1
-      subject.collections << collection2
-      expect(subject.generic_works). to eq []
+      subject.ordered_members << collection1
+      subject.ordered_members << collection2
+      expect(subject.ordered_works). to eq []
     end
 
     context 'with collections and generic works' do
       before do
-        subject.collections << collection1
-        subject.collections << collection2
-        subject.generic_works << generic_work1
-        subject.generic_works << generic_work2
+        subject.ordered_members << collection1
+        subject.ordered_members << collection2
+        subject.ordered_members << generic_work1
+        subject.ordered_members << generic_work2
       end
 
       it 'returns only generic works' do
-        expect(subject.generic_works). to eq [generic_work1, generic_work2]
+        expect(subject.ordered_works). to eq [generic_work1, generic_work2]
       end
     end
   end
 
-  describe '#generic_works <<' do
-    context 'with acceptable generic_works' do
-      context 'with collections and generic_works' do
-        before do
-          subject.collections << collection1
-          subject.collections << collection2
-          subject.generic_works << generic_work1
-          subject.generic_works << generic_work2
-        end
-
-        it 'adds generic_work to collection with collections and generic_works' do
-          subject.generic_works << generic_work3
-          expect(subject.generic_works).to eq [generic_work1, generic_work2, generic_work3]
-        end
-      end
-
-      describe 'aggregates generic_works that implement Hydra::Works' do
-        before do
-          class DummyIncWork < ActiveFedora::Base
-            include Hydra::Works::GenericWorkBehavior
-          end
-        end
-        after { Object.send(:remove_const, :DummyIncWork) }
-        let(:iwork1) { DummyIncWork.new }
-
-        it 'accepts implementing generic_work as a child' do
-          subject.generic_works << iwork1
-          expect(subject.generic_works).to eq [iwork1]
-        end
-      end
-
-      describe 'aggregates generic_works that extend Hydra::Works' do
-        before do
-          class DummyExtWork < Hydra::Works::GenericWork::Base
-          end
-        end
-        after { Object.send(:remove_const, :DummyExtWork) }
-        let(:ework1) { DummyExtWork.new }
-
-        it 'accepts extending generic_work as a child' do
-          subject.generic_works << ework1
-          expect(subject.generic_works).to eq [ework1]
-        end
-      end
-    end
-
-    context 'with unacceptable inputs' do
-      before(:all) do
-        @works_collection101  = described_class.new
-        @works_collection102  = described_class.new
-        @generic_file101      = Hydra::Works::GenericFile::Base.new
-        @pcdm_collection101   = Hydra::PCDM::Collection.new
-        @pcdm_object101       = Hydra::PCDM::Object.new
-        @pcdm_file101         = Hydra::PCDM::File.new
-        @non_pcdm_object      = "I'm not a PCDM object"
-        @af_base_object       = ActiveFedora::Base.new
-      end
-
-      context 'that are unacceptable child generic works' do
-        let(:error_type1)    { ArgumentError }
-        let(:error_message1) { /Hydra::Works::(GenericFile::Base|Collection) with ID:  was expected to works_generic_work\?, but it was false/ }
-        let(:error_type2)    { NoMethodError }
-        let(:error_message2) { /undefined method `works_generic_work\?' for .*/ }
-
-        it 'does not aggregate Hydra::Works::Collection in generic works aggregation' do
-          expect { subject.generic_works << @works_collection101 }.to raise_error(error_type1, error_message1)
-        end
-
-        it 'does not aggregate Hydra::Works::GenericFile in generic works aggregation' do
-          expect { subject.generic_works << @generic_file101 }.to raise_error(error_type1, error_message1)
-        end
-
-        it 'does not aggregate Hydra::PCDM::Collections in generic works aggregation' do
-          expect { subject.generic_works << @pcdm_collection101 }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate Hydra::PCDM::Objects in generic works aggregation' do
-          expect { subject.generic_works << @pcdm_object101 }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate Hydra::PCDM::Files in generic works aggregation' do
-          expect { subject.generic_works << @pcdm_file101 }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate non-PCDM objects in generic works aggregation' do
-          expect { subject.generic_works << @non_pcdm_object }.to raise_error(error_type2, error_message2)
-        end
-
-        it 'does not aggregate AF::Base objects in generic works aggregation' do
-          expect { subject.generic_works << @af_base_object }.to raise_error(error_type2, error_message2)
-        end
-      end
-    end
-  end
-
-  describe '#generic_works.delete' do
-    context 'when multiple generic works' do
-      before do
-        subject.generic_works << generic_work1
-        subject.generic_works << generic_work2
-        subject.collections << collection2
-        subject.generic_works << generic_work3
-        subject.collections << collection1
-        expect(subject.generic_works). to eq [generic_work1, generic_work2, generic_work3]
-      end
-
-      it 'removes first generic work' do
-        expect(subject.generic_works.delete generic_work1).to eq [generic_work1]
-        expect(subject.generic_works). to eq [generic_work2, generic_work3]
-        expect(subject.collections).to eq [collection2, collection1]
-      end
-
-      it 'removes last generic work' do
-        expect(subject.generic_works.delete generic_work3).to eq [generic_work3]
-        expect(subject.generic_works). to eq [generic_work1, generic_work2]
-        expect(subject.collections).to eq [collection2, collection1]
-      end
-
-      it 'removes middle generic work' do
-        expect(subject.generic_works.delete generic_work2).to eq [generic_work2]
-        expect(subject.generic_works). to eq [generic_work1, generic_work3]
-        expect(subject.collections).to eq [collection2, collection1]
-      end
+  describe "#ordered_work_ids" do
+    it "returns IDs of ordered works" do
+      subject.ordered_members << generic_work1
+      expect(subject.ordered_work_ids).to eq [generic_work1.id]
     end
   end
 
   describe '#related_objects' do
-    let(:generic_file1) { Hydra::Works::GenericFile::Base.new }
+    let(:generic_file1) { Hydra::Works::FileSet.new }
     let(:object1) { Hydra::PCDM::Object.new }
     let(:object2) { Hydra::PCDM::Object.new }
 
     context 'with collections and generic works' do
       before do
-        subject.collections << collection1
-        subject.collections << collection2
-        subject.generic_works << generic_work1
+        subject.ordered_members << collection1
+        subject.ordered_members << collection2
+        subject.ordered_members << generic_work1
       end
 
       it 'returns empty array when only collections and generic works are aggregated' do
@@ -356,7 +101,7 @@ describe Hydra::Works::Collection do
     context 'with acceptable related objects' do
       let(:object1) { Hydra::PCDM::Object.new }
       let(:object2) { Hydra::PCDM::Object.new }
-      let(:generic_file1) { Hydra::Works::GenericFile::Base.new }
+      let(:generic_file1) { Hydra::Works::FileSet.new }
 
       it 'adds various types of related objects to collection' do
         subject.related_objects << generic_work1
@@ -370,16 +115,16 @@ describe Hydra::Works::Collection do
         expect(subject.related_objects.size).to eq 3
       end
 
-      context 'with collections and generic_works' do
+      context 'with collections and works' do
         before do
-          subject.collections << collection1
-          subject.collections << collection2
-          subject.generic_works << generic_work1
-          subject.generic_works << generic_work2
+          subject.ordered_members << collection1
+          subject.ordered_members << collection2
+          subject.ordered_members << generic_work1
+          subject.ordered_members << generic_work2
           subject.related_objects << object1
         end
 
-        it 'adds a related object to collection with collections and generic_works' do
+        it 'adds a related object to collection with collections and works' do
           subject.related_objects << object2
           subject.save
           subject.reload
@@ -437,20 +182,20 @@ describe Hydra::Works::Collection do
 
   describe '#related_objects.delete' do
     let(:related_object1) { Hydra::PCDM::Object.new }
-    let(:related_work2)   { Hydra::Works::GenericWork::Base.new }
-    let(:related_file3)   { Hydra::Works::GenericFile::Base.new }
+    let(:related_work2)   { Hydra::Works::GenericWork.new }
+    let(:related_file3)   { Hydra::Works::FileSet.new }
     let(:related_object4) { Hydra::PCDM::Object.new }
-    let(:related_work5)   { Hydra::Works::GenericWork::Base.new }
+    let(:related_work5)   { Hydra::Works::GenericWork.new }
 
     context 'when multiple related objects' do
       before do
         subject.related_objects << related_object1
         subject.related_objects << related_work2
-        subject.collections << collection2
-        subject.generic_works << generic_work1
+        subject.members << collection2
+        subject.members << generic_work1
         subject.related_objects << related_file3
         subject.related_objects << related_object4
-        subject.collections << collection1
+        subject.members << collection1
         subject.related_objects << related_work5
         expect(subject.related_objects).to eq [related_object1, related_work2, related_file3, related_object4, related_work5]
       end
@@ -459,39 +204,25 @@ describe Hydra::Works::Collection do
         expect(subject.related_objects.delete related_object1).to eq [related_object1]
         expect(subject.related_objects).to eq [related_work2, related_file3, related_object4, related_work5]
         expect(subject.collections).to eq [collection2, collection1]
-        expect(subject.generic_works). to eq [generic_work1]
+        expect(subject.works). to eq [generic_work1]
       end
 
       it 'removes last related object' do
         expect(subject.related_objects.delete related_work5).to eq [related_work5]
         expect(subject.related_objects).to eq [related_object1, related_work2, related_file3, related_object4]
         expect(subject.collections).to eq [collection2, collection1]
-        expect(subject.generic_works). to eq [generic_work1]
+        expect(subject.works). to eq [generic_work1]
       end
 
       it 'removes middle related object' do
         expect(subject.related_objects.delete related_file3).to eq [related_file3]
         expect(subject.related_objects).to eq [related_object1, related_work2, related_object4, related_work5]
         expect(subject.collections).to eq [collection2, collection1]
-        expect(subject.generic_works). to eq [generic_work1]
+        expect(subject.works). to eq [generic_work1]
       end
     end
   end
 
-  describe '#collections=' do
-    it 'aggregates collections' do
-      collection1.collections = [collection2, collection3]
-      expect(collection1.collections).to eq [collection2, collection3]
-    end
-  end
-
-  describe '#generic_works=' do
-    it 'aggregates generic_works' do
-      collection1.generic_works = [generic_work1, generic_work2]
-      expect(collection1.generic_works).to eq [generic_work1, generic_work2]
-    end
-  end
-
   describe 'Related objects' do
     let(:object) { Hydra::PCDM::Object.new }
     let(:collection) { described_class.new }
@@ -507,7 +238,7 @@ describe Hydra::Works::Collection do
 
   describe 'should have parent collection accessors' do
     before do
-      collection1.collections << collection2
+      collection1.ordered_members << collection2
       collection1.save
     end
 
@@ -521,16 +252,17 @@ describe Hydra::Works::Collection do
 
   describe 'make sure deprecated methods still work' do
     it 'deprecated methods should pass' do
-      expect(collection1.child_collections = [collection2]).to eq [collection2]
-      expect(collection1.child_collections << collection3).to eq [collection2, collection3]
-      expect(collection1.child_collections += [collection4]).to eq [collection2, collection3, collection4]
-      expect(collection1.child_generic_works = [generic_work1]).to eq [generic_work1]
-      expect(collection1.child_generic_works << generic_work2).to eq [generic_work1, generic_work2]
-      expect(collection1.child_generic_works += [generic_work3]).to eq [generic_work1, generic_work2, generic_work3]
-      collection1.save # required until issue AF-Agg-75 is fixed
-      expect(collection2.parent_collections).to eq [collection1]
-      expect(collection2.parents).to eq [collection1]
-      expect(collection2.parent_collection_ids).to eq [collection1.id]
+      Deprecation.silence(Hydra::Works::CollectionBehavior) do
+        collection1.ordered_members << collection2
+        collection1.ordered_members << generic_work1
+        expect(collection1.child_collections).to eq [collection2]
+        expect(collection1.child_collection_ids).to eq [collection2.id]
+        expect(collection1.child_generic_works).to eq [generic_work1]
+        expect(collection1.child_generic_work_ids).to eq [generic_work1.id]
+        collection1.save # required until issue AF-Agg-75 is fixed
+        expect(collection2.parent_collections).to eq [collection1]
+        expect(collection2.parents).to eq [collection1]
+      end
     end
   end
 end