hyrax 3.0.2 → 3.1.0

data/app/helpers/hyrax/work_form_helper.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 module Hyrax
   module WorkFormHelper
+    ##
+    # @todo this implementation hits database backends (solr) and is invoked
+    #   from views. refactor to avoid
+    # @return  [Array<Array<String, String, Hash>] options for the admin set drop down.
+    def admin_set_options
+      return @admin_set_options.select_options if @admin_set_options
+
+      service = Hyrax::AdminSetService.new(controller)
+      Hyrax::AdminSetOptionsPresenter.new(service).select_options
+    end
+
     ##
     # This helper allows downstream applications and engines to add/remove/reorder the tabs to be
     # rendered on the work form.
@@ -26,6 +37,29 @@ module Hyrax
       end
     end
 
+    ##
+    # This helper allows downstream applications and engines to change the label of tabs to be
+    # rendered on the work form.
+    #
+    # @example passing information from the form into the translations
+    #  Override this helper and ensure that it loads after Hyrax's helpers.
+    #  module WorksHelper
+    #    def form_tab_label_for(form:, tab:)
+    #      if tab == 'metadata'
+    #        t("hyrax.works.form.tab.#{tab}", title: form.model.title.first)
+    #      else
+    #        super
+    #      end
+    #    end
+    #  end
+    #
+    # @param form [Hyrax::Forms::WorkForm]
+    # @param tab [String]
+    # @return [String] the label of the tab to be rendered in the form
+    def form_tab_label_for(form:, tab:) # rubocop:disable Lint/UnusedMethodArgument
+      t("hyrax.works.form.tab.#{tab}")
+    end
+
     ##
     # This helper allows downstream applications and engines to add additional sections to be
     # rendered after the visibility section in the Save Work panel on the work form.
@@ -44,5 +78,24 @@ module Hyrax
     def form_progress_sections_for(*)
       []
     end
+
+    ##
+    # Constructs a hash for a form `select`.
+    #
+    # @param form [Object]
+    #
+    # @return [Array<Hash{String => String}>] a map from file set labels to ids for
+    #   the parent object
+    def form_file_set_select_for(parent:)
+      return parent.select_files if parent.respond_to?(:select_files)
+      return {} unless parent.respond_to?(:member_ids)
+
+      file_sets =
+        Hyrax::PcdmMemberPresenterFactory.new(parent, nil).file_set_presenters
+
+      file_sets.each_with_object({}) do |presenter, hash|
+        hash[presenter.title_or_label] = presenter.id
+      end
+    end
   end
 end

data/app/indexers/hyrax/administrative_set_indexer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Indexes Hyrax::AdministrativeSet objects
+  class AdministrativeSetIndexer < Hyrax::ValkyrieIndexer
+    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
+      end
+    end
+  end
+end

data/app/indexers/hyrax/valkyrie_indexer.rb

@@ -68,8 +68,8 @@ module Hyrax
     def to_solr
       {
         "id": resource.id.to_s,
-        "created_at_dtsi": resource.created_at,
-        "updated_at_dtsi": resource.updated_at,
+        "date_uploaded_dtsi": resource.created_at,
+        "date_modified_dtsi": resource.updated_at,
         "has_model_ssim": resource.internal_resource
       }
     end
@@ -114,7 +114,7 @@ module Hyrax
 
         return indexer_class if indexer_class.is_a?(Class) &&
                                 indexer_class.instance_methods.include?(:to_solr)
-        ValkyrieIndexer
+        resource.try(:work?) ? Hyrax::ValkyrieWorkIndexer : ValkyrieIndexer
       end
     end
   end

data/app/inputs/controlled_vocabulary_input.rb

@@ -78,10 +78,7 @@ class ControlledVocabularyInput < MultiValueInput
   end
 
   def collection
-    @collection ||= begin
-                      val = object[attribute_name]
-                      col = val.respond_to?(:to_ary) ? val.to_ary : val
-                      col.reject { |value| value.to_s.strip.blank? }
-                    end
+    @collection ||=
+      Array(object[attribute_name]).reject { |v| v.to_s.strip.blank? }
   end
 end

data/app/jobs/attach_files_to_work_job.rb

@@ -23,19 +23,23 @@ class AttachFilesToWorkJob < Hyrax::ApplicationJob
     user = User.find_by_user_key(depositor)
 
     work, work_permissions = create_permissions work, depositor
