hyrax 2.9.6 → 3.0.0.pre.beta1

data/spec/models/collection_spec.rb

@@ -0,0 +1,326 @@
+RSpec.describe Collection, type: :model do
+  let(:collection) { build(:public_collection) }
+
+  it "has open visibility" do
+    expect(collection.read_groups).to eq ['public']
+  end
+
+  describe "#validates_with" do
+    before { collection.title = nil }
+    it "ensures the collection has a title" do
+      expect(collection).not_to be_valid
+      expect(collection.errors.messages[:title]).to eq(["You must provide a title"])
+    end
+  end
+
+  describe "#to_solr" do
+    let(:user) { build(:user) }
+    let(:collection) { build(:collection, user: user, title: ['A good title']) }
+
+    let(:solr_document) { collection.to_solr }
+
+    it "has title information and depositor information" do
+      expect(solr_document).to include 'title_tesim' => ['A good title'],
+                                       'title_sim' => ['A good title'],
+                                       'depositor_tesim' => [user.user_key],
+                                       'depositor_ssim' => [user.user_key]
+    end
+  end
+
+  describe "#depositor" do
+    let(:user) { build(:user) }
+
+    before do
+      subject.apply_depositor_metadata(user)
+    end
+
+    it "has a depositor" do
+      expect(subject.depositor).to eq(user.user_key)
+    end
+  end
+
+  describe "#members_objects", clean_repo: true do
+    let(:collection) { create(:collection) }
+
+    it "is empty by default" do
+      expect(collection.member_objects).to match_array []
+    end
+
+    context "when adding members" do
+      let(:work1) { create(:work) }
+      let(:work2) { create(:work) }
+      let(:work3) { create(:work) }
+
+      it "allows multiple files to be added" do
+        collection.add_member_objects [work1.id, work2.id]
+        collection.save!
+        expect(collection.reload.member_objects).to match_array [work1, work2]
+      end
+
+      context 'when multiple membership checker returns a non-nil value' do
+        before do
+          allow(Hyrax::MultipleMembershipChecker).to receive(:new).with(item: work1).and_return(nil_checker)
+          allow(Hyrax::MultipleMembershipChecker).to receive(:new).with(item: work2).and_return(checker)
+          allow(Hyrax::MultipleMembershipChecker).to receive(:new).with(item: work3).and_return(nil_checker)
+          allow(nil_checker).to receive(:check).and_return(nil)
+          allow(checker).to receive(:check).and_return(error_message)
+        end
+
+        let(:checker) { double }
+        let(:nil_checker) { double }
+        let(:error_message) { 'Error: foo bar' }
+
+        it 'fails to add the member' do
+          collection.add_member_objects [work1.id, work2.id, work3.id]
+          collection.save!
+          expect(collection.reload.member_objects).to match_array [work1, work3]
+        end
+      end
+    end
+  end
+
+  describe "#destroy", clean_repo: true do
+    let(:collection) { build(:collection) }
+    let(:work1) { create(:work) }
+
+    before do
+      collection.add_member_objects [work1.id]
+      collection.save!
+      collection.destroy
+    end
+
+    it "does not delete member files when deleted" do
+      expect(GenericWork.exists?(work1.id)).to be true
+    end
+  end
+
+  describe "Collection by another name" do
+    before do
+      class OtherCollection < ActiveFedora::Base
+        include Hyrax::CollectionBehavior
+      end
+
+      class Member < ActiveFedora::Base
+        include Hydra::Works::WorkBehavior
+      end
+      collection.add_member_objects member.id
+    end
+    after do
+      Object.send(:remove_const, :OtherCollection)
+      Object.send(:remove_const, :Member)
+    end
+
+    let(:member) { Member.create }
+    let(:collection) { OtherCollection.create(title: ['test title'], collection_type_gid: create(:user_collection_type).gid) }
+
+    it "have members that know about the collection", clean_repo: true do
+      member.reload
+      expect(member.member_of_collections).to eq [collection]
+    end
+  end
+
+  describe '#collection_type_gid', :clean_repo do
+    subject(:collection) { described_class.new(collection_type_gid: collection_type.gid) }
+
+    let(:collection_type) { create(:collection_type) }
+
+    it 'has a collection_type_gid' do
+      expect(collection.collection_type_gid).to eq collection_type.gid
+    end
+  end
+
+  describe '#collection_type_gid=' do
+    let(:collection) { build(:collection) }
+    let(:collection_type) { create(:collection_type) }
+
+    it 'sets gid' do
+      collection.collection_type_gid = collection_type.gid
+      expect(collection.collection_type_gid).to eq collection_type.gid
+    end
+
+    it 'throws ActiveRecord::RecordNotFound if cannot find collection type for the gid' do
+      gid = 'gid://internal/hyrax-collectiontype/999'
+      expect { collection.collection_type_gid = gid }.to raise_error(ActiveRecord::RecordNotFound, "Couldn't find Hyrax::CollectionType matching GID '#{gid}'")
+    end
+
+    it 'throws ActiveRecord::RecordNotFound if set to nil' do
+      expect { collection.collection_type_gid = nil }.to raise_error(ActiveRecord::RecordNotFound, "Couldn't find Hyrax::CollectionType matching GID ''")
+    end
+
+    it 'updates the collection_type instance variable' do
+      expect { collection.collection_type_gid = collection_type.gid }.to change { collection.collection_type }.from(create(:user_collection_type)).to(collection_type)
+    end
+
+    it 'throws ArgumentError if collection has already been persisted with a collection type' do
+      collection.save!
+      expect(collection.collection_type_gid).not_to be_nil
+      expect { collection.collection_type_gid = create(:collection_type).gid }.to raise_error(RuntimeError, "Can't modify collection type of this collection")
+    end
+  end
+
+  describe '#collection_type' do
+    let(:collection) { described_class.new(collection_type: collection_type) }
+    let(:collection_type) { create(:collection_type) }
+
+    it 'returns a collection_type instance from the collection_type_gid' do
+      expect(collection.collection_type).to be_kind_of(Hyrax::CollectionType)
+      expect(collection.collection_type).to eq collection_type
+      expect(collection.collection_type.gid).to eq collection_type.gid
+    end
+  end
+
+  describe 'collection type delegated methods' do
+    subject { build(:collection) }
+
+    it { is_expected.to delegate_method(:nestable?).to(:collection_type) }
+    it { is_expected.to delegate_method(:discoverable?).to(:collection_type) }
+    it { is_expected.to delegate_method(:brandable?).to(:collection_type) }
+    it { is_expected.to delegate_method(:sharable?).to(:collection_type) }
+    it { is_expected.to delegate_method(:share_applies_to_new_works?).to(:collection_type) }
+    it { is_expected.to delegate_method(:allow_multiple_membership?).to(:collection_type) }
+    it { is_expected.to delegate_method(:require_membership?).to(:collection_type) }
+    it { is_expected.to delegate_method(:assigns_workflow?).to(:collection_type) }
+    it { is_expected.to delegate_method(:assigns_visibility?).to(:collection_type) }
+  end
+
+  describe '.after_destroy' do
+    it 'will destroy the associated permission template' do
+      collection = create(:collection, with_permission_template: true)
+      expect { collection.destroy }.to change { Hyrax::PermissionTemplate.count }.by(-1)
+    end
+  end
+
+  describe '#reset_access_controls!' do
+    let!(:user) { build(:user) }
+    let(:collection_type) { create(:collection_type) }
+    let!(:collection) { create(:collection, user: user, collection_type_gid: collection_type.gid) }
+    let!(:permission_template) { build(:permission_template) }
+
+    before do
+      allow(collection).to receive(:permission_template).and_return(permission_template)
+      allow(permission_template).to receive(:agent_ids_for).with(access: 'manage', agent_type: 'user').and_return(['mgr1@ex.com', 'mgr2@ex.com', user.user_key])
+      allow(permission_template).to receive(:agent_ids_for).with(access: 'manage', agent_type: 'group').and_return(['managers', ::Ability.admin_group_name])
+      allow(permission_template).to receive(:agent_ids_for).with(access: 'deposit', agent_type: 'user').and_return(['dep1@ex.com', 'dep2@ex.com'])
+      allow(permission_template).to receive(:agent_ids_for).with(access: 'deposit', agent_type: 'group').and_return(['depositors', ::Ability.admin_group_name])
+      allow(permission_template).to receive(:agent_ids_for).with(access: 'view', agent_type: 'user').and_return(['vw1@ex.com', 'vw2@ex.com'])
+      allow(permission_template).to receive(:agent_ids_for).with(access: 'view', agent_type: 'group').and_return(['viewers', ::Ability.admin_group_name])
+    end
+
+    it 'resets user edit access' do
+      expect(collection.edit_users).to match_array([user.user_key])
+      collection.reset_access_controls!
+      expect(collection.edit_users).to match_array([user.user_key, 'mgr1@ex.com', 'mgr2@ex.com'])
+    end
+
+    it 'resets group edit access' do
+      expect(collection.edit_groups).to match_array([])
+      collection.reset_access_controls!
+      expect(collection.edit_groups).to match_array(['managers', ::Ability.admin_group_name])
+    end
+
+    it 'resets user read access' do
+      expect(collection.read_users).to match_array([])
+      collection.reset_access_controls!
+      expect(collection.read_users).to match_array(['vw1@ex.com', 'vw2@ex.com', 'dep1@ex.com', 'dep2@ex.com'])
+    end
+
+    it 'resets group read access' do
+      expect(collection.read_groups).to match_array([])
+      collection.reset_access_controls!
+      expect(collection.read_groups).to match_array(['viewers', 'depositors', ::Ability.admin_group_name])
+    end
+  end
+
+  context 'collection factory' do
+    let(:user) { build(:user) }
+
+    describe 'permission template' do
+      it 'will be created when with_permission_template is true' do
+        expect { create(:collection, with_permission_template: true) }.to change { Hyrax::PermissionTemplate.count }.by(1)
+      end
+
+      it 'will be created when with_permission_template is set to attributes identifying access' do
+        expect { create(:collection, with_permission_template: { manage_users: [user] }) }.to change { Hyrax::PermissionTemplate.count }.by(1)
+        expect { create(:collection, with_permission_template: { manage_users: [user], deposit_users: [user] }) }.to change { Hyrax::PermissionTemplate.count }.by(1)
+      end
+
+      it 'will be created when create_access is true' do
+        expect { create(:collection, create_access: true) }.to change { Hyrax::PermissionTemplate.count }.by(1)
+      end
+
+      it 'will not be created by default' do
+        expect { create(:collection) }.not_to change { Hyrax::PermissionTemplate.count }
+      end
+    end
+
+    describe 'permission template access' do
+      it 'will not be created when with_permission_template is true' do
+        expect { create(:collection, with_permission_template: true) }.not_to change { Hyrax::PermissionTemplateAccess.count }
+      end
+
+      it 'will be created when with_permission_template is set to attributes identifying access' do
+        expect { create(:collection, with_permission_template: { manage_users: [user] }) }.to change { Hyrax::PermissionTemplateAccess.count }.by(1)
+        expect { create(:collection, with_permission_template: { manage_users: [user], deposit_users: [user] }) }.to change { Hyrax::PermissionTemplateAccess.count }.by(2)
+      end
+
+      it 'will be created when create_access is true' do
+        expect { create(:collection, user: user, create_access: true) }.to change { Hyrax::PermissionTemplate.count }.by(1)
+      end
+
+      it 'will not be created by default' do
+        expect { create(:collection) }.not_to change { Hyrax::PermissionTemplateAccess.count }
+      end
+    end
+
+    describe 'when including nesting indexing', with_nested_reindexing: true do
+      # Nested indexing requires that the user's permissions be saved
+      # on the Fedora object... if simply in local memory, they are
+      # lost when the adapter pulls the object from Fedora to reindex.
+      let(:user) { create(:user) }
+      let(:collection) { create(:collection, user: user) }
+
+      it 'will authorize the creating user' do
+        expect(user.can?(:edit, collection)).to be true
+      end
+    end
+
+    describe 'when including with_nesting_attributes' do
+      let(:collection_type) { create(:collection_type) }
+      let(:blacklight_config) { CatalogController.blacklight_config }
+      let(:repository) { Blacklight::Solr::Repository.new(blacklight_config) }
+      let(:current_ability) { instance_double(Ability, admin?: true) }
+      let(:scope) { double('Scope', can?: true, current_ability: current_ability, repository: repository, blacklight_config: blacklight_config) }
+
+      context 'when building a collection' do
+        let(:coll123) do
+          build(:collection,
+                id: 'Collection123',
+                collection_type_gid: collection_type.gid,
+                with_nesting_attributes:
+                { ancestors: ['Parent_1'],
+                  parent_ids: ['Parent_1'],
+                  pathnames: ['Parent_1/Collection123'],
+                  depth: 2 })
+        end
+        let(:nesting_attributes) do
+          Hyrax::Collections::NestedCollectionQueryService::NestingAttributes.new(id: coll123.id, scope: scope)
+        end
+
+        it 'will persist a queryable solr document with the given attributes' do
+          expect(nesting_attributes.id).to eq('Collection123')
+          expect(nesting_attributes.parents).to eq(['Parent_1'])
+          expect(nesting_attributes.pathnames).to eq(['Parent_1/Collection123'])
+          expect(nesting_attributes.ancestors).to eq(['Parent_1'])
+          expect(nesting_attributes.depth).to eq(2)
+        end
+      end
+    end
+  end
+
+  describe '#update_nested_collection_relationship_indices', :with_nested_reindexing do
+    it 'will be called after save' do
+      expect(Samvera::NestingIndexer).to receive(:reindex_relationships).with(id: kind_of(String), extent: kind_of(String))
+      collection.save!
+    end
+  end
+end

