hydra-pcdm 0.0.1

data/spec/hydra/pcdm/services/collection/remove_related_object_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::RemoveRelatedObjectFromCollection do
+
+  subject { Hydra::PCDM::Collection.create }
+
+  let(:object1) { Hydra::PCDM::Object.create }
+  let(:object2) { Hydra::PCDM::Object.create }
+  let(:object3) { Hydra::PCDM::Object.create }
+  let(:object4) { Hydra::PCDM::Object.create }
+  let(:object5) { Hydra::PCDM::Object.create }
+
+  let(:collection1) { Hydra::PCDM::Collection.create }
+  let(:collection2) { Hydra::PCDM::Collection.create }
+
+  describe '#call' do
+    context 'when it is the only related object' do
+      before do
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object1 )
+        subject.save
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq [object1]
+      end
+
+      it 'should remove related object' do
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, object1 ) ).to eq object1
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq []
+      end
+
+      it 'should remove related object only when objects & collections' do
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection2 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object3 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object2 )
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, object1 ) ).to eq object1
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq []
+        expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject )).to eq [collection1,collection2]
+        expect( Hydra::PCDM::GetObjectsFromCollection.call( subject )).to eq [object3,object2]
+      end
+    end
+
+    context 'when multiple related objects' do
+      before do
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object1 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object2 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object3 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object4 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object5 )
+        subject.save
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq [object1,object2,object3,object4,object5]
+      end
+
+      it 'should remove first related object' do
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, object1 ) ).to eq object1
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq [object2,object3,object4,object5]
+      end
+
+      it 'should remove last related object' do
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, object5 ) ).to eq object5
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq [object1,object2,object3,object4]
+      end
+
+      it 'should remove middle related object' do
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, object3 ) ).to eq object3
+        expect( Hydra::PCDM::GetRelatedObjectsFromCollection.call( subject.reload )).to eq [object1,object2,object4,object5]
+      end
+    end
+
+    context 'when related object is missing' do
+      it 'should return nil when 0 related objects and 0 collections and objects' do
+        subject.save
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject.reload, object1 )).to be nil
+      end
+
+      it 'should return nil when 0 related objects, but has collections and objects' do
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection2 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object1 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object2 )
+        subject.save
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject.reload, object1 )).to be nil
+      end
+
+      it 'should return nil when other related objects' do
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object1 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object2 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object4 )
+        Hydra::PCDM::AddRelatedObjectToCollection.call( subject, object5 )
+        subject.save
+        expect( Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject.reload, object3 )).to be nil
+      end
+    end
+  end
+
+  context 'with unacceptable related objects' do
+    let(:collection1)     { Hydra::PCDM::Collection.create }
+    let(:file1)           { Hydra::PCDM::File.new }
+    let(:non_PCDM_object) { "I'm not a PCDM object" }
+    let(:af_base_object)  { ActiveFedora::Base.create }
+
+    let(:error_type)    { ArgumentError }
+    let(:error_message) { 'child_related_object must be a pcdm object' }
+
+    it 'should NOT remove Hydra::PCDM::Collections from related_objects aggregation' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, collection1 ) }.to raise_error(error_type,error_message)
+    end
+
+    it 'should NOT remove Hydra::PCDM::Files from related_objects aggregation' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, file1 ) }.to raise_error(error_type,error_message)
+    end
+
+    it 'should NOT remove non-PCDM objects from related_objects aggregation' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, non_PCDM_object ) }.to raise_error(error_type,error_message)
+    end
+
+    it 'should NOT remove AF::Base objects from related_objects aggregation' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( subject, af_base_object ) }.to raise_error(error_type,error_message)
+    end
+  end
+
+  context 'with unacceptable parent collection' do
+    let(:object2)          { Hydra::PCDM::Object.create }
+    let(:object1)          { Hydra::PCDM::Object.create }
+    let(:file1)            { Hydra::PCDM::File.new }
+    let(:non_PCDM_object)  { "I'm not a PCDM object" }
+    let(:af_base_object)   { ActiveFedora::Base.create }
+
+    let(:error_type)    { ArgumentError }
+    let(:error_message) { 'parent_collection must be a pcdm collection' }
+
+    it 'should NOT accept Hydra::PCDM::Objects as parent collection' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( object1, object2 ) }.to raise_error(error_type,error_message)
+    end
+
+    it 'should NOT accept Hydra::PCDM::Files as parent collection' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( file1, object2 ) }.to raise_error(error_type,error_message)
+    end
+
+    it 'should NOT accept non-PCDM objects as parent collection' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( non_PCDM_object, object2 ) }.to raise_error(error_type,error_message)
+    end
+
+    it 'should NOT accept AF::Base objects as parent collection' do
+      expect{ Hydra::PCDM::RemoveRelatedObjectFromCollection.call( af_base_object, object2 ) }.to raise_error(error_type,error_message)
+    end
+  end
+end

