hydra-works 0.0.1

data/lib/hydra/works/version.rb

@@ -0,0 +1,5 @@
+module Hydra
+  module Works
+    VERSION = "0.0.1"
+  end
+end

data/lib/hydra/works/vocab/works_terms.rb

@@ -0,0 +1,12 @@
+require 'rdf'
+module WorksVocabularies
+  class WorksTerms < RDF::Vocabulary("http://hydra.org/works/models#")
+
+    # Class definitions
+    term :Collection
+    term :GenericWork
+    term :GenericFile
+    term :File
+
+  end
+end

data/spec/fixtures/updated-file.txt

@@ -0,0 +1 @@
+some updated content

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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Hydra::Works::Collection do
+
+  let(:collection1) { Hydra::Works::Collection.create }
+  let(:collection2) { Hydra::Works::Collection.create }
+  let(:collection3) { Hydra::Works::Collection.create }
+
+  let(:generic_work1) { Hydra::Works::GenericWork::Base.create }
+  let(:generic_work2) { Hydra::Works::GenericWork::Base.create }
+
+  describe '#collections=' do
+    it 'should aggregate collections' do
+      collection1.collections = [collection2, collection3]
+      collection1.save
+      expect(collection1.collections).to eq [collection2, collection3]
+    end
+  end
+
+  describe '#generic_works=' do
+    it 'should aggregate generic_works' do
+      collection1.generic_works = [generic_work1,generic_work2]
+      collection1.save
+      expect(collection1.generic_works).to eq [generic_work1,generic_work2]
+    end
+  end
+
+  describe 'Related objects' do
+    let(:object) { Hydra::PCDM::Object.create }
+    let(:collection) { Hydra::Works::Collection.create }
+
+    before do
+      collection.related_objects = [object]
+      collection.save
+    end
+
+    it 'persists' do
+      expect(collection.reload.related_objects).to eq [object]
+    end
+  end
+end

data/spec/hydra/works/models/concerns/file/contained_files_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Hydra::Works::GenericFile::ContainedFiles do
+
+  let(:generic_file) do
+    Hydra::Works::GenericFile::Base.create
+  end
+
+  let(:thumbnail)   do
+    file = generic_file.files.build
+    Hydra::PCDM::AddTypeToFile.call(file, pcdm_thumbnail_uri)
+  end
+
+  let(:file)                { generic_file.files.build }
+  let(:pcdm_thumbnail_uri)  { ::RDF::URI("http://pcdm.org/ThumbnailImage") }
+
+  before do
+    generic_file.files = [file]
+    generic_file.save
+  end
+
+  describe "#thumbnail" do
+
+    context "when a thumbnail is present" do
+      before do
+        generic_file.thumbnail.content = "thumbnail"
+      end
+      subject { generic_file.thumbnail }
+      it "can be saved without errors" do
+        expect(subject.save).to be_truthy
+      end
+      it "retrieves content of the thumbnail" do
+        expect(subject.content).to eql "thumbnail"
+      end
+      it "retains origin pcdm.File RDF type" do
+        expect(subject.metadata_node.type).to include( ::RDF::URI("http://pcdm.org/ThumbnailImage") )
+        expect(subject.metadata_node.type).to include(RDFVocabularies::PCDMTerms.File)
+      end
+    end
+
+    context "when no thumbnail is present" do
+      subject { generic_file.thumbnail }
+      it "initializes an unsaved File object with Thumbnail type" do
+        expect(subject).to be_new_record
+        expect(subject.metadata_node.type).to include(pcdm_thumbnail_uri)
+        expect(subject.metadata_node.type).to include(RDFVocabularies::PCDMTerms.File)
+      end
+    end
+
+  end
+
+  describe "#original_file" do
+
+    context "when an original file is present" do
+      before do
+        generic_file.original_file.content = "original_file"
+      end
+      subject { generic_file.original_file }
+
+      it "can be saved without errors" do
+        expect(subject.save).to be_truthy
+      end
+      it "retrieves content of the original_file" do
+        expect(subject.content).to eql "original_file"
+      end
+      it "retains origin pcdm.File RDF type" do
+        expect(subject.metadata_node.type).to include(::RDF::URI("http://pcdm.org/OriginalFile") )
+        expect(generic_file.original_file.metadata_node.type).to include(RDFVocabularies::PCDMTerms.File)
+      end
+    end
+
+    context "when no original file is present" do
+      subject { generic_file.original_file }
+      it "initializes an unsaved File object with OrignalFile type" do
+        expect(subject).to be_new_record
+        expect(subject.metadata_node.type).to include(::RDF::URI("http://pcdm.org/OriginalFile") )
+        expect(subject.metadata_node.type).to include(RDFVocabularies::PCDMTerms.File)
+      end
+    end
+
+  end
+
+  describe "#extracted_text" do
+
+    context "when extracted text is present" do
+      before do
+        generic_file.extracted_text.content = "extracted_text"
+      end
+      subject { generic_file.extracted_text }
+      it "can be saved without errors" do
+        expect(subject.save).to be_truthy
+      end
+      it "retrieves content of the extracted_text" do
+        expect(subject.content).to eql "extracted_text"
+      end
+      it "retains origin pcdm.File RDF type" do
+        expect(subject.metadata_node.type).to include(::RDF::URI("http://pcdm.org/ExtractedText") )
+        expect(subject.metadata_node.type).to include(RDFVocabularies::PCDMTerms.File)
+      end
+    end
+
+    context "when no extracted text is present" do
+      subject { generic_file.extracted_text }
+      it "initializes an unsaved File object with ExtractedText type" do
+        expect(subject).to be_new_record
+        expect(subject.metadata_node.type).to include(::RDF::URI("http://pcdm.org/ExtractedText") )
+        expect(subject.metadata_node.type).to include(RDFVocabularies::PCDMTerms.File)
+      end
+    end
+
+  end
+
+end

