🎁 [i84] - Integrate Hyrax dynamic metadata feature into Hyku

.env

@@ -70,4 +70,6 @@ HYKU_RESTRICT_CREATE_AND_DESTROY_PERMISSIONS=true
 HYRAX_ANALYTICS=false
 ##END## Enable Google Analytics
 
+HYRAX_FLEXIBLE=true
 HYRAX_VALKYRIE=true
+VALKYRIE_TRANSITION=true

Gemfile

@@ -51,12 +51,12 @@ gem 'good_job', '~> 2.99'
 gem 'googleauth', '~> 1.9.0'
 gem 'google-protobuf', force_ruby_platform: true # required because google-protobuf is not compatible with Alpine linux
 gem 'grpc', force_ruby_platform: true # required because google-protobuf is not compatible with Alpine linux
-gem 'hyrax', github: 'samvera/hyrax', branch: 'double_combo'
+gem 'hyrax', github: 'samvera/hyrax', branch: 'flexible_double_combo'
 gem 'hyrax-doi', github: 'samvera-labs/hyrax-doi', branch: 'rails_hyrax_upgrade'
 gem 'hyrax-iiif_av', github: 'samvera-labs/hyrax-iiif_av', branch: 'rails_hyrax_upgrade'
 gem 'i18n-debug', require: false, group: %i[development test]
 gem 'i18n-tasks', group: %i[development test]
-gem 'iiif_print', github: 'scientist-softserv/iiif_print', branch: 'main'
+gem 'iiif_print', github: 'scientist-softserv/iiif_print', branch: 'i84-support-dynamic-metadata'
 gem 'jbuilder', '~> 2.5'
 gem 'jquery-rails' # Use jquery as the JavaScript library
 gem 'openssl', '>= 3.2.0'

Gemfile.lock

@@ -147,8 +147,8 @@ GIT
 
 GIT
   remote: https://github.com/samvera/hyrax.git
-  revision: 6447872e0bcea17abfc1aab477f2eea57639298f
-  branch: double_combo
+  revision: 17f1e60f0c6d9d6339da8d8c085c6294517eed3e
+  branch: flexible_double_combo
   specs:
     hyrax (5.0.1)
       active-fedora (~> 14.0)
@@ -168,6 +168,7 @@ GIT
       dry-logic (~> 1.5)
       dry-monads (~> 1.6)
       dry-validation (~> 1.10)
+      faraday (= 2.9.1)
       flipflop (~> 2.3)
       flot-rails (~> 0.0.6)
       font-awesome-rails (~> 4.2)
@@ -220,10 +221,10 @@ GIT
 
 GIT
   remote: https://github.com/scientist-softserv/iiif_print.git
-  revision: fb07dcdafdf1b2e7e05ebd34a50187bf69b46474
-  branch: main
+  revision: 63ef540419fcb3aabc73d61c0010638b173c11aa
+  branch: i84-support-dynamic-metadata
   specs:
-    iiif_print (2.0.1)
+    iiif_print (3.0.1)
       blacklight_iiif_search (>= 1.0, < 3.0)
       derivative-rodeo (~> 0.5)
       hyrax (>= 2.5, < 6)
@@ -586,10 +587,8 @@ GEM
     factory_bot_rails (6.4.2)
       factory_bot (~> 6.4)
       railties (>= 5.0.0)
-    faraday (2.7.12)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
+    faraday (2.9.1)
+      faraday-net_http (>= 2.0, < 3.2)
     faraday-encoding (0.0.5)
       faraday
     faraday-excon (2.1.0)

app/forms/collection_resource_form.rb

@@ -3,8 +3,8 @@
 # Generated via
 #  `rails generate hyrax:collection_resource CollectionResource`
 class CollectionResourceForm < Hyrax::Forms::PcdmCollectionForm
-  include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:bulkrax_metadata)
-  include Hyrax::FormFields(:collection_resource)
+  include Hyrax::FormFields(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:collection_resource) unless Hyrax.config.flexible?
   include CollectionAccessFiltering
 end

app/forms/etd_resource_form.rb

@@ -8,9 +8,9 @@
 class EtdResourceForm < Hyrax::Forms::ResourceForm(EtdResource)
   # Commented out basic_metadata because these terms were added to etd_resource so we can customize it.
   # include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:etd_resource)