data/spec/models/concerns/hyrax/collection_nesting_spec.rb

@@ -0,0 +1,83 @@
+RSpec.describe Hyrax::CollectionNesting do
+  describe 'including this module' do
+    let(:klass) do
+      Class.new do
+        extend ActiveModel::Callbacks
+        include ActiveModel::Validations::Callbacks
+        # Because we need these declared before we include the Hyrax::CollectionNesting
+        define_model_callbacks :destroy, only: :after
+        define_model_callbacks :save, only: :after
+        define_model_callbacks :save, only: :before
+
+        def destroy
+          true
+        end
+
+        def update_index
+          true
+        end
+
+        def before_save
+          false
+        end
+
+        def after_save
+          true
+        end
+        include Hyrax::CollectionNesting
+
+        attr_accessor :id
+      end
+    end
+
+    let(:user) { create(:user) }
+    let!(:collection) { create(:collection, collection_type_settings: [:nestable]) }
+    let!(:child_collection) { create(:collection, collection_type_settings: [:nestable]) }
+    let(:extent) { Hyrax::Adapters::NestingIndexAdapter::FULL_REINDEX }
+
+    before do
+      Hyrax::Collections::NestedCollectionPersistenceService.persist_nested_collection_for(parent: collection, child: child_collection)
+    end
+
+    subject { klass.new.tap { |obj| obj.id = collection.id } }
+
+    it { is_expected.to callback(:update_nested_collection_relationship_indices).after(:update_index) }
+    it { is_expected.to callback(:update_child_nested_collection_relationship_indices).after(:destroy) }
+    it { is_expected.to callback(:before_update_nested_collection_relationship_indices).before(:save) }
+    it { is_expected.to callback(:after_update_nested_collection_relationship_indices).after(:save) }
+    it { is_expected.to respond_to(:update_nested_collection_relationship_indices) }
+    it { is_expected.to respond_to(:update_child_nested_collection_relationship_indices) }
+    it { is_expected.to respond_to(:use_nested_reindexing?) }
+    it { is_expected.to respond_to(:reindex_extent) }
+    it { is_expected.to respond_to(:reindex_extent=) }
+
+    context 'after_update_index callback' do
+      describe '#update_nested_collection_relationship_indices' do
+        it 'will call Hyrax.config.nested_relationship_reindexer' do
+          expect(Hyrax.config.nested_relationship_reindexer).to receive(:call).with(id: subject.id, extent: extent).and_call_original
+          subject.update_nested_collection_relationship_indices
+        end
+
+        it 'will not call during save' do
+          allow(klass).to receive(:before_save).and_return(true)
+          expect(Hyrax.config.nested_relationship_reindexer).not_to receive(:call)
+        end
+      end
+    end
+
+    context 'after_destroy callback', with_nested_reindexing: true do
+      describe '#update_child_nested_collection_relationship_indices' do
+        it 'will call Hyrax.config.nested_relationship_reindexer' do
+          expect(Hyrax.config.nested_relationship_reindexer).to receive(:call).with(id: child_collection.id, extent: extent).and_call_original
+          subject.update_child_nested_collection_relationship_indices
+        end
+      end
+
+      describe '#find_children_of' do
+        it 'will return an array containing the child collection ids' do
+          expect(subject.find_children_of(destroyed_id: collection.id).first.id).to eq(child_collection.id)
+        end
+      end
+    end
+  end
+end