-    metadata = visibility_attributes(work_attributes)
     uploaded_files.each do |uploaded_file|
       next if uploaded_file.file_set_uri.present?
-
-      actor = Hyrax::Actors::FileSetActor.new(FileSet.create, user)
-      uploaded_file.add_file_set!(actor.file_set)
-      actor.file_set.permissions_attributes = work_permissions
-      actor.create_metadata(metadata)
-      actor.create_content(uploaded_file)
-      actor.attach_to_work(work)
+      attach_work(user, work, work_attributes, work_permissions, uploaded_file)
     end
   end
 
+  def attach_work(user, work, work_attributes, work_permissions, uploaded_file)
+    actor = Hyrax::Actors::FileSetActor.new(FileSet.create, user)
+    file_set_attributes = file_set_attrs(work_attributes, uploaded_file)
+    metadata = visibility_attributes(work_attributes, file_set_attributes)
+    uploaded_file.add_file_set!(actor.file_set)
+    actor.file_set.permissions_attributes = work_permissions
+    actor.create_metadata(metadata)
+    actor.create_content(uploaded_file)
+    actor.attach_to_work(work, metadata)
+  end
+
   def create_permissions(work, depositor)
     work.edit_users += [depositor]
     work.edit_users = work.edit_users.dup
@@ -44,13 +48,18 @@ class AttachFilesToWorkJob < Hyrax::ApplicationJob
   end
 
   # The attributes used for visibility - sent as initial params to created FileSets.
