hyrax 4.0.0.beta1 → 4.0.0.rc1

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

@@ -11,12 +11,16 @@ module Hyrax
     #     # other WorkForm-like configuration here
     #   end
     #
+    # @note The returned class will extend +Hyrax::Forms::PcdmObjectForm+, not
+    #   only +Hyrax::Forms::ResourceForm+. This is for backwards‐compatibility
+    #   with existing Hyrax instances and satisfies the expected general use
+    #   case (building forms for various PCDM object classes), but is *not*
+    #   necessarily suitable for other kinds of Hyrax resource, like
+    #   +Hyrax::FileSet+s.
     def self.ResourceForm(work_class)
-      Class.new(Hyrax::Forms::ResourceForm) do
+      Class.new(Hyrax::Forms::PcdmObjectForm) do
         self.model_class = work_class
 
-        include Hyrax::FormFields(:core_metadata)
-
         ##
         # @return [String]
         def self.inspect
@@ -29,7 +33,7 @@ module Hyrax
     ##
     # @api public
     #
-    # This form wraps `Hyrax::ChangeSet` in the `HydraEditor::Form` interface.
+    # This form wraps +Hyrax::ChangeSet+ in the +HydraEditor::Form+ interface.
     class ResourceForm < Hyrax::ChangeSet # rubocop:disable Metrics/ClassLength
       ##
       # @api private
@@ -69,10 +73,8 @@ module Hyrax
       property :human_readable_type, writable: false
 
       property :depositor
-      property :on_behalf_of
-      property :proxy_depositor
 
-      property :visibility, default: VisibilityIntention::PRIVATE
+      property :visibility, default: VisibilityIntention::PRIVATE, populator: :visibility_populator
 
       property :date_modified, readable: false
       property :date_uploaded, readable: false
@@ -85,6 +87,9 @@ module Hyrax
                  populator: :permission_populator,
                  prepopulator: ->(_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: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
       property :visibility_after_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
@@ -94,17 +99,7 @@ module Hyrax
       property :visibility_after_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_after_lease = model.lease&.visibility_after_lease }
       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 = 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, populator: :in_collections_populator
-      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
@@ -116,10 +111,6 @@ module Hyrax
       # @see https://github.com/samvera/valkyrie/wiki/Optimistic-Locking
       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
-      property :find_child_work, default: nil, virtual: true
-
       class << self
         ##
         # @api public
@@ -140,6 +131,7 @@ module Hyrax
           when Hyrax::PcdmCollection
             Hyrax::Forms::PcdmCollectionForm.new(resource)
           else
+            # NOTE: This will create a +Hyrax::Forms::PcdmObjectForm+.
             Hyrax::Forms::ResourceForm(resource.class).new(resource)
           end
         end
@@ -208,18 +200,12 @@ module Hyrax
 
       private
 
-      def in_collections_populator(fragment:, **_options)
-        adds = []
-        deletes = []
-        fragment.each do |_, h|
-          if h["_destroy"] == "true"
-            deletes << Valkyrie::ID.new(h["id"])
-          else
-            adds << Valkyrie::ID.new(h["id"])
-          end
-        end
+      def embargo_populator(**)
+        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
+      end
 
-        self.member_of_collection_ids = ((member_of_collection_ids + adds) - deletes).uniq
+      def lease_populator(**)
+        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
       end
 
       # https://trailblazer.to/2.1/docs/reform.html#reform-populators-populator-collections
@@ -227,6 +213,24 @@ module Hyrax
         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/work_embargo_form.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # Represents an embargo for edit through a work. That is, this form can
