hyrax 3.1.0 → 3.4.0

data/app/controllers/hyrax/my_controller.rb

@@ -27,7 +27,9 @@ module Hyrax
     configure_facets
 
     before_action :authenticate_user!
-    load_and_authorize_resource only: :show, instance_name: :collection
+    load_and_authorize_resource only: :show,
+                                instance_name: :collection,
+                                class: Hyrax.config.collection_model
 
     # include the render_check_all view helper method
     helper Hyrax::BatchEditsHelper
@@ -36,9 +38,7 @@ module Hyrax
 
     def index
       @user = current_user
-      Deprecation.silence(Hyrax::MyController) do
-        (@response, @document_list) = query_solr
-      end
+      (@response, @document_list) = search_service.search_results
       prepare_instance_variables_for_batch_control_display
 
       respond_to do |format|

data/app/controllers/hyrax/stats_controller.rb

@@ -7,7 +7,9 @@ module Hyrax
     before_action :build_breadcrumbs, only: [:work, :file]
 
     def work
-      @stats = Hyrax::WorkUsage.new(params[:id])
+      @document = ::SolrDocument.find(params[:id])
+      @pageviews = Hyrax::Analytics.daily_events_for_id(@document.id, 'work-view')
+      @downloads = Hyrax::Analytics.daily_events_for_id(@document.id, 'file-set-in-work-download')
     end
 
     def file

data/app/controllers/hyrax/workflow_actions_controller.rb

@@ -3,6 +3,13 @@ module Hyrax
   class WorkflowActionsController < ApplicationController
     DEFAULT_FORM_CLASS = Hyrax::Forms::WorkflowActionForm
 
+    ##
+    # @!attribute [r] curation_concern
+    #   @api private
+    #   @return [Hyrax::Resource]
+    attr_reader :curation_concern
+
+    load_resource class: Hyrax::Resource, instance_name: :curation_concern
     before_action :authenticate_user!
 
     def update
@@ -11,17 +18,13 @@ module Hyrax
       else
         respond_to do |wants|
           wants.html { render 'hyrax/base/unauthorized', status: :unauthorized }
-          wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
+          wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: workflow_action_form.errors }) }
         end
       end
     end
 
     private
 
