☄️ Valkyrize Hyku EPIC

Gemfile.lock

@@ -125,7 +125,7 @@ GIT
 
 GIT
   remote: https://github.com/samvera/hyrax.git
-  revision: b7891b758411c59f71ff54212e0d250fcc47e35f
+  revision: 8fe90b5058c09d672f9179c9aaa9e01e94abd83c
   branch: double_combo
   specs:
     hyrax (5.0.0.rc2)
@@ -197,7 +197,7 @@ GIT
 
 GIT
   remote: https://github.com/scientist-softserv/iiif_print.git
-  revision: cad2cf33fc07ec2abb5b6834a858b5ed74903c12
+  revision: cc105d061727988e016c32235459f4cb82bd3ad6
   branch: rails_hyrax_upgrade
   specs:
     iiif_print (1.0.0)

app/assets/stylesheets/hyku.scss

@@ -16,6 +16,10 @@
   }
 }
 
+.dashboard .form-tab-content label {
+  font-weight: 700;
+}
+
 @media (min-width: 768px) {
   .logo-set {
     display: flex;
@@ -532,6 +536,7 @@ span.constraint-value p, .facet-values p {
 // style the analytics button to match citations button
 #stats {
   margin-top: 10px;
+
   @media (min-width: 576px) {
     max-width: 300px;
   }
@@ -549,25 +554,28 @@ span.constraint-value p, .facet-values p {
 // collection show page styles
 
 .space-between {
-  justify-content: space-between;
   align-items: center;
+  justify-content: space-between;
 }
 
 .hyc-banner {
   padding: 15px;
-  .hyc-bugs .hyc-created-by, .hyc-bugs .hyc-last-updated, .hyc-title {
+  .hyc-bugs .hyc-created-by,
+  .hyc-bugs .hyc-last-updated,
+  .hyc-title {
     padding: 0;
   }
 
   .hyc-item-count {
-    margin: 0;
     background: rgba(255, 255, 255, 0.75);
-    padding: 10px;
     border-radius: 0.5em;
     color: #333;
+    margin: 0;
+    padding: 10px;
   }
 
-  .hyc-bugs div, div {
+  .hyc-bugs div,
+  div {
     position: relative;
   }
 }
@@ -588,7 +596,7 @@ span.constraint-value p, .facet-values p {
 }
 
 .mb-2 {
-  margin-bottom: .5em;
+  margin-bottom: 0.5em;
 }
 
 .mb-5 {
@@ -605,13 +613,13 @@ span.constraint-value p, .facet-values p {
 }
 
 .py-0 {
-  padding-top: 0;
   padding-bottom: 0;
+  padding-top: 0;
 }
 
 .py-4 {
-  padding-top: 2em;
   padding-bottom: 2em;
+  padding-top: 2em;
 }
 
 .d-block {

app/assets/stylesheets/hyrax.scss

@@ -22,6 +22,6 @@
 
 // for catalog search result snippets
 .highlight {
-  background: yellow;
+    background: #ffff00;
   font-weight: 700;
-}
+}

app/assets/stylesheets/viewer.scss

@@ -22,4 +22,4 @@
 .video-embed-viewer {
   aspect-ratio: 16 / 9;
   width: 100%;
-}
+}

app/controllers/application_controller.rb

@@ -41,7 +41,7 @@ def api_or_pdf?
   end
 
   def staging?
-    ['staging'].include?(Rails.env)
+    Rails.env.staging? # rubocop:disable Rails/UnknownEnv
   end
 
   def authenticate_if_needed

app/controllers/hyrax/generic_work_resources_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource GenericWorkResource`
+module Hyrax
+  # Generated controller for GenericWorkResource
+  class GenericWorkResourcesController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::GenericWorkResource
+
+    # Use a Valkyrie aware form service to generate Valkyrie::ChangeSet style
+    # forms.
+    self.work_form_service = Hyrax::FormFactory.new
+  end
+end

app/controllers/hyrax/homepage_controller.rb

@@ -54,8 +54,7 @@ def index
       load_shared_info
       recent
 
-      # override hyrax v2.9.0 added for facets on homepage - Adding Themes
-      (@response, @document_list) = search_results(params)
+      (@response, @document_list) = search_service.search_results
 
       respond_to do |format|
         format.html { store_preferred_view }

app/controllers/hyrax/image_resources_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource ImageResource`
+module Hyrax
+  # Generated controller for ImageResource
+  class ImageResourcesController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::ImageResource
+
+    # Use a Valkyrie aware form service to generate Valkyrie::ChangeSet style
+    # forms.
+    self.work_form_service = Hyrax::FormFactory.new
+  end
+end

app/controllers/saved_searches_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class SavedSearchesController < ApplicationController
+  include Blacklight::SavedSearches
+
+  helper BlacklightAdvancedSearch::RenderConstraintsOverride
+end

app/forms/generic_work_resource_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource GenericWorkResource`
+#
+# @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(:generic_work_resource)
+
+  # Define custom form fields using the Valkyrie::ChangeSet interface
+  #
+  # property :my_custom_form_field
+
+  # if you want a field in the form, but it doesn't have a directly corresponding
+  # model attribute, make it virtual
+  #
+  # property :user_input_not_destined_for_the_model, virtual: true
+end

app/forms/image_resource_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource ImageResource`
+#
+# @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(:image_resource)
+
+  # Define custom form fields using the Valkyrie::ChangeSet interface
+  #
+  # property :my_custom_form_field
+
+  # if you want a field in the form, but it doesn't have a directly corresponding
+  # model attribute, make it virtual
+  #
+  # property :user_input_not_destined_for_the_model, virtual: true
+end

app/indexers/generic_work_resource_indexer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource GenericWorkResource`
+class GenericWorkResourceIndexer < Hyrax::ValkyrieWorkIndexer
+  include Hyrax::Indexer(:basic_metadata)
+  include Hyrax::Indexer(:generic_work_resource)
+
+  # Uncomment this block if you want to add custom indexing behavior:
+  #  def to_solr
+  #    super.tap do |index_document|
+  #      index_document[:my_field_tesim]   = resource.my_field.map(&:to_s)
+  #      index_document[:other_field_ssim] = resource.other_field
+  #    end
+  #  end
+end

app/indexers/image_resource_indexer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource ImageResource`
+class ImageResourceIndexer < Hyrax::ValkyrieWorkIndexer
+  include Hyrax::Indexer(:basic_metadata)
+  include Hyrax::Indexer(:image_resource)
+
+  # Uncomment this block if you want to add custom indexing behavior:
+  #  def to_solr
+  #    super.tap do |index_document|
+  #      index_document[:my_field_tesim]   = resource.my_field.map(&:to_s)
+  #      index_document[:other_field_ssim] = resource.other_field
+  #    end
+  #  end
+end

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

@@ -9,16 +9,16 @@ def solr_document_abilities
         if admin?
           can [:manage], ::SolrDocument
         else
-          # OVERRIDE: remove :destroy -- only users with manage access can destroy
+          # OVERRIDE: remove :destroy -- only users with manage access can destroy This is brought
+          # about by the permission restrictions added by the Groups with Roles feature,
           can [:edit, :update], ::SolrDocument do |solr_doc|
             test_edit(solr_doc.id)
           end
           can :read, ::SolrDocument do |solr_doc|
             test_read(solr_doc.id)
           end
 
-          # "Undo" permission restrictions added by the Groups with Roles feature,
-          # effectively reverting them back to default Hyrax behavior
+          # To "Undo" the above override (e.g. return to default Hyrax behavior) set the below ENV.
           unless ActiveModel::Type::Boolean.new.cast(
             ENV.fetch('HYKU_RESTRICT_CREATE_AND_DESTROY_PERMISSIONS', nil)
           )

app/models/featured_work_decorator.rb

@@ -0,0 +1 @@
+FeaturedWork.feature_limit = 6

app/models/generic_work_resource.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource GenericWorkResource`
+class GenericWorkResource < Hyrax::Work
+  include Hyrax::Schema(:basic_metadata)
+  include Hyrax::Schema(:generic_work_resource)
+end

app/models/image_resource.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Generated via
+#  `rails generate hyrax:work_resource ImageResource`
+class ImageResource < Hyrax::Work
+  include Hyrax::Schema(:basic_metadata)
+  include Hyrax::Schema(:image_resource)
+end

app/models/solr_endpoint.rb

@@ -11,7 +11,7 @@ def connection
   # @return [Hash] options for the RSolr connection.
   def connection_options
     bl_defaults = Blacklight.connection_config
-    af_defaults = ActiveFedora::SolrService.instance.conn.options
+    af_defaults = Hyrax::SolrService.instance.conn.options
     switchable_options.reverse_merge(bl_defaults).reverse_merge(af_defaults)
   end
 
@@ -22,7 +22,8 @@ def ping
   end
 
   def switch!
-    ActiveFedora::SolrService.instance.conn = connection
+    Hyrax::SolrService.instance.conn = connection
+    Valkyrie::IndexingAdapter.adapters[:solr_index].connection = connection
     Blacklight.connection_config = connection_options
     Blacklight.default_index = nil
   end
@@ -42,7 +43,7 @@ def remove!
   end
 
   def self.reset!
-    ActiveFedora::SolrService.reset!
+    Hyrax::SolrService.reset!
     Blacklight.connection_config = Blacklight.blacklight_yml[::Rails.env].symbolize_keys
     Blacklight.default_index = nil
   end

app/services/hyrax/custom_queries/find_by_bulkrax_identifier.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Hyrax
+  module CustomQueries
+    ##
+    # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+    class FindByBulkraxIdentifier
+      def self.queries
+        [:find_by_bulkrax_identifier]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+      delegate :orm_class, to: :resource_factory
+
+      ##
+      # @param identifier String
+      def find_by_bulkrax_identifier(identifier:)
+        query_service.run_query(sql_by_bulkrax_identifier, identifier).first
+      end
+
+      def sql_by_bulkrax_identifier
+        <<-SQL
+          SELECT * FROM orm_resources
+          WHERE metadata -> 'bulkrax_identifier' ->> 0 = ?;
+        SQL
+      end
+    end
+  end
+end