hydra-works 1.0.0 → 1.1.0

data/lib/hydra/works/models/concerns/collection_behavior.rb

@@ -28,6 +28,30 @@ module Hydra::Works
       type [Hydra::PCDM::Vocab::PCDMTerms.Collection, Vocab::WorksTerms.Collection]
     end
 
+    def parent_collections
+      in_collections + member_of_collections
+    end
+
+    def parent_collection_ids
+      in_collection_ids + member_of_collection_ids
+    end
+
+    def child_collections
+      collections + member_collections
+    end
+
+    def child_collection_ids
+      collection_ids + member_collection_ids
+    end
+
+    def child_works
+      works + member_works
+    end
+
+    def child_work_ids
+      work_ids + member_work_ids
+    end
+
     def ordered_works
       ordered_members.to_a.select(&:work?)
     end
@@ -44,6 +68,26 @@ module Hydra::Works
       works.map(&:id)
     end
 
+    def member_collections
+      return [] if id.nil?
+      member_objects = ActiveFedora::Base.where('member_of_collection_ids_ssim' => id)
+      member_objects.select(&:collection?).to_a
+    end
+
+    def member_collection_ids
+      member_collections.map(&:id)
+    end
+
+    def member_works
+      return [] if id.nil?
+      member_objects = ActiveFedora::Base.where('member_of_collection_ids_ssim' => id)
+      member_objects.select(&:work?).to_a
+    end
+
+    def member_work_ids
+      member_works.map(&:id)
+    end
+
     # @return [Boolean] whether this instance is a Hydra::Works Collection.
     def collection?
       true

data/lib/hydra/works/models/concerns/file_set_behavior.rb

@@ -43,10 +43,30 @@ module Hydra::Works
       true
     end
 
+    def parent_works
+      in_works + member_of_works
+    end
+
+    def parent_work_ids
+      in_work_ids + member_of_work_ids
+    end
+
     def in_works
       ordered_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::WorkBehavior) }.to_a
     end
 
+    def in_work_ids
+      in_works.map(&:id)
+    end
+
+    def member_of_works
+      member_of.select(&:work?).to_a
+    end
+
+    def member_of_work_ids
+      member_of_works.map(&:id)
+    end
+
     private
 
       def remove_from_works

data/lib/hydra/works/models/concerns/work_behavior.rb

@@ -29,6 +29,38 @@ module Hydra::Works
       type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.Work]
     end
 
+    def parent_collections
+      in_collections + member_of_collections
+    end
+
+    def parent_collection_ids
+      in_collection_ids + member_of_collection_ids
+    end
+
+    def parent_works
+      in_works + member_of_works
+    end
+
+    def parent_work_ids
+      in_work_ids + member_of_work_ids
+    end
+
+    def child_works
+      works + member_works
+    end
+
+    def child_work_ids
+      work_ids + member_work_ids
+    end
+
+    def child_file_sets
+      file_sets
+    end
+
+    def child_file_set_ids
+      file_set_ids
+    end
+
     def works
       members.select(&:work?)
     end
@@ -37,6 +69,16 @@ module Hydra::Works
       works.map(&:id)
     end
 
+    def member_works
+      return [] if id.nil?
+      member_objects = ActiveFedora::Base.where('object_ids_ssim' => id)
+      member_objects.select(&:work?).to_a
+    end
+
+    def member_work_ids
+      member_works.map(&:id)
+    end
+
     def ordered_works
       ordered_members.to_a.select(&:work?)
     end
@@ -82,6 +124,18 @@ module Hydra::Works
       ordered_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::WorkBehavior) }.to_a
     end
 
+    def in_work_ids
+      in_works.map(&:id)
+    end
+
+    def member_of_works
+      in_objects.to_a.select(&:work?)
+    end
+
+    def member_of_work_ids
+      member_of_works.map(&:id)
+    end
+
     private
 
       # Remove this object from parent works or collections

data/lib/hydra/works/services/characterization_service.rb

