hyrax 5.2.0 → 5.3.0

data/app/forms/concerns/hyrax/based_near_field_behavior.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+module Hyrax
+  # Form-side handling for the `based_near` (location) controlled vocabulary
+  # field. The form expects a `ControlledVocabularies::Location` object as
+  # input and produces a hash like those used with `accepts_nested_attributes_for`.
+  #
+  # The `deserialize!` override below is the canonical Field Behavior pattern
+  # for nested-attribute properties: a module prepended onto every
+  # `ResourceForm` subclass that strips its own key from the rewritten params
+  # so Reform's `from_hash` doesn't write the raw `_attributes` payload to a
+  # same-named property. Calling `super` first lets the chain compose — every
+  # Field Behavior runs its own delete, then control falls through to Reform's
+  # base `deserialize!` (the `<name>_attributes` rename pass).
+  module BasedNearFieldBehavior
+    def self.included(descendant)
+      descendant.property :based_near_attributes, virtual: true, populator: :based_near_attributes_populator, prepopulator: :based_near_attributes_prepopulator
+    end
+
+    # Skipping based_near in deserialize avoids a race condition where it
+    # would otherwise end up in an inconsistent state during validation; the
+    # field is handled exclusively by the populator on
+    # `based_near_attributes`.
+    #
+    # Override `deserialize!` (not `deserialize`) so the strip runs *after*
+    # Reform's `FormBuilderMethods#deserialize!` has renamed
+    # `based_near_attributes` to `based_near`, but *before* `from_hash`
+    # reads property values from the params. Stripping in `deserialize`
+    # would happen before the rename, and the rename would put the key
+    # back; `from_hash` would then write raw fragment hashes onto the
+    # form's `based_near` field, breaking the populator's contract.
+    #
+    # Mutate `params` in place — never replace it. Reform's `validate(params)`
+    # exposes the same hash via `form.input_params`, and downstream callers
+    # (`WorksControllerBehavior#update_valkyrie_work` reading
+    # `form.input_params["permissions"]`) read from that exact reference
+    # *after* the rename.
+    def deserialize!(params)
+      result = super
+      if result.respond_to?(:delete)
+        result.delete('based_near')
+        result.delete(:based_near)
+      end
+      result
+    end
+
+    private
+
+    def based_near_attributes_populator(fragment:, **_options)
+      return unless respond_to?(:based_near)
+      adds = []
+      deletes = []
+      fragment.each do |_, h|
+        uri = RDF::URI.parse(h["id"]).to_s
+        if h["_destroy"] == "true"
+          deletes << uri
+        else
+          adds << uri
+        end
+      end
+      self.based_near = ((model.based_near + adds) - deletes).uniq
+    end
+
+    def based_near_attributes_prepopulator
+      return unless respond_to?(:based_near)
+      self.based_near = based_near&.map do |loc|
+        uri = RDF::URI.parse(loc)
+        if uri
+          Hyrax::ControlledVocabularies::Location.new(uri)
+        else
+          loc
+        end
+      end
+      self.based_near ||= []
+      self.based_near << Hyrax::ControlledVocabularies::Location.new if self.based_near.blank?
+    end
+  end
+end

data/app/forms/concerns/hyrax/flexible_form_behavior.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Hyrax
+  module FlexibleFormBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      property :contexts
+
+      validate :validate_flexible_required_fields
+    end
+
+    def validate_flexible_required_fields
+      required_fields = singleton_class.schema_definitions.select { |_, opts| opts[:required] }.keys
+
+      required_fields.each do |field|
+        value = send(field)
+        errors.add(field, :blank) if value.blank?
+      end
+    end
+
+    # OVERRIDE disposable 0.6.3 to make schema dynamic
+    def schema
+      Hyrax::Forms::ResourceForm::Definition::Each.new(singleton_class.schema_definitions)
+    end
+
+    private
+
+    # OVERRIDE valkyrie 3.0.1 to make schema dynamic
+    def field(field_name)
+      singleton_class.schema_definitions.fetch(field_name.to_s)
+    end
+
+    def _form_field_definitions
+      singleton_class.schema_definitions
+    end
+  end
+end