-  include Hyrax::FormFields(:with_pdf_viewer)
-  include Hyrax::FormFields(:with_video_embed)
+  include Hyrax::FormFields(:etd_resource) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_video_embed) unless Hyrax.config.flexible?
   include VideoEmbedBehavior::Validation
   # Define custom form fields using the Valkyrie::ChangeSet interface
   #

app/forms/generic_work_resource_form.rb

@@ -6,10 +6,10 @@
 # @see https://github.com/samvera/hyrax/wiki/Hyrax-Valkyrie-Usage-Guide#forms
 # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
 class GenericWorkResourceForm < Hyrax::Forms::ResourceForm(GenericWorkResource)
-  include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:bulkrax_metadata)
-  include Hyrax::FormFields(:generic_work_resource)
-  include Hyrax::FormFields(:with_pdf_viewer)
-  include Hyrax::FormFields(:with_video_embed)
+  include Hyrax::FormFields(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:generic_work_resource) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_video_embed) unless Hyrax.config.flexible?
   include VideoEmbedBehavior::Validation
 end

app/forms/hyrax/forms/pcdm_collection_form_decorator.rb

@@ -2,8 +2,8 @@
 # OVERRIDE Hyraxv5.0.0 to add the ability to upload a collection thumbnail
 
 Hyrax::Forms::PcdmCollectionForm.class_eval do
-  include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:bulkrax_metadata)
+  include Hyrax::FormFields(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:bulkrax_metadata) unless Hyrax.config.flexible?
   include CollectionAccessFiltering
 
   ThumbnailInfoPrepopulator = lambda do |_options = nil|

app/forms/image_resource_form.rb

@@ -6,10 +6,10 @@
 # @see https://github.com/samvera/hyrax/wiki/Hyrax-Valkyrie-Usage-Guide#forms
 # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
 class ImageResourceForm < Hyrax::Forms::ResourceForm(ImageResource)
-  include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:bulkrax_metadata)
-  include Hyrax::FormFields(:image_resource)
-  include Hyrax::FormFields(:with_pdf_viewer)
-  include Hyrax::FormFields(:with_video_embed)
+  include Hyrax::FormFields(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:image_resource) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_video_embed) unless Hyrax.config.flexible?
   include VideoEmbedBehavior::Validation
 end

app/forms/oer_resource_form.rb

@@ -8,9 +8,9 @@
 class OerResourceForm < Hyrax::Forms::ResourceForm(OerResource)
   # Commented out basic_metadata because these terms were added to etd_resource so we can customize it.
   # include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:oer_resource)
-  include Hyrax::FormFields(:with_pdf_viewer)
-  include Hyrax::FormFields(:with_video_embed)
+  include Hyrax::FormFields(:oer_resource) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::FormFields(:with_video_embed) unless Hyrax.config.flexible?
   include VideoEmbedBehavior::Validation
   # Define custom form fields using the Valkyrie::ChangeSet interface
   #

app/indexers/admin_set_resource_indexer.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
 class AdminSetResourceIndexer < Hyrax::Indexers::AdministrativeSetIndexer
+  # include Hyrax::Indexer(:core_metadata) unless Hyrax.config.flexible?
+  # include Hyrax::Indexer('AdminSetResource') if Hyrax.config.flexible?
 end
+

app/indexers/collection_resource_indexer.rb

@@ -3,9 +3,11 @@
 # Generated via
 #  `rails generate hyrax:collection_resource CollectionResource`
 class CollectionResourceIndexer < Hyrax::Indexers::PcdmCollectionIndexer
-  include Hyrax::Indexer(:basic_metadata)
-  include Hyrax::Indexer(:bulkrax_metadata)
-  include Hyrax::Indexer(:collection_resource)
+  include Hyrax::Indexer(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:collection_resource) unless Hyrax.config.flexible?
+  include Hyrax::Indexer('CollectionResource') if Hyrax.config.flexible?
+
   include Hyrax::IndexesThumbnails
 
   def to_solr

app/indexers/etd_resource_indexer.rb

@@ -3,11 +3,12 @@
 # Generated via
 #  `rails generate hyrax:work_resource EtdResource`
 class EtdResourceIndexer < Hyrax::ValkyrieWorkIndexer
