hyrax 4.0.0.rc3 → 5.0.0.rc1

data/app/indexers/hyrax/pcdm_collection_indexer.rb

@@ -19,6 +19,14 @@ module Hyrax
         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]
+        # add all attributes that should be indexed for collections here
+        tesim_and_ssim_attributes = ['abstract', 'access_right', 'alternative_title', 'based_near',
+                                     'bibliographic_citation', 'contributor', 'identifier', 'import_url', 'publisher', 'label',
+                                     'language', 'license', 'publisher', 'rights_notes', 'rights_statement', 'source', 'subject']
+        tesim_and_ssim_attributes.each do |attribute|
+          index_document["#{attribute}_ssim"] = resource[attribute.to_s]
+          index_document["#{attribute}_tesim"] = resource[attribute.to_s]
+        end
       end
     end
   end

data/app/indexers/hyrax/valkyrie_file_set_indexer.rb

@@ -3,7 +3,7 @@
 module Hyrax
   ##
   # Indexes Hyrax::FileSet objects
-  class ValkyrieFileSetIndexer < Hyrax::ValkyrieIndexer
+  class ValkyrieFileSetIndexer < Hyrax::ValkyrieIndexer # rubocop:disable Metrics/ClassLength
     include Hyrax::ResourceIndexer
     include Hyrax::PermissionIndexer
     include Hyrax::VisibilityIndexer
@@ -17,11 +17,14 @@ module Hyrax
 
         # Metadata from the FileSet
         solr_doc['file_ids_ssim']                = resource.file_ids&.map(&:to_s)
-        solr_doc['original_file_id_ssi']         = resource.original_file_id.to_s
+        solr_doc['original_file_id_ssi']         = original_file_id
         solr_doc['extracted_text_id_ssi']        = resource.extracted_text_id.to_s
         solr_doc['hasRelatedMediaFragment_ssim'] = resource.representative_id.to_s
         solr_doc['hasRelatedImage_ssim']         = resource.thumbnail_id.to_s
 
+        index_lease(solr_doc)
+        index_embargo(solr_doc)
+
         # Add in metadata from the original file.
         file_metadata = Hyrax::FileSetFileService.new(file_set: resource).original_file
         return solr_doc unless file_metadata
@@ -36,12 +39,13 @@ module Hyrax
 
         solr_doc['file_format_tesim']       = file_format(file_metadata)
         solr_doc['file_format_sim']         = file_format(file_metadata)
-        solr_doc['file_size_lts']           = file_metadata.size[0]
-        solr_doc['type_tesim']              = file_metadata.type.map(&:to_s) if file_metadata.type.present?
+        solr_doc['file_size_lts']           = file_metadata.recorded_size[0]
+        solr_doc['type_tesim']              = file_metadata.pcdm_use.map(&:to_s) if file_metadata.pcdm_use.present?
+        solr_doc['pcdm_use_tesim'] = file_metadata.pcdm_use.map(&:to_s) if file_metadata.pcdm_use.present?
 
         # attributes set by fits
         solr_doc['format_label_tesim']      = file_metadata.format_label if file_metadata.format_label.present?
-        solr_doc['size_tesim']              = file_metadata.size if file_metadata.size.present?
+        solr_doc['size_tesim']              = file_metadata.recorded_size if file_metadata.recorded_size.present?
         solr_doc['well_formed_tesim']       = file_metadata.well_formed if file_metadata.well_formed.present?
         solr_doc['valid_tesim']             = file_metadata.valid if file_metadata.valid.present?
         solr_doc['fits_version_tesim']      = file_metadata.fits_version if file_metadata.fits_version.present?
@@ -56,10 +60,13 @@ module Hyrax
 
         solr_doc['height_tesim']            = file_metadata.height if file_metadata.height.present? # image, video
         solr_doc['width_tesim']             = file_metadata.width if file_metadata.width.present? # image, video