-  def visibility_attributes(attributes)
-    attributes.slice(:visibility, :visibility_during_lease,
+  def visibility_attributes(attributes, file_set_attributes)
+    attributes.merge(file_set_attributes).slice(:visibility, :visibility_during_lease,
                      :visibility_after_lease, :lease_expiration_date,
                      :embargo_release_date, :visibility_during_embargo,
                      :visibility_after_embargo)
   end
 
+  def file_set_attrs(attributes, uploaded_file)
+    attrs = Array(attributes[:file_set]).find { |fs| fs[:uploaded_file_id].present? && (fs[:uploaded_file_id].to_i == uploaded_file&.id) }
+    Hash(attrs).symbolize_keys
+  end
+
   def validate_files!(uploaded_files)
     uploaded_files.each do |uploaded_file|
       next if uploaded_file.is_a? Hyrax::UploadedFile

data/app/jobs/attach_files_to_work_with_ordered_members_job.rb

@@ -11,21 +11,22 @@ class AttachFilesToWorkWithOrderedMembersJob < AttachFilesToWorkJob
     @ordered_members = work.ordered_members.to_a # Build array of ordered members
     depositor = proxy_or_depositor(work)
     user = User.find_by_user_key(depositor)
-    metadata = visibility_attributes(work_attributes)
-    add_uploaded_files(user, metadata, work)
+    add_uploaded_files(user, work_attributes, work)
     add_ordered_members(user, work)
   end
 
   private
 
-  def add_uploaded_files(user, metadata, work)
+  def add_uploaded_files(user, work_attributes, work)
     work_permissions = work.permissions.map(&:to_hash)
     uploaded_files.each do |uploaded_file|
+      file_set_attributes = file_set_attrs(work_attributes, uploaded_file)
+      metadata = visibility_attributes(work_attributes, file_set_attributes)
       actor = file_set_actor_class.new(FileSet.create, user)
+      actor.file_set.permissions_attributes = work_permissions
       actor.create_metadata(metadata)
       actor.create_content(uploaded_file)
-      actor.attach_to_work(work)
-      actor.file_set.permissions_attributes = work_permissions
+      actor.attach_to_work(work, metadata)
       ordered_members << actor.file_set
       uploaded_file.update(file_set_uri: actor.file_set.uri)
     end

data/app/jobs/inherit_permissions_job.rb

@@ -5,12 +5,16 @@ class InheritPermissionsJob < Hyrax::ApplicationJob
   # Perform the copy from the work to the contained filesets
   #
   # @param work containing access level and filesets
-  # @param use_valkyrie [Boolean] whether to use valkyrie support
-  def perform(work, use_valkyrie: Hyrax.config.use_valkyrie?)
-    if use_valkyrie
-      valkyrie_perform(work)
-    else
+  # @param use_valkyrie [Boolean] whether to use valkyrie support (deprecated)
+  def perform(work, use_valkyrie: :DEFAULT)
+    Deprecation.warn("use_valkyrie argument is deprecated, behavior depends on deserialized resource") unless
+      use_valkyrie == :DEFAULT
+
+    case work
+    when ActiveFedora::Base
       af_perform(work)
+    else
+      valkyrie_perform(work)
     end
   end
 

data/app/models/admin_set.rb

@@ -75,37 +75,18 @@ class AdminSet < ActiveFedora::Base
     Sipity::Workflow.find_active_workflow_for(admin_set_id: id)
   end
 
+  ##
+  # @deprecated use PermissionTemplate#reset_access_controls instead
+  #
   # Calculate and update who should have edit access based on who
   # has "manage" access in the PermissionTemplateAccess
   def reset_access_controls!
-    # NOTE: This is different from Collections in that it doesn't update read access based on visibility.
-    #       See also app/models/concerns/hyrax/collection_behavior.rb#reset_access_controls!
-    update!(edit_users: permission_template_edit_users,
-            edit_groups: permission_template_edit_groups,
-            read_users: permission_template_read_users,
-            read_groups: permission_template_read_groups)
-  end
-
-  private
-
-  def permission_template_edit_users
-    permission_template.agent_ids_for(access: 'manage', agent_type: 'user')
-  end
-
-  def permission_template_edit_groups
-    permission_template.agent_ids_for(access: 'manage', agent_type: 'group')
-  end
+    Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
 
-  def permission_template_read_users
-    (permission_template.agent_ids_for(access: 'view', agent_type: 'user') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')).uniq
+    permission_template.reset_access_controls_for(collection: self)
   end
 
-  def permission_template_read_groups
-    (permission_template.agent_ids_for(access: 'view', agent_type: 'group') +
-      permission_template.agent_ids_for(access: 'deposit', agent_type: 'group')).uniq -
-      [::Ability.registered_group_name, ::Ability.public_group_name]
-  end
+  private
 
   def destroy_permission_template
     permission_template.destroy

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

@@ -417,8 +417,10 @@ module Hyrax
 
     def extract_subjects(subject)
       case subject
+      when Hyrax::WorkShowPresenter, FileSetPresenter, Hyrax::CollectionPresenter
+        extract_subjects(subject.solr_document)
       when Draper::Decorator
-        super(subject.model)
+        extract_subjects(subject.model)
       else
         super
       end

data/app/models/concerns/hyrax/collection_behavior.rb

@@ -51,27 +51,22 @@ module Hyrax
     end
 
     # Add members using the members association.
-    # TODO: Confirm if this is ever used.  I believe all relationships are done through
-    #       add_member_objects using the member_of_collections relationship.  Deprecate?
     def add_members(new_member_ids)
-      return if new_member_ids.blank?
-      members << Hyrax.custom_queries.find_many_by_alternate_ids(alternate_ids: new_member_ids, use_valkyrie: false)
+      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
+      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
+                                                                     new_member_ids: new_member_ids,
+                                                                     user: nil)
     end
 
     # Add member objects by adding this collection to the objects' member_of_collection association.
     # @param [Enumerable<String>] the ids of the new child collections and works collection ids
     def add_member_objects(new_member_ids)
-      Array(new_member_ids).collect do |member_id|
-        member = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: member_id, use_valkyrie: false)
-        message = Hyrax::MultipleMembershipChecker.new(item: member).check(collection_ids: id, include_current_members: true)
-        if message
-          member.errors.add(:collections, message)
-        else
-          member.member_of_collections << self
-          member.save!
-        end
-        member
-      end
+      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
+      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
+                                                                     new_member_ids: new_member_ids,
+                                                                     user: nil)
     end
 
     # @return [Enumerable<ActiveFedora::Base>] an enumerable over the children of this collection
@@ -125,41 +120,19 @@ module Hyrax
       Hyrax::PermissionTemplate.find_by!(source_id: id)
     end
 
+    ##
+    # @deprecated use PermissionTemplate#reset_access_controls instead
+    #
     # Calculate and update who should have read/edit access to the collections based on who
     # has access in PermissionTemplateAccess
     def reset_access_controls!
-      update!(edit_users: permission_template_edit_users,
-              edit_groups: permission_template_edit_groups,
-              read_users: permission_template_read_users,
-              read_groups: (permission_template_read_groups + visibility_group).uniq)
-    end
-
-    private
-
-    def permission_template_edit_users
-      permission_template.agent_ids_for(access: 'manage', agent_type: 'user')
-    end
+      Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
 
