hydra-pcdm 0.0.1 → 0.1.0

data/lib/hydra/pcdm/services/object/add_related_object.rb

@@ -1,21 +0,0 @@
-module Hydra::PCDM
-  class AddRelatedObjectToObject
-
-    ##
-    # Add a related object to an object.
-    #
-    # @param [Hydra::PCDM::Object] :parent_object to which to add the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being added
-    #
-    # @return [Hydra::PCDM::Object] the updated pcdm object
-
-    def self.call( parent_object, child_related_object )
-      raise ArgumentError, "parent_object must be a pcdm object" unless Hydra::PCDM.object? parent_object
-      raise ArgumentError, "child_related_object must be a pcdm object" unless Hydra::PCDM.object? child_related_object
-
-      # parent_object.related_objects = parent_object.related_objects + child_related_object
-      parent_object.related_objects << child_related_object
-    end
-
-  end
-end

data/lib/hydra/pcdm/services/object/get_objects.rb

@@ -1,18 +0,0 @@
-module Hydra::PCDM
-  class GetObjectsFromObject
-
-    ##
-    # Get member objects from an object in order.
-    #
-    # @param [Hydra::PCDM::Object] :parent_object in which the child objects are members
-    #
-    # @return [Array<Hydra::PCDM::Object>] all member objects
-
-    def self.call( parent_object )
-      raise ArgumentError, "parent_object must be a pcdm object" unless Hydra::PCDM.object? parent_object
-
-      parent_object.objects
-    end
-
-  end
-end

data/lib/hydra/pcdm/services/object/get_related_objects.rb

@@ -1,17 +0,0 @@
-module Hydra::PCDM
-  class GetRelatedObjectsFromObject
-
-    ##
-    # Get related objects from an object.
-    #
-    # @param [Hydra::PCDM::Object] :parent_object to which the child objects are related
-    #
-    # @return [Array<Hydra::PCDM::Object>] all related objects
-
-    def self.call( parent_object )
-      raise ArgumentError, "parent_object must be a pcdm object" unless Hydra::PCDM.object? parent_object
-      parent_object.related_objects.to_a
-    end
-
-  end
-end

data/lib/hydra/pcdm/services/object/remove_object.rb

@@ -1,43 +0,0 @@
-module Hydra::PCDM
-  class RemoveObjectFromObject
-
-    ##
-    # Remove an object from an object.
-    #
-    # @param [Hydra::PCDM::Object] :parent_object from which to remove object
-    # @param [Hydra::PCDM::Object] :child_object being removed
-    # @param [Fixnum] :nth_occurrence remove nth occurrence of this object in the list (default=1)
-    #
-    # @return [Hydra::PCDM::Object] the updated pcdm object
-
-    def self.call( parent_object, child_object, nth_occurrence=1 )
-      raise ArgumentError, "parent_object must be a pcdm object" unless Hydra::PCDM.object? parent_object
-      raise ArgumentError, "child_object must be a pcdm object" unless Hydra::PCDM.object? child_object
-
-
-      # TODO FIX when members is empty, members.delete raises ActiveFedora::ObjectNotFoundError "Can't reload an object that hasn't been saved"  (activefedora-aggregation issue #35)
-
-      # TODO members.delete should...   (issue #103)(activefedora-aggregation issue #34)
-      #   * return child_object when successful delete  (not Array [child_object])
-      #   * return nil if child_object does not exist in parent_object
-      #   * raise error for any other problems
-
-      # TODO Per issue #103, uncomment the following line when (activefedora-aggregation issue #34) is resolved
-      # parent_object.members.delete child_object
-
-      # TODO Per issue #103, remove the following lines when (activefedora-aggregation issue #34) is resolved
-      return nil    unless parent_object.members.include? child_object
-      removed_object = parent_object.members.delete child_object
-      removed_object = removed_object.first  if removed_object.is_a? Array
-      removed_object
-      # END WORK-AROUND
-
-
-      # TODO -- The same object may be in the list multiple times.  (issue #102)
-      #   * How to remove nth occurrence?
-      #   * Default to removing 1st occurrence from the beginning of the list.
-
-    end
-
-  end
-end

data/lib/hydra/pcdm/services/object/remove_related_object.rb

@@ -1,36 +0,0 @@
-module Hydra::PCDM
-  class RemoveRelatedObjectFromObject
-
-    ##
-    # Remove an object from an object.
-    #
-    # @param [Hydra::PCDM::Object] :parent_object from which to remove the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being removed
-    #
-    # @return [Hydra::PCDM::Collection] the updated pcdm collection
-
-    def self.call( parent_object, child_related_object )
-      raise ArgumentError, "parent_object must be a pcdm object" unless Hydra::PCDM.object? parent_object
-      raise ArgumentError, "child_related_object must be a pcdm object" unless Hydra::PCDM.object? child_related_object
-
-
-      # TODO FIX when related_objects is empty, related_objects.delete raises ActiveFedora::ObjectNotFoundError "Can't reload an object that hasn't been saved"  (activefedora-aggregation issue #805)
-
-      # TODO related_objects.delete should...   (issue #103)(activefedora-aggregation issue #805)
-      #   * return child_related_object when successful delete  (not Array [child_related_object])
-      #   * return nil if child_related_object does not exist in parent_object
-      #   * raise error for any other problems
-
-      # TODO Per issue #103, uncomment the following line when (activefedora issue #805) is resolved
-      # parent_object.related_objects.delete child_related_object
-
-      # TODO Per issue #103, remove the following lines when (activefedora issue #805) is resolved
-      return nil unless Hydra::PCDM::GetRelatedObjectsFromObject.call( parent_object ).include? child_related_object
-      removed_related_object = parent_object.related_objects.delete child_related_object
-      removed_related_object = removed_related_object.first  if removed_related_object.is_a? Array
-      removed_related_object
-      # END WORK-AROUND
-    end
-
-  end
-end

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

@@ -1,197 +0,0 @@
-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

@@ -1,132 +0,0 @@
-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