-  include Hyrax::Indexer(:basic_metadata)
-  include Hyrax::Indexer(:bulkrax_metadata)
-  include Hyrax::Indexer(:etd_resource)
-  include Hyrax::Indexer(:with_pdf_viewer)
-  include Hyrax::Indexer(:with_video_embed)
+  include Hyrax::Indexer(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:etd_resource) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_video_embed) unless Hyrax.config.flexible?
+  include Hyrax::Indexer('EtdResource') if Hyrax.config.flexible?
 
   include HykuIndexing
 

app/indexers/generic_work_resource_indexer.rb

@@ -3,11 +3,12 @@
 # Generated via
 #  `rails generate hyrax:work_resource GenericWorkResource`
 class GenericWorkResourceIndexer < Hyrax::ValkyrieWorkIndexer
-  include Hyrax::Indexer(:basic_metadata)
-  include Hyrax::Indexer(:bulkrax_metadata)
-  include Hyrax::Indexer(:generic_work_resource)
-  include Hyrax::Indexer(:with_pdf_viewer)
-  include Hyrax::Indexer(:with_video_embed)
+  include Hyrax::Indexer(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:generic_work_resource) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_video_embed) unless Hyrax.config.flexible?
+  include Hyrax::Indexer('GenericWorkResource') if Hyrax.config.flexible?
 
   include HykuIndexing
   # Uncomment this block if you want to add custom indexing behavior:

app/indexers/image_resource_indexer.rb

@@ -3,11 +3,12 @@
 # Generated via
 #  `rails generate hyrax:work_resource ImageResource`
 class ImageResourceIndexer < Hyrax::ValkyrieWorkIndexer
-  include Hyrax::Indexer(:basic_metadata)
-  include Hyrax::Indexer(:bulkrax_metadata)
-  include Hyrax::Indexer(:image_resource)
-  include Hyrax::Indexer(:with_pdf_viewer)
-  include Hyrax::Indexer(:with_video_embed)
+  include Hyrax::Indexer(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:image_resource) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_video_embed) unless Hyrax.config.flexible?
+  include Hyrax::Indexer('ImageResource') if Hyrax.config.flexible?
 
   include HykuIndexing
   # Uncomment this block if you want to add custom indexing behavior:

app/indexers/oer_resource_indexer.rb

@@ -3,11 +3,12 @@
 # Generated via
 #  `rails generate hyrax:work_resource OerResource`
 class OerResourceIndexer < Hyrax::ValkyrieWorkIndexer
-  include Hyrax::Indexer(:basic_metadata)
-  include Hyrax::Indexer(:bulkrax_metadata)
-  include Hyrax::Indexer(:oer_resource)
-  include Hyrax::Indexer(:with_pdf_viewer)
-  include Hyrax::Indexer(:with_video_embed)
+  include Hyrax::Indexer(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:oer_resource) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Indexer(:with_video_embed) unless Hyrax.config.flexible?
+  include Hyrax::Indexer('OerResource') if Hyrax.config.flexible?
 
   include HykuIndexing
 

app/models/collection_resource.rb

@@ -3,9 +3,9 @@
 # Generated via
 #  `rails generate hyrax:collection_resource CollectionResource`
 class CollectionResource < Hyrax::PcdmCollection
-  include Hyrax::Schema(:basic_metadata)
-  include Hyrax::Schema(:bulkrax_metadata)
-  include Hyrax::Schema(:collection_resource)
+  include Hyrax::Schema(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:collection_resource) unless Hyrax.config.flexible?
   include Hyrax::ArResource
   include HykuIndexing
 
@@ -19,7 +19,7 @@ class CollectionResource < Hyrax::PcdmCollection
 
   include WithPermissionTemplateShim
 
-  prepend OrderAlready.for(:creator)
+  prepend OrderAlready.for(:creator) unless Hyrax.config.flexible?
 
   ##
   # @!group Methods to Extract

