hyrax 5.0.0.rc2 → 5.0.0.rc3

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

@@ -33,6 +33,7 @@ module Hyrax
           loc
         end
       end
+      based_near << Hyrax::ControlledVocabularies::Location.new if based_near.empty?
     end
   end
 end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # A module of form behaviours for resources which can be contained in works.
+  module ContainedInWorksBehavior
+    ##
+    # @api private
+    InWorksPrepopulator = proc do |_options|
+      self.in_works_ids =
+        if persisted?
+          Hyrax.query_service
+               .find_inverse_references_by(resource: model, property: :member_ids)
+               .select(&:work?)
+               .map(&:id)
+        else
+          []
+        end
+    end
+
+    def self.included(descendant)
+      descendant.property :in_works_ids, virtual: true, prepopulator: InWorksPrepopulator
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # A module of form behaviours for depositors and depositor agreements.
+  module DepositAgreementBehavior
+    def self.included(descendant)
+      descendant.property :depositor
+
+      descendant.property :agreement_accepted, virtual: true, default: false, prepopulator: proc { |_opts| self.agreement_accepted = !model.new_record }
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # A module of form behaviours for embargoes, leases, and resulting
+  # visibilities.
+  module LeaseabilityBehavior
+    def self.included(descendant) # rubocop:disable Metrics/AbcSize
+      descendant.property :visibility, default: VisibilityIntention::PRIVATE, populator: :visibility_populator
+
+      descendant.property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator
+      descendant.property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator
+
+      # virtual properties for embargo/lease;
+      descendant.property :embargo_release_date, virtual: true, prepopulator: proc { |_opts| self.embargo_release_date = model.embargo&.embargo_release_date }
+      descendant.property :visibility_after_embargo, virtual: true, prepopulator: proc { |_opts| self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
+      descendant.property :visibility_during_embargo, virtual: true, prepopulator: proc { |_opts| self.visibility_during_embargo = model.embargo&.visibility_during_embargo }
+
+      descendant.property :lease_expiration_date, virtual: true,  prepopulator: proc { |_opts| self.lease_expiration_date = model.lease&.lease_expiration_date }
+      descendant.property :visibility_after_lease, virtual: true, prepopulator: proc { |_opts| self.visibility_after_lease = model.lease&.visibility_after_lease }
+      descendant.property :visibility_during_lease, virtual: true, prepopulator: proc { |_opts| self.visibility_during_lease = model.lease&.visibility_during_lease }
+    end
+
+    def embargo_populator(**)
+      self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
+    end
+
+    def lease_populator(**)
+      self.lease = Hyrax::LeaseManager.lease_for(resource: model)
+    end
+
+    def visibility_populator(fragment:, doc:, **)
+      case fragment
+      when "embargo"
+        self.visibility = doc['visibility_during_embargo']
+
+        doc['embargo'] = doc.slice('visibility_after_embargo',
+                                   'visibility_during_embargo',
+                                   'embargo_release_date')
+      when "lease"
+        self.visibility = doc['visibility_during_lease']
+        doc['lease'] = doc.slice('visibility_after_lease',
+                                   'visibility_during_lease',
+                                   'lease_expiration_date')
+      else
+        self.visibility = fragment
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # A module of form behaviours for populating permissions.
+  module PermissionBehavior
+    def self.included(descendant)
+      descendant.collection(:permissions,
+                 virtual: true,
+                 default: [],
+                 form: Hyrax::Forms::Permission,
+                 populator: :permission_populator,
+                 prepopulator: proc { |_opts| self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
+    end
+
+    # https://trailblazer.to/2.1/docs/reform.html#reform-populators-populator-collections
+    def permission_populator(collection:, index:, **)
+      Hyrax::Forms::Permission.new(collection[index])
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Hyrax
     ##
     # @api public
     # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
-    class AdministrativeSetForm < Valkyrie::ChangeSet
+    class AdministrativeSetForm < Hyrax::Forms::ResourceForm
       ##
       # @api private
       AdminSetMembersPopulator = lambda do |**_options|
@@ -23,10 +23,6 @@ module Hyrax
       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

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

@@ -35,6 +35,12 @@ module Hyrax
         end
       end
 
+      # This describes the parameters we are expecting to receive from the client
+      # @return [Array] a list of parameters used by sanitize_params
+      def self.build_permitted_params
+        super + [{ based_near_attributes: [:id, :_destroy] }]
+      end
+
       # @param model [::Collection] the collection model that backs this form
       # @param current_ability [Ability] the capabilities of the current user
       # @param repository [Blacklight::Solr::Repository] the solr repository
@@ -123,6 +129,19 @@ module Hyrax
         collection_member_service.available_member_subcollections.documents
       end
 
+      protected
+
+      def initialize_field(key)
+        # rubocop:disable Lint/AssignmentInCondition
+        if class_name = model_class.properties[key.to_s].try(:class_name)
+          # Initialize linked properties such as based_near
+          self[key] += [class_name.new]
+        else
+          super
+        end
+        # rubocop:enable Lint/AssignmentInCondition
+      end
+
       private
 
       def all_files_with_access

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

@@ -12,6 +12,11 @@ module Hyrax
       # be configurable.
       include Hyrax::FormFields(:file_set_metadata)
 
+      include Hyrax::DepositAgreementBehavior
+      include Hyrax::ContainedInWorksBehavior
+      include Hyrax::LeaseabilityBehavior
+      include Hyrax::PermissionBehavior
+
       property :representative_id, type: Valkyrie::Types::String, writeable: false
       property :thumbnail_id, type: Valkyrie::Types::String, writeable: false
     end

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

@@ -5,7 +5,7 @@ module Hyrax
     ##
     # @api public
     # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
-    class PcdmCollectionForm < Valkyrie::ChangeSet # rubocop:disable Metrics/ClassLength
+    class PcdmCollectionForm < Hyrax::Forms::ResourceForm # rubocop:disable Metrics/ClassLength
       include Hyrax::FormFields(:core_metadata)
 
       BannerInfoPrepopulator = lambda do |**_options|
@@ -33,10 +33,6 @@ module Hyrax
         end
       end
 
-      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

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

@@ -2,38 +2,25 @@
 
 module Hyrax
   module Forms
-    ##
-    # @api public
-    #
-    # @example defining a form class using HydraEditor-like configuration
-    #   class MonographForm < Hyrax::Forms::PcdmObjectForm(Monograph)
-    #     self.required_fields = [:title, :creator, :rights_statement]
-    #     # other WorkForm-like configuration here
-    #   end
-    def self.PcdmObjectForm(work_class)
-      Class.new(Hyrax::Forms::PcdmObjectForm) do
-        self.model_class = work_class
-
-        ##
-        # @return [String]
-        def self.inspect
-          return "Hyrax::Forms::PcdmObjectForm(#{model_class})" if name.blank?
-          super
-        end
-      end
-    end
-
     ##
     # A form for PCDM objects: resources which have collection relationships and
     # generally resemble +Hyrax::Work+.
+    #
+    # 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
+
       property :on_behalf_of
       property :proxy_depositor
 
       # pcdm relationships
-      property :admin_set_id, prepopulator: proc { |_opts| self.admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
+      property :admin_set_id, prepopulator: :admin_set_prepopulator
       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, populator: :in_collections_populator
@@ -49,6 +36,10 @@ module Hyrax
 
       private
 
+      def admin_set_prepopulator
+        self.admin_set_id ||= Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s
+      end
+
       def in_collections_populator(fragment:, **_options)
         adds = []
         deletes = []

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

@@ -4,6 +4,11 @@ module Hyrax
     class ResourceBatchEditForm < Hyrax::Forms::ResourceForm
       include Hyrax::FormFields(:basic_metadata)
 
+      include Hyrax::ContainedInWorksBehavior
+      include Hyrax::DepositAgreementBehavior
+      include Hyrax::LeaseabilityBehavior
+      include Hyrax::PermissionBehavior
+
       self.required_fields = []
       self.model_class = Hyrax.primary_work_type
 
@@ -22,9 +27,9 @@ module Hyrax
         @batch_document_ids = batch_document_ids
         if @batch_document_ids.present?
           combined_fields = model_attributes(model, initialize_combined_fields)
-          super(model.class.new(combined_fields))
+          super(resource: model.class.new(combined_fields))
         else
-          super(model)
+          super(resource: model)
         end
       end
 

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

@@ -2,50 +2,11 @@
 
 module Hyrax
   module Forms
-    ##
-    # @api public
-    #
-    # Returns the form class associated with a given model.
-    #
-    # @note The default case assumes that the provided model class is for a
-    #   PCDM object and returns a +Hyrax::Forms::PcdmObjectForm+. This is for
-    #   backwards‐compatibility with existing Hyrax instances. However, a
-    #   different +Hyrax::Forms::ResourceForm+ subclass will be returned in
-    #   some known cases where that is preferable.
-    def self.ResourceForm(model_class)
-      @resource_forms ||= {}.compare_by_identity
-      @resource_forms[model_class] ||=
-        if model_class <= Hyrax::AdministrativeSet
-          Hyrax::Forms::AdministrativeSetForm
-        elsif model_class <= Hyrax::FileSet
-          Hyrax::Forms::FileSetForm
-        elsif model_class <= Hyrax::PcdmCollection
-          Hyrax::Forms::PcdmCollectionForm
-        else
-          "Hyrax::Forms::PcdmObjectForm".constantize # autoload
-          Hyrax::Forms::PcdmObjectForm(model_class)
-        end
-    end
-
     ##
     # @api public
     #
     # This form wraps +Hyrax::ChangeSet+ in the +HydraEditor::Form+ interface.
     class ResourceForm < Hyrax::ChangeSet # rubocop:disable Metrics/ClassLength
-      ##
-      # @api private
-      InWorksPrepopulator = proc do |_options|
-        self.in_works_ids =
-          if persisted?
-            Hyrax.query_service
-                 .find_inverse_references_by(resource: model, property: :member_ids)
-                 .select(&:work?)
-                 .map(&:id)
-          else
-            []
-          end
-      end
-
       ##
       # @api private
       #
@@ -68,35 +29,8 @@ module Hyrax
       class_attribute :model_class
 
       property :human_readable_type, writable: false
-
-      property :depositor
-
-      property :visibility, default: VisibilityIntention::PRIVATE, populator: :visibility_populator
-
       property :date_modified, readable: false
       property :date_uploaded, readable: false
-      property :agreement_accepted, virtual: true, default: false, prepopulator: proc { |_opts| self.agreement_accepted = !model.new_record }
-
-      collection(:permissions,
-                 virtual: true,
-                 default: [],
-                 form: Hyrax::Forms::Permission,
-                 populator: :permission_populator,
-                 prepopulator: proc { |_opts| self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
-
-      property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator
-      property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator
-
-      # virtual properties for embargo/lease;
-      property :embargo_release_date, virtual: true, prepopulator: proc { |_opts| self.embargo_release_date = model.embargo&.embargo_release_date }
-      property :visibility_after_embargo, virtual: true, prepopulator: proc { |_opts| self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
-      property :visibility_during_embargo, virtual: true, prepopulator: proc { |_opts| self.visibility_during_embargo = model.embargo&.visibility_during_embargo }
-
-      property :lease_expiration_date, virtual: true,  prepopulator: proc { |_opts| self.lease_expiration_date = model.lease&.lease_expiration_date }
-      property :visibility_after_lease, virtual: true, prepopulator: proc { |_opts| self.visibility_after_lease = model.lease&.visibility_after_lease }
-      property :visibility_during_lease, virtual: true, prepopulator: proc { |_opts| self.visibility_during_lease = model.lease&.visibility_during_lease }
-
-      property :in_works_ids, virtual: true, prepopulator: InWorksPrepopulator
 
       # provide a lock token for optimistic locking; we name this `version` for
       # backwards compatibility
@@ -108,6 +42,24 @@ module Hyrax
       # @see https://github.com/samvera/valkyrie/wiki/Optimistic-Locking
       property :version, virtual: true, prepopulator: LockKeyPrepopulator
 
+      ##
+      # @api public
+      #
+      # Forms should be initialized with an explicit +resource:+ parameter to
+      # match indexers.
+      def initialize(deprecated_resource = nil, resource: nil)
+        if resource.nil?
+          if !deprecated_resource.nil?
+            Deprecation.warn "Initializing Valkyrie forms without an explicit resource parameter is deprecated. Pass the resource with `resource:` instead."
+            super(deprecated_resource)
+          else
+            super()
+          end
+        else
+          super(resource)
+        end
+      end
+
       class << self
         ##
         # @api public
@@ -116,11 +68,20 @@ module Hyrax
         #
         # @example
         #   monograph  = Monograph.new
-        #   change_set = Hyrax::Forms::ResourceForm.for(monograph)
-        def for(resource)
+        #   change_set = Hyrax::Forms::ResourceForm.for(resource: monograph)
+        def for(deprecated_resource = nil, resource: nil)
+          if resource.nil? && !deprecated_resource.nil?
+            Deprecation.warn "Initializing Valkyrie forms without an explicit resource parameter is deprecated. Pass the resource with `resource:` instead."
+            return self.for(resource: deprecated_resource)
+          end
           klass = "#{resource.class.name}Form".safe_constantize
           klass ||= Hyrax::Forms::ResourceForm(resource.class)
-          klass.new(resource)
+          begin
+            klass.new(resource: resource)
+          rescue ArgumentError
+            Deprecation.warn "Initializing Valkyrie forms without an explicit resource parameter is deprecated. #{klass} should be updated accordingly."
+            klass.new(resource)
+          end
         end
 
         ##
@@ -187,37 +148,6 @@ module Hyrax
 
       private
 
-      def embargo_populator(**)
-        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
-      end
-
-      def lease_populator(**)
-        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
-      end
-
-      # 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 visibility_populator(fragment:, doc:, **)
-        case fragment
-        when "embargo"
-          self.visibility = doc['visibility_during_embargo']
-
-          doc['embargo'] = doc.slice('visibility_after_embargo',
-                                     'visibility_during_embargo',
-                                     'embargo_release_date')
-        when "lease"
-          self.visibility = doc['visibility_during_lease']
-          doc['lease'] = doc.slice('visibility_after_lease',
-                                     'visibility_during_lease',
-                                     'lease_expiration_date')
-        else
-          self.visibility = fragment
-        end
-      end
-
       def _form_field_definitions
         self.class.definitions
       end

data/app/forms/hyrax/forms.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # @api public
+    #
+    # @example defining a form class using HydraEditor-like configuration
+    #   class MonographForm < Hyrax::Forms::PcdmObjectForm(Monograph)
+    #     self.required_fields = [:title, :creator, :rights_statement]
+    #     # other WorkForm-like configuration here
+    #   end
+    def self.PcdmObjectForm(work_class) # rubocop:disable Naming/MethodName
+      Class.new(Hyrax::Forms::PcdmObjectForm) do
+        self.model_class = work_class
+
+        ##
+        # @return [String]
+        def self.inspect
+          return "Hyrax::Forms::PcdmObjectForm(#{model_class})" if name.blank?
+          super
+        end
+      end
+    end
+
+    ##
+    # @api public
+    #
+    # Returns the form class associated with a given model.
+    def self.ResourceForm(model_class) # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Naming/MethodName
+      @resource_forms ||= {}.compare_by_identity
+      @resource_forms[model_class] ||=
+        # +#respond_to?+ needs to be used here, not +#try+, because Dry::Types
+        # overrides the latter??
+        if model_class.respond_to?(:pcdm_collection?) && model_class.pcdm_collection?
+          if model_class <= Hyrax::AdministrativeSet
+            Hyrax.config.administrative_set_form
+          else
+            Hyrax.config.pcdm_collection_form
+          end
+        elsif model_class.respond_to?(:pcdm_object?) && model_class.pcdm_object?
+          if model_class.respond_to?(:file_set?) && model_class.file_set?
+            Hyrax.config.file_set_form
+          else
+            Hyrax.config.pcdm_object_form_builder.call(model_class)
+          end
+        else
+          Hyrax::Forms::ResourceForm
+        end
+    end
+  end
+end

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -294,6 +294,8 @@ module Hyrax
       solr_field = solr_docs.first["title_tesim"]
       return nil if solr_field.nil?
       solr_field.first
+    rescue Blacklight::Exceptions::RecordNotFound
+      nil
     end
 
     ##

data/app/indexers/{hyrax → concerns/hyrax}/location_indexer.rb

@@ -14,11 +14,7 @@ module Hyrax
 
     def based_near_label_lookup(locations)
       locations.map do |loc|
-        if URI.parse(loc)
-          location_service.full_label(loc)
-        else
-          loc
-        end
+        location_service.full_label(loc)
       end
     end
 

data/app/indexers/{hyrax → concerns/hyrax}/permission_indexer.rb

@@ -6,14 +6,14 @@ module Hyrax
   # permissions being up-to-date in the index to support `Hyrax::Ability`.
   #
   # @example
-  #   class MyIndexer < Hyrax::ValkyrieIndexer
+  #   class MyIndexer < Hyrax::Indexers::ResourceIndexer
   #     include Hyrax::PermissionIndexer
   #   end
   module PermissionIndexer
     def to_solr
       super.tap do |index_document|
         config      = Hydra.config.permissions
-        permissions = Hyrax::PermissionManager.new(resource: resource)
+        permissions = resource.permission_manager || Hyrax::PermissionManager.new(resource: resource)
 
         index_document[config.edit.group] = permissions.edit_groups.to_a
         index_document[config.edit.individual] = permissions.edit_users.to_a

data/app/indexers/{hyrax → concerns/hyrax}/visibility_indexer.rb

@@ -7,7 +7,7 @@ module Hyrax
   # views.
   #
   # @example
-  #   class MyIndexer < Hyrax::ValkyrieIndexer
+  #   class MyIndexer < Hyrax::Indexers::ResourceIndexer
   #     include Hyrax::VisibilityIndexer
   #   end
   module VisibilityIndexer

data/app/indexers/hyrax/administrative_set_indexer.rb

@@ -2,23 +2,11 @@
 
 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[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
+  # @deprecated use +Hyrax::Indexers::AdministrativeSetIndexer+ instead
+  class AdministrativeSetIndexer < Hyrax::Indexers::AdministrativeSetIndexer
+    def initialize(*args, **kwargs)
+      Deprecation.warn "`Hyrax::AdministrativeSetIndexer` is deprecated. Use `Hyrax::Indexers::AdministrativeSetIndexer` instead."
+      super
     end
   end
 end

data/app/indexers/hyrax/indexers/administrative_set_indexer.rb

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