data/spec/hydra/pcdm/services/file/add_type_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::AddTypeToFile do
+
+  let(:file) { Hydra::PCDM::File.new }
+
+  context "with a file that has no type" do
+    let(:uri)  { ::RDF::URI("http://example.com/MyType") }
+    subject { described_class.call(file, uri).metadata_node.type }
+    it { is_expected.to include(uri)}
+  end
+
+  context "when adding a type that already exists" do
+    let(:uri)  { RDFVocabularies::PCDMTerms.File }
+    subject { described_class.call(file, uri).metadata_node.type }
+    it { is_expected.to eql [uri] }
+  end
+
+end

data/spec/hydra/pcdm/services/file/get_mime_type_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::GetMimeTypeForFile do
+
+  context "with faulty input" do
+    let(:error_message) { "supplied argument should be a path to a file" }
+    it "raises and error" do
+      expect( lambda{described_class.call(["bad input"])}).to raise_error(ArgumentError, error_message)
+    end
+  end
+
+  context "with a standard file type" do
+    let(:path) { "/path/file.jpg" }
+    subject { described_class.call(path) }
+    it { is_expected.to eql "image/jpeg" }
+  end
+
+  context "with an unknown file type" do
+    let(:path) { "/path/file.jkl" }
+    subject { described_class.call(path) }
+    it { is_expected.to eql "application/octet-stream" }
+  end
+
+end