data/spec/hydra/works/models/concerns/generic_file_behavior_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Hydra::Works::GenericFileBehavior do
+  class IncludesGenericFileBehavior < ActiveFedora::Base
+    include Hydra::Works::GenericFileBehavior
+  end
+  subject { IncludesGenericFileBehavior.new }
+
+  it "ensures that objects will be recognized as generic_files" do
+    expect(Hydra::Works.generic_file? subject).to be_truthy
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Hydra::Works::GenericFile::Base do
+
+  let(:generic_file1) { Hydra::Works::GenericFile::Base.create }
+  let(:generic_file2) { Hydra::Works::GenericFile::Base.create }
+  let(:generic_file3) { Hydra::Works::GenericFile::Base.create }
+
+  describe '#generic_files=' do
+    it 'should aggregate generic_files' do
+      generic_file1.generic_files = [generic_file2, generic_file3]
+      generic_file1.save
+      expect(generic_file1.generic_files).to eq [generic_file2, generic_file3]
+    end
+  end
+
+  describe 'Related objects' do
+    let(:object1) { Hydra::PCDM::Object.create }
+
+    before do
+      generic_file1.related_objects = [object1]
+      generic_file1.save
+    end
+
+    it 'persists' do
+      expect(generic_file1.reload.related_objects).to eq [object1]
+    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
+end

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

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Hydra::Works::GenericWork do
+
+  let(:generic_work1) { Hydra::Works::GenericWork::Base.create }
+  let(:generic_work2) { Hydra::Works::GenericWork::Base.create }
+  let(:generic_work3) { Hydra::Works::GenericWork::Base.create }
+
+  let(:generic_file1) { Hydra::Works::GenericFile::Base.create }
+  let(:generic_file2) { Hydra::Works::GenericFile::Base.create }
+
+  let(:pcdm_file1)       { Hydra::PCDM::File.new }
+
+  describe '#generic_works=' do
+    it 'should aggregate generic_works' do
+      generic_work1.generic_works = [generic_work2, generic_work3]
+      generic_work1.save
+      expect(generic_work1.generic_works).to eq [generic_work2, generic_work3]
+    end
+  end
+
+  describe '#generic_files=' do
+    it 'should aggregate generic_files' do
+      generic_work1.generic_files = [generic_file1, generic_file2]
+      generic_work1.save
+      expect(generic_work1.generic_files).to eq [generic_file1, generic_file2]
+    end
+  end
+
+  describe '#contains' do
+    it 'should present as a missing method' do
+      expect{ generic_work1.contains = [pcdm_file1] }.to raise_error(NoMethodError,"works can not directly contain files.  You must add a GenericFile to the work's members and add files to that GenericFile.")
+    end
+  end
+
+  describe 'Related objects' do
+    let(:generic_work1) { Hydra::Works::GenericWork::Base.create }
+    let(:object1) { Hydra::PCDM::Object.create }
+
+    before do
+      generic_work1.related_objects = [object1]
+      generic_work1.save
+    end
+
+    it 'persists' do
+      expect(generic_work1.reload.related_objects).to eq [object1]
+    end
+  end
+
+end

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

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe Hydra::Works::AddCollectionToCollection do
+
+  subject { Hydra::Works::Collection.create }
+
+  describe '#call' do
+    context 'with acceptable collections' do
+      let(:collection1) { Hydra::Works::Collection.create }
+      let(:collection2) { Hydra::Works::Collection.create }
+      let(:collection3) { Hydra::Works::Collection.create }
+      let(:generic_work1)  { Hydra::Works::GenericWork::Base.create }
+      let(:generic_work2)  { Hydra::Works::GenericWork::Base.create }
+
+      context 'with collections and generic_works' do
+        before do
+          Hydra::Works::AddCollectionToCollection.call( subject, collection1 )
+          Hydra::Works::AddCollectionToCollection.call( subject, collection2 )
+          Hydra::Works::AddGenericWorkToCollection.call( subject, generic_work1 )
+          Hydra::Works::AddGenericWorkToCollection.call( subject, generic_work2 )
+          subject.save
+        end
+
+        it 'should add an generic_work to collection with collections and generic_works' do
+          Hydra::Works::AddCollectionToCollection.call( subject, collection3 )
+          expect( Hydra::Works::GetCollectionsFromCollection.call( subject ) ).to eq [collection1,collection2,collection3]
+        end
+
+        it 'should solrize member ids' do
+          skip 'skipping this test because issue #109 needs to be addressed' do
+          expect(subject.to_solr["generic_works_ssim"]).to include(generic_work1.id,generic_work2.id)
+          expect(subject.to_solr["generic_works_ssim"]).not_to include(collection2.id,collection1.id,collection3.id)
+          expect(subject.to_solr["collections_ssim"]).to include(collection2.id,collection1.id,collection3.id)
+          expect(subject.to_solr["collections_ssim"]).not_to include(generic_work1.id,generic_work2.id)
+        end
+        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.create }
+
+        it 'should accept implementing collection as a child' do
+          Hydra::Works::AddCollectionToCollection.call( subject, kollection1 )
+          subject.save
+          expect( Hydra::Works::GetCollectionsFromCollection.call( subject ) ).to eq [kollection1]
+        end
+
+        it 'should accept implementing collection as a parent' do
+          Hydra::Works::AddCollectionToCollection.call( kollection1, collection1 )
+          subject.save
+          expect( Hydra::Works::GetCollectionsFromCollection.call( kollection1 ) ).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.create }
+
+        it 'should accept extending collection as a child' do
+          Hydra::Works::AddCollectionToCollection.call( subject, cullection1 )
+          subject.save
+          expect( Hydra::Works::GetCollectionsFromCollection.call( subject ) ).to eq [cullection1]
+        end
+
+        it 'should accept extending collection as a parent' do
+          Hydra::Works::AddCollectionToCollection.call( cullection1, collection1 )
+          subject.save
+          expect( Hydra::Works::GetCollectionsFromCollection.call( cullection1 ) ).to eq [collection1]
+        end
+      end
+    end
+
+    context 'with unacceptable child collections' do
+      let(:generic_work1)    { Hydra::Works::GenericWork::Base.create }
+      let(:generic_file1)    { Hydra::Works::GenericFile::Base.create }
+      let(:pcdm_collection1) { Hydra::PCDM::Collection.create }
+      let(:pcdm_object1)     { Hydra::PCDM::Object.create }
+      let(:pcdm_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 hydra-works collection' }
+
+      it 'should NOT aggregate Hydra::Works::GenericWork in collections aggregation' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( subject, generic_work1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::Works::GenericFile in collections aggregation' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( subject, generic_file1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Collections in collections aggregation' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( subject, pcdm_collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Objects in collections aggregation' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( subject, pcdm_object1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate Hydra::PCDM::Files in collections aggregation' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( subject, pcdm_file1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT aggregate non-PCDM objects in collections aggregation' do
+        expect{ Hydra::Works::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::Works::AddCollectionToCollection.call( subject, af_base_object ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+
+    context 'with unacceptable parent collections' do
+      let(:collection1)      { Hydra::Works::Collection.create }
+      let(:generic_work1)    { Hydra::Works::GenericWork::Base.create }
+      let(:generic_file1)    { Hydra::Works::GenericFile::Base.create }
+      let(:pcdm_collection1) { Hydra::PCDM::Collection.create }
+      let(:pcdm_object1)     { Hydra::PCDM::Object.create }
+      let(:pcdm_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 hydra-works collection' }
+
+      it 'should NOT accept Hydra::Works::GenericWork as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( generic_work1, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::Works::GenericFile as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( generic_file1, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::PCDM::Collections as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( pcdm_collection1, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::PCDM::Objects as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( pcdm_object1, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept Hydra::PCDM::Files as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( pcdm_file1, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept non-PCDM objects as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( non_PCDM_object, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+
+      it 'should NOT accept AF::Base objects as parent collection' do
+        expect{ Hydra::Works::AddCollectionToCollection.call( af_base_object, collection1 ) }.to raise_error(ArgumentError,error_message)
+      end
+    end
+
+  end
+
+end