-    def curation_concern
-      @curation_concern ||= Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: params[:id], use_valkyrie: false)
-    end
-
     def workflow_action_form
       @workflow_action_form ||= DEFAULT_FORM_CLASS.new(
         current_ability: current_ability,

data/app/forms/hyrax/forms/administrative_set_form.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # @api public
+    # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
+    class AdministrativeSetForm < Valkyrie::ChangeSet
+      ##
+      # @api private
+      AdminSetMembersPopulator = lambda do |_options|
+        self.member_ids =
+          if model.new_record
+            []
+          else
+            Hyrax
+              .query_service
+              .find_inverse_references_by(property: :admin_set_id, resource: model)
+              .map(&:id)
+          end
+      end
+
+      property :title, required: true, primary: true
+      property :description, primary: true
+
+      property :human_readable_type, writable: false
+      property :date_modified, readable: false
+      property :date_uploaded, readable: false
+
+      property :creator
+
+      validates :title, presence: true
+
+      property :member_ids, virtual: true, default: [], prepopulator: AdminSetMembersPopulator
+
+      class << self
+        def model_class
+          Hyrax::AdministrativeSet
+        end
+
+        ##
+        # @return [Array<Symbol>] list of required field names as symbols
+        def required_fields
+          definitions
+            .select { |_, definition| definition[:required] }
+            .keys.map(&:to_sym)
+        end
+      end
+
+      ##
+      # @return [Array<Symbol>] terms for display 'above-the-fold', or in the most
+      #   prominent form real estate
+      def primary_terms
+        _form_field_definitions
+          .select { |_, definition| definition[:primary] }
+          .keys.map(&:to_sym)
+      end
+
+      ##
+      # @return [Array<Symbol>] terms for display 'below-the-fold'
+      def secondary_terms
+        _form_field_definitions
+          .select { |_, definition| definition[:display] && !definition[:primary] }
+          .keys.map(&:to_sym)
+      end
+
+      ##
+      # @return [Boolean] whether there are terms to display 'below-the-fold'
+      def display_additional_fields?
+        secondary_terms.any?
+      end
+
+      private
+
+      def _form_field_definitions
+        self.class.definitions
+      end
+    end
+  end
+end

data/app/forms/hyrax/forms/batch_edit_form.rb

@@ -65,7 +65,7 @@ module Hyrax
       def initialize_combined_fields
         # For each of the files in the batch, set the attributes to be the concatenation of all the attributes
         batch_document_ids.each_with_object({}) do |doc_id, combined_attributes|
-          work = ActiveFedora::Base.find(doc_id)
+          work = Hyrax.query_service.find_by(id: doc_id)
           terms.each do |field|
             combined_attributes[field] ||= []
             combined_attributes[field] = (combined_attributes[field] + work[field].to_a).uniq

data/app/forms/hyrax/forms/collection_form.rb

@@ -16,7 +16,7 @@ module Hyrax
       # Required for search builder (FIXME)
       alias collection model
 
-      self.model_class = ::Collection
+      self.model_class = Hyrax.config.collection_class
 
       self.membership_service_class = Collections::CollectionMemberSearchService
 
@@ -131,7 +131,7 @@ module Hyrax
       def available_parent_collections(scope:)
         return @available_parents if @available_parents.present?
 
-        collection = ::Collection.find(id)
+        collection = model_class.find(id)
         colls = Hyrax::Collections::NestedCollectionQueryService.available_parent_collections(child: collection, scope: scope, limit_to_id: nil)
         @available_parents = colls.map do |col|
           { "id" => col.id, "title_first" => col.title.first }

data/app/forms/hyrax/forms/dashboard/nest_collection_form.rb

@@ -10,18 +10,28 @@ module Hyrax
         self.default_query_service = Hyrax::Collections::NestedCollectionQueryService
         self.default_persistence_service = Hyrax::Collections::NestedCollectionPersistenceService
 
+        ##
         # @param parent [::Collection, NilClass]
         # @param child [::Collection, NilClass]
+        # @param parent_id [String, nil]
+        # @param child_id [String, nil]
         # @param context [#can?,#repository,#blacklight_config]
         # @param query_service [Hyrax::Collections::NestedCollectionQueryService]
         # @param persistence_service [Hyrax::Collections::NestedCollectionPersistenceService] responsible for persisting the parent/child relationship
-        def initialize(parent: nil, child: nil, context:, query_service: default_query_service, persistence_service: default_persistence_service)
-          self.parent = parent
-          self.child = child
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(parent: nil,
+                       child: nil,
+                       parent_id: nil,
+                       child_id: nil,
+                       context:,
+                       query_service: default_query_service,
+                       persistence_service: default_persistence_service)
           self.context = context
           self.query_service = query_service
           self.persistence_service = persistence_service
-        end
+          self.parent = parent || (parent_id.present? && find_parent(parent_id))
+          self.child = child || (child_id.present? && find_child(child_id))
+        end # rubocop:enable Metrics/ParameterLists
 
         attr_accessor :parent, :child
 
@@ -73,7 +83,7 @@ module Hyrax
         # rerouting to new_dashboard_collection_path to add the new collection as
         # a child. Since we don't yet have a child collection, the valid? option can't be used here.
         def validate_add
-          if parent.try(:nestable?)
+          if nestable?(parent)
             nesting_within_maximum_depth
           else
             errors.add(:parent, :cannot_have_child_nested)
@@ -106,15 +116,30 @@ module Hyrax
         end
 
         def parent_and_child_can_be_nested
-          if parent.try(:nestable?) && child.try(:nestable?)
+          if nestable?(parent) && nestable?(child)
             return true if query_service.parent_and_child_can_nest?(parent: parent, child: child, scope: context)
             errors.add(:parent, :cannot_have_child_nested)
             errors.add(:child, :cannot_nest_in_parent)
           else
-            errors.add(:parent, :is_not_nestable) unless parent.try(:nestable?)
-            errors.add(:child, :is_not_nestable) unless child.try(:nestable?)
+            errors.add(:parent, :is_not_nestable) unless nestable?(parent)
+            errors.add(:child, :is_not_nestable) unless nestable?(child)
           end
         end
+
+        def find_parent(parent_id)
+          Hyrax.query_service.find_by(id: parent_id)
+        end
+
+        def find_child(child_id)
+          Hyrax.query_service.find_by(id: child_id)
+        end
+
+        def nestable?(collection)
+          return false if collection.blank?
+          return collection.nestable? if collection.respond_to? :nestable?
+          collection_type = Hyrax::CollectionType.find_by_gid!(collection.collection_type_gid)
+          collection_type.nestable?
+        end
       end
     end
   end

data/app/forms/hyrax/forms/pcdm_collection_form.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # @api public
+    # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
+    class PcdmCollectionForm < Valkyrie::ChangeSet # rubocop:disable Metrics/ClassLength
+      property :title, required: true, primary: true
+
+      property :human_readable_type, writable: false
+      property :date_modified, readable: false
+      property :date_uploaded, readable: false
+
+      property :depositor, required: true
+      property :collection_type_gid, required: true
+      property :visibility, default: VisibilityIntention::PRIVATE
+
+      property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
+
+      validates :title, presence: true
+      validates :collection_type_gid, presence: true
+
+      class << self
+        def model_class
+          Hyrax::PcdmCollection
+        end
+
+        ##
+        # @return [Array<Symbol>] list of required field names as symbols
+        def required_fields
+          definitions
+            .select { |_, definition| definition[:required] }
+            .keys.map(&:to_sym)
+        end
+      end
+
+      ##
+      # @return [Array<Symbol>] terms for display 'above-the-fold', or in the most
+      #   prominent form real estate
+      def primary_terms
+        _form_field_definitions
+          .select { |_, definition| definition[:primary] }
+          .keys.map(&:to_sym)
+      end
+
+      ##
+      # @return [Array<Symbol>] terms for display 'below-the-fold'
+      def secondary_terms
+        _form_field_definitions
+          .select { |_, definition| definition[:display] && !definition[:primary] }
+          .keys.map(&:to_sym)
+      end
+
+      ##
+      # @return [Boolean] whether there are terms to display 'below-the-fold'
+      def display_additional_fields?
+        secondary_terms.any?
+      end
+
+      private
+
+      def _form_field_definitions
+        self.class.definitions
+      end
+    end
+  end
+end

data/app/forms/hyrax/forms/permission_template_form.rb

@@ -7,16 +7,12 @@ module Hyrax
       self.model_class = PermissionTemplate
       self.terms = []
       delegate :access_grants, :access_grants_attributes=, :release_date, :release_period, :visibility, to: :model
-      delegate :available_workflows, :active_workflow, :source_model, to: :model
-
-      # @return [#to_s] the primary key of the associated admin_set or collection
-      # def source_id (because you might come looking for this method)
-      delegate :id, to: :source_model, prefix: :source
+      delegate :available_workflows, :active_workflow, :source, :source_id, to: :model
 
       ##
-      # @deprecated  use PermissionTemplate#reset_access_controls instead.
+      # @deprecated  use PermissionTemplate#reset_access_controls_for instead.
       def reset_access_controls!
-        Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
+        Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls_for instead.")
         source_model.reset_access_controls!
       end
 
@@ -73,8 +69,8 @@ module Hyrax
       # Copy this access to the permissions of the Admin Set or Collection and to
       # the WorkflowResponsibilities of the active workflow if this is an Admin Set
       def update_access(remove_agent: false)
-        source_model.reset_access_controls!
-        update_workflow_responsibilities(remove_agent: remove_agent) if source_model.is_a?(AdminSet)
+        model.reset_access_controls_for(collection: source)
+        update_workflow_responsibilities(remove_agent: remove_agent) if source.is_a?(Hyrax::AdministrativeSet)
       end
 
       # This method is used to revoke access to a Collection or Admin Set and its workflows
@@ -85,6 +81,18 @@ module Hyrax
         update_access(remove_agent: true)
       end
 
+      ##
+      # A bit of an analogue for a `belongs_to :source_model` as it crosses from Fedora to the DB
+      # @return [AdminSet, ::Collection]
+      # @raise [Hyrax::ObjectNotFoundError] when neither an AdminSet or Collection is found
+      # @note This method will eventually be replaced by #source which returns a Hyrax::Resource
+      #   object.  Many methods are equally able to process both Hyrax::Resource and
+      #   ActiveFedora::Base.  Only call this method if you need the ActiveFedora::Base object.
+      # @see #source
+      def source_model # rubocop:disable Rails/Delegate
+        model.source_model
+      end
+
       private
 
       # @return [String]

data/app/forms/hyrax/forms/resource_form.rb

@@ -30,10 +30,10 @@ module Hyrax
     # @api public
     #
     # This form wraps `Hyrax::ChangeSet` in the `HydraEditor::Form` interface.
-    class ResourceForm < Hyrax::ChangeSet
+    class ResourceForm < Hyrax::ChangeSet # rubocop:disable Metrics/ClassLength
       ##
       # @api private
-      InWorksPopulator = lambda do |_options|
+      InWorksPrepopulator = lambda do |_options|
         self.in_works_ids =
           if persisted?
             Hyrax.query_service
@@ -52,17 +52,16 @@ module Hyrax
       #   with `etag`-driven, application-side lock checks. for non-wings adapters
       #   we want to move away from application side lock validation and rely
       #   on the adapter/database features instead.
-      LockKeyPopulator = lambda do |_options|
-        self.version =
-          case Hyrax.metadata_adapter
-          when Wings::Valkyrie::MetadataAdapter
+      LockKeyPrepopulator = lambda do |_options|
+        if Hyrax.config.disable_wings || !Hyrax.metadata_adapter.is_a?(Wings::Valkyrie::MetadataAdapter)
+          Hyrax.logger.info "trying to prepopulate a lock token for " \
+                            "#{self.class.inspect}, but optimistic locking isn't " \
+                            "supported for the configured adapter: #{Hyrax.metadata_adapter.class}"
+          self.version = ''
+        else
+          self.version =
             model.persisted? ? Wings::ActiveFedoraConverter.convert(resource: model).etag : ''
-          else
-            Hyrax.logger.info 'trying to prepopulate a lock token for ' \
-                              "#{self.class.inspect}, but optimistic locking isn't " \
-                              "supported for the configured adapter: #{Hyrax.metadata_adapter.class}"
-            ''
-          end
+        end
       end
 
       class_attribute :model_class
@@ -96,10 +95,16 @@ module Hyrax
       property :visibility_during_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_during_lease = model.lease&.visibility_during_lease }
 
       # pcdm relationships