+    # be used to wrap a Work in order to capture state changes related only to
+    # its embargo, ignoring the work's other fields.
+    #
+    # @note this supports the edit functionality of
+    #   +EmbargoesControllerBehavior+.
+    class WorkEmbargoForm < Hyrax::ChangeSet
+      property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator, prepopulator: :embargo_populator
+      property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
+      property :visibility_after_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
+      property :visibility_during_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_during_embargo = model.embargo&.visibility_during_embargo }
+
+      def embargo_populator(**)
+        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
+      end
+
+      ##
+      # @return [String]
+      def human_readable_type
+        model.to_model.human_readable_type
+      end
+
+      ##
+      # @return [ActiveModel::Name]
+      def model_name
+        model.to_model.model_name
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module Hyrax
 
       self.terms = [:title, :alternative_title, :creator, :contributor, :description, :abstract,
                     :keyword, :license, :rights_statement, :access_right, :rights_notes, :publisher, :date_created,
-                    :subject, :language, :identifier, :based_near, :related_url,
+                    :subject, :language, :identifier, :based_near, :related_url, :bibliographic_citation,
                     :representative_id, :thumbnail_id, :rendering_ids, :files,
                     :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,
                     :visibility_during_lease, :lease_expiration_date, :visibility_after_lease,
@@ -120,7 +120,7 @@ module Hyrax
         primary = (required_fields & terms)
 
         (required_fields - primary).each do |missing|
-          Rails.logger.warn("The form field #{missing} is configured as a " \
+          Hyrax.logger.warn("The form field #{missing} is configured as a " \
                             'required field, but not as a term. This can lead ' \
                             'to unexpected behavior. Did you forget to add it ' \
                             "to `#{self.class}#terms`?")

data/app/forms/hyrax/forms/work_lease_form.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # Represents a lease for edit through a work. That is, this form can
+    # be used to wrap a Work in order to capture state changes related only to
+    # its lease, ignoring the work's other fields.
+    #
+    # @note this supports the edit functionality of
+    #   +LeasesControllerBehavior+.
+    class WorkLeaseForm < Hyrax::ChangeSet
+      property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator, prepopulator: :lease_populator
+      property :lease_expiration_date, virtual: true, prepopulator: ->(_opts) { self.lease_expiration_date = model.lease&.lease_expiration_date }
+      property :visibility_after_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_after_lease = model.lease&.visibility_after_lease }
+      property :visibility_during_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_during_lease = model.lease&.visibility_during_lease }
+
+      def lease_populator(**)
+        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
+      end
+
+      ##
+      # @return [String]
+      def human_readable_type
+        model.to_model.human_readable_type
+      end
+
+      ##
+      # @return [ActiveModel::Name]
+      def model_name
+        model.to_model.model_name
+      end
+    end
+  end
+end

data/app/helpers/hyrax/collections_helper.rb

@@ -123,14 +123,7 @@ module Hyrax
     ##
     # @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
+      CollectionType.for(collection: collection).title
     end
 
     ##
@@ -138,14 +131,7 @@ module Hyrax
     #
     # @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
+      CollectionType.for(collection: collection).brandable?
     end
 
     ##
@@ -153,14 +139,7 @@ module Hyrax
     #
     # @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
+      CollectionType.for(collection: collection).discoverable?
     end
 
     ##
@@ -168,14 +147,7 @@ module Hyrax
     #
     # @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
+      CollectionType.for(collection: collection).sharable?
     end
 
     ##

data/app/helpers/hyrax/embargo_helper.rb

@@ -40,5 +40,16 @@ module Hyrax
         Hyrax::EmbargoManager.new(resource: resource).enforced?
       end
     end
+
+    ##
+    # @since 3.5.0
+    #
+    # @param [#embargo_history, #embargo] resource
+    #
+    # @return [Array]
+    def embargo_history(resource)
+      resource.try(:embargo_history) ||
+        Array(resource.embargo&.embargo_history)
+    end
   end
 end

data/app/helpers/hyrax/facets_helper.rb

@@ -6,145 +6,5 @@ module Hyrax
     # This module is used to ensure Hyrax facet views that rely on deprecated Blacklight helper methods are still functional
 
     include Blacklight::Facet