-    def permission_template_edit_groups
-      permission_template.agent_ids_for(access: 'manage', agent_type: 'group')
+      permission_template
+        .reset_access_controls_for(collection: self, interpret_visibility: true)
     end
 
-    def permission_template_read_users
-      (permission_template.agent_ids_for(access: 'view', agent_type: 'user') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')).uniq
-    end
-
-    def permission_template_read_groups
-      (permission_template.agent_ids_for(access: 'view', agent_type: 'group') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'group')).uniq -
-        [::Ability.registered_group_name, ::Ability.public_group_name]
-    end
-
-    def visibility_group
-      return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
-      return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
-      []
-    end
+    private
 
     # Solr field name works use to index member ids
     def member_ids_field

data/app/models/concerns/hyrax/file_set/characterization.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
-# This module points the FileSet to the location of the technical metadata.
-# By default, the file holding the metadata is :original_file and the terms
-# are listed under ::characterization_terms.
-# Implementations may define their own terms or use a different source file, but
-# any terms must be set on the ::characterization_proxy by the Hydra::Works::CharacterizationService
-#
-# class MyFileSet
-#   include Hyrax::FileSetBehavior
-# end
-#
-# MyFileSet.characterization_proxy = :master_file
-# MyFileSet.characterization_terms = [:term1, :term2, :term3]
+
 module Hyrax
   class FileSet
+    ##
+    # This module points the FileSet to the location of the technical metadata.
+    # By default, the file holding the metadata is +:original_file+ and the terms
+    # are listed under +.characterization_terms+.
+    #
+    # Implementations may define their own terms or use a different source file, but
+    # any terms must be set on the +.characterization_proxy+ by the
+    # +Hydra::Works::CharacterizationService+.
+    #
+    # @example
+    #   class MyFileSet
+    #     include Hyrax::FileSetBehavior
+    #   end
+    #
+    #   MyFileSet.characterization_proxy = :master_file
+    #   MyFileSet.characterization_terms = [:term1, :term2, :term3]
+    #
     module Characterization
       extend ActiveSupport::Concern
 

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -13,6 +13,8 @@ module Hyrax
   #
   # @see https://github.com/projectblacklight/blacklight/wiki/Understanding-Rails-and-Blacklight#models
   module SolrDocumentBehavior
+    ModelWrapper = ActiveFedoraDummyModel # alias for backward compatibility
+
     extend ActiveSupport::Concern
     include Hydra::Works::MimeTypes
     include Hyrax::Permissions::Readable
@@ -39,64 +41,13 @@ module Hyrax
       title_or_label.to_s
     end
 
-    ##
-    # Given a model class and an +id+, provides +ActiveModel+ style model methods.
-    #
-    # @note access this via {SolrDocumentBehavior#to_model}.
-    class ModelWrapper
-      ##
-      # @api private
-      #
-      # @param [Class] model
-      # @param [String, nil] id
-      def initialize(model, id)
-        @model = model
-        @id = id
-      end
-
-      ##
-      # @api public
-      def persisted?
-        true
-      end
-
-      ##
-      # @api public
-      def to_param
-        @id
-      end
-
-      ##
-      # @api public
-      def model_name
-        @model.model_name
-      end
-
-      ##
-      # @api public
-      #
-      # @note uses the @model's `._to_partial_path` if implemented, otherwise
-      #   constructs a default
-      def to_partial_path
-        return @model._to_partial_path if
-          @model.respond_to?(:_to_partial_path)
-
-        "hyrax/#{model_name.collection}/#{model_name.element}"
-      end
-
-      ##
-      # @api public
-      def to_global_id
-        URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
-      end
-    end
     ##
     # Offer the source model to Rails for some of the Rails methods (e.g. link_to).
     #
     # @example
     #   link_to '...', SolrDocument(:id => 'bXXXXXX5').new => <a href="/dams_object/bXXXXXX5">...</a>
     def to_model
-      @model ||= ModelWrapper.new(hydra_model, id)
+      @model ||= ActiveFedoraDummyModel.new(hydra_model, id)
     end
 
     ##
@@ -117,6 +68,12 @@ module Hyrax
       hydra_model == ::AdminSet
     end
 
+    ##
+    # @return [Boolean]
+    def work?
+      Hyrax.config.curation_concerns.include? hydra_model
+    end
+
     # Method to return the model
     def hydra_model(classifier: ActiveFedora.model_mapper)
       "::#{first('has_model_ssim')}".safe_constantize ||