-      property :admin_set_id, prepopulator: ->(_opts) { self.admin_set_id = AdminSet::DEFAULT_ID }
-      property :in_works_ids, virtual: true, prepopulator: InWorksPopulator
+      property :admin_set_id, prepopulator: ->(_opts) { self.admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
+      property :in_works_ids, virtual: true, prepopulator: InWorksPrepopulator
       property :member_ids, default: [], type: Valkyrie::Types::Array
       property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
+      property :member_of_collections_attributes, virtual: true
+      validates_with CollectionMembershipValidator
+
+      property :representative_id, type: Valkyrie::Types::String
+      property :thumbnail_id, type: Valkyrie::Types::String
+      property :rendering_ids, default: [], type: Valkyrie::Types::Array
 
       # provide a lock token for optimistic locking; we name this `version` for
       # backwards compatibility
@@ -109,7 +114,7 @@ module Hyrax
       # the model is disabled
       #
       # @see https://github.com/samvera/valkyrie/wiki/Optimistic-Locking
-      property :version, virtual: true, prepopulator: LockKeyPopulator
+      property :version, virtual: true, prepopulator: LockKeyPrepopulator
 
       # backs the child work search element;
       # @todo: look for a way for the view template not to depend on this
@@ -128,8 +133,12 @@ module Hyrax
           "#{resource.class.name}Form".constantize.new(resource)
         rescue NameError => _err
           case resource
+          when Hyrax::AdministrativeSet
+            Hyrax::Forms::AdministrativeSetForm.new(resource)
           when Hyrax::FileSet
             Hyrax::Forms::FileSetForm.new(resource)
+          when Hyrax::PcdmCollection
+            Hyrax::Forms::PcdmCollectionForm.new(resource)
           else
             Hyrax::Forms::ResourceForm(resource.class).new(resource)
           end

data/app/forms/hyrax/forms/workflow_action_form.rb

@@ -17,6 +17,10 @@ module Hyrax
       include ActiveModel::Validations
       extend ActiveModel::Translation
 
+      ##
+      # @param current_ability [::Ability]
+      # @param work [ActiveFedora::Base, Valkyrie::Resource]
+      # @param attributes [Hash{Symbol => String}]
       def initialize(current_ability:, work:, attributes: {})
         @current_ability = current_ability
         @work = work

data/app/helpers/hyrax/collections_helper.rb

@@ -191,6 +191,20 @@ module Hyrax
       CollectionType.find_or_create_default_collection_type.title
     end
 
+    ##
+    # @param collection [Object]
+    #
+    # @return [PermissionTemplateForm]
+    def collection_permission_template_form_for(form:)
+      case form
+      when Valkyrie::ChangeSet
+        template_model = Hyrax::PermissionTemplate.find_or_create_by(source_id: form.id.to_s)
+        Hyrax::Forms::PermissionTemplateForm.new(template_model)
+      else
+        form.permission_template
+      end
+    end
+
     private
 
     # add hidden fields to a form for performing an action on a single document on a collection

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -296,6 +296,15 @@ module Hyrax
       solr_field.first
     end
 
+    ##
+    # @param [Object] an object that might have a thumbnail
+    #
+    # @return [String] a label for the object's thumbnail
+    def thumbnail_label_for(object:)
+      object.try(:thumbnail_title).presence ||
+        ""
+    end
+
     private
 
     def user_agent

data/app/helpers/hyrax/membership_helper.rb

@@ -41,7 +41,7 @@ module Hyrax
       Hyrax.custom_queries.find_child_works(resource: resource).map do |member|
         { id: member.id.to_s,
           label: member.title.first,
-          path: url_for(member) }
+          path: main_app.url_for([member, { only_path: true }]) }
       end.to_json
     end
   end

