hyrax 3.3.0 → 3.4.2

data/lib/hyrax/specs/shared_specs/indexers.rb

@@ -85,6 +85,27 @@ RSpec.shared_examples 'a visibility indexer' do
   end
 end
 
+RSpec.shared_examples 'a thumbnail indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    # optionally can pass in default_visibility by setting it with a let statement if your application changes the default; Hyrax defines this as 'restricted'
+    # See samvera/hyrda-head hydra-access-controls/app/models/concerns/hydra/access_controls/access_rights.rb for possible VISIBILITY_TEXT_VALUE_...'
+  end
+  subject(:indexer)  { indexer_class.new(resource: resource) }
+  let(:thumbnail_path) { '/downloads/foo12345?file=thumbnail' }
+
+  before do
+    allow(indexer.thumbnail_path_service).to receive(:call).and_return(thumbnail_path)
+  end
+
+  describe '#to_solr' do
+    it 'indexes a thumbnail path' do
+      expect(indexer.to_solr).to include(thumbnail_path_ss: thumbnail_path)
+    end
+  end
+end
+
 RSpec.shared_examples 'a Core metadata indexer' do
   before do
     raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
@@ -144,6 +165,53 @@ RSpec.shared_examples 'a Basic metadata indexer' do
   end
 end
 
+RSpec.shared_examples 'a File Set indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: resource must be persisted for permission tests to pass
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::FileSet' unless defined?(resource) && resource.kind_of?(Hyrax::FileSet)
+    # optionally can pass in default_visibility by setting it with a let statement if your application changes the default; Hyrax defines this as 'restricted'
+    # See samvera/hyrda-head hydra-access-controls/app/models/concerns/hydra/access_controls/access_rights.rb for possible VISIBILITY_TEXT_VALUE_...'
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+  let(:file_ids)          { ['fileid1', 'fileid2'] }
+
+  it_behaves_like 'a Hyrax::Resource indexer'
+  it_behaves_like 'a Core metadata indexer'
+  it_behaves_like 'a Basic metadata indexer'
+  it_behaves_like 'a permission indexer'
+  it_behaves_like 'a visibility indexer'
+  it_behaves_like 'a thumbnail indexer'
+
+  describe '#to_solr' do
+    it 'indexes generic type' do
+      expect(indexer.to_solr)
+        .to include(generic_type_sim: a_collection_containing_exactly('FileSet'))
+    end
+
+    it 'indexed file ids' do
+      expect(indexer.to_solr)
+        .to include(file_ids_ssim: a_collection_containing_exactly(*ids))
+    end
+
+    it 'indexes representative id' do
+      expect(indexer.to_solr)
+        .to include(hasRelatedMediaFragment_ssim: a_collection_containing_exactly(an_instance_of(String)))
+    end
+
+    it 'indexes thumbnail id' do
+      expect(indexer.to_solr)
+        .to include(hasRelatedImage_ssim: a_collection_containing_exactly(an_instance_of(String)))
+    end
+
+    it 'indexes depositor' do
+      expect(indexer.to_solr)
+        .to include(depositor_ssim: [resource.depositor],
+                    depositor_tesim: [resource.depositor])
+    end
+  end
+end
+
 RSpec.shared_examples 'a Work indexer' do
   before do
     raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
@@ -158,6 +226,19 @@ RSpec.shared_examples 'a Work indexer' do
   it_behaves_like 'a Core metadata indexer'
   it_behaves_like 'a permission indexer'
   it_behaves_like 'a visibility indexer'
+  it_behaves_like 'a thumbnail indexer'
+
+  describe '#to_solr' do
+    it 'indexes representative id' do
+      expect(indexer.to_solr)
+        .to include('hasRelatedMediaFragment_ssim': a_collection_containing_exactly(an_instance_of(String)))
+    end
+
+    it 'indexes thumbnail id' do
+      expect(indexer.to_solr)
+        .to include('hasRelatedImage_ssim': a_collection_containing_exactly(an_instance_of(String)))
+    end
+  end
 end
 
 RSpec.shared_examples 'a Collection indexer' do
@@ -172,6 +253,7 @@ RSpec.shared_examples 'a Collection indexer' do
   it_behaves_like 'a Core metadata indexer'
   it_behaves_like 'a permission indexer'
   it_behaves_like 'a visibility indexer'