+        solr_doc['height_is']               = Integer(file_metadata.height.first) if file_metadata.height.present?
+        solr_doc['width_is']                = Integer(file_metadata.width.first) if file_metadata.width.present?
 
         # attributes set by fits for audio files
         solr_doc['bit_depth_tesim']         = file_metadata.bit_depth if file_metadata.bit_depth.present?
         solr_doc['channels_tesim']          = file_metadata.channels if file_metadata.channels.present?
+        solr_doc['alpha_channels_ssi']      = file_metadata.channels.first if file_metadata.channels.present?
         solr_doc['data_format_tesim']       = file_metadata.data_format if file_metadata.data_format.present?
         solr_doc['offset_tesim']            = file_metadata.offset if file_metadata.offset.present?
 
@@ -99,6 +106,11 @@ module Hyrax
 
     private
 
+    # Convert Valkyrie Original File Pointer to versioned url syntax expected by the iiif_presenter
+    def original_file_id
+      "#{resource.id}/files/#{resource.original_file_id}"
+    end
+
     def file_format(file)
       if file.mime_type.present? && file.format_label.present?
         "#{file.mime_type.split('/').last} (#{file.format_label.join(', ')})"
@@ -108,5 +120,29 @@ module Hyrax
         file.format_label
       end
     end
+
+    def index_lease(doc)
+      if resource.lease&.active?
+        doc['lease_expiration_date_dtsi'] = resource.lease.lease_expiration_date&.to_datetime
+        doc['visibility_after_lease_ssim'] = resource.lease.visibility_after_lease
+        doc['visibility_during_lease_ssim'] = resource.lease.visibility_during_lease
+      else
+        doc['lease_history_ssim'] = resource&.lease&.lease_history
+      end
+
+      doc
+    end
+
+    def index_embargo(doc)
+      if resource.embargo&.active?
+        doc['embargo_release_date_dtsi'] = resource.embargo.embargo_release_date&.to_datetime
+        doc['visibility_after_embargo_ssim'] = resource.embargo.visibility_after_embargo
+        doc['visibility_during_embargo_ssim'] = resource.embargo.visibility_during_embargo
+      else
+        doc['embargo_history_ssim'] = resource&.embargo&.embargo_history
+      end
+
+      doc
+    end
   end
 end

data/app/indexers/hyrax/valkyrie_work_indexer.rb

@@ -25,6 +25,7 @@ module Hyrax
         solr_doc['depositor_tesim'] = [resource.depositor]
         solr_doc['hasRelatedMediaFragment_ssim'] = [resource.representative_id.to_s]
         solr_doc['hasRelatedImage_ssim'] = [resource.thumbnail_id.to_s]
+        solr_doc['hasFormat_ssim'] = resource.rendering_ids.map(&:to_s) if resource.rendering_ids.present?
         index_embargo(solr_doc)
         index_lease(solr_doc)
       end
@@ -43,19 +44,24 @@ module Hyrax
     end
 
     def index_embargo(doc)
-      if Hyrax::EmbargoManager.new(resource: resource).under_embargo?
+      if resource.embargo&.active?
         doc['embargo_release_date_dtsi'] = resource.embargo.embargo_release_date&.to_datetime
         doc['visibility_after_embargo_ssim'] = resource.embargo.visibility_after_embargo
         doc['visibility_during_embargo_ssim'] = resource.embargo.visibility_during_embargo
+      else
+        doc['embargo_history_ssim'] = resource&.embargo&.embargo_history
       end
+
       doc
     end
 
     def index_lease(doc)
-      if Hyrax::LeaseManager.new(resource: resource).under_lease?
+      if resource.lease&.active?
         doc['lease_expiration_date_dtsi'] = resource.lease.lease_expiration_date&.to_datetime
         doc['visibility_after_lease_ssim'] = resource.lease.visibility_after_lease
         doc['visibility_during_lease_ssim'] = resource.lease.visibility_during_lease
