hyrax 3.4.2 → 3.6.0

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

@@ -3,44 +3,17 @@
 module Hyrax
   module Forms
     ##
-    # @api public
-    class FileSetForm < Hyrax::ChangeSet
+    # A form for +Hyrax::FileSet+s.
+    class FileSetForm < Hyrax::Forms::ResourceForm
       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
+      # 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)
 
-      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
+      property :representative_id, type: Valkyrie::Types::String
+      property :thumbnail_id, type: Valkyrie::Types::String
     end
   end
 end

data/app/forms/hyrax/forms/lease.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Hyrax
+  module Forms
+    ##
+    # Nested form for leases.
+    class Lease < Hyrax::ChangeSet
+      property :visibility_after_lease
+      property :visibility_during_lease
+      property :lease_expiration_date
+      property :lease_history, default: []
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # A form for PCDM objects: resources which have collection relationships and
+    # generally resemble +Hyrax::Work+.
+    class PcdmObjectForm < Hyrax::Forms::ResourceForm
+      include Hyrax::FormFields(:core_metadata)
+
+      property :on_behalf_of
+      property :proxy_depositor
+
+      # pcdm relationships
+      property :admin_set_id, prepopulator: ->(_opts) { self.admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
+      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
+
+      # 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
+
+      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
+
+        self.member_of_collection_ids = ((member_of_collection_ids + adds) - deletes).uniq
+      end
+    end
+  end
+end

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_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/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/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/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(', ')})"

data/app/jobs/content_event_job.rb

@@ -18,6 +18,6 @@ class ContentEventJob < EventJob
 
   # log the event to the users profile stream
   def log_user_event(depositor)
-    depositor.log_profile_event(event)
+    depositor&.log_profile_event(event)
   end
 end

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

@@ -10,7 +10,8 @@ module Hyrax
     include Hyrax::HumanReadableType
     include Hyrax::HasRepresentative
     include Hyrax::Permissions
-    include Hyrax::CollectionNesting
+    include(Hyrax::CollectionNesting) unless
+      Hyrax.config.use_solr_graph_for_collection_nesting
 
     included do
       validates_with HasOneTitleValidator

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

@@ -3,11 +3,20 @@ module Hyrax
   # Responsible for adding the necessary callbacks for updating the nested collection information
   # This is part of the after update index because it is a potentially very expensive process.
   #
-  # @todo Consider extracting the update_index callback to ActiveFedora::Base
+  # @deprecation deprecated for removal in 4.0.0; nested reindexing is replaced by solr
+  #   graph query. if you want to drop this behavior now, you can set
+  #   +HYRAX_USE_SOLR_GRAPH_NESTING+ to +true+ in the environment.
   module CollectionNesting
     extend ActiveSupport::Concern
 
     included do
+      Deprecation.warn "Hyrax::CollectionNesting is deprecated for removal in " \
+                       "4.0.0. Nested reindexing behavior can be replaced " \
+                       "by a Solr graph traversal query. Legacy nested " \
+                       "indexing behavior is retained by default, but can be " \
+                       "replaced with the 4.0.0 default by setting " \
+                       "HYRAX_USE_SOLR_GRAPH_NESTING to `true` in the environment."
+
       extend ActiveModel::Callbacks
       include ActiveModel::Validations::Callbacks
 

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

@@ -35,6 +35,7 @@ module Hyrax
 
     # Cast to a SolrDocument by querying from Solr
     def to_presenter
+      Deprecation.warn "Method #to_presenter will be removed in Hyrax 5.0. Use Hyrax::FileSetsController#presenter.solr_document or `@presenter.solr_document` from a view instead."
       CatalogController.new.fetch(id).last
     end
   end

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

@@ -21,7 +21,8 @@ module Hyrax
     include ProxyDeposit
     include Works::Metadata
     include WithEvents
-    include Hyrax::CollectionNesting
+    include(Hyrax::CollectionNesting) unless
+      Hyrax.config.use_solr_graph_for_collection_nesting
 
     included do
       property :owner, predicate: RDF::URI.new('http://opaquenamespace.org/ns/hydra/owner'), multiple: false

data/app/models/hyrax/embargo.rb

@@ -15,7 +15,7 @@ module Hyrax
     attribute :embargo_history,           Valkyrie::Types::Array
 
     def active?
-      (embargo_release_date.present? && Time.zone.today < embargo_release_date)
+      (embargo_release_date.present? && Hyrax::TimeService.time_in_utc < embargo_release_date)
     end
   end
 end

data/app/models/hyrax/file_set.rb