app/models/concerns/hyrax/solr_document_behavior_decorator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# OVERRIDE: Hyrax v5.0.1 to fix a bug
+# previously presenter.file_set_presenters didn't know it
+# had any files to display.
+module Hyrax
+  ##
+  # @api public
+  #
+  # Hyrax extensions for +Blacklight+'s generated +SolrDocument+.
+  #
+  # @example using with +Blacklight::Solr::Document+
+  #   class SolrDocument
+  #     include Blacklight::Solr::Document
+  #     include Hyrax::SolrDocumentBehavior
+  #   end
+  #
+  # @see https://github.com/projectblacklight/blacklight/wiki/Understanding-Rails-and-Blacklight#models
+  module SolrDocumentBehaviorDecorator
+    # Method to return the model
+    def hydra_model(classifier: nil)
+      model = first('has_model_ssim')&.safe_constantize
+      model = (first('has_model_ssim')&.+ 'Resource')&.safe_constantize if Hyrax.config.valkyrie_transition?
+      model || model_classifier(classifier).classifier(self).best_model
+    end
+  end
+end
+
+Hyrax::SolrDocumentBehavior.prepend(Hyrax::SolrDocumentBehaviorDecorator)

app/models/etd_resource.rb

@@ -5,10 +5,10 @@
 class EtdResource < Hyrax::Work
   # Commented out basic_metadata because these terms were added to etd_resource so we can customize it.
   # include Hyrax::Schema(:basic_metadata)
-  include Hyrax::Schema(:etd_resource)
-  include Hyrax::Schema(:bulkrax_metadata)
-  include Hyrax::Schema(:with_pdf_viewer)
-  include Hyrax::Schema(:with_video_embed)
+  include Hyrax::Schema(:etd_resource) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:with_video_embed) unless Hyrax.config.flexible?
   include Hyrax::ArResource
   include Hyrax::NestedWorks
 
@@ -19,7 +19,7 @@ class EtdResource < Hyrax::Work
     pdf_splitter_service: IiifPrint::TenantConfig::PdfSplitter
   )
 
-  prepend OrderAlready.for(:creator)
+  prepend OrderAlready.for(:creator) unless Hyrax.config.flexible?
 
   def human_readable_type
     super.upcase

app/models/generic_work_resource.rb

@@ -3,11 +3,11 @@
 # Generated via
 #  `rails generate hyrax:work_resource GenericWorkResource`
 class GenericWorkResource < Hyrax::Work
-  include Hyrax::Schema(:basic_metadata)
-  include Hyrax::Schema(:bulkrax_metadata)
-  include Hyrax::Schema(:generic_work_resource)
-  include Hyrax::Schema(:with_pdf_viewer)
-  include Hyrax::Schema(:with_video_embed)
+  include Hyrax::Schema(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:generic_work_resource) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:with_video_embed) unless Hyrax.config.flexible?
   include Hyrax::ArResource
   include Hyrax::NestedWorks
 
@@ -18,5 +18,5 @@ class GenericWorkResource < Hyrax::Work
     pdf_splitter_service: IiifPrint::TenantConfig::PdfSplitter
   )
 
-  prepend OrderAlready.for(:creator)
+  prepend OrderAlready.for(:creator) unless Hyrax.config.flexible?
 end

app/models/hyrax/file_set_decorator.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 Hyrax::FileSet.class_eval do
-  include Hyrax::Schema(:bulkrax_metadata)
-  include Hyrax::Schema(:hyku_file_set_metadata)
+  include Hyrax::Schema(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:hyku_file_set_metadata) unless Hyrax.config.flexible?
   include Hyrax::ArResource
 end
 

app/models/image_resource.rb

@@ -3,11 +3,11 @@
 # Generated via
 #  `rails generate hyrax:work_resource ImageResource`
 class ImageResource < Hyrax::Work
-  include Hyrax::Schema(:basic_metadata)
-  include Hyrax::Schema(:bulkrax_metadata)
-  include Hyrax::Schema(:image_resource)
-  include Hyrax::Schema(:with_pdf_viewer)
-  include Hyrax::Schema(:with_video_embed)
+  include Hyrax::Schema(:basic_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:bulkrax_metadata) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:image_resource) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:with_pdf_viewer) unless Hyrax.config.flexible?
+  include Hyrax::Schema(:with_video_embed) unless Hyrax.config.flexible?
   include Hyrax::ArResource
   include Hyrax::NestedWorks
 
@@ -18,5 +18,5 @@ class ImageResource < Hyrax::Work
     pdf_splitter_service: IiifPrint::TenantConfig::PdfSplitter
   )
 
-  prepend OrderAlready.for(:creator)
+  prepend OrderAlready.for(:creator) unless Hyrax.config.flexible?
 end