+      else
+        doc['lease_history_ssim'] = resource&.lease&.lease_history
       end
 
       doc

data/app/jobs/valkyrie_create_derivatives_job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 class ValkyrieCreateDerivativesJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
-  def perform(_file_set_id, file_id, _filepath = nil)
+  def perform(file_set_id, file_id, _filepath = nil)
     file_metadata = Hyrax.custom_queries.find_file_metadata_by(id: file_id)
     return if file_metadata.video? && !Hyrax.config.enable_ffmpeg
     # Get file into a local path.
@@ -9,15 +9,16 @@ class ValkyrieCreateDerivativesJob < Hyrax::ApplicationJob
     # Call derivatives with the file_set.
     derivative_service = Hyrax::DerivativeService.for(file_metadata)
     derivative_service.create_derivatives(file.disk_path)
+    reindex_parent(file_set_id)
   end
 
   private
 
-  def query_service
-    Hyrax.query_service
-  end
-
-  def storage_adapter
-    Hyrax.storage_adapter
+  def reindex_parent(file_set_id)
+    file_set = Hyrax.query_service.find_by(id: file_set_id)
+    parent = Hyrax.custom_queries.find_parent_work(resource: file_set)
+    return unless parent.thumbnail_id == file_set.id
+    Hyrax.logger.debug { "Reindexing #{parent.id} due to creation of thumbnail derivatives." }
+    Hyrax.index_adapter.save(resource: parent)
   end
 end

data/app/jobs/valkyrie_ingest_job.rb

@@ -25,7 +25,6 @@ class ValkyrieIngestJob < Hyrax::ApplicationJob
   def ingest(file:, pcdm_use:)
     file_set_uri = Valkyrie::ID.new(file.file_set_uri)
     file_set = Hyrax.query_service.find_by(id: file_set_uri)
-
     updated_metadata = upload_file(
       file: file,
       file_set: file_set,

data/app/models/admin_set.rb

@@ -42,25 +42,6 @@ class AdminSet < ActiveFedora::Base
   before_destroy :check_if_not_default_set, :check_if_empty
   after_destroy :destroy_permission_template
 
-  def self.default_set?(id)
-    Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                     "Instead, use 'Hyrax::AdminSetCreateService.default_admin_set?(id:)'.")
-    Hyrax::AdminSetCreateService.default_admin_set?(id: id)
-  end
-
-  def default_set?
-    Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                     "Instead, use 'Hyrax::AdminSetCreateService.default_admin_set?(id:)'.")
-    self.class.default_set?(id)
-  end
-
-  # Creates the default AdminSet and an associated PermissionTemplate with workflow
-  def self.find_or_create_default_admin_set_id
-    Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                     "Instead, use 'Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id'.")
-    Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s
-  end
-
   def collection_type_gid
     # allow AdminSet to behave more like a regular Collection
     Hyrax::CollectionType.find_or_create_admin_set_type.to_global_id
@@ -86,17 +67,6 @@ class AdminSet < ActiveFedora::Base
     Sipity::Workflow.find_active_workflow_for(admin_set_id: id)
   end
 
-  ##
-  # @deprecated use PermissionTemplate#reset_access_controls_for instead
-  #
-  # Calculate and update who should have edit access based on who
-  # has "manage" access in the PermissionTemplateAccess
-  def reset_access_controls!
-    Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls_for instead.")
-
-    permission_template.reset_access_controls_for(collection: self)
-  end
-
   # @api public
   #
   # return an id for the AdminSet.
@@ -120,7 +90,7 @@ class AdminSet < ActiveFedora::Base
   end
 
   def check_if_not_default_set
-    return true unless default_set?
+    return true unless Hyrax::AdminSetCreateService.default_admin_set?(id: id)
     errors[:base] << I18n.t('hyrax.admin.admin_sets.delete.error_default_set')
     throw :abort
   end