data/spec/models/content_block_spec.rb

@@ -0,0 +1,198 @@
+RSpec.describe ContentBlock, type: :model do
+  describe '.for' do
+    context 'with a nil' do
+      it 'raises an ArgumentError' do
+        expect { described_class.for(nil) }.to raise_error(ArgumentError)
+      end
+    end
+    context 'with a non-whitelisted value' do
+      it 'raises an ArgumentError' do
+        expect { described_class.for(:destroy_all) }.to raise_error(ArgumentError)
+      end
+    end
+    context 'with a whitelisted value as a symbol' do
+      subject { described_class.for(:about) }
+
+      it 'returns a new instance' do
+        expect(described_class).to receive(:about_page).and_call_original
+        expect(subject).to be_instance_of ContentBlock
+        expect(subject).to be_persisted
+      end
+    end
+    context 'with a whitelisted value as a string' do
+      subject { described_class.for('about') }
+
+      it 'returns a new instance' do
+        expect(described_class).to receive(:about_page).and_call_original
+        expect(subject).to be_instance_of ContentBlock
+        expect(subject).to be_persisted
+      end
+    end
+  end
+
+  describe '.announcement_text' do
+    let!(:announcement) do
+      create(:content_block,
+             name: ContentBlock::NAME_REGISTRY[:announcement],
+             value: '<h1>Announcement Text</h1>')
+    end
+
+    subject { described_class.for(:announcement).value }
+
+    it { is_expected.to eq '<h1>Announcement Text</h1>' }
+  end
+
+  describe '.announcement_text=' do
+    let(:new_announcement) { '<h2>Foobar</h2>' }
+
+    it 'sets a new announcement_text' do
+      described_class.announcement_text = new_announcement
+      expect(described_class.for(:announcement).value).to eq new_announcement
+    end
+  end
+
+  describe '.marketing_text' do
+    let!(:marketing) do
+      create(:content_block,
+             name: ContentBlock::NAME_REGISTRY[:marketing],
+             value: '<h1>Marketing Text</h1>')
+    end
+
+    subject { described_class.for(:marketing).value }
+
+    it { is_expected.to eq '<h1>Marketing Text</h1>' }
+  end
+
+  describe '.marketing_text=' do
+    let(:new_marketing) { '<h2>Barbaz</h2>' }
+
+    it 'sets a new marketing_text' do
+      described_class.marketing_text = new_marketing
+      expect(described_class.for(:marketing).value).to eq new_marketing
+    end
+  end
+
+  describe '.featured_researcher' do
+    let!(:bilbo) do
+      create(:content_block,
+             name: ContentBlock::NAME_REGISTRY[:researcher],
+             value: '<h1>Bilbo Baggins</h1>',
+             created_at: Time.zone.now)
+    end
+
+    subject { described_class.for(:researcher) }
+
+    it 'returns entry for featured_researcher' do
+      expect(subject).to eq bilbo
+    end
+  end
+
+  describe '.featured_researcher=' do
+    let(:new_researcher) { '<h2>Baz Quux</h2>' }
+
+    it 'adds a new featured researcher' do
+      described_class.featured_researcher = new_researcher
+      expect(described_class.for(:researcher).value).to eq new_researcher
+    end
+  end
+
+  describe '.agreement_page' do
+    before do
+      allow(ApplicationController).to receive(:helpers).and_return(helper_module)
+    end
+    let(:helper_module) do
+      double('helpers',
+             application_name: 'TheBest',
+             institution_name: 'Foo E D U',
+             institution_name_full: 'Foolhardy Edutainment')
+    end
+
+    subject { described_class.for(:agreement) }
+
+    it 'defaults to text loaded from a template' do
+      expect(subject.value).to include 'TheBest Deposit Agreement'
+    end
+  end
+
+  describe '.agreement_page=' do
+    let(:new_agreement) { '<h2>Quuuuuuuuuux</h2>' }
+
+    it 'changes the agreement page value' do
+      described_class.agreement_page = new_agreement
+      expect(described_class.for(:agreement).value).to eq new_agreement
+    end
+  end
+
+  describe '.terms_page' do
+    before do
+      allow(ApplicationController).to receive(:helpers).and_return(helper_module)
+    end
+    let(:helper_module) do
+      double('helpers',
+             application_name: 'TheBest',
+             institution_name: 'Foo E D U',
+             institution_name_full: 'Foolhardy Edutainment')
+    end
+
+    subject { described_class.for(:terms) }
+
+    it 'defaults to text loaded from a template' do
+      expect(subject.value).to include 'Terms of Use for TheBest'
+    end
+  end
+
+  describe '.terms_page=' do
+    let(:new_terms) { '<h2>Fooooooob</h2>' }
+
+    it 'changes the terms page value' do
+      described_class.terms_page = new_terms
+      expect(described_class.for(:terms).value).to eq new_terms
+    end
+  end
+
+  context "the about page" do
+    before do
+      create(:content_block,
+             name: ContentBlock::NAME_REGISTRY[:about],
+             value: '<h1>About Page</h1>')
+    end
+
+    describe 'getter' do
+      subject { described_class.for(:about).value }
+
+      it { is_expected.to eq '<h1>About Page</h1>' }
+    end
+
+    describe 'setter' do
+      let(:new_about) { '<h2>Foobarfoo</h2>' }
+
+      it 'sets a new about_page' do
+        described_class.about_page = new_about
+        expect(described_class.for(:about).value).to eq new_about
+      end
+    end
+  end
+
+  context "the help page" do
+    before do
+      create(:content_block,
+             name: ContentBlock::NAME_REGISTRY[:help],
+             value: '<h1>Help Page</h1>')
+    end
+
+    describe 'getter' do
+      subject { described_class.for(:help).value }
+
+      it { is_expected.to eq '<h1>Help Page</h1>' }
+    end
+
+    describe 'setter' do
+      let(:new_help) { '<h2>Foobarfoo</h2>' }
+
+      it 'sets a new help_page' do
+        described_class.help_page = new_help
+        expect(described_class.for(:help).value).to eq new_help
+      end
+    end
+  end
+end