-
-    ##
-    # Renders the list of values
-    # removes any elements where render_facet_item returns a nil value. This enables an application
-    # to filter undesireable facet items so they don't appear in the UI
-    def render_facet_limit_list(paginator, facet_field, wrapping_element = :li)
-      safe_join(paginator.items.map { |item| render_facet_item(facet_field, item) }.compact.map { |item| content_tag(wrapping_element, item) })
-    end
-
-    ##
-    # Renders a single facet item
-    def render_facet_item(facet_field, item)
-      if facet_in_params?(facet_field, item.value)
-        render_selected_facet_value(facet_field, item)
-      else
-        render_facet_value(facet_field, item)
-      end
-    end
-
-    ##
-    # Standard display of a facet value in a list. Used in both _facets sidebar
-    # partial and catalog/facet expanded list. Will output facet value name as
-    # a link to add that to your restrictions, with count in parens.
-    #
-    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-    # @param [Blacklight::Solr::Response::Facets::FacetItem] item
-    # @param [Hash] options
-    # @option options [Boolean] :suppress_link display the facet, but don't link to it
-    # @return [String]
-    def render_facet_value(facet_field, item, options = {})
-      path = path_for_facet(facet_field, item)
-      content_tag(:span, class: "facet-label") do
-        link_to_unless(options[:suppress_link], facet_display_value(facet_field, item), path, class: "facet_select")
-      end + render_facet_count(item.hits)
-    end
-
-    ##
-    # Where should this facet link to?
-    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-    # @param [String] item
-    # @return [String]
-    def path_for_facet(facet_field, item)
-      facet_config = facet_configuration_for_field(facet_field)
-      if facet_config.url_method
-        send(facet_config.url_method, facet_field, item)
-      else
-        search_action_path(search_state.add_facet_params_and_redirect(facet_field, item))
-      end
-    end
-
-    ##
-    # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
-    # @see #render_facet_value
-    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-    # @param [String] item
-    def render_selected_facet_value(facet_field, item)
-      remove_href = search_action_path(search_state.remove_facet_params(facet_field, item))
-      content_tag(:span, class: "facet-label") do
-        content_tag(:span, facet_display_value(facet_field, item), class: "selected") +
-          # remove link
-          link_to(remove_href, class: "remove") do
-            content_tag(:i, '', class: "fa fa-times") +
-              content_tag(:span, '[remove]', class: 'sr-only')
-          end
-      end + render_facet_count(item.hits, classes: ["selected"])
-    end
-
-    ##
-    # Renders a count value for facet limits. Can be over-ridden locally
-    # to change style. And can be called by plugins to get consistent display.
-    #
-    # @param [Integer] num number of facet results
-    # @param [Hash] options
-    # @option options [Array<String>]  an array of classes to add to count span.
-    # @return [String]
-    def render_facet_count(num, options = {})
-      classes = (options[:classes] || []) << "facet-count"
-      content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(num)), class: classes)
-    end
-
-    ##
-    # Check if the query parameters have the given facet field with the
-    # given value.
-    #
-    # @param [Object] field
-    # @param [Object] item facet value
-    # @return [Boolean]
-    def facet_in_params?(field, item)
-      value = facet_value_for_facet_item(item)
-
-      (facet_params(field) || []).include? value
-    end
-
-    ##
-    # Get the values of the facet set in the blacklight query string
-    def facet_params(field)
-      config = facet_configuration_for_field(field)
-
-      params[:f][config.key] if params[:f]
-    end
-
-    ##
-    # Get the displayable version of a facet's value
-    #
-    # @param [Object] field
-    # @param [String] item value
-    # @return [String]
-    # rubocop:disable Metrics/MethodLength
-    def facet_display_value(field, item)
-      facet_config = facet_configuration_for_field(field)
-
-      value = if item.respond_to? :label
-                item.label
-              else
-                facet_value_for_facet_item(item)
-              end
-
-      if facet_config.helper_method
-        send facet_config.helper_method, value
-      elsif facet_config.query && facet_config.query[value]
-        facet_config.query[value][:label]
-      elsif facet_config.date
-        localization_options = facet_config.date == true ? {} : facet_config.date
-
-        l(value.to_datetime, localization_options)
-      else
-        value
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    private
-
-    def facet_value_for_facet_item(item)
-      if item.respond_to? :value
-        item.value
-      else
-        item
-      end
-    end
   end
 end

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -289,7 +289,7 @@ module Hyrax
     end
 
     def collection_title_by_id(id)
-      solr_docs = controller.repository.find(id).docs
+      solr_docs = controller.blacklight_config.repository.find(id).docs
       return nil if solr_docs.empty?
       solr_field = solr_docs.first["title_tesim"]
       return nil if solr_field.nil?
@@ -305,6 +305,21 @@ module Hyrax
         ""
     end
 
+    ##
+    # @param value [Object] the thing we'll attempt to cast to a formatted date.
+    # @param format [String] the `DateTime.strftime` format string
+    # @return [String]
+    #
+    # @see https://github.com/samvera/hyrax/issues/5818
+    # @see https://ruby-doc.org/core-3.0.1/Time.html#method-i-strftime
+    def cast_to_date_time_format(value, format:)
+      return value.strftime(format).to_s if value.respond_to?(:strftime)
+
+      (Time.zone.parse(value)&.strftime(format) || value).to_s
+    rescue ArgumentError, TypeError
+      value.to_s
+    end
+
     private
 
     def user_agent

data/app/helpers/hyrax/lease_helper.rb