data/app/forms/concerns/hyrax/redirects_field_behavior.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # Form-side handling for the `redirects` nested-attribute field.
+  #
+  # Submitted form payloads arrive under `redirects_attributes` and are
+  # turned into plain hashes (the persisted shape — see
+  # `config/metadata/redirects.yaml`, `type: hash`) by the populator.
+  # The form partial wraps each persisted hash in a `Hyrax::Redirect`
+  # value object at render time so the view can call `.path` and
+  # `.is_display_url`.
+  #
+  # The `deserialize!` override removes the renamed `redirects` key
+  # before Reform's `from_hash` runs, so the form's `redirects`
+  # property is written exclusively by the populator. See
+  # `Hyrax::BasedNearFieldBehavior` for the parallel pattern.
+  #
+  # ## Feature gating
+  #
+  # `self.included` runs at class load time and uses the structural
+  # gate `Hyrax.config.redirects_enabled?`. The runtime Flipflop
+  # check isn't meaningful here because the form class is being
+  # defined, not handling a request.
+  #
+  # All runtime-side methods (`deserialize!`, populator) delegate to
+  # `Hyrax.config.redirects_active?`, the two-gate combinator
+  # (`redirects_enabled? && Flipflop.redirects?`). Calling
+  # `Flipflop.redirects?` directly is unsafe when the config is off
+  # because the feature isn't registered in that case.
+  module RedirectsFieldBehavior
+    def self.included(descendant)
+      return unless Hyrax.config.redirects_enabled?
+      # Declare the radio-group scalar before redirects_attributes so Reform
+      # deserializes it first; the populator reads its value while building
+      # per-row entries.
+      descendant.property :redirects_display_url_index, virtual: true
+      descendant.property :redirects_attributes,
+                          virtual: true,
+                          populator: :redirects_attributes_populator
+    end
+
+    # Reform's FormBuilderMethods rewrites `redirects_attributes` →
+    # `redirects` before `from_hash` runs. Strip the renamed key so
+    # the populator on `redirects_attributes` is the single entry
+    # point for form-driven writes.
+    def deserialize!(params)
+      result = super
+      if Hyrax.config.redirects_active? && result.respond_to?(:delete)
+        result.delete('redirects')
+        result.delete(:redirects)
+      end
+      result
+    end
+
+    private
+
+    # Builds plain hashes (the persisted shape) from the submitted
+    # `redirects_attributes` payload. Drops rows marked for destruction
+    # or with a blank path. Normalizes paths up-front so the validator
+    # sees normalized form (so DSpace-style pasted URLs validate cleanly).
+    #
+    # When `redirects_display_url_index` is set (form-driven radio
+    # group), the matching original-index row gets `is_display_url: true`
+    # and all other rows get false. When absent (Bulkrax import path),
+    # the row's own `is_display_url` value is honored.
+    def redirects_attributes_populator(fragment:, **_options)
+      return unless respond_to?(:redirects)
+      return unless Hyrax.config.redirects_active?
+      pairs = redirects_fragment_pairs(fragment)
+      self.redirects = pairs.sort_by { |k, _row| k.to_i }
+                            .map { |k, row| redirects_entry_from(k, row) }
+                            .compact
+    end
+
+    def redirects_fragment_pairs(fragment)
+      return {} if fragment.nil?
+      fragment.respond_to?(:to_unsafe_h) ? fragment.to_unsafe_h : fragment.to_h
+    end
+
+    def redirects_entry_from(key, row)
+      row = row.respond_to?(:to_unsafe_h) ? row.to_unsafe_h : row
+      return nil if row['_destroy'].to_s == 'true' || row['path'].to_s.strip.empty?
+      { 'path' => Hyrax::RedirectPathNormalizer.call(row['path']),
+        'is_display_url' => redirects_is_display_url_flag_for(key, row) }
+    end
+
+    def redirects_is_display_url_flag_for(key, row)
+      if redirects_display_url_index.nil?
+        row['is_display_url'].to_s == 'true'
+      else
+        key.to_s == redirects_display_url_index.to_s
+      end
+    end
+  end
+end

data/app/forms/concerns/hyrax/transcripts_behavior.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Hyrax
+  module TranscriptsBehavior
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def available_transcripts(parent:, current_ability:)
+         member_ids = Hyrax.custom_queries.find_child_file_set_ids(resource: parent)
+         Hyrax::SolrQueryService.new
+                                # Cast Valkyrie::IDs to strings
+                                .with_ids(ids: member_ids.map(&:to_s).to_a)
+                                .accessible_by(ability: current_ability, action: :edit)
+                                .solr_documents(
+                                  # Using "has_model_ssim:*FileSet" in fq will return both FileSet
+                                  # and Hyrax::FileSet documents. In test mode, Koppie and Sirenia 
+                                  # index file sets with has_model_ssim:Hyrax::FileSet. 
+                                  # But in dev mode, they index file sets with 
+                                  # has_model_ssim:FileSet instead. This query covers both cases.
+                                  fq: [mime_type_filter_query.to_s, "has_model_ssim:*FileSet"],
+                                  fl: "id,title_tesim",
+                                  rows: 1000
+                                )
+      end
+
+      private
+
+      def mime_type_filter_query
+        valid_mime_types.map { |type| "mime_type_ssi:\"#{type}\"" }.join(" OR ")
+      end
+
+      # According to IIIF, .srt and .ttml are also acceptable but may
+      # not be supported by viewers. Clover and Ramp are confirmed to work
+      # with .vtt. (https://iiif.io/api/cookbook/recipe/0219-using-caption-file/).
+      # When Hyrax supports Ramp, we may want to add "text/plain" (.srt) to this list.
+      def valid_mime_types
+        ["text/vtt"]
+      end
+    end
+  end
+end

