Modify Collection & Admin Set Valkyrization

app/forms/collection_resource_form.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:collection_resource CollectionResource`
+class CollectionResourceForm < Hyrax::Forms::PcdmCollectionForm
+  include Hyrax::FormFields(:basic_metadata)
+  include Hyrax::FormFields(:collection_resource)
+  include CollectionAccessFiltering
+end

app/forms/hyrax/admin_set_resource_form.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AdminSetResourceForm < Hyrax::Forms::AdministrativeSetForm
+  include CollectionAccessFiltering
+end

app/indexers/admin_set_resource_indexer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class AdminSetResourceIndexer < Hyrax::Indexers::AdministrativeSetIndexer
+end

app/indexers/collection_indexer.rb

@@ -9,6 +9,7 @@ class CollectionIndexer < Hyrax::CollectionIndexer
   def generate_solr_document
     super.tap do |solr_doc|
       solr_doc['bulkrax_identifier_tesim'] = object.bulkrax_identifier if object.respond_to?(:bulkrax_identifier)
+      solr_doc['bulkrax_identifier_sim'] = object.bulkrax_identifier if object.respond_to?(:bulkrax_identifier)
       solr_doc["account_cname_tesim"] = Site.instance&.account&.cname
       solr_doc['account_institution_name_ssim'] = Site.instance.institution_label
     end

app/indexers/collection_resource_indexer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:collection_resource CollectionResource`
+class CollectionResourceIndexer < Hyrax::Indexers::PcdmCollectionIndexer
+  include Hyrax::Indexer(:basic_metadata)
+  include Hyrax::Indexer(:collection_resource)
+
+  def to_solr
+    super.tap do |index_document|
+      # TODO: Do we need the indexing for bulkrax_identifier? If it is in the resource yml, it is probably redundant.
+      solr_doc['bulkrax_identifier_tesim'] = object.bulkrax_identifier if object.respond_to?(:bulkrax_identifier)
+      solr_doc['bulkrax_identifier_sim'] = object.bulkrax_identifier if object.respond_to?(:bulkrax_identifier)
+      index_document["account_cname_tesim"] = Site.instance&.account&.cname
+      index_document['account_institution_name_ssim'] = Site.instance.institution_label
+    end
+  end
+end

app/indexers/concerns/hyku_indexing.rb

@@ -14,6 +14,7 @@ module HykuIndexing
 
         solr_doc['account_cname_tesim'] = Site.instance&.account&.cname
         solr_doc['bulkrax_identifier_tesim'] = object.bulkrax_identifier if object.respond_to?(:bulkrax_identifier)
+        solr_doc['bulkrax_identifier_sim'] = object.bulkrax_identifier if object.respond_to?(:bulkrax_identifier)
         solr_doc['account_institution_name_ssim'] = Site.instance.institution_label
         # TODO: Reinstate once valkyrie fileset work is complete - https://github.com/scientist-softserv/hykuup_knapsack/issues/34
         solr_doc['all_text_tsimv'] = full_text(object.file_sets.first&.id) if object.kind_of?(ActiveFedora::Base)

app/models/hyrax/administrative_set_decorator.rb → app/models/admin_set_resource.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-# OVERRIDE Hyrax 5.0 to add AF methods to collection
-
-Hyrax::AdministrativeSet.class_eval do
+class AdminSetResource < Hyrax::AdministrativeSet
   include Hyrax::ArResource
   include Hyrax::Permissions::Readable
 end

app/models/hyrax/pcdm_collection_decorator.rb → app/models/collection_resource.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-# OVERRIDE Hyrax 5.0 to add basic metadata and AF methods to collection
-
-Hyrax::PcdmCollection.class_eval do
+# Generated via
+#  `rails generate hyrax:collection_resource CollectionResource`
+class CollectionResource < Hyrax::PcdmCollection
   include Hyrax::Schema(:basic_metadata)
+  include Hyrax::Schema(:collection_resource)
   include Hyrax::ArResource
-
-  # This module provides the #public?, #private?, #restricted? methods; consider contributing this
-  # back to Hyrax; but that decision requires further discussion on architecture.
+  # This module provides the #public?, #private?, #restricted? methods; consider
+  # contributing this back to Hyrax; but that decision requires further discussion
+  # on architecture.
   # @see https://samvera.slack.com/archives/C0F9JQJDQ/p1705421588370699 Slack discussion thread.
   include Hyrax::Permissions::Readable
   prepend OrderAlready.for(:creator)

app/models/concerns/hyrax/ability/collection_ability.rb

@@ -11,7 +11,7 @@ module CollectionAbility
       # rubocop:disable Metrics/PerceivedComplexity
       # rubocop:disable Metrics/CyclomaticComplexity
       def collection_abilities