data/app/models/concerns/hyrax/file_set/derivatives.rb

@@ -43,8 +43,9 @@ module Hyrax
         #          # ./spec/jobs/create_derivatives_job_spec.rb:7:in `block (2 levels) in <top (required)>'
         #
         Hydra::Derivatives.source_file_service = Hyrax::LocalFileService
-        Hydra::Derivatives.output_file_service = Hyrax::PersistDerivatives
-        Hydra::Derivatives::FullTextExtract.output_file_service = Hyrax::PersistDirectlyContainedOutputFileService
+        Hydra::Derivatives.output_file_service = Hyrax::ValkyriePersistDerivatives
+        # Hydra::Derivatives::FullTextExtract.output_file_service = Hyrax::PersistDirectlyContainedOutputFileService
+        Hydra::Derivatives::FullTextExtract.output_file_service = Hyrax::ValkyriePersistDerivatives
         before_destroy :cleanup_derivatives
         # This completely overrides the version in Hydra::Works so that we
         # read and write to a local file. It's important that characterization runs

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

@@ -59,7 +59,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def file_set?
-      hydra_model == ::FileSet
+      hydra_model == ::FileSet || hydra_model == Hyrax::FileSet
     end
 
     ##

data/app/models/hyrax/collection_type.rb

@@ -49,7 +49,10 @@ module Hyrax
     # @return [Hyrax::PcdmCollection | ::Collection] an instance of Hyrax::CollectionType with id = the model_id portion of the gid (e.g. 3)
     # @raise [ActiveRecord::RecordNotFound] if record matching gid is not found
     def self.for(collection:)
-      find_by_gid!(collection.collection_type_gid)
+      gid = collection.collection_type_gid
+      gid = gid.first if gid.is_a?(Enumerable)
+
+      find_by_gid!(gid)
     end
 
     # Find the collection type associated with the Global Identifier (gid)
@@ -67,7 +70,7 @@ module Hyrax
     # @see #gid
     # @see Hyrax::MultipleMembershipChecker
     def self.gids_that_do_not_allow_multiple_membership
-      where(allow_multiple_membership: false).map(&:gid)
+      where(allow_multiple_membership: false).map { |c| c.to_global_id.to_s }
     end
 
     # Find the collection type associated with the Global Identifier (gid)
@@ -95,18 +98,6 @@ module Hyrax
       SETTINGS_ATTRIBUTES
     end
 
-    ##
-    # @deprecation use #to_global_id
-    #
-    # Return the Global Identifier for this collection type.
-    # @return [String, nil] Global Identifier (gid) for this collection_type (e.g. gid://internal/hyrax-collectiontype/3)
-    #
-    # @see https://github.com/rails/globalid#usage
-    def gid
-      Deprecation.warn('use #to_global_id.')
-      to_global_id.to_s if id
-    end
-
     ##
     # @return [Enumerable<Collection, PcdmCollection>]
     def collections(use_valkyrie: Hyrax.config.use_valkyrie?)

data/app/models/hyrax/file_metadata.rb

@@ -18,7 +18,6 @@ module Hyrax
                        "with id #{file.id}. Initializing a new one")
 
     FileMetadata.new(file_identifier: file.id,
-                     alternative_ids: [file.id],
                      original_filename: File.basename(file.io))
   end
 
@@ -67,11 +66,11 @@ module Hyrax
     attribute :label, ::Valkyrie::Types::Set
     attribute :original_filename, ::Valkyrie::Types::String
     attribute :mime_type, ::Valkyrie::Types::String.default(GENERIC_MIME_TYPE)
-    attribute :type, ::Valkyrie::Types::Set.default([Use::ORIGINAL_FILE].freeze) # Use += to add types, not <<
+    attribute :pcdm_use, ::Valkyrie::Types::Set.default([Use::ORIGINAL_FILE].freeze) # Use += to add pcdm_uses, not <<
 
     # attributes set by fits
     attribute :format_label, ::Valkyrie::Types::Set