@@ -40,5 +40,16 @@ module Hyrax
         Hyrax::LeaseManager.new(resource: resource).enforced?
       end
     end
+
+    ##
+    # @since 3.5.0
+    #
+    # @param [#lease_history, #lease] resource
+    #
+    # @return [Array]
+    def lease_history(resource)
+      resource.try(:lease_history) ||
+        Array(resource.lease&.lease_history)
+    end
   end
 end

data/app/helpers/hyrax/work_form_helper.rb

@@ -97,5 +97,112 @@ module Hyrax
         hash[presenter.title_or_label] = presenter.id
       end
     end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def in_works_ids_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:in_works_ids]
+      else
+        form.model.errors[:in_works_ids]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def ordered_member_ids_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:ordered_member_ids]
+      else
+        form.model.errors[:ordered_member_ids]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def visibility_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:visibility]
+      else
+        form.model.errors[:visibility]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def embargo_release_date_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:embargo_release_date]
+      else
+        form.model.errors[:embargo_release_date]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def visibility_after_embargo_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:visibility_after_embargo]
+      else
+        form.model.errors[:visibility_after_embargo]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def lease_expiration_date_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:lease_expiration_date_errors]
+      else
+        form.model.errors[:lease_expiration_date_errors]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def visibility_after_lease_errors_for(form:)
+      case form
+      when Hyrax::ChangeSet
+        form.errors[:visibility_after_lease]
+      else
+        form.model.errors[:visibility_after_lease]
+      end
+    end
+
+    ##
+    # This helper retrieves errors based on form type.
+    #
+    # @param form [Hyrax::Forms::WorkForm] or Hyrax::ChangeSet
+    # @return [String] specific error message
+    def full_collections_errors(form:)
+      form.full_error(:collections) || form.full_error(:member_of_collection_ids)
+    end
   end
 end

data/app/indexers/hyrax/deep_indexing_service.rb

@@ -48,12 +48,12 @@ module Hyrax
     end
 
     def fetch_value(value)
-      Rails.logger.info "Fetching #{value.rdf_subject} from the authorative source. (this is slow)"
+      Hyrax.logger.info "Fetching #{value.rdf_subject} from the authorative source. (this is slow)"
       value.fetch(headers: { 'Accept' => default_accept_header })
     rescue IOError, SocketError => e
       # IOError could result from a 500 error on the remote server
       # SocketError results if there is no server to connect to
-      Rails.logger.error "Unable to fetch #{value.rdf_subject} from the authorative source.\n#{e.message}"
+      Hyrax.logger.error "Unable to fetch #{value.rdf_subject} from the authorative source.\n#{e.message}"
     end
 
     # Stripping off the */* to work around https://github.com/rails/rails/issues/9940

data/app/indexers/hyrax/pcdm_collection_indexer.rb

@@ -16,6 +16,7 @@ module Hyrax
       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[:member_of_collection_ids_ssim] = resource.member_of_collection_ids.map(&:to_s)
         index_document[:depositor_ssim] = [resource.depositor]
         index_document[:depositor_tesim] = [resource.depositor]
       end

data/app/indexers/hyrax/valkyrie_file_set_indexer.rb

@@ -9,7 +9,7 @@ module Hyrax
     include Hyrax::VisibilityIndexer
     include Hyrax::ThumbnailIndexer
     include Hyrax::Indexer(:core_metadata)
-    include Hyrax::Indexer(:basic_metadata)
+    include Hyrax::Indexer(:file_set_metadata)
 
     def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       super.tap do |solr_doc| # rubocop:disable Metrics/BlockLength
@@ -23,7 +23,7 @@ module Hyrax
         solr_doc['hasRelatedImage_ssim']         = resource.thumbnail_id.to_s
 
         # Add in metadata from the original file.
-        file_metadata = original_file
+        file_metadata = Hyrax::FileSetFileService.new(file_set: resource).original_file
         return solr_doc unless file_metadata
 
         # Label is the actual file name. It's not editable by the user.
@@ -99,12 +99,6 @@ module Hyrax
 
     private
 
-    def original_file
-      Hyrax.custom_queries.find_original_file(file_set: resource)
-    rescue Valkyrie::Persistence::ObjectNotFoundError
-      Hyrax.custom_queries.find_files(file_set: resource).first
-    end
-
     def file_format(file)
       if file.mime_type.present? && file.format_label.present?
         "#{file.mime_type.split('/').last} (#{file.format_label.join(', ')})"