hydra-pcdm 0.0.1

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

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::Collection do
+
+  let(:collection1) { Hydra::PCDM::Collection.create }
+  let(:collection2) { Hydra::PCDM::Collection.create }
+  let(:collection3) { Hydra::PCDM::Collection.create }
+
+  let(:object1) { Hydra::PCDM::Object.create }
+  let(:object2) { Hydra::PCDM::Object.create }
+
+  describe '#child_collections=' do
+    it 'should aggregate collections' do
+      collection1.child_collections = [collection2, collection3]
+      collection1.save
+      expect(collection1.child_collections).to eq [collection2, collection3]
+    end
+  end
+
+  describe '#objects=' do
+    it 'should aggregate objects' do
+      collection1.objects = [object1,object2]
+      collection1.save
+      expect(collection1.objects).to eq [object1,object2]
+    end
+  end
+
+  describe 'Related objects' do
+    let(:object1)     { Hydra::PCDM::Object.create }
+    let(:collection1) { Hydra::PCDM::Collection.create }
+
+    before do
+      collection1.related_objects = [object1]
+      collection1.save
+    end
+
+    it 'persists' do
+      expect(collection1.reload.related_objects).to eq [object1]
+    end
+  end
+
+  describe ".indexer" do
+    after do
+      Object.send(:remove_const, :Foo)
+    end
+
+    context "without overriding" do
+      before do
+        class Foo < ActiveFedora::Base
+          include Hydra::PCDM::CollectionBehavior
+        end
+      end
+
+      subject { Foo.indexer }
+      it { is_expected.to eq Hydra::PCDM::CollectionIndexer }
+    end
+
+    context "when overridden with AS::Concern" do
+      before do
+        module IndexingStuff
+          extend ActiveSupport::Concern
+
+          class AltIndexer; end
+
+          module ClassMethods
+            def indexer
+              AltIndexer
+            end
+          end
+        end
+
+        class Foo < ActiveFedora::Base
+          include Hydra::PCDM::CollectionBehavior
+          include IndexingStuff
+        end
+      end
+
+      subject { Foo.indexer }
+      it { is_expected.to eq IndexingStuff::AltIndexer }
+    end
+  end
+end

data/spec/hydra/pcdm/models/file_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::File do
+
+  let(:file) { Hydra::PCDM::File.new }
+  let(:reloaded) { Hydra::PCDM::File.new(file.uri) }
+
+  describe "when saving" do
+    it "sets an RDF type" do
+      file.content = 'stuff'
+      expect(file.save).to be true
+      expect(reloaded.metadata_node.query(predicate: RDF.type, object: RDFVocabularies::PCDMTerms.File).map(&:object)).to eq [RDFVocabularies::PCDMTerms.File]
+    end
+  end
+
+  describe "#label" do
+    it "saves a label" do
+      file.content = 'stuff'
+      file.label = 'foo'
+      expect(file.label).to eq ['foo']
+      expect(file.save).to be true
+      expect(reloaded.label).to eq ['foo']
+    end
+  end
+
+  describe "technical metadata" do
+    let(:date_created) { Date.parse "Fri, 08 May 2015 08:00:00 -0400 (EDT)" }
+    let(:date_modified) { Date.parse "Sat, 09 May 2015 09:00:00 -0400 (EDT)" }
+    let(:content) { "hello world" }
+    let(:file) { Hydra::PCDM::File.new.tap { |ds| ds.content = content } }
+    it "saves technical metadata" do
+      file.file_name = "picture.jpg"
+      file.file_size = content.length.to_s
+      file.date_created = date_created
+      file.has_mime_type = "application/jpg"
+      file.date_modified = date_modified
+      file.byte_order = "little-endian"
+      expect(file.save).to be true
+      expect(reloaded.file_name).to eq ["picture.jpg"]
+      expect(reloaded.file_size).to eq [content.length.to_s]
+      expect(reloaded.has_mime_type).to eq ["application/jpg"]
+      expect(reloaded.date_created).to eq [date_created]
+      expect(reloaded.date_modified).to eq [date_modified]
+      expect(reloaded.byte_order).to eq ["little-endian"]
+    end
+
+    it "does not save server managed properties" do
+      # Currently we can't write this property because Fedora 
+      # complains that it's a server managed property. This test 
+      # is mostly to document this situation.
+      file.file_hash = "the-hash"
+      expect{file.save}.to raise_error(Ldp::BadRequest)
+    end
+  end
+
+end