-    attribute :size, ::Valkyrie::Types::Set
+    attribute :recorded_size, ::Valkyrie::Types::Set
     attribute :well_formed, ::Valkyrie::Types::Set
     attribute :valid, ::Valkyrie::Types::Set
     attribute :date_created, ::Valkyrie::Types::Set
@@ -130,19 +129,19 @@ module Hyrax
     ##
     # @return [Boolean]
     def original_file?
-      type.include?(Use::ORIGINAL_FILE)
+      pcdm_use.include?(Use::ORIGINAL_FILE)
     end
 
     ##
     # @return [Boolean]
     def thumbnail_file?
-      type.include?(Use::THUMBNAIL)
+      pcdm_use.include?(Use::THUMBNAIL)
     end
 
     ##
     # @return [Boolean]
     def extracted_file?
-      type.include?(Use::EXTRACTED_TEXT)
+      pcdm_use.include?(Use::EXTRACTED_TEXT)
     end
 
     def title
@@ -154,7 +153,7 @@ module Hyrax
     end
 
     def valid?
-      file.valid?(size: size.first, digests: { sha256: checksum&.first&.sha256 })
+      file.valid?(size: recorded_size.first, digests: { sha256: checksum&.first&.sha256 })
     end
 
     ##

data/app/models/hyrax/file_set.rb

@@ -51,6 +51,14 @@ module Hyrax
       id
     end
 
+    ##
+    # @return [Valkyrie::ID]
+    def representative_id=(_input)
+      # saving a file set using valkyrie would err because this method didn't exist.
+      Rails.logger.warn('This is not a valid method for file sets')
+      id
+    end
+
     ##
     # @return [Boolean] true
     def pcdm_object?

data/app/models/hyrax/resource.rb

@@ -35,8 +35,8 @@ module Hyrax
     include Hyrax::WithEvents
 
     attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
-    attribute :embargo,       Hyrax::Embargo.optional
-    attribute :lease,         Hyrax::Lease.optional
+    attribute :embargo_id,    Valkyrie::Types::ID
+    attribute :lease_id,      Valkyrie::Types::ID
 
     delegate :edit_groups, :edit_groups=,
              :edit_users,  :edit_users=,
@@ -91,6 +91,10 @@ module Hyrax
       false
     end
 
+    def ==(other)
+      attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at)
+    end
+
     def permission_manager
       @permission_manager ||= Hyrax::PermissionManager.new(resource: self)
     end
@@ -103,6 +107,30 @@ module Hyrax
       visibility_reader.read
     end
 
+    def embargo=(value)
+      raise TypeError "can't convert #{value.class} into Hyrax::Embargo" unless value.is_a? Hyrax::Embargo
+
+      @embargo = value
+      self.embargo_id = @embargo.id
+    end
+
+    def embargo
+      return @embargo if @embargo
+      @embargo = Hyrax.query_service.find_by(id: embargo_id) if embargo_id.present?
+    end
+
+    def lease=(value)
+      raise TypeError "can't convert #{value.class} into Hyrax::Lease" unless value.is_a? Hyrax::Lease
+
+      @lease = value
+      self.lease_id = @lease.id
+    end
+
+    def lease
+      return @lease if @lease
+      @lease = Hyrax.query_service.find_by(id: lease_id) if lease_id.present?
+    end
+
     protected
 
     def visibility_writer

data/app/presenters/hyrax/file_set_presenter.rb

@@ -105,6 +105,12 @@ module Hyrax
       current_ability.can?(:edit, id) || current_ability.can?(:destroy, id) || current_ability.can?(:download, id)
     end
 
+    ##
+    # @return [Array<String>]
+    def show_partials
+      ['show_details']
+    end
+
     private
 
     def link_presenter_class

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -56,7 +56,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def file_set?
-      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet')
+      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet') || Array(model[:has_model_ssim]).include?('Hyrax::FileSet')
     end
 
     ##