data/app/helpers/hyrax/trophy_helper.rb

@@ -15,7 +15,7 @@ module Hyrax
       args[:data]['remove-text'] = args[:remove_text]
 
       args[:data][:url] = hyrax.trophy_work_path(id)
-      link_to '#', class: args[:class], data: args[:data] do
+      link_to '#', id: 'action-highlight-work', class: args[:class], data: args[:data] do
         yield(text)
       end
     end

data/app/helpers/hyrax/url_helper.rb

@@ -3,7 +3,7 @@ module Hyrax
   module UrlHelper
     # generated models get registered as curation concerns and need a
     # track_model_path to render Blacklight-related views
-    (['FileSet', 'Collection'] + Hyrax.config.registered_curation_concern_types).each do |concern|
+    (['FileSet', 'Collection', 'Hyrax::AdministrativeSet'] + Hyrax.config.registered_curation_concern_types).each do |concern|
       model = concern.safe_constantize
       model_name = model.respond_to?(:model_name) && model.model_name
       next unless model_name

data/app/indexers/hyrax/administrative_set_indexer.rb

@@ -4,14 +4,20 @@ module Hyrax
   ##
   # Indexes Hyrax::AdministrativeSet objects
   class AdministrativeSetIndexer < Hyrax::ValkyrieIndexer