data/spec/hydra/pcdm/models/object_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::Object do
+
+  let(:object1) { Hydra::PCDM::Object.create }
+  let(:object2) { Hydra::PCDM::Object.create }
+  let(:object3) { Hydra::PCDM::Object.create }
+
+  describe '#objects=' do
+    it 'should aggregate objects' do
+      object1.objects = [object2, object3]
+      object1.save
+      expect(object1.objects).to eq [object2, object3]
+    end
+  end
+
+  describe 'Related objects' do
+    before do
+      object1.related_objects = [object2]
+      object1.save
+    end
+
+    it 'persists' do
+      expect(object1.reload.related_objects).to eq [object2]
+    end
+  end
+
+  describe '#files' do
+    let(:object) { described_class.create }
+    let(:file1) { object.files.build }
+    let(:file2) { object.files.build }
+
+    before do
+      file1.content = "I'm a file"
+      file2.content = "I am too"
+      object.save!
+    end
+
+    subject { described_class.find(object.id).files }
+
+    it { is_expected.to eq [file1, file2] }
+  end
+
+  describe "filtering files" do
+    let(:object) { described_class.create }
+    let(:thumbnail)   do
+      file = object.files.build
+      Hydra::PCDM::AddTypeToFile.call(file, pcdm_thumbnail_uri)
+    end
+
+    let(:file)                { object.files.build }
+    let(:pcdm_thumbnail_uri)  { ::RDF::URI("http://pcdm.org/ThumbnailImage") }
+
+    before do
+      object.files = [file]
+      object.save
+    end
+
+    describe "filter_files_by_type" do
+      context "when the object has files with that type" do
+        before do
+          thumbnail
+        end
+        it "allows you to filter the contained files by type URI" do
+          expect( object.filter_files_by_type(pcdm_thumbnail_uri) ).to eq [thumbnail]
+        end
+        it "only overrides the #files method when you specify :type" do
+          expect( object.files ).to eq [file, thumbnail]
+        end
+      end
+      context "when the object does NOT have any files with that type" do
+        it "returns an empty array" do
+          expect( object.filter_files_by_type(pcdm_thumbnail_uri) ).to eq []
+        end
+      end
+    end
+
+    describe "file_of_type" do
+      context "when the object has files with that type" do
+        before do
+          thumbnail
+        end
+        it "returns the first file with the requested type" do
+          expect( object.file_of_type(pcdm_thumbnail_uri) ).to eq thumbnail
+        end
+      end
+      context "when the object does NOT have any files with that type" do
+        it "initializes a contained file with the requested type" do
+          returned_file =  object.file_of_type(pcdm_thumbnail_uri)
+          expect(object.files).to include(returned_file)
+          expect(returned_file).to be_new_record
+          expect(returned_file.metadata_node.get_values(:type)).to include(pcdm_thumbnail_uri)
+        end
+      end
+    end
+  end
+
+
+
+  describe ".indexer" do
+    after do
+      Object.send(:remove_const, :Foo)
+    end
+
+    context "without overriding" do
+      before do
+        class Foo < ActiveFedora::Base
+          include Hydra::PCDM::ObjectBehavior
+        end
+      end
+
+      subject { Foo.indexer }
+      it { is_expected.to eq Hydra::PCDM::ObjectIndexer }
+    end
+
+    context "when overridden with AS::Concern" do
+      before do
+        module IndexingStuff
+          extend ActiveSupport::Concern
+
+          class AltIndexer; end
+
+          module ClassMethods
+            def indexer
+              AltIndexer
+            end
+          end
+        end
+
+        class Foo < ActiveFedora::Base
+          include Hydra::PCDM::ObjectBehavior
+          include IndexingStuff
+        end
+      end
+
+      subject { Foo.indexer }
+      it { is_expected.to eq IndexingStuff::AltIndexer }
+    end
+  end
+
+end

data/spec/hydra/pcdm/object_indexer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::ObjectIndexer do
+  let(:object) { Hydra::PCDM::Object.new }
+  let(:subobject1) { Hydra::PCDM::Object.new(id: '123') }
+  let(:subobject2) { Hydra::PCDM::Object.new(id: '456') }
+  let(:indexer) { described_class.new(object) }
+
+  before do
+    allow(object).to receive(:objects).and_return([subobject1, subobject2])
+  end
+
+  describe "#generate_solr_document" do
+    subject { indexer.generate_solr_document }
+
+    it "has fields" do
+      expect(subject['objects_ssim']).to eq ['123', '456']
+    end
+  end
+end

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