@@ -93,12 +93,8 @@ module Hyrax
     ##
     # @return [Array<#to_s>]
     def member_ids
-      case model
-      when Valkyrie::Resource
-        Array(model.try(:member_ids))
-      else
-        Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
-      end
+      m = model.is_a?(::SolrDocument) ? model.hydra_model : model.class
+      m < Hyrax::Resource ? Array(model.member_ids) : Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
     end
 
     ##

data/app/presenters/hyrax/presenter_renderer.rb

@@ -22,13 +22,6 @@ module Hyrax
         default: [:"defaults.#{field}", field.to_s.humanize]).presence
     end
 
-    ##
-    # @deprecated
-    def fields(terms, &_block)
-      Deprecation.warn("Fields is deprecated for removal in Hyrax 4.0.0. use #value and #label directly instead.")
-      @view_context.safe_join(terms.map { |term| yield self, term })
-    end
-
     private
 
     def render_show_field_partial(field_name, locals)

data/app/presenters/hyrax/work_show_presenter.rb

@@ -190,16 +190,6 @@ module Hyrax
       paginated_item_list(page_array: authorized_item_ids)
     end
 
-    ##
-    # @deprecated use `#member_presenters(ids)` instead
-    #
-    # @param [Array<String>] ids a list of ids to build presenters for
-    # @return [Array<presenter_class>] presenters for the array of ids (not filtered by class)
-    def member_presenters_for(an_array_of_ids)
-      Deprecation.warn("Use `#member_presenters` instead.")
-      member_presenters(an_array_of_ids)
-    end
-
     # @return [Integer] total number of pages of viewable items
     def total_pages
       (total_items.to_f / rows_from_params.to_f).ceil
@@ -262,6 +252,11 @@ module Hyrax
       Hyrax::ChildTypes.for(parent: solr_document.hydra_model).to_a
     end
 
+    # @return [Boolean]
+    def valkyrie_presenter?
+      solr_document.hydra_model < Valkyrie::Resource
+    end
+
     private
 
     # list of item ids to display is based on ordered_ids
@@ -308,7 +303,7 @@ module Hyrax
 
     def member_presenter_factory
       @member_presenter_factory ||=
-        if solr_document.hydra_model < Valkyrie::Resource
+        if valkyrie_presenter?
           PcdmMemberPresenterFactory.new(solr_document, current_ability)
         else
           self.class

data/app/search_builders/hyrax/file_set_search_builder.rb

@@ -5,7 +5,7 @@ module Hyrax
 
     # This overrides the models in FilterByType
     def models
-      [::FileSet]
+      [::FileSet, ::Hyrax::FileSet]
     end
   end
 end

data/app/search_builders/hyrax/valkyrie_abstract_type_relation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class ValkyrieAbstractTypeRelation
+    def initialize(allowable_types: nil, _opts: {})
+      @allowable_types = allowable_types
+    end
+
+    def allowable_types
+      @allowable_types.present? ||
+        raise(NotImplementedException, "Implement allowable_types in a subclass")
+    end
+
+    def equivalent_class?(klass)
+      allowable_types.include?(klass)
+    end
+
+    def count
+      Hyrax.query_service.custom_queries.find_count_by(models: allowable_types)
+    end
+
+    def where(hash)
+      Hyrax.query_service.find_references_by(resource: hash.values.first, property: hash.keys.first)
+    end
+
+    def ==(other)
+      case other
+      when Relation
+        other.where_values == where_values
+      when Array
+        to_a == other
+      end
+    end
+
+    delegate :inspect, to: :to_a
+  end
+end

data/app/search_builders/hyrax/valkyrie_work_relation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class ValkyrieWorkRelation < ValkyrieAbstractTypeRelation
+    def allowable_types
+      Hyrax.config.curation_concerns
+    end
+  end
+end