+    include Hyrax::ResourceIndexer
+    include Hyrax::PermissionIndexer
+    include Hyrax::VisibilityIndexer
+    include Hyrax::Indexer(:core_metadata)
+
     def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       super.tap do |solr_doc|
-        solr_doc['generic_type_si'] = 'Admin Set'
-        solr_doc['alternative_title_tesim'] = resource.alternative_title
-        solr_doc['creator_ssim']            = resource.creator
-        solr_doc['description_tesim']       = resource.description
-        solr_doc['title_tesim']             = resource.title
-        solr_doc['title_sim']               = resource.title
+        solr_doc[Hyrax.config.collection_type_index_field.to_sym] = Array(resource.try(:collection_type_gid)&.to_s)
+        solr_doc[:alternative_title_tesim] = resource.alternative_title
+        solr_doc[:creator_ssim]            = [resource.creator]
+        solr_doc[:creator_tesim]           = [resource.creator]
+        solr_doc[:description_tesim]       = resource.description
+        solr_doc[:generic_type_sim]        = ['Admin Set']
+        solr_doc[:thumbnail_path_ss]       = Hyrax::CollectionThumbnailPathService.call(resource)
       end
     end
   end

data/app/indexers/hyrax/deep_indexing_service.rb

@@ -41,7 +41,7 @@ module Hyrax
 
     def fetch_with_persistence(resource)
       old_label = resource.rdf_label.first