data/app/forms/hyrax/forms/admin_set_form.rb

@@ -8,7 +8,7 @@ module Hyrax
       # Cast any array values on the model to scalars.
       def [](key)
         return super if key == :thumbnail_id
-        super.first
+        super&.first
       end
 
       def permission_template

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

@@ -6,6 +6,8 @@ module Hyrax
     # @api public
     # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
     class AdministrativeSetForm < Hyrax::Forms::ResourceForm
+      check_if_flexible(Hyrax::AdministrativeSet)
+
       ##
       # @api private
       AdminSetMembersPopulator = lambda do |**_options|
@@ -22,6 +24,7 @@ module Hyrax
 
       property :title, required: true, primary: true
       property :description, primary: true
+      property :contexts, primary: true if Hyrax.config.admin_set_flexible?
 
       property :creator
 

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

@@ -5,8 +5,7 @@ module Hyrax
       # Used for drawing the fields that appear on the page
       self.terms = [:creator, :contributor, :description,
                     :keyword, :resource_type, :license, :publisher, :date_created,
-                    :subject, :language, :identifier, :based_near,
-                    :related_url]
+                    :subject, :language, :identifier, :related_url]
       self.required_fields = []
       self.model_class = Hyrax.primary_work_type
 
@@ -39,7 +38,6 @@ module Hyrax
          { subject: [] },
          { language: [] },
          { identifier: [] },
-         { based_near: [] },
          { related_url: [] },
          { permissions_attributes: [:type, :name, :access, :id, :_destroy] },
          :on_behalf_of,

data/app/forms/hyrax/forms/batch_upload_form.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+
+# It isn't ideal but this form is used for both active fedora and valkyrie.
 module Hyrax
   module Forms
     class BatchUploadForm < Hyrax::Forms::WorkForm
@@ -22,6 +24,18 @@ module Hyrax
         super - [:title]
       end
 
+      def required_fields
+        return super unless Hyrax.config.use_valkyrie?
+        form_class.required_fields
+      end
+
+      def payload_class
+        @payload_class ||= Valkyrie.config.resource_class_resolver.call(payload_concern)
+      end
+
+      def form_class
+        @form_class ||= "#{payload_class}Form".safe_constantize
+      end
       # # On the batch upload, title is set per-file.
       # def secondary_terms
       #   super - [:title]

data/app/forms/hyrax/forms/file_set_edit_form.rb

@@ -12,7 +12,7 @@ module Hyrax::Forms
 
     self.terms = [:resource_type, :title, :creator, :contributor, :description,
                   :keyword, :license, :publisher, :date_created, :subject, :language,
-                  :identifier, :based_near, :related_url,
+                  :identifier, :based_near, :related_url, :transcript_ids,
                   :visibility_during_embargo, :visibility_after_embargo, :embargo_release_date,
                   :visibility_during_lease, :visibility_after_lease, :lease_expiration_date,
                   :visibility]

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

@@ -5,17 +5,16 @@ module Hyrax
     ##
     # A form for +Hyrax::FileSet+s.
     class FileSetForm < Hyrax::Forms::ResourceForm
-      include Hyrax::FormFields(:core_metadata)
-
-      # The fields in +:file_set_metadata+ were hardcoded into this form in a
-      # previous version of Hyrax, but ideally in the future this metadata will
-      # be configurable.
-      include Hyrax::FormFields(:file_set_metadata)
-
+      if Hyrax.config.file_set_include_metadata?
+        include Hyrax::FormFields(:core_metadata)
+        include Hyrax::FormFields(:file_set_metadata)
+      end
+      check_if_flexible(Hyrax::FileSet)
       include Hyrax::DepositAgreementBehavior
       include Hyrax::ContainedInWorksBehavior
       include Hyrax::LeaseabilityBehavior
       include Hyrax::PermissionBehavior
+      include Hyrax::TranscriptsBehavior
 
       property :representative_id, type: Valkyrie::Types::String, writeable: false
       property :thumbnail_id, type: Valkyrie::Types::String, writeable: false

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

@@ -6,7 +6,16 @@ module Hyrax
     # @api public
     # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
     class PcdmCollectionForm < Hyrax::Forms::ResourceForm # rubocop:disable Metrics/ClassLength