-        models = [Hyrax::PcdmCollection, Hyrax.config.collection_class].uniq
+        models = [Collection, Hyrax::PcdmCollection, Hyrax.config.collection_class].uniq
         if admin?
           models.each do |collection_model|
             can :manage, collection_model
@@ -107,8 +107,10 @@ def collection_abilities
           unless ActiveModel::Type::Boolean.new.cast(
             ENV.fetch('HYKU_RESTRICT_CREATE_AND_DESTROY_PERMISSIONS', nil)
           )
-            can %i[destroy manage_discovery manage_items_in_collection], Hyrax::PcdmCollection do |collection|
-              test_edit(collection.id)
+            models.each do |collection_model|
+              can %i[destroy manage_discovery manage_items_in_collection], collection_model do |collection|
+                test_edit(collection.id)
+              end
             end
           end
         end

app/models/concerns/hyrax/ability/work_ability.rb

@@ -32,7 +32,7 @@ def admin_set_with_deposit?
 
         return false if ids.empty?
 
-        Hyrax.custom_queries.find_ids_by_model(model: Hyrax::AdministrativeSet, ids:).any?
+        Hyrax.custom_queries.find_ids_by_model(model: Hyrax.config.admin_set_model, ids:).any?
       end
     end
   end

app/services/roles_service.rb

@@ -233,45 +233,51 @@ def seed_qa_users!
 
   class GrantWorkflowRolesForAllAdminSetsJob < Hyrax::ApplicationJob
     def perform
-      AdminSet.find_each do |admin_set|
-        Hyrax::Workflow::PermissionGrantor
-          .grant_default_workflow_roles!(permission_template: admin_set.permission_template)
+      models = [AdminSet, Hyrax::AdministrativeSet, Hyrax.config.admin_set_class].uniq
+      models.each do |admin_set_model|
+        Hyrax.query_service.find_all_of_model(model: admin_set_model) do |admin_set|
+          Hyrax::Workflow::PermissionGrantor
+            .grant_default_workflow_roles!(permission_template: admin_set.permission_template)
+        end
       end
     end
   end
 
   class CreateCollectionAccessesJob < Hyrax::ApplicationJob
     # rubocop:disable Metrics/MethodLength
     def perform
-      Collection.find_each do |c|
-        pt = Hyrax::PermissionTemplate.find_or_create_by!(source_id: c.id)
-        original_access_grants_count = pt.access_grants.count
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::MANAGE,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: Ability.admin_group_name
-        )
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::MANAGE,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: 'collection_manager'
-        )
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::VIEW,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: 'collection_editor'
-        )
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::VIEW,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: 'collection_reader'
-        )
-
-        pt.reset_access_controls_for(collection: c) if pt.access_grants.count != original_access_grants_count
+      models = [Collection, Hyrax::PcdmCollection, Hyrax.config.collection_class].uniq
+      models.each do |collection_model|
+        Hyrax.query_service.find_all_of_model(model: collection_model) do |c|
+          pt = Hyrax::PermissionTemplate.find_or_create_by!(source_id: c.id)
+          original_access_grants_count = pt.access_grants.count
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::MANAGE,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: Ability.admin_group_name
+          )
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::MANAGE,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: 'collection_manager'
+          )
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::VIEW,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: 'collection_editor'
+          )
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::VIEW,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: 'collection_reader'
+          )
+
+          pt.reset_access_controls_for(collection: c) if pt.access_grants.count != original_access_grants_count
+        end
       end
     end
     # rubocop:enable Metrics/MethodLength
@@ -280,35 +286,38 @@ def perform
   class CreateAdminSetAccessesJob < Hyrax::ApplicationJob
     # rubocop:disable Metrics/MethodLength
     def perform
-      AdminSet.find_each do |as|
-        pt = Hyrax::PermissionTemplate.find_or_create_by!(source_id: as.id)
-        original_access_grants_count = pt.access_grants.count
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::MANAGE,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: Ability.admin_group_name
-        )
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::DEPOSIT,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: 'work_depositor'
-        )
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::DEPOSIT,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: 'work_editor'
-        )
-
-        pt.access_grants.find_or_create_by!(
-          access: Hyrax::PermissionTemplateAccess::VIEW,
-          agent_type: Hyrax::PermissionTemplateAccess::GROUP,
-          agent_id: 'work_editor'
-        )
-
-        pt.reset_access_controls_for(collection: as) if pt.access_grants.count != original_access_grants_count
+      models = [AdminSet, Hyrax::AdministrativeSet, Hyrax.config.admin_set_class].uniq
+      models.each do |admin_set_model|
+        Hyrax.query_service.find_all_of_model(model: admin_set_model) do |as|
+          pt = Hyrax::PermissionTemplate.find_or_create_by!(source_id: as.id)
+          original_access_grants_count = pt.access_grants.count
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::MANAGE,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: Ability.admin_group_name
+          )
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::DEPOSIT,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: 'work_depositor'
+          )
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::DEPOSIT,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: 'work_editor'
+          )
+
+          pt.access_grants.find_or_create_by!(
+            access: Hyrax::PermissionTemplateAccess::VIEW,
+            agent_type: Hyrax::PermissionTemplateAccess::GROUP,
+            agent_id: 'work_editor'
+          )
+
+          pt.reset_access_controls_for(collection: as) if pt.access_grants.count != original_access_grants_count
+        end
       end
     end
     # rubocop:enable Metrics/MethodLength