-      return unless old_label == resource.rdf_subject.to_s || old_label.nil?
+      return unless old_label == resource.rdf_subject.to_s
       fetch_value(resource)
       return if old_label == resource.rdf_label.first || resource.rdf_label.first == resource.rdf_subject.to_s
       resource.persist! # Stores the fetched values into our marmotta triplestore

data/app/indexers/hyrax/file_set_indexer.rb

@@ -30,6 +30,7 @@ module Hyrax
         solr_doc['original_checksum_tesim'] = object.original_checksum
         solr_doc['alpha_channels_ssi']      = object.alpha_channels
         solr_doc['original_file_id_ssi']    = original_file_id
+        solr_doc['generic_type_si'] = 'FileSet'
       end
     end
 

data/app/indexers/hyrax/pcdm_collection_indexer.rb

@@ -7,14 +7,18 @@ module Hyrax
     include Hyrax::ResourceIndexer
     include Hyrax::PermissionIndexer
     include Hyrax::VisibilityIndexer
+    include Hyrax::ThumbnailIndexer
     include Hyrax::Indexer(:core_metadata)
     include Hyrax::Indexer(:basic_metadata)
 
+    self.thumbnail_path_service = CollectionThumbnailPathService
+
     def to_solr
       super.tap do |index_document|
         index_document[Hyrax.config.collection_type_index_field.to_sym] = Array(resource.try(:collection_type_gid)&.to_s)
         index_document[:generic_type_sim] = ['Collection']
-        index_document[:thumbnail_path_ss] = Hyrax::CollectionThumbnailPathService.call(resource)
+        index_document[:depositor_ssim] = [resource.depositor]
+        index_document[:depositor_tesim] = [resource.depositor]
       end
     end
   end

data/app/indexers/hyrax/thumbnail_indexer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Hyrax
+  module ThumbnailIndexer
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :thumbnail_path_service
+      self.thumbnail_path_service = ThumbnailPathService
+      class_attribute :thumbnail_field
+      self.thumbnail_field = :thumbnail_path_ss
+    end
+
+    # Adds thumbnail indexing to the solr document of a valkyrie resource
+    def to_solr
+      super.tap do |solr_doc|
+        index_thumbnails(solr_doc)
+      end
+    end
+
+    # Write the thumbnail paths into the solr_document
+    # @param [Hash] solr_document the solr document to add the field to
+    def index_thumbnails(solr_document)
+      solr_document[thumbnail_field] = thumbnail_path.to_s
+    end
+
+    # Returns the value for the thumbnail path to put into the solr document
+    def thumbnail_path
+      self.class.thumbnail_path_service.call(resource)
+    end
+  end
+end