data/spec/hydra/pcdm/services/object/add_object_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::AddObjectToObject do
+
+  let(:subject) { Hydra::PCDM::Object.create }
+
+  describe '#call' do
+    context 'with acceptable objects' do
+      let(:object1) { Hydra::PCDM::Object.create }
+      let(:object2) { Hydra::PCDM::Object.create }
+      let(:object3) { Hydra::PCDM::Object.create }
+      let(:object4) { Hydra::PCDM::Object.create }
+      let(:object5) { Hydra::PCDM::Object.create }
+
+      it 'should add an object to empty object' do
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        expect( Hydra::PCDM::GetObjectsFromObject.call( subject ) ).to eq [object1]
+      end
+
+      it 'should add an object to an object with objects' do
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        Hydra::PCDM::AddObjectToObject.call( subject, object2 )
+        expect( Hydra::PCDM::GetObjectsFromObject.call( subject ) ).to eq [object1,object2]
+      end
+
+      it 'should allow objects to repeat' do
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        Hydra::PCDM::AddObjectToObject.call( subject, object2 )
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        expect( Hydra::PCDM::GetObjectsFromObject.call( subject ) ).to eq [object1,object2,object1]
+      end
+
+      it 'should aggregate objects in a sub-object of a object' do
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        object1.save
+        Hydra::PCDM::AddObjectToObject.call( object1, object2 )
+        object2.save
+        expect(subject.objects).to eq [object1]
+        expect(object1.objects).to eq [object2]
+      end
+
+      context 'with files and objects' do
+        let(:file1) { subject.files.build }
+        let(:file2) { subject.files.build }
+
+        before do
+          file1.content = "I'm a file"
+          file2.content = "I am too"
+          Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+          Hydra::PCDM::AddObjectToObject.call( subject, object2 )
+          subject.save!
+        end
+
+        it 'should add an object to an object with files and objects' do
+          Hydra::PCDM::AddObjectToObject.call( subject, object3 )
+          expect( Hydra::PCDM::GetObjectsFromObject.call( subject ) ).to eq [object1,object2,object3]
+        end
+      end
+
+      describe 'adding objects that are ancestors' do
+        let(:error_message) { "an object can't be an ancestor of itself" }
+
+        context 'when the source object is the same' do
+          it 'raises an error' do
+            expect{ Hydra::PCDM::AddObjectToObject.call( object1, object1 )}.to raise_error(ArgumentError, error_message)
+          end
+        end
+
+        before do
+          Hydra::PCDM::AddObjectToObject.call( object1, object2 )
+          object1.save
+        end
+
+        it 'raises and error' do
+          expect{ Hydra::PCDM::AddObjectToObject.call( object2, object1 )}.to raise_error(ArgumentError, error_message)
+        end
+
+        context 'with more ancestors' do
+          before do
+            Hydra::PCDM::AddObjectToObject.call( object2, object3 )
+            object2.save
+          end
+
+          it 'raises an error' do
+            expect{ Hydra::PCDM::AddObjectToObject.call( object3, object1 )}.to raise_error(ArgumentError, error_message)
+          end
+
+          context 'with a more complicated example' do
+            before do
+              Hydra::PCDM::AddObjectToObject.call( object3, object4 )
+              Hydra::PCDM::AddObjectToObject.call( object3, object5 )
+              object3.save
+            end
+
+            it 'raises errors' do
+              expect{ Hydra::PCDM::AddObjectToObject.call( object4, object1 )}.to raise_error(ArgumentError, error_message)
+              expect{ Hydra::PCDM::AddObjectToObject.call( object4, object2 )}.to raise_error(ArgumentError, error_message)
+            end
+          end
+        end
+      end
+
+      describe 'aggregates objects that implement Hydra::PCDM' do
+        before do
+          class DummyIncObject < ActiveFedora::Base
+            include Hydra::PCDM::ObjectBehavior
+          end
+        end
+        after { Object.send(:remove_const, :DummyIncObject) }
+        let(:iobject1) { DummyIncObject.create }
+
+        it 'should accept implementing object as a child' do
+          Hydra::PCDM::AddObjectToObject.call( subject, iobject1 )
+          subject.save
+          expect( Hydra::PCDM::GetObjectsFromObject.call( subject ) ).to eq [iobject1]
+        end
+      end
+
+      describe 'aggregates objects that extend Hydra::PCDM' do
+        before do
+          class DummyExtObject < Hydra::PCDM::Object
+          end
+        end
+        after { Object.send(:remove_const, :DummyExtObject) }
+        let(:eobject1) { DummyExtObject.create }
+
+        it 'should accept extending object as a child' do
+          Hydra::PCDM::AddObjectToObject.call( subject, eobject1 )
+          subject.save
+          expect( Hydra::PCDM::GetObjectsFromObject.call( subject ) ).to eq [eobject1]
+        end
+      end
+    end
+
+    context 'with unacceptable objects' do
+      let(:collection1) { Hydra::PCDM::Collection.create }
+      let(:file1) { Hydra::PCDM::File.new }
+      let(:non_PCDM_object) { "I'm not a PCDM object" }
+      let(:af_base_object)  { ActiveFedora::Base.create }
+
+      let(:error_message) { 'child_object must be a pcdm object' }
+
+      it 'should NOT aggregate Hydra::PCDM::Collection in objects aggregation' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( subject, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Files in objects aggregation' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( subject, file1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate non-PCDM objects in objects aggregation' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( subject, non_PCDM_object ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate AF::Base objects in objects aggregation' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( subject, af_base_object ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+
+    context 'with unacceptable parent object' do
+      let(:collection1)      { Hydra::PCDM::Collection.create }
+      let(:object2)          { Hydra::PCDM::Object.create }
+      let(:file1)            { Hydra::PCDM::File.new }
+      let(:non_PCDM_object)  { "I'm not a PCDM object" }
+      let(:af_base_object)   { ActiveFedora::Base.create }
+
+      let(:error_message) { 'parent_object must be a pcdm object' }
+
+      it 'should NOT accept Hydra::PCDM::Collections as parent object' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( collection1, object2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::PCDM::Files as parent object' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( file1, object2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept non-PCDM objects as parent object' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( non_PCDM_object, object2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept AF::Base objects as parent object' do
+        expect{ Hydra::PCDM::AddObjectToObject.call( af_base_object, object2 ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+  end
+end

data/spec/hydra/pcdm/services/object/add_related_object_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::AddRelatedObjectToObject do
+
+  let(:subject) { Hydra::PCDM::Object.create }
+
+  describe '#call' do
+
+    context 'with acceptable objects' do
+      let(:object1) { Hydra::PCDM::Object.create }
+      let(:object2) { Hydra::PCDM::Object.create }
+      let(:object3) { Hydra::PCDM::Object.create }
+      let(:file1)   { Hydra::PCDM::File.new }
+
+      it 'should add a related object to empty object' do
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object1 )
+        expect( Hydra::PCDM::GetRelatedObjectsFromObject.call( subject ) ).to eq [object1]
+      end
+
+      it 'should add a related object to object with related objects' do
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object1 )
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object2 )
+        related_objects = Hydra::PCDM::GetRelatedObjectsFromObject.call( subject )
+        expect( related_objects.include? object1 ).to be true
+        expect( related_objects.include? object2 ).to be true
+        expect( related_objects.size ).to eq 2
+      end
+
+      context 'with files and objects' do
+        let(:file1) { subject.files.build }
+        let(:file2) { subject.files.build }
+
+        before do
+          file1.content = "I'm a file"
+          file2.content = "I am too"
+          Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+          Hydra::PCDM::AddRelatedObjectToObject.call( subject, object2 )
+          subject.save!
+        end
+
+        it 'should add an object to an object with files and objects' do
+          Hydra::PCDM::AddRelatedObjectToObject.call( subject, object3 )
+          related_objects = Hydra::PCDM::GetRelatedObjectsFromObject.call( subject )
+          expect( related_objects.include? object2 ).to be true
+          expect( related_objects.include? object3 ).to be true
+          expect( related_objects.size ).to eq 2
+        end
+      end
+    end
+
+    context 'with unacceptable objects' do
+      let(:collection1) { Hydra::PCDM::Collection.create }
+      let(:file1) { Hydra::PCDM::File.new }
+      let(:non_PCDM_object) { "I'm not a PCDM object" }
+      let(:af_base_object)  { ActiveFedora::Base.create }
+
+      let(:error_message) { 'child_related_object must be a pcdm object' }
+
+      it 'should NOT aggregate Hydra::PCDM::Collection in related objects aggregation' do
+        expect{ Hydra::PCDM::AddRelatedObjectToObject.call( subject, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Files in related objects aggregation' do
+        expect{ Hydra::PCDM::AddRelatedObjectToObject.call( subject, file1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate non-PCDM objects in related objects aggregation' do
+        expect{ Hydra::PCDM::AddRelatedObjectToObject.call( subject, non_PCDM_object ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate AF::Base objects in related objects aggregation' do
+        expect{ Hydra::PCDM::AddRelatedObjectToObject.call( subject, af_base_object ) }.to raise_error(ArgumentError,error_message)
+      end
+
+    end
+
+    context 'with invalid bahaviors' do
+      let(:object1) { Hydra::PCDM::Object.create }
+      let(:object2) { Hydra::PCDM::Object.create }
+
+      it 'should NOT allow related objects to repeat' do
+        skip 'skipping this test because issue #92 needs to be addressed' do
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object1 )
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object2 )
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object1 )
+        related_objects = Hydra::PCDM::GetRelatedObjectsFromObject.call( subject )
+        expect( related_objects.include? object1 ).to be true
+        expect( related_objects.include? object2 ).to be true
+        expect( related_objects.size ).to eq 2
+      end
+      end
+    end
+  end
+end

data/spec/hydra/pcdm/services/object/get_objects_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::GetObjectsFromObject do
+
+  subject { Hydra::PCDM::Object.create }
+
+  let(:object1) { Hydra::PCDM::Object.create }
+  let(:object2) { Hydra::PCDM::Object.create }
+
+  describe '#call' do
+    it 'should return empty array when no members' do
+      subject.save
+      expect(Hydra::PCDM::GetObjectsFromObject.call( subject )).to eq []
+    end
+
+    context 'with files and objects' do
+      let(:file1) { subject.files.build }
+      let(:file2) { subject.files.build }
+
+      before do
+        file1.content = "I'm a file"
+        file2.content = "I am too"
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        Hydra::PCDM::AddObjectToObject.call( subject, object2 )
+        subject.save!
+      end
+
+      it 'should only return objects' do
+        expect(Hydra::PCDM::GetObjectsFromObject.call( subject )).to eq [object1,object2]
+      end
+   end
+  end
+end

data/spec/hydra/pcdm/services/object/get_related_objects_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::GetRelatedObjectsFromObject do
+
+  subject { Hydra::PCDM::Object.create }
+
+  let(:object1) { Hydra::PCDM::Object.create }
+  let(:object2) { Hydra::PCDM::Object.create }
+
+  describe '#call' do
+    it 'should return empty array when no related object' do
+      subject.save
+      expect(Hydra::PCDM::GetRelatedObjectsFromObject.call( subject )).to eq []
+    end
+
+
+    context 'with files and objects' do
+      let(:file1) { subject.files.build }
+      let(:file2) { subject.files.build }
+
+      before do
+        file1.content = "I'm a file"
+        file2.content = "I am too"
+        Hydra::PCDM::AddObjectToObject.call( subject, object1 )
+        Hydra::PCDM::AddObjectToObject.call( subject, object2 )
+        subject.save!
+      end
+
+      it 'should return empty array when only files and object are aggregated' do
+        expect(Hydra::PCDM::GetRelatedObjectsFromObject.call( subject )).to eq []
+      end
+
+      it 'should only return related objects' do
+        Hydra::PCDM::AddRelatedObjectToObject.call( subject, object2 )
+        expect(Hydra::PCDM::GetRelatedObjectsFromObject.call( subject )).to eq [object2]
+      end
+   end
+  end
+end