@@ -31,7 +31,7 @@ module Hyrax
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
-    include Hyrax::Schema(:basic_metadata)
+    include Hyrax::Schema(:file_set_metadata)
 
     def self.model_name(name_class: Hyrax::Name)
       @_model_name ||= name_class.new(self, nil, 'FileSet')
@@ -42,8 +42,8 @@ module Hyrax
 
     attribute :file_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID) # id for FileMetadata resources
     attribute :thumbnail_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
-    attribute :original_file_id, Valkyrie::Types::ID # id for FileMetadata resource
-    attribute :extracted_text_id, Valkyrie::Types::ID # id for FileMetadata resource
+    attribute :original_file_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
+    attribute :extracted_text_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
 
     ##
     # @return [Valkyrie::ID]

data/app/models/hyrax/lease.rb

@@ -15,7 +15,7 @@ module Hyrax
     attribute :lease_history,           Valkyrie::Types::Array
 
     def active?
-      (lease_expiration_date.present? && Time.zone.today < lease_expiration_date)
+      (lease_expiration_date.present? && Hyrax::TimeService.time_in_utc < lease_expiration_date)
     end
   end
 end

data/app/models/proxy_deposit_request.rb

@@ -7,7 +7,7 @@ class ProxyDepositRequest < ActiveRecord::Base
   include ActionView::Helpers::UrlHelper
 
   class_attribute :work_query_service_class
-  self.work_query_service_class = Hyrax::WorkQueryService
+  self.work_query_service_class = Hyrax.config.use_valkyrie? ? Hyrax::WorkResourceQueryService : Hyrax::WorkQueryService
 
   delegate :deleted_work?, :work, :to_s, to: :work_query_service
 

data/app/presenters/hyrax/permission_badge.rb

@@ -24,14 +24,15 @@ module Hyrax
     private
 
     def dom_label_class
-      VISIBILITY_LABEL_CLASS.fetch(@visibility.to_sym, 'label-info')
+      VISIBILITY_LABEL_CLASS.fetch(@visibility&.to_sym, 'label-info')
     end
 
     def text
       if registered?
         Institution.name
       else
-        I18n.t("hyrax.visibility.#{@visibility}.text")
+        visibility_key = @visibility || 'unknown'
+        I18n.t("hyrax.visibility.#{visibility_key}.text")
       end
     end
 

data/app/presenters/hyrax/version_list_presenter.rb

@@ -19,7 +19,12 @@ module Hyrax
     #
     # @raise [ArgumentError] if we can't build an enu
     def self.for(file_set:)
-      new(file_set.original_file&.versions&.all.to_a)
+      original_file = if file_set.respond_to?(:original_file)
+                        file_set.original_file
+                      else
+                        Hyrax::FileSetFileService.new(file_set: file_set).original_file
+                      end
+      new(Hyrax::VersioningService.new(resource: original_file).versions)
     rescue NoMethodError
       raise ArgumentError
     end

data/app/search_builders/hyrax/dashboard/nested_collections_search_builder.rb

@@ -26,11 +26,19 @@ module Hyrax
 
       def show_only_other_collections_of_the_same_collection_type(solr_parameters)
         solr_parameters[:fq] ||= []
-        solr_parameters[:fq] += [
-          "-" + Hyrax::SolrQueryBuilderService.construct_query_for_ids([limit_ids]),
-          Hyrax::SolrQueryBuilderService.construct_query(Hyrax.config.collection_type_index_field => @collection.collection_type_gid)
-        ]
-        solr_parameters[:fq] += limit_clause if limit_clause # add limits to prevent illegal nesting arrangements
+        if Hyrax.config.use_solr_graph_for_collection_nesting
+          solr_parameters[:fq] += [
+            Hyrax::SolrQueryBuilderService.construct_query(Hyrax.config.collection_type_index_field => @collection.collection_type_gid),
+            "-{!graph from=id to=member_of_collection_ids_ssim#{' maxDepth=1' if @nest_direction == :as_parent}}id:#{@collection.id}",
+            "-{!graph to=id from=member_of_collection_ids_ssim#{' maxDepth=1' if @nest_direction == :as_child}}id:#{@collection.id}"
+          ]
+        else
+          solr_parameters[:fq] += [
+            "-" + Hyrax::SolrQueryBuilderService.construct_query_for_ids([limit_ids]),
+            Hyrax::SolrQueryBuilderService.construct_query(Hyrax.config.collection_type_index_field => @collection.collection_type_gid)
+          ]
+          solr_parameters[:fq] += limit_clause if limit_clause # add limits to prevent illegal nesting arrangements
+        end
       end
 
       private