@@ -1,4 +1,5 @@
 require 'hydra-file_characterization'
+require 'nokogiri'
 
 module Hydra::Works
   class CharacterizationService

data/lib/hydra/works/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Works
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/lib/hydra/works/virus_scanner.rb

@@ -50,7 +50,7 @@ module Hydra::Works
     private
 
       def warning(msg)
-        ActiveFedora::Base.logger.warn(msg) if ActiveFedora::Base.logger
+        ActiveFedora::Base.logger&.warn(msg)
       end
   end
 end

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

@@ -148,4 +148,154 @@ describe Hydra::Works::Collection do
       end
     end
   end
+
+  context 'relationships' do
+    context '#parent_collections and #parent_collection_ids' do
+      let(:parent_col1) { described_class.new(id: 'parent_col1') }
+      let(:parent_col2) { described_class.new(id: 'parent_col2') }
+      let(:collection) { described_class.new(id: 'collection') }
+
+      context 'when parents collection knows about child collections' do
+        before do
+          parent_col1.members = [collection]
+          parent_col2.members = [collection]
+          collection.save
+          parent_col1.save
+          parent_col2.save
+        end
+
+        it 'gets both parent collections' do
+          expect(collection.parent_collections).to match_array [parent_col1, parent_col2]
+          expect(collection.parent_collection_ids).to match_array [parent_col1.id, parent_col2.id]
+        end
+      end
+
+      context 'when child collection knows about parent collections' do
+        before do
+          collection.member_of_collections = [parent_col1, parent_col2]
+        end
+
+        it 'gets both parent collections' do
+          expect(collection.parent_collections).to match_array [parent_col1, parent_col2]
+          expect(collection.parent_collection_ids).to match_array [parent_col1.id, parent_col2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about child' do
+        before do
+          parent_col1.members = [collection]
+          collection.member_of_collections = [parent_col2]
+          collection.save
+          parent_col1.save
+        end
+
+        it 'gets both parent collections' do
+          expect(collection.parent_collections).to match_array [parent_col1, parent_col2]
+          expect(collection.parent_collection_ids).to match_array [parent_col1.id, parent_col2.id]
+        end
+      end
+    end
+
+    context '#child_collections and #child_collection_ids' do
+      let(:child_col1) { described_class.new(id: 'child_col1') }
+      let(:child_col2) { described_class.new(id: 'child_col2') }
+      let(:child_work) { Hydra::Works::Work.new(id: 'child_work') }
+      let(:collection) { described_class.new(id: 'collection') }
+
+      context 'when child collections knows about parent collections' do
+        before do
+          child_col1.member_of_collections = [collection]
+          child_col2.member_of_collections = [collection]
+          child_work.member_of_collections = [collection]
+          child_col1.save
+          child_col2.save
+          child_work.save
+          collection.save
+        end
+
+        it 'gets both child collections' do
+          expect(collection.child_collections).to match_array [child_col1, child_col2]
+          expect(collection.child_collection_ids).to match_array [child_col1.id, child_col2.id]
+        end
+      end
+
+      context 'when parent collection knows about child collections' do
+        before do
+          collection.members = [child_col1, child_col2, child_work]
+        end
+
+        it 'gets both child collections' do
+          expect(collection.child_collections).to match_array [child_col1, child_col2]
+          expect(collection.child_collection_ids).to match_array [child_col1.id, child_col2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about children' do
+        before do
+          collection.members = [child_col1]
+          child_col2.member_of_collections = [collection]
+          child_work.member_of_collections = [collection]
+          child_col2.save
+          child_work.save
+          collection.save
+        end
+
+        it 'gets both child collections' do
+          expect(collection.child_collections).to match_array [child_col1, child_col2]
+          expect(collection.child_collection_ids).to match_array [child_col1.id, child_col2.id]
+        end
+      end
+    end
+
+    context '#child_works and #child_work_ids' do
+      let(:work1) { Hydra::Works::Work.new(id: 'work1') }
+      let(:work2) { Hydra::Works::Work.new(id: 'work2') }
+      let(:child_collection) { described_class.new(id: 'child_collection') }
+      let(:collection) { described_class.new(id: 'collection') }
+
+      context 'when child works knows about parent collections' do
+        before do
+          work1.member_of_collections = [collection]
+          work2.member_of_collections = [collection]
+          child_collection.member_of_collections = [collection]
+          work1.save
+          work2.save
+          child_collection.save
+          collection.save
+        end
+
+        it 'gets both child works' do
+          expect(collection.child_works).to match_array [work1, work2]
+          expect(collection.child_work_ids).to match_array [work1.id, work2.id]
+        end
+      end
+
+      context 'when parent collection knows about child works' do
+        before do
+          collection.members = [work1, work2, child_collection]
+        end
+
+        it 'gets both child works' do
+          expect(collection.child_works).to match_array [work1, work2]
+          expect(collection.child_work_ids).to match_array [work1.id, work2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about children' do
+        before do
+          collection.members = [work1]
+          work2.member_of_collections = [collection]
+          child_collection.member_of_collections = [collection]
+          work2.save
+          child_collection.save
+          collection.save
+        end
+
+        it 'gets both child works' do
+          expect(collection.child_works).to match_array [work1, work2]
+          expect(collection.child_work_ids).to match_array [work1.id, work2.id]
+        end
+      end
+    end
+  end
 end

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

@@ -48,6 +48,17 @@ describe Hydra::Works::FileSet do
     it { is_expected.to eq [work] }
   end
 
+  describe '#in_work_ids' do
+    subject { file_set.in_work_ids }
+    let(:work) { Hydra::Works::Work.create }
+    before do
+      work.ordered_members << file_set
+      work.save
+    end
+
+    it { is_expected.to eq [work.id] }
+  end
+
   describe '#destroy' do
     let(:work) { Hydra::Works::Work.create }
     before do
@@ -86,4 +97,40 @@ describe Hydra::Works::FileSet do
       expect(file_set.collection?).to be false
     end
   end
+
+  context 'relationships' do
+    context '#parent_works and #parent_work_ids' do
+      let(:parent_work) { Hydra::Works::Work.new(id: 'parent_work') }
+      let(:child_file_set1)   { described_class.new(id: 'child_file_set1') }
+      let(:child_file_set2)   { described_class.new(id: 'child_file_set2') }
+
+      context 'when parent work knows about child file sets' do
+        before do
+          parent_work.members = [child_file_set1, child_file_set2]
+          child_file_set1.save
+          child_file_set2.save
+          parent_work.save
+        end
+
+        it 'gets parent work' do
+          expect(child_file_set1.parent_works).to match_array [parent_work]
+          expect(child_file_set1.parent_work_ids).to match_array [parent_work.id]
+        end
+      end
+
+      context 'when child works know about parent works' do
+        # before do
+        #   # NOOP: The :member_of relationship is not defined for works.  It only uses the :members relationship.
+        #   child_file_set1.member_of = [parent_work]
+        #   child_file_set2.member_of = [parent_work]
+        # end
+
+        it 'gets parent work' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(child_file_set1.parent_works).to match_array [parent_work]
+          expect(child_file_set1.parent_work_ids).to match_array [parent_work.id]
+        end
+      end
+    end
+  end
 end

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

@@ -3,14 +3,14 @@ require 'spec_helper'
 describe Hydra::Works::Work do
   subject { described_class.new }
 
-  let(:work1) { described_class.new }
-  let(:work2) { described_class.new }
-  let(:work3) { described_class.new }
-  let(:work4) { described_class.new }
-  let(:work5) { described_class.new }
+  let(:work1) { described_class.new(id: 'wk1') }
+  let(:work2) { described_class.new(id: 'wk2') }
+  let(:work3) { described_class.new(id: 'wk3') }
+  let(:work4) { described_class.new(id: 'wk4') }
+  let(:work5) { described_class.new(id: 'wk5') }
 
-  let(:file_set1) { Hydra::Works::FileSet.new }
-  let(:file_set2) { Hydra::Works::FileSet.new }
+  let(:file_set1) { Hydra::Works::FileSet.new(id: 'fs1') }
+  let(:file_set2) { Hydra::Works::FileSet.new(id: 'fs2') }
 
   let(:object1) { Hydra::PCDM::Object.new }
   let(:object2) { Hydra::PCDM::Object.new }
@@ -262,9 +262,11 @@ describe Hydra::Works::Work do
     end
     it 'has a parent collection' do
       expect(work2.in_collections).to eq [collection1]
+      expect(work2.in_collection_ids).to eq [collection1.id]
     end
     it 'has a parent work' do
       expect(work2.in_works).to eq [work1]
+      expect(work2.in_work_ids).to eq [work1.id]
     end
   end
 
@@ -279,4 +281,208 @@ describe Hydra::Works::Work do
       expect(work1.member_of_collection_ids).to eq [collection1.id]
     end
   end
+
+  context 'relationships' do
+    context '#parent_collections and #parent_collection_ids' do
+      let(:col1) { Hydra::Works::Collection.new(id: 'col1') }
+      let(:col2) { Hydra::Works::Collection.new(id: 'col2') }
+
+      context 'when parents collection knows about child works' do
+        before do
+          col1.members = [work1]
+          col2.members = [work1]
+          work1.save
+          col1.save
+          col2.save
+        end
+
+        it 'get both parent collections' do
+          expect(work1.parent_collections).to match_array [col1, col2]
+          expect(work1.parent_collection_ids).to match_array [col1.id, col2.id]
+        end
+      end
+
+      context 'when child works knows about parent collections' do
+        before do
+          work1.member_of_collections = [col1, col2]
+        end
+
+        it 'gets both parent collections' do
+          expect(work1.parent_collections).to match_array [col1, col2]
+          expect(work1.parent_collection_ids).to match_array [col1.id, col2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about child' do
+        before do
+          col1.members = [work1]
+          work1.member_of_collections = [col2]
+          work1.save
+          col1.save
+        end
+
+        it 'gets both parent collections' do
+          expect(work1.parent_collections).to match_array [col1, col2]
+          expect(work1.parent_collection_ids).to match_array [col1.id, col2.id]
+        end
+      end
+    end
+
+    context '#parent_works and #parent_work_ids' do
+      let(:parent_col1)  { Hydra::Works::Collection.new(id: 'col1') }
+      let(:parent_work1) { work1 }
+      let(:parent_work2) { work2 }
+      let(:child_work)   { work3 }
+
+      context 'when parent work knows about child works' do
+        before do
+          parent_col1.members = [child_work] # collection is included to make sure parent_works only returns works
+          parent_work1.members = [child_work]
+          parent_work2.members = [child_work]
+          child_work.save
+          parent_col1.save
+          parent_work1.save
+          parent_work2.save
+        end
+
+        it 'gets both parent works' do
+          expect(child_work.parent_works).to match_array [parent_work1, parent_work2]
+          expect(child_work.parent_work_ids).to match_array [parent_work1.id, parent_work2.id]
+        end
+      end
+
+      context 'when child works know about parent works' do
+        # before do
+        #   # NOOP: The :member_of relationship is not defined for works.  It only uses the :members relationship.
+        #   child_work.member_of = [parent_work1, parent_work2]
+        # end
+
+        it 'gets both parent works' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(child_work.parent_works).to match_array [parent_work1, parent_work2]
+          expect(child_work.parent_work_ids).to match_array [parent_work1.id, parent_work2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about child' do
+        # before do
+        #   parent_work1.members = [child_work]
+        #   child_work.save
+        #   parent_work1.save
+        #   # NOOP: The :member_of relationship is not defined for works.  It only uses the :members relationship.
+        #   child_work.member_of = [parent_work2]
+        # end
+
+        it 'gets both parent works' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(child_work.parent_works).to match_array [parent_work1, parent_work2]
+          expect(child_work.parent_work_ids).to match_array [parent_work1.id, parent_work2.id]
+        end
+      end
+    end
+
+    context '#child_works and #child_work_ids' do
+      context 'when parent works know about child works' do
+        let(:child_work1)   { work1 }
+        let(:child_work2)   { work2 }
+        let(:parent_work)   { work3 }
+        let(:child_fileset) { file_set1 } # fileset is included to make sure child_works only returns works
+
+        before do
+          parent_work.members = [child_work1, child_work2, child_fileset]
+          parent_work.save
+        end
+
+        it 'gets both child works' do
+          expect(parent_work.child_works).to match_array [child_work1, child_work2]
+          expect(parent_work.child_work_ids).to match_array [child_work1.id, child_work2.id]
+        end
+      end
+
+      context 'when child knows about parent' do
+        before do
+          # before do
+          #   # NOOP: The :member_of relationship is not defined for works.  It only uses the :members relationship.
+          #   child_work1.member_of = [parent_work]
+          #   child_work2.member_of = [parent_work]
+          # end
+        end
+
+        it 'gets both child works' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(parent_work.child_works).to match_array [child_work1, child_work2]
+          expect(parent_work.child_work_ids).to match_array [child_work1.id, child_work2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about child' do
+        before do
+          # before do
+          #   # NOOP: The :member_of relationship is not defined for works.  It only uses the :members relationship.
+          #   child_work1.member_of = [parent_work]
+          #   parent_work.members = [child_work2, child_fileset]
+          #   parent_work.save
+          # end
+        end
+
+        it 'gets both child works' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(parent_work.child_works).to match_array [child_work1, child_work2]
+          expect(parent_work.child_work_ids).to match_array [child_work1.id, child_work2.id]
+        end
+      end
+    end
+
+    context '#child_file_sets and #child_file_set_ids' do
+      context 'when parents knows about child' do
+        let(:child_fileset1) { file_set1 }
+        let(:child_fileset2) { file_set2 }
+        let(:parent_work)    { work1 }
+        let(:child_work)     { work2 } # work is included to make sure child_file_sets only returns file_sets
+
+        before do
+          parent_work.members = [child_fileset1, child_fileset2, child_work]
+          parent_work.save
+        end
+
+        it 'gets both child filesets' do
+          expect(parent_work.child_file_sets).to match_array [child_fileset1, child_fileset2]
+          expect(parent_work.child_file_set_ids).to match_array [child_fileset1.id, child_fileset2.id]
+        end
+      end
+
+      context 'when child knows about parent' do
+        before do
+          # before do
+          #   # NOOP: The :member_of relationship is not defined for file sets.  It only uses the :members relationship.
+          #   child_fileset1.member_of = [parent_work]
+          #   child_fileset2.member_of = [parent_work]
+          # end
+        end
+
+        it 'gets both child filesets' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(parent_work.child_file_sets).to match_array [child_fileset1, child_fileset2]
+          expect(parent_work.child_file_set_ids).to match_array [child_fileset1.id, child_fileset2.id]
+        end
+      end
+
+      context 'when some children know about parent and some parents know about child' do
+        before do
+          # before do
+          #   # NOOP: The :member_of relationship is not defined for file sets.  It only uses the :members relationship.
+          #   child_fileset1.member_of = [parent_work]
+          #   parent_work.members = [child_fileset2, child_work]
+          #   parent_work.save
+          # end
+        end
+
+        it 'gets both child filesets' do
+          skip 'Pending implementation of the :member_of relationship for works'
+          expect(parent_work.child_file_sets).to match_array [child_fileset1, child_fileset2]
+          expect(parent_work.child_file_set_ids).to match_array [child_fileset1.id, child_fileset2.id]
+        end
+      end
+    end
+  end
 end