app/services/wings/custom_queries/find_by_bulkrax_identifier.rb

@@ -17,7 +17,7 @@ def initialize(query_service:)
       end
 
       def find_by_bulkrax_identifier(identifier:, use_valkyrie: true)
-        af_object = ActiveFedora::Base.where("bulkrax_identifier_sim:#{identifier}").first
+        af_object = ActiveFedora::Base.where("bulkrax_identifier_sim:#{identifier}").first || ActiveFedora::Base.where("bulkrax_identifier_tesim:#{identifier}").first
 
         return af_object unless use_valkyrie
 

config/initializers/hyrax.rb

@@ -15,12 +15,18 @@
   # Identify the model class name that will be used for Collections in your app
   # (i.e. ::Collection for ActiveFedora, Hyrax::PcdmCollection for Valkyrie)
   # config.collection_model = '::Collection'
-  config.collection_model = 'Hyrax::PcdmCollection'
+  # Injected via `rails g hyrax:collection_resource CollectionResource`
+  config.collection_model = 'CollectionResource'
 
   # Identify the model class name that will be used for Admin Sets in your app
   # (i.e. AdminSet for ActiveFedora, Hyrax::AdministrativeSet for Valkyrie)
   # config.admin_set_model = 'AdminSet'
-  config.admin_set_model = 'Hyrax::AdministrativeSet'
+  config.admin_set_model = 'AdminSetResource'
+  # Identify the form that will be used for Admin Sets
+  config.administrative_set_form = 'AdminSetResourceForm'
+  # Identify the indexer that will be used for Admin Sets
+  config.administrative_set_indexer = 'AdminSetResourceIndexer'
+
   # The email address that messages submitted via the contact page are sent to
   # This is set by account settings
   # config.contact_email = '[email protected]'

config/initializers/wings.rb

@@ -11,8 +11,10 @@
   end
   Wings::ModelRegistry.register(Collection, Collection)
   Wings::ModelRegistry.register(Hyrax::PcdmCollection, Collection)
+  Wings::ModelRegistry.register(CollectionResource, Collection)
   Wings::ModelRegistry.register(Hyrax::AdministrativeSet, AdminSet)
   Wings::ModelRegistry.register(AdminSet, AdminSet)
+  Wings::ModelRegistry.register(AdminSetResource, AdminSet)
 
   Valkyrie::MetadataAdapter.register(
     Freyja::MetadataAdapter.new,
@@ -83,9 +85,9 @@
     ].include?(klass_name)
       "#{klass_name}Resource".constantize
     elsif 'Collection' == klass_name
-      Hyrax::PcdmCollection
+      CollectionResource
     elsif 'AdminSet' == klass_name
-      Hyrax::AdministrativeSet
+      AdminSetResource
     else
       klass_name.constantize
     end

config/metadata/collection_resource.yaml

@@ -0,0 +1,24 @@
+# Simple yaml config-driven schema which is used to define model attributes,
+# index key names, and form properties.
+#
+# Attributes must have a type but all other configuration options are optional.
+# Please note: If using Valkyrie's Fedora Metadata Adapter, predicates for attributes
+# must be placed here.
+#
+# attributes:
+#   attribute_name:
+#     type: string
+#     multiple: false
+#     index_keys:
+#       - "attribute_name_sim"
+#     form:
+#       required: true
+#       primary: true
+#       multiple: false
+#
+# @see config/metadata/basic_metadata.yaml for an example configuration
+#
+# Generated via
+#  `rails generate hyrax:collection_resource CollectionResource`
+
+attributes: {}

spec/forms/collection_resource_form_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:collection_resource CollectionResource`
+require 'rails_helper'
+require 'valkyrie/specs/shared_specs'
+
+RSpec.describe CollectionResourceForm do
+  let(:change_set) { described_class.new(resource) }
+  let(:resource)   { CollectionResource.new }
+
+  it_behaves_like 'a Valkyrie::ChangeSet'
+end

spec/indexers/collection_resource_indexer_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:collection_resource CollectionResource`
+require 'rails_helper'
+require 'hyrax/specs/shared_specs/indexers'
+
+RSpec.describe CollectionResourceIndexer do
+  let(:indexer_class) { described_class }
+  let(:resource)      { CollectionResource.new }
+
+  it_behaves_like 'a Hyrax::Resource indexer'
+end