@@ -0,0 +1,197 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::AddCollectionToCollection do
+
+  subject { Hydra::PCDM::Collection.create }
+
+  describe '#call' do
+    context 'with acceptable collections' do
+      let(:collection1) { Hydra::PCDM::Collection.create }
+      let(:collection2) { Hydra::PCDM::Collection.create }
+      let(:collection3) { Hydra::PCDM::Collection.create }
+      let(:collection4) { Hydra::PCDM::Collection.create }
+      let(:object1)  { Hydra::PCDM::Object.create }
+      let(:object2)  { Hydra::PCDM::Object.create }
+
+      it 'should add a collection to empty collection' do
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [collection1]
+      end
+
+      it 'should add a collection to collection with collections' do
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection2 )
+        expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [collection1,collection2]
+      end
+
+      it 'should aggregate collections in a sub-collection of a collection' do
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        Hydra::PCDM::AddCollectionToCollection.call( collection1, collection2 )
+        expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [collection1]
+        expect( Hydra::PCDM::GetCollectionsFromCollection.call( collection1 ) ).to eq [collection2]
+      end
+
+      it 'should allow collections to repeat' do
+        skip 'skipping this test because issue #94 needs to be addressed' do
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection2 )
+        Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+        expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [collection1,collection2,collection1]
+      end
+      end
+
+      context 'with collections and objects' do
+        before 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
+        end
+
+        it 'should add an object to collection with collections and objects' do
+          Hydra::PCDM::AddCollectionToCollection.call( subject, collection3 )
+          expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [collection1,collection2,collection3]
+        end
+      end
+
+      describe "adding collections that are ancestors" do
+        let(:error_message) { "a collection can't be an ancestor of itself" }
+
+        context "when the source collection is the same" do
+          it "raises an error" do
+
+            expect{ Hydra::PCDM::AddCollectionToCollection.call( subject, subject ) }.to raise_error(ArgumentError, error_message)
+          end
+        end
+
+        before do
+          Hydra::PCDM::AddCollectionToCollection.call( subject, collection1 )
+          subject.save
+        end
+
+        it "raises and error" do
+          expect{ Hydra::PCDM::AddCollectionToCollection.call( collection1, subject ) }.to raise_error(ArgumentError, error_message)
+        end
+
+        context "with more ancestors" do
+          before do
+            Hydra::PCDM::AddCollectionToCollection.call( collection1, collection2 )
+            collection2.save
+          end
+
+          it "raises an error" do
+            expect{ Hydra::PCDM::AddCollectionToCollection.call( collection2, subject ) }.to raise_error(ArgumentError, error_message)
+          end
+
+          context "with a more complicated example" do
+            before do
+              Hydra::PCDM::AddCollectionToCollection.call( collection2, collection3 )
+              Hydra::PCDM::AddCollectionToCollection.call( collection2, collection4 )
+              collection2.save
+            end
+
+            it "raises errors" do
+              expect{ Hydra::PCDM::AddCollectionToCollection.call( collection3, subject ) }.to raise_error(ArgumentError, error_message)
+              expect{ Hydra::PCDM::AddCollectionToCollection.call( collection3, collection1 ) }.to raise_error(ArgumentError, error_message)
+            end
+          end
+        end
+      end
+
+      describe 'aggregates collections that implement Hydra::PCDM' do
+        before do
+          class Kollection < ActiveFedora::Base
+            include Hydra::PCDM::CollectionBehavior
+          end
+        end
+        after { Object.send(:remove_const, :Kollection) }
+        let(:kollection1) { Kollection.create }
+
+        it 'should accept implementing collection as a child' do
+          Hydra::PCDM::AddCollectionToCollection.call( subject, kollection1 )
+          subject.save
+          expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [kollection1]
+        end
+
+        it 'should accept implementing collection as a parent' do
+          Hydra::PCDM::AddCollectionToCollection.call( kollection1, collection1 )
+          subject.save
+          expect( Hydra::PCDM::GetCollectionsFromCollection.call( kollection1 ) ).to eq [collection1]
+        end
+      end
+
+      describe 'aggregates collections that extend Hydra::PCDM' do
+        before do
+          class Cullection < Hydra::PCDM::Collection
+          end
+        end
+        after { Object.send(:remove_const, :Cullection) }
+        let(:cullection1) { Cullection.create }
+
+        it 'should accept extending collection as a child' do
+          Hydra::PCDM::AddCollectionToCollection.call( subject, cullection1 )
+          subject.save
+          expect( Hydra::PCDM::GetCollectionsFromCollection.call( subject ) ).to eq [cullection1]
+        end
+
+        it 'should accept extending collection as a parent' do
+          Hydra::PCDM::AddCollectionToCollection.call( cullection1, collection1 )
+          subject.save
+          expect( Hydra::PCDM::GetCollectionsFromCollection.call( cullection1 ) ).to eq [collection1]
+        end
+      end
+    end
+
+    context 'with unacceptable collections' do
+      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_message) { 'child_collection must be a pcdm collection' }
+
+      it 'should NOT aggregate Hydra::PCDM::Objects in collections aggregation' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( subject, object1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Files in collections aggregation' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( subject, file1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate non-PCDM objects in collections aggregation' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( subject, non_PCDM_object ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate AF::Base objects in collections aggregation' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( subject, af_base_object ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+
+    context 'with unacceptable parent collection' do
+      let(:collection2)      { Hydra::PCDM::Collection.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_message) { 'parent_collection must be a pcdm collection' }
+
+      it 'should NOT accept Hydra::PCDM::Objects as parent collection' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( object1, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::PCDM::Files as parent collection' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( file1, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept non-PCDM objects as parent collection' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( non_PCDM_object, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept AF::Base objects as parent collection' do
+        expect{ Hydra::PCDM::AddCollectionToCollection.call( af_base_object, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::AddObjectToCollection do
+
+  let(:subject) { Hydra::PCDM::Collection.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(:collection1) { Hydra::PCDM::Collection.create }
+      let(:collection2) { Hydra::PCDM::Collection.create }
+
+      it 'should add an object to empty collection' do
+        Hydra::PCDM::AddObjectToCollection.call( subject, object1 )
+        expect( Hydra::PCDM::GetObjectsFromCollection.call( subject ) ).to eq [object1]
+      end
+
+      it 'should add an object to collection with objects' do
+        Hydra::PCDM::AddObjectToCollection.call( subject, object1 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object2 )
+        expect( Hydra::PCDM::GetObjectsFromCollection.call( subject ) ).to eq [object1,object2]
+      end
+
+      it 'should allow objects to repeat' do
+        Hydra::PCDM::AddObjectToCollection.call( subject, object1 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object2 )
+        Hydra::PCDM::AddObjectToCollection.call( subject, object1 )
+        expect( Hydra::PCDM::GetObjectsFromCollection.call( subject ) ).to eq [object1,object2,object1]
+      end
+
+      context 'with collections and objects' do
+        before 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
+        end
+
+        it 'should add an object to collection with collections and objects' do
+          Hydra::PCDM::AddObjectToCollection.call( subject, object3 )
+          expect( Hydra::PCDM::GetObjectsFromCollection.call( subject ) ).to eq [object1,object2,object3]
+        end
+      end
+
+      describe 'aggregates objects that implement Hydra::PCDM' do
+        before do
+          class Ahbject < ActiveFedora::Base
+            include Hydra::PCDM::ObjectBehavior
+          end
+        end
+        after { Object.send(:remove_const, :Ahbject) }
+        let(:ahbject1) { Ahbject.create }
+
+        it 'should accept implementing object as a child' do
+          Hydra::PCDM::AddObjectToCollection.call( subject, ahbject1 )
+          subject.save
+          expect( Hydra::PCDM::GetObjectsFromCollection.call( subject ) ).to eq [ahbject1]
+        end
+
+      end
+
+      describe 'aggregates objects that extend Hydra::PCDM' do
+        before do
+          class Awbject < Hydra::PCDM::Object
+          end
+        end
+        after { Object.send(:remove_const, :Awbject) }
+        let(:awbject1) { Awbject.create }
+
+        it 'should accept extending object as a child' do
+          Hydra::PCDM::AddObjectToCollection.call( subject, awbject1 )
+          subject.save
+          expect( Hydra::PCDM::GetObjectsFromCollection.call( subject ) ).to eq [awbject1]
+        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::AddObjectToCollection.call( subject, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Files in objects aggregation' do
+        expect{ Hydra::PCDM::AddObjectToCollection.call( subject, file1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate non-PCDM objects in objects aggregation' do
+        expect{ Hydra::PCDM::AddObjectToCollection.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::AddObjectToCollection.call( subject, af_base_object ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+
+    context 'with unacceptable parent collection' do
+      let(:collection2)      { Hydra::PCDM::Collection.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_message) { 'parent_collection must be a pcdm collection' }
+
+      it 'should NOT accept Hydra::PCDM::Objects as parent collection' do
+        expect{ Hydra::PCDM::AddObjectToCollection.call( object1, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::PCDM::Files as parent collection' do
+        expect{ Hydra::PCDM::AddObjectToCollection.call( file1, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept non-PCDM objects as parent collection' do
+        expect{ Hydra::PCDM::AddObjectToCollection.call( non_PCDM_object, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept AF::Base objects as parent collection' do
+        expect{ Hydra::PCDM::AddObjectToCollection.call( af_base_object, collection2 ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+  end
+end