data/spec/models/featured_work_list_spec.rb

@@ -0,0 +1,56 @@
+RSpec.describe FeaturedWorkList, type: :model do
+  let(:work1) { create(:generic_work) }
+  let(:work2) { create(:generic_work) }
+
+  describe 'featured_works' do
+    before do
+      create(:featured_work, work_id: work1.id)
+      create(:featured_work, work_id: work2.id)
+    end
+
+    it 'is a list of the featured work objects, each with the generic_work\'s solr_doc' do
+      expect(subject.featured_works.size).to eq 2
+      presenter = subject.featured_works.first.presenter
+      expect(presenter).to be_kind_of Hyrax::WorkShowPresenter
+      expect(presenter.id).to eq work1.id
+    end
+
+    context 'when one of the files is deleted' do
+      before do
+        work1.destroy
+      end
+
+      it 'is a list of the remaining featured work objects, each with the generic_work\'s solr_doc' do
+        expect(subject.featured_works.size).to eq 1
+        presenter = subject.featured_works.first.presenter
+        expect(presenter).to be_kind_of Hyrax::WorkShowPresenter
+        expect(presenter.id).to eq work2.id
+      end
+    end
+  end
+
+  describe '#featured_works_attributes=' do
+    # We don't need to persist the given work. This saves a few LDP calls.
+    let(:work_id) { 'no-need-to-persist' }
+    let(:featured_work) { create(:featured_work, work_id: work_id) }
+
+    let(:attributes) do
+      ActionController::Parameters.new(
+        "0" => {
+          "id" => featured_work.id,
+          "order" => "5"
+        }
+      ).permit!
+    end
+    let(:instance) { described_class.new }
+
+    subject { instance.featured_works_attributes = attributes }
+
+    it "sets order" do
+      subject
+      expect(featured_work.order).to eq 5
+    end
+  end
+
+  it { is_expected.to delegate_method(:empty?).to(:featured_works) }
+end