hyrax 3.0.0 → 3.2.0

data/app/controllers/hyrax/workflow_actions_controller.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 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
@@ -9,19 +18,15 @@ 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 ||= Hyrax::Forms::WorkflowActionForm.new(
+      @workflow_action_form ||= DEFAULT_FORM_CLASS.new(
         current_ability: current_ability,
         work: curation_concern,
         attributes: workflow_action_params

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

@@ -0,0 +1,62 @@
+# 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
+      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 :depositor
+
+      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/collection_form.rb

@@ -16,9 +16,9 @@ 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::CollectionMemberService
+      self.membership_service_class = Collections::CollectionMemberSearchService
 
       delegate :blacklight_config, to: Hyrax::CollectionsController
 
@@ -80,18 +80,20 @@ module Hyrax
       def banner_info
         @banner_info ||= begin
           # Find Banner filename
-          banner_info = CollectionBrandingInfo.where(collection_id: id).where(role: "banner")
+          banner_info = CollectionBrandingInfo.where(collection_id: id, role: "banner")
           banner_file = File.split(banner_info.first.local_path).last unless banner_info.empty?
+          alttext = banner_info.first.alt_text unless banner_info.empty?
           file_location = banner_info.first.local_path unless banner_info.empty?
           relative_path = "/" + banner_info.first.local_path.split("/")[-4..-1].join("/") unless banner_info.empty?
-          { file: banner_file, full_path: file_location, relative_path: relative_path }
+          { file: banner_file, full_path: file_location, relative_path: relative_path, alttext: alttext }
         end
       end
 
       def logo_info
         @logo_info ||= begin
           # Find Logo filename, alttext, linktext
-          logos_info = CollectionBrandingInfo.where(collection_id: id).where(role: "logo")
+          logos_info = CollectionBrandingInfo.where(collection_id: id, role: "logo")
+
           logos_info.map do |logo_info|
             logo_file = File.split(logo_info.local_path).last
             relative_path = "/" + logo_info.local_path.split("/")[-4..-1].join("/")
@@ -121,15 +123,19 @@ module Hyrax
         collection_member_service.available_member_subcollections.documents
       end
 
+      ##
+      # @deprecated this implementation requires an extra db round trip, had a
+      #   buggy cacheing mechanism, and was largely duplicative of other code.
+      #   all versions of this code are replaced by
+      #   {CollectionsHelper#available_parent_collections_data}.
       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 }
-        end
-        @available_parents.to_json
+        end.to_json
       end
 
       private

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.parent = parent || (parent_id.present? && Hyrax.config.collection_class.find(parent_id))
+          self.child = child || (child_id.present? && Hyrax.config.collection_class.find(child_id))
           self.context = context
           self.query_service = query_service
           self.persistence_service = persistence_service
-        end
+        end # rubocop:enable Metrics/ParameterLists
 
         attr_accessor :parent, :child
 
@@ -32,18 +42,40 @@ module Hyrax
 
         def save
           return false unless valid?
-          persistence_service.persist_nested_collection_for(parent: parent, child: child)
+          persistence_service.persist_nested_collection_for(parent: parent, child: child, user: context.current_user)
         end
 
+        ##
+        # @deprecated this method is unused by hyrax, and is effectively a
+        #   delegation to `Hyrax::Collections::NestedCollectionQueryService`.
+        #   if you want to be sure to use nested indexing to generate this list,
+        #   use the query service directly.
+        #
         # For the given parent, what are all of the available collections that
         # can be added as sub-collection of the parent.
         def available_child_collections
+          Deprecation.warn "#{self.class}#available_child_collections " \
+                           "is deprecated. the helper of the same name or " \
+                           "Hyrax::Collections::NestedCollectionQueryService " \
+                           "instead."
+
           query_service.available_child_collections(parent: parent, scope: context)
         end
 
+        ##
+        # @deprecated this method is unused by hyrax, and is effectively a
+        #   delegation to `Hyrax::Collections::NestedCollectionQueryService`.
+        #   if you want to be sure to use nested indexing to generate this list,
+        #   use the query service directly.
+        #
         # For the given child, what are all of the available collections to
         # which the child can be added as a sub-collection.
         def available_parent_collections
+          Deprecation.warn "#{self.class}#available_parent_collections " \
+                           "is deprecated. the helper of the same name or " \
+                           "Hyrax::Collections::NestedCollectionQueryService " \
+                           "instead."
+
           query_service.available_parent_collections(child: child, scope: context)
         end
 
@@ -61,7 +93,7 @@ module Hyrax
 
         def remove
           if context.can? :edit, parent
-            persistence_service.remove_nested_relationship_for(parent: parent, child: child)
+            persistence_service.remove_nested_relationship_for(parent: parent, child: child, user: context.current_user)
           else
             errors.add(:parent, :cannot_remove_relationship)
             false

data/app/forms/hyrax/forms/file_set_form.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # @api public
+    class FileSetForm < Hyrax::ChangeSet
+      include Hyrax::FormFields(:core_metadata)
+
+      class << self
+        ##
+        # @return [Array<Symbol>] list of required field names as symbols
+        def required_fields
+          definitions
+            .select { |_, definition| definition[:required] }
+            .keys.map(&:to_sym)
+        end
+      end
+
+      property :creator, required: true
+      property :license, required: true
+
+      property :based_near
+      property :contributor
+      property :date_created
+      property :description
+      property :identifier
+      property :keyword
+      property :language
+      property :publisher
+      property :related_url
+      property :subject
+
+      property :permissions, virtual: true
+      property :visibility, default: VisibilityIntention::PRIVATE
+
+      # virtual properties for embargo/lease;
+      property :embargo_release_date, virtual: true
+      property :visibility_after_embargo, virtual: true
+      property :visibility_during_embargo, virtual: true
+      property :lease_expiration_date, virtual: true
+      property :visibility_after_lease, virtual: true
+      property :visibility_during_lease, virtual: true
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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 :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
+
+      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.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Hyrax
+  module Forms
+    ##
+    # Nested form for permissions.
+    #
+    # @note due to historical oddities with Hydra::AccessControls and Hydra
+    #   Editor, Hyrax's views rely on `agent_name` and `access` as field
+    #   names. we provide these as virtual fields and prepopulate these from
+    #   `Hyrax::Permission`.
+    class Permission < Hyrax::ChangeSet
+      property :agent_name, virtual: true, prepopulator: ->(_opts) { self.agent_name = model.agent }
+      property :access, virtual: true, prepopulator: ->(_opts) { self.access = model.mode }
+
+      ##
+      # @note support a {#to_hash} method for compatibility with
+      #   {Hydra::AccessControl::Permissions}
+      def to_hash
+        { name: agent_name, access: access }
+      end
+    end
+  end
+end

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

@@ -12,7 +12,13 @@ module Hyrax
       # @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 :reset_access_controls!, to: :source_model
+
+      ##
+      # @deprecated  use PermissionTemplate#reset_access_controls instead.
+      def reset_access_controls!
+        Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
+        source_model.reset_access_controls!
+      end
 
       # Stores which radio button under release "Varies" option is selected
       attr_accessor :release_varies
@@ -67,7 +73,7 @@ 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)
-        reset_access_controls!
+        source_model.reset_access_controls!
         update_workflow_responsibilities(remove_agent: remove_agent) if source_model.is_a?(AdminSet)
       end
 

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

@@ -30,19 +30,7 @@ module Hyrax
     # @api public
     #
     # This form wraps `Hyrax::ChangeSet` in the `HydraEditor::Form` interface.
-    class ResourceForm < Hyrax::ChangeSet
-      ##
-      # Nested form for permissions.
-      #
-      # @note due to historical oddities with Hydra::AccessControls and Hydra
-      #   Editor, Hyrax's views rely on `agent_name` and `access` as field
-      #   names. we provide these as virtual fields and prepopulate these from
-      #   `Hyrax::Permission`.
-      class Permission < Hyrax::ChangeSet
-        property :agent_name, virtual: true, prepopulator: ->(_opts) { self.agent_name = model.agent }
-        property :access, virtual: true, prepopulator: ->(_opts) { self.access = model.mode }
-      end
-
+    class ResourceForm < Hyrax::ChangeSet # rubocop:disable Metrics/ClassLength
       ##
       # @api private
       InWorksPopulator = lambda do |_options|
@@ -65,16 +53,15 @@ module Hyrax
       #   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
+        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
@@ -91,7 +78,12 @@ module Hyrax
       property :date_uploaded, readable: false
       property :agreement_accepted, virtual: true, default: false, prepopulator: ->(_opts) { self.agreement_accepted = !model.new_record }
 
-      collection :permissions, virtual: true, default: [], form: Permission, prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions }
+      collection(:permissions,
+                 virtual: true,
+                 default: [],
+                 form: Hyrax::Forms::Permission,
+                 populator: :permission_populator,
+                 prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
 
       # virtual properties for embargo/lease;
       property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
@@ -108,6 +100,10 @@ module Hyrax
       property :member_ids, default: [], type: Valkyrie::Types::Array
       property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
 
+      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
       #
@@ -131,10 +127,17 @@ module Hyrax
         # @example
         #   monograph  = Monograph.new
         #   change_set = Hyrax::Forms::ResourceForm.for(monograph)
-        def for(work)
-          "#{work.class}Form".constantize.new(work)
+        def for(resource)
+          "#{resource.class.name}Form".constantize.new(resource)
         rescue NameError => _err
-          Hyrax::Forms::ResourceForm(work.class).new(work)
+          case 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
         end
 
         ##
@@ -201,6 +204,11 @@ module Hyrax
 
       private
 
+      # https://trailblazer.to/2.1/docs/reform.html#reform-populators-populator-collections
+      def permission_populator(collection:, index:, **)
+        Hyrax::Forms::Permission.new(collection[index])
+      end
+
       def _form_field_definitions
         self.class.definitions
       end

data/app/forms/hyrax/forms/work_form.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
-# rubocop:disable Metrics/ClassLength
 module Hyrax
   module Forms
     # @abstract
-    class WorkForm
+    class WorkForm # rubocop:disable Metrics/ClassLength
       include HydraEditor::Form
       include HydraEditor::Form::Permissions
       attr_accessor :current_ability
@@ -176,6 +175,10 @@ module Hyrax
             based_near_attributes: [:id, :_destroy],
             member_of_collections_attributes: [:id, :_destroy],
             work_members_attributes: [:id, :_destroy]
+          },
+          {
+            file_set: [:visibility, :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,
+                       :visibility_during_lease, :lease_expiration_date, :visibility_after_lease, :uploaded_file_id]
           }
         ]
       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/batch_edits_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
-# View Helpers for Hydra Batch Edit functionality
+
 module Hyrax
+  ##
+  # View Helpers for Hydra Batch Edit functionality
   module BatchEditsHelper
     # Displays the delete button for batch editing
     def batch_delete

data/app/helpers/hyrax/collections_helper.rb

@@ -1,6 +1,29 @@
 # frozen_string_literal: true
 module Hyrax
-  module CollectionsHelper
+  module CollectionsHelper # rubocop:disable Metrics/ModuleLength
+    ##
+    # @since 3.1.0
+    # @return [Array<SolrDocument>]
+    def available_child_collections(collection:)
+      Hyrax::Collections::NestedCollectionQueryService
+        .available_child_collections(parent: collection, scope: controller, limit_to_id: nil)
+    end
+
+    ##
+    # @since 3.1.0
+    #
+    # @note provides data for handleAddToCollection javascript
+    #
+    # @return [String] JSON document containing id/title pairs for eligible
+    #   parent collections to be displayed in an "Add to Collection" dropdown
+    def available_parent_collections_data(collection:)
+      Hyrax::Collections::NestedCollectionQueryService
+        .available_parent_collections(child: collection, scope: controller, limit_to_id: nil)
+        .map do |result|
+        { "id" => result.id, "title_first" => result.title.first }
+      end.to_json
+    end
+
     ##
     # @since 3.0.0
     # @return [#to_s]
@@ -97,6 +120,69 @@ module Hyrax
       single_item_action_form_fields(form, document, 'remove')
     end
 
+    ##
+    # @param collection [Object]
+    def collection_type_label_for(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .title
+      else
+        collection.collection_type.title
+      end
+    end
+
+    ##
+    # @param collection [Object]
+    #
+    # @return [Boolean]
+    def collection_brandable?(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .brandable?
+      else
+        collection.try(:brandable?)
+      end
+    end
+
+    ##
+    # @param collection [Object]
+    #
+    # @return [Boolean]
+    def collection_discoverable?(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .discoverable?
+      else
+        collection.try(:discoverable?)
+      end
+    end
+
+    ##
+    # @param collection [Object]
+    #
+    # @return [Boolean]
+    def collection_sharable?(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .sharable?
+      else
+        collection.try(:sharable?)
+      end
+    end
+
+    ##
+    # @note this helper is primarily intended for use with blacklight facet
+    #   fields. it assumes we index a `collection_type_gid` and the helper
+    #   can be passed as as a `helper_method:` to `add_facet_field`.
+    #
     # @param collection_type_gid [String] The gid of the CollectionType to be looked up
     # @return [String] The CollectionType's title if found, else the gid
     def collection_type_label(collection_type_gid)
@@ -112,4 +198,4 @@ module Hyrax
       render 'hyrax/dashboard/collections/single_item_action_fields', form: form, document: document, action: action
     end
   end
-end
+end # rubocop:enable Metrics/ModuleLength