-      include Hyrax::FormFields(:core_metadata)
+      include Hyrax::FormFields(:core_metadata) if Hyrax.config.collection_include_metadata?
+      include RedirectsFieldBehavior
+      include Hyrax::FormFields(:redirects) if Hyrax.config.redirects_enabled? && Hyrax.config.collection_include_metadata?
+      if Hyrax.config.redirects_enabled?
+        validation(name: :default, inherit: true) do
+          validates_with Hyrax::RedirectValidator, attributes: [:redirects]
+        end
+      end
+
+      check_if_flexible(Hyrax::PcdmCollection)
 
       BannerInfoPrepopulator = lambda do |**_options|
         self.banner_info ||= begin
@@ -33,7 +42,7 @@ module Hyrax
         end
       end
 
-      property :depositor, required: true
+      property :depositor
       property :collection_type_gid, required: true
       property :visibility, default: VisibilityIntention::PRIVATE
 
@@ -62,9 +71,12 @@ module Hyrax
       # @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)
+        terms = _form_field_definitions
+                .select { |_, definition| definition[:primary] }
+                .keys.map(&:to_sym)
+
+        terms = [:schema_version] + terms if model.flexible?
+        terms
       end
 
       ##

data/app/forms/hyrax/forms/pcdm_object_form.rb

@@ -9,13 +9,21 @@ module Hyrax
     # Although File Sets are technically also PCDM objects, they use a separate
     # form class: +Hyrax::Forms::FileSetForm+.
     class PcdmObjectForm < Hyrax::Forms::ResourceForm
-      include Hyrax::FormFields(:core_metadata)
-
       include Hyrax::ContainedInWorksBehavior
       include Hyrax::DepositAgreementBehavior
       include Hyrax::LeaseabilityBehavior
       include Hyrax::PermissionBehavior
 
+      # redirects is wired here (and on PcdmCollectionForm), not on the shared
+      # ResourceForm; see ResourceForm for why FileSetForm must not inherit it.
+      include RedirectsFieldBehavior
+      include Hyrax::FormFields(:redirects) if Hyrax.config.redirects_enabled? && Hyrax.config.work_include_metadata?
+      if Hyrax.config.redirects_enabled?
+        validation(name: :default, inherit: true) do
+          validates_with Hyrax::RedirectValidator, attributes: [:redirects]
+        end
+      end
+
       property :on_behalf_of
       property :proxy_depositor
 
@@ -37,7 +45,7 @@ module Hyrax
       private
 
       def admin_set_prepopulator
-        self.admin_set_id ||= Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s
+        self.admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s if admin_set_id.to_s.blank?
       end
 
       def in_collections_populator(fragment:, **_options)

data/app/forms/hyrax/forms/resource_batch_edit_form.rb

@@ -2,19 +2,20 @@
 module Hyrax
   module Forms
     class ResourceBatchEditForm < Hyrax::Forms::ResourceForm
-      include Hyrax::FormFields(:basic_metadata)
+      # batch edit is unfortunately all or nothing when it comes to flexible metadata
+      # because the form could be a mix of AF records, Valkyrie records and Flexible Valkyrie records
+      # we have no real way of turning this on or off more precisely
+      include Hyrax::FormFields(:batch_edit_metadata) unless Hyrax.primary_work_type.flexible?
 
       include Hyrax::ContainedInWorksBehavior
       include Hyrax::DepositAgreementBehavior
       include Hyrax::LeaseabilityBehavior
       include Hyrax::PermissionBehavior
 
+      class_attribute :terms
       self.required_fields = []
-      self.model_class = Hyrax.primary_work_type
-
-      # Terms that need to exclude from batch edit
-      class_attribute :terms_excluded
-      self.terms_excluded = [:abstract, :label, :source]
+      self.model_class = Valkyrie.config.resource_class_resolver.call(Hyrax.primary_work_type.to_s)
+      self.terms = Hyrax::Forms::BatchEditForm.terms
 
       # Contains a list of titles of all the works in the batch
       attr_accessor :names
@@ -33,21 +34,6 @@ module Hyrax
         end
       end
 
-      def terms
-        self.class.terms
-      end
-
-      def self.terms
-        return Hyrax::Forms::BatchEditForm.terms if model_class < ActiveFedora::Base
-
-        terms_primary = definitions.select { |_, definition| definition[:primary] }
-                                   .keys.map(&:to_sym)
-        terms_secondary = definitions.select { |_, definition| definition[:display] && !definition[:primary] }
-                                     .keys.map(&:to_sym)
-
-        (terms_primary + terms_secondary) - terms_excluded
-      end
-
       attr_reader :batch_document_ids
 
       # Returns a list of parameters we accept from the form
@@ -101,7 +87,7 @@ module Hyrax
         # 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 = Hyrax.query_service.find_by(id: doc_id)
-          terms.each do |field|
+          self.class.terms.each do |field|
             combined_attributes[field] ||= []
             combined_attributes[field] = (combined_attributes[field] + Array.wrap(work[field])).uniq
           end