+  it_behaves_like 'a thumbnail indexer'
 
   describe '#to_solr' do
     it 'indexes collection type gid' do
@@ -184,15 +266,47 @@ RSpec.shared_examples 'a Collection indexer' do
         .to include(generic_type_sim: a_collection_containing_exactly('Collection'))
     end
 
+    it 'indexes depositor' do
+      expect(indexer.to_solr)
+        .to include(depositor_ssim: [resource.depositor],
+                    depositor_tesim: [resource.depositor])
+    end
+  end
+end
+
+RSpec.shared_examples 'an Administrative Set indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: resource must be persisted for permission tests to pass
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::AdministrativeSet' unless defined?(resource) && resource.kind_of?(Hyrax::AdministrativeSet)
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+
+  it_behaves_like 'a Hyrax::Resource indexer'
+  it_behaves_like 'a Core metadata indexer'
+  it_behaves_like 'a permission indexer'
+  it_behaves_like 'a visibility indexer'
+
+  describe '#to_solr' do
+    it 'indexes collection type gid' do
+      expect(indexer.to_solr)
+        .to include(collection_type_gid_ssim: a_collection_containing_exactly(an_instance_of(String)))
+    end
+
+    it 'indexes generic type' do
+      expect(indexer.to_solr)
+        .to include(generic_type_sim: a_collection_containing_exactly('Admin Set'))
+    end
+
     it 'indexes thumbnail' do
       expect(indexer.to_solr)
         .to include(thumbnail_path_ss: include('assets/collection', '.png'))
     end
 
-    it 'indexes depositor' do
+    it 'indexes creator' do
       expect(indexer.to_solr)
-        .to include(depositor_ssim: [resource.depositor],
-                    depositor_tesim: [resource.depositor])
+        .to include(creator_ssim: [resource.creator],
+                    creator_tesim: [resource.creator])
     end
   end
 end

data/lib/hyrax/transactions/admin_set_create.rb

@@ -8,7 +8,8 @@ module Hyrax
     #
     # @since 3.2.0
     class AdminSetCreate < Transaction
-      DEFAULT_STEPS = ['change_set.apply',
+      DEFAULT_STEPS = ['change_set.set_user_as_creator',
+                       'change_set.apply',
                        'admin_set_resource.apply_collection_type_permissions',
                        'admin_set_resource.save_acl'].freeze
 

data/lib/hyrax/transactions/admin_set_destroy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Destroys a {Hyraxe::AdministrativeSet}
+    #
+    # @since 3.4.0
+    class AdminSetDestroy < Transaction
+      DEFAULT_STEPS = ['admin_set_resource.check_empty',
+                       'admin_set_resource.delete',
+                       'admin_set_resource.delete_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/admin_set_update.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Updates a {Hyrax::AdministrativeSet} from a ChangeSet
+    #
+    # @since 3.4.0
+    class AdminSetUpdate < Transaction
+      DEFAULT_STEPS = ['change_set.apply',
+                       'admin_set_resource.save_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/collection_destroy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Destroys a {Hyrax::PcdmCollection}
+    #
+    # @since 3.4.0
+    class CollectionDestroy < Transaction
+      # TODO: Add step that checks if collection is empty for collections of types that require it
+      DEFAULT_STEPS = ['collection_resource.delete',
+                       'collection_resource.delete_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/collection_update.rb

@@ -4,11 +4,14 @@ require 'hyrax/transactions/transaction'
 module Hyrax
   module Transactions
     ##
-    # Creates a Collection from a ChangeSet
+    # Updates a Collection from a ChangeSet
     #
     # @since 3.2.0
     class CollectionUpdate < Transaction
-      DEFAULT_STEPS = ['change_set.apply'].freeze
+      DEFAULT_STEPS = ['change_set.apply',
+                       'collection_resource.save_collection_banner',
+                       'collection_resource.save_collection_logo',
+                       'collection_resource.save_acl'].freeze
 
       ##
       # @see Hyrax::Transactions::Transaction

data/lib/hyrax/transactions/container.rb

@@ -10,51 +10,64 @@ module Hyrax
     #
     # In advanced use, the container could provide runtime dependency injection
     # for particular step code. For the basic case, users can consider it as
-    # providing namespaceing and resolution for steps (as used in
-    # `Hyrax::Transaction::CreateWork`; e.g.
-    # `step :save_work, with: 'work.save_work'`).
+    # providing namespacing and resolution for steps (as used in
+    # `Hyrax::Transaction::WorkCreate`; e.g.
+    # `step :save, with: 'work_resource.save'`).
     #
     # @since 2.4.0
     #
     # @see https://dry-rb.org/gems/dry-container/
     class Container # rubocop:disable Metrics/ClassLength
       require 'hyrax/transactions/admin_set_create'
+      require 'hyrax/transactions/admin_set_destroy'
+      require 'hyrax/transactions/admin_set_update'
       require 'hyrax/transactions/apply_change_set'
       require 'hyrax/transactions/collection_create'
+      require 'hyrax/transactions/collection_destroy'
       require 'hyrax/transactions/collection_update'
-      require 'hyrax/transactions/create_work'
-      require 'hyrax/transactions/destroy_work'
       require 'hyrax/transactions/file_set_destroy'
       require 'hyrax/transactions/work_create'
       require 'hyrax/transactions/work_destroy'
-      require 'hyrax/transactions/update_work'
+      require 'hyrax/transactions/work_update'
       require 'hyrax/transactions/steps/add_file_sets'
       require 'hyrax/transactions/steps/add_to_collections'
       require 'hyrax/transactions/steps/add_to_parent'
-      require 'hyrax/transactions/steps/apply_collection_permission_template'
       require 'hyrax/transactions/steps/apply_collection_type_permissions'
-      require 'hyrax/transactions/steps/apply_permission_template'
-      require 'hyrax/transactions/steps/apply_visibility'
+      require 'hyrax/transactions/steps/change_depositor'
+      require 'hyrax/transactions/steps/check_for_empty_admin_set'
+      require 'hyrax/transactions/steps/delete_access_control'
       require 'hyrax/transactions/steps/delete_resource'
-      require 'hyrax/transactions/steps/destroy_work'
       require 'hyrax/transactions/steps/ensure_admin_set'
       require 'hyrax/transactions/steps/set_collection_type_gid'
-      require 'hyrax/transactions/steps/ensure_permission_template'
       require 'hyrax/transactions/steps/remove_file_set_from_work'
       require 'hyrax/transactions/steps/save'
-      require 'hyrax/transactions/steps/save_work'
       require 'hyrax/transactions/steps/save_access_control'
+      require 'hyrax/transactions/steps/save_collection_banner'
+      require 'hyrax/transactions/steps/save_collection_logo'
       require 'hyrax/transactions/steps/set_default_admin_set'
       require 'hyrax/transactions/steps/set_modified_date'
       require 'hyrax/transactions/steps/set_uploaded_date_unless_present'
+      require 'hyrax/transactions/steps/set_user_as_creator'
       require 'hyrax/transactions/steps/set_user_as_depositor'
+      require 'hyrax/transactions/steps/update_work_members'
       require 'hyrax/transactions/steps/validate'
 
+      # The following transactions and steps are deprecated.
+      require 'hyrax/transactions/create_work'
+      require 'hyrax/transactions/destroy_work'
+      require 'hyrax/transactions/update_work'
+      require 'hyrax/transactions/steps/apply_collection_permission_template'
+      require 'hyrax/transactions/steps/apply_permission_template'
+      require 'hyrax/transactions/steps/apply_visibility'
+      require 'hyrax/transactions/steps/destroy_work'
+      require 'hyrax/transactions/steps/ensure_permission_template'
+      require 'hyrax/transactions/steps/save_work'
+
       extend Dry::Container::Mixin
 
       # Disable BlockLength rule for DSL code
       # rubocop:disable Metrics/BlockLength
-      namespace 'change_set' do |ops|
+      namespace 'change_set' do |ops| # Hyrax::ChangeSet
         ops.register 'add_to_collections' do
           Steps::AddToCollections.new
         end
@@ -63,12 +76,12 @@ module Hyrax
           ApplyChangeSet.new
         end
 
-        ops.register 'create_collection' do
-          CollectionCreate.new
+        ops.register 'create_admin_set' do
+          AdminSetCreate.new
         end
 
-        ops.register 'update_collection' do
-          CollectionUpdate.new
+        ops.register 'create_collection' do
+          CollectionCreate.new
         end
 
         ops.register 'create_work' do
@@ -99,12 +112,20 @@ module Hyrax
           Steps::SetUploadedDateUnlessPresent.new
         end
 
+        ops.register 'set_user_as_creator' do
+          Steps::SetUserAsCreator.new
+        end
+
         ops.register 'set_user_as_depositor' do
           Steps::SetUserAsDepositor.new
         end
 
+        ops.register 'update_collection' do
+          CollectionUpdate.new
+        end
+
         ops.register 'update_work' do
-          UpdateWork.new
+          WorkUpdate.new
         end
 
         ops.register 'validate' do
@@ -112,7 +133,7 @@ module Hyrax
         end
       end
 
-      namespace 'file_set' do |ops| # Hyrax::FileSet
+      namespace 'file_set' do |ops| # Hyrax::FileSet resource
         ops.register 'delete' do
           Steps::DeleteResource.new
         end
@@ -126,27 +147,67 @@ module Hyrax
         end
       end
 
-      namespace 'admin_set_resource' do |ops| # valkyrie administrative set
+      namespace 'admin_set_resource' do |ops| # Hyrax::AdministrativeSet resource
+        ops.register 'check_empty' do
+          Steps::CheckForEmptyAdminSet.new
+        end
+
+        ops.register 'delete' do
+          Steps::DeleteResource.new
+        end
+
+        ops.register 'destroy' do
+          AdminSetDestroy.new
+        end
+
+        ops.register 'update' do
+          AdminSetUpdate.new
+        end
+
         ops.register 'apply_collection_type_permissions' do
           Steps::ApplyCollectionTypePermissions.new
         end
 
+        ops.register 'delete_acl' do
+          Steps::DeleteAccessControl.new
+        end
+
         ops.register 'save_acl' do
           Steps::SaveAccessControl.new
         end
       end
 
-      namespace 'collection_resource' do |ops| # valkyrie collection
+      namespace 'collection_resource' do |ops| # Hyrax::PcdmCollection resource
         ops.register 'apply_collection_type_permissions' do
           Steps::ApplyCollectionTypePermissions.new
         end
 
+        ops.register 'delete' do
+          Steps::DeleteResource.new
+        end
+
+        ops.register 'destroy' do
+          CollectionDestroy.new
+        end
+
+        ops.register 'delete_acl' do
+          Steps::DeleteAccessControl.new
+        end
+
         ops.register 'save_acl' do
           Steps::SaveAccessControl.new
         end
+
+        ops.register 'save_collection_banner' do
+          Steps::SaveCollectionBanner.new
+        end
+
+        ops.register 'save_collection_logo' do
+          Steps::SaveCollectionLogo.new
+        end
       end
 
-      namespace 'work_resource' do |ops| # valkyrie works
+      namespace 'work_resource' do |ops| # Hyrax::Work resource
         ops.register 'add_file_sets' do
           Steps::AddFileSets.new
         end
@@ -155,6 +216,10 @@ module Hyrax
           Steps::AddToParent.new
         end
 
+        ops.register 'change_depositor' do
+          Steps::ChangeDepositor.new
+        end
+
         ops.register 'delete' do
           Steps::DeleteResource.new
         end
@@ -163,12 +228,21 @@ module Hyrax
           WorkDestroy.new
         end
 
+        ops.register 'delete_acl' do
+          Steps::DeleteAccessControl.new
+        end
+
         ops.register 'save_acl' do
           Steps::SaveAccessControl.new
         end
+
+        ops.register 'update_work_members' do
+          Steps::UpdateWorkMembers.new
+        end
       end
 
-      namespace 'work' do |ops| # legacy AF works
+      # legacy AF works processing by transactions is deprecated
+      namespace 'work' do |ops|
         ops.register 'apply_collection_permission_template' do
           Steps::ApplyCollectionPermissionTemplate.new
         end

data/lib/hyrax/transactions/create_work.rb

@@ -46,9 +46,12 @@ module Hyrax
     # @deprecated Development on Dry::Transaction has been discontinued, we're
     #   removing existing transactions and replacing them with Dry::Monad-based
     #   valkyrie versions.
+    # @see Hyrax::Transactions::WorkCreate
     class CreateWork
       include Dry::Transaction(container: Hyrax::Transactions::Container)
 
+      # DO NOT USE - This class is deprecated.  See Hyrax::Transactions::WorkCreate for resource works.
+
       step :set_default_admin_set,     with: 'work.set_default_admin_set'
       step :ensure_admin_set,          with: 'work.ensure_admin_set'
       step :apply_permission_template, with: 'work.apply_permission_template'

data/lib/hyrax/transactions/destroy_work.rb

@@ -16,9 +16,12 @@ module Hyrax
     # @deprecated Development on Dry::Transaction has been discontinued, we're
     #   removing existing transactions and replacing them with Dry::Monad-based
     #   valkyrie versions.
+    # @see Hyrax::Transactions::WorkDestroy
     class DestroyWork
       include Dry::Transaction(container: Hyrax::Transactions::Container)
 
+      # DO NOT USE - This class is deprecated.  See Hyrax::Transactions::WorkDestroy for resource works.
+
       step :destroy_work, with: 'work.destroy_work'
     end
   end

data/lib/hyrax/transactions/steps/apply_collection_permission_template.rb

@@ -7,6 +7,8 @@ module Hyrax
       # collections on a given work.
       #
       # @since 3.0.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class ApplyCollectionPermissionTemplate
         include Dry::Transaction::Operation
 

data/lib/hyrax/transactions/steps/apply_permission_template.rb

@@ -7,6 +7,8 @@ module Hyrax
       # work's AdminSet.
       #
       # @since 2.4.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class ApplyPermissionTemplate
         include Dry::Transaction::Operation
 

data/lib/hyrax/transactions/steps/apply_visibility.rb

@@ -7,6 +7,8 @@ module Hyrax
       # passed arguments.
       #
       # @since 3.0.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class ApplyVisibility
         include Dry::Transaction::Operation
 

data/lib/hyrax/transactions/steps/change_depositor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Add a given `::User` as the `#depositor`
+      # Move the previous value of that property to `#proxy_depositor`
+      #
+      #
+      # If no user is given, simply passes as a `Success`.
+      #
+      # @since 3.4.0
+      class ChangeDepositor
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Hyrax::Work] obj
+        # @param user [User] the user that will "become" the depositor of
+        #             the given work
+        #
+        # @return [Dry::Monads::Result]
+        def call(obj, user: NullUser.new, reset: false)
+          return Success(obj) unless user&.user_key
+
+          obj = Hyrax::ChangeDepositorService.call(obj, user, reset)
+
+          Success(obj)
+        rescue StandardError => err
+          Failure([err.message, obj])
+        end
+
+        ##
+        # @api private
+        class NullUser
+          ##
+          # @return [nil]
+          def user_key
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/check_for_empty_admin_set.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Validates emptiness of the {Hyrax::AdministrativeSet}; gives `Success`
+      # when empty and `Failure` otherwise.
+      #
+      # Use this step to guard against destroying AdminSets with member objects.
+      class CheckForEmptyAdminSet
+        include Dry::Monads[:result]
+
+        ##
+        # @param [#find_inverse_references_by] query_service
+        def initialize(query_service: Hyrax.query_service)
+          @query_service = query_service
+        end
+
+        ##
+        # @param [Hyrax::AdministrativeSet] admin_set
+        #
+        # @return [Dry::Monads::Result]
+        def call(admin_set)
+          members = @query_service
+                    .find_inverse_references_by(property: :admin_set_id,
+                                                resource: admin_set)
+          return Failure[:admin_set_has_members, members] if members.any?
+
+          Success(admin_set)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/delete_access_control.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Deletes the Hyrax::AccessControlList for any resource with a `#permission_manager`.
+      # If `#permission_manager` is undefined, succeeds.
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class DeleteAccessControl
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Valkyrie::Resource] obj
+        #
+        # @return [Dry::Monads::Result]
+        def call(obj)
+          return Success(obj) unless obj.respond_to?(:permission_manager)
+
+          acl = obj.permission_manager&.acl
+          return Success(obj) if acl.nil?
+
+          acl.destroy || (return Failure[:failed_to_delete_acl, acl])
+
+          Success(obj)
+        end
+      end
+    end
+  end
+end