hyrax 3.3.0 → 3.4.0

data/app/jobs/change_depositor_event_job.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# Log work depositor change to activity streams
+#
+# This class simply logs the transfer, pulling data from the object that was
+# just transferred. It does not perform the transfer.
+class ChangeDepositorEventJob < ContentEventJob
+  include Rails.application.routes.url_helpers
+  include ActionDispatch::Routing::PolymorphicRoutes
+
+  # @param [ActiveFedora::Base, Hyrax::Work] work the work that's been transfered
+  def perform(work)
+    # these get set to repo_object and depositor
+    super(work, new_owner(work))
+  end
+
+  def action
+    "User #{link_to_profile repo_object.proxy_depositor} has transferred #{link_to_work repo_object.title.first} to user #{link_to_profile depositor}"
+  end
+
+  def link_to_work(text)
+    link_to text, polymorphic_path(repo_object)
+  end
+
+  # Log the event to the work's stream
+  def log_work_event(work)
+    work.log_event(event)
+  end
+  alias log_file_set_event log_work_event
+
+  # overriding default to log the event to the depositor instead of their profile
+  # and to log the event for both users
+  def log_user_event(depositor)
+    previous_owner.log_profile_event(event)
+    depositor.log_event(event)
+  end
+
+  private
+
+  def previous_owner
+    ::User.find_by_user_key(repo_object.proxy_depositor)
+  end
+
+  # used for @depositor
+  def new_owner(work)
+    ::User.find_by_user_key(work.depositor)
+  end
+end

data/app/jobs/characterize_job.rb

@@ -36,12 +36,48 @@ class CharacterizeJob < Hyrax::ApplicationJob
 
   private
 
-  def characterize(file_set, _file_id, filepath)
+  def characterize(file_set, _file_id, filepath) # rubocop:disable Metrics/AbcSize
+    # store this so we can tell if the original_file is actually changing
+    previous_checksum = file_set.characterization_proxy.original_checksum.first
+
+    clear_metadata(file_set)
+
+    # If the current FileSet title is the same as the label, it must be a filename as opposed to a user-entered...
+    # value. So later we'll ensure it's set to the new file's filename.
+    reset_title = file_set.title.first == file_set.label
+
     characterization_service.run(file_set.characterization_proxy, filepath)
     Rails.logger.debug "Ran characterization on #{file_set.characterization_proxy.id} (#{file_set.characterization_proxy.mime_type})"
     file_set.characterization_proxy.alpha_channels = channels(filepath) if file_set.image? && Hyrax.config.iiif_image_server?
     file_set.characterization_proxy.save!
-    file_set.update_index
+
+    # Ensure that if the actual file content has changed, the mod timestamp on the FileSet object changes.
+    # Otherwise this does not happen when rolling back to a previous version. Perhaps this should be set as part of...
+    # `FileActor.revert_to` (or its replacement Transaction?!), where the FileSet is saved. Not sure if the...
+    # before/after checksum is readily available there though. I like this checksum verification because it allows...
+    # all changes to the current FileSet version to be detected, which in our case triggers re-creation of a...
+    # "cold storage" archive of the parent Work. It's worth noting that adding a *new* version always touches this...
+    # mod time. This is done in the versioning code.
+    file_set.date_modified = Hyrax::TimeService.time_in_utc if file_set.characterization_proxy.original_checksum.first != previous_checksum
+
+    # set title to label if that's how it was before this characterization
+    file_set.title = [file_set.characterization_proxy.original_name] if reset_title
+    # always set the label to the original_name
+    file_set.label = file_set.characterization_proxy.original_name
+
+    file_set.save!
+  end
+
+  def clear_metadata(file_set)
+    # The characterization of additional file versions adds new height/width/size/checksum values to un-orderable...
+    # `ActiveTriples::Relation` fields on `original_file`. Values from those are then randomly pulled into Solr...
+    # fields which may have scalar or vector cardinality. So for height/width you get two scalar values pulled from...
+    # "randomized parallel arrays". Upshot is to reset all of these before (re)characterization to stop the mayhem.
+    file_set.characterization_proxy.height = []
+    file_set.characterization_proxy.width  = []
+    file_set.characterization_proxy.original_checksum = []
+    file_set.characterization_proxy.file_size = []
+    file_set.characterization_proxy.format_label = []
   end
 
   def channels(filepath)

data/app/jobs/concerns/hyrax/members_permission_job_behavior.rb

@@ -17,7 +17,7 @@ module Hyrax
       when ActiveFedora::Base
         ::FileSet.search_with_conditions(id: work.member_ids).map(&:id)
       when Valkyrie::Resource
-        Hyrax.custom_queries.find_child_fileset_ids(resource: work)
+        Hyrax.custom_queries.find_child_file_set_ids(resource: work)
       end
     end
 

data/app/jobs/content_depositor_change_event_job.rb

@@ -8,10 +8,11 @@ class ContentDepositorChangeEventJob < ContentEventJob
 
   attr_accessor :reset
 
-  # @param [ActiveFedora::Base] work the work to be transfered
+  # @param [ActiveFedora::Base, Hyrax::Work] work the work to be transferred
   # @param [User] user the user the work is being transfered to.
   # @param [TrueClass,FalseClass] reset (false) if true, reset the access controls. This revokes edit access from the depositor
   def perform(work, user, reset = false)
+    Deprecation.warn("This class will be removed in the next major release. Use Hyrax::ChangeDepositorService.call instead.")
     @reset = reset
     super(work, user)
   end

data/app/jobs/hyrax/propagate_change_depositor_job.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Hyrax
+  # updates depositor on file sets and resets permissions if flagged. Used by
+  # ChangeDepositorService to background changes to lots of file sets
+  class PropagateChangeDepositorJob < ApplicationJob
+    # @param work_id [Valkyrie::Id, String] the id of the work
+    #             that is receiving a change of depositor
+    # @param user [User] the user that will "become" the depositor of
+    #             the given work
+    # @param reset [TrueClass, FalseClass] when true, first clear
+    #              permissions for the given work and contained file
+    #              sets; regardless of true/false make the given user
+    #              the depositor of the given work
+    def perform(work_id, user, reset)
+      work = Hyrax.query_service.find_by(id: work_id)
+      Hyrax.custom_queries.find_child_file_sets(resource: work).each do |f|
+        if reset
+          f.permission_manager.acl.permissions = []
+          f.permission_manager.acl.save
+        end
+        apply_depositor_metadata(f, user)
+        Hyrax.persister.save(resource: f)
+      end
+    end
+
+    def apply_depositor_metadata(resource, depositor)
+      depositor_id = depositor.respond_to?(:user_key) ? depositor.user_key : depositor
+      resource.depositor = depositor_id if resource.respond_to? :depositor=
+      Hyrax::AccessControlList.new(resource: resource).grant(:edit).to(::User.find_by_user_key(depositor_id)).save
+    end
+  end
+end

data/app/jobs/inherit_permissions_job.rb

@@ -24,7 +24,7 @@ class InheritPermissionsJob < Hyrax::ApplicationJob
   # @param work [Resource]
   # @return [Array<Hyrax::File_Set>]
   def file_sets_for(work)
-    Hyrax.custom_queries.find_child_filesets(resource: work)
+    Hyrax.custom_queries.find_child_file_sets(resource: work)
   end
 
   # Perform the copy from the work to the contained filesets

data/app/jobs/valkyrie_create_derivatives_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+class ValkyrieCreateDerivativesJob < Hyrax::ApplicationJob
+  queue_as Hyrax.config.ingest_queue_name
+  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.
+    file = Hyrax.storage_adapter.find_by(id: file_metadata.file_identifier)
+    # Call derivatives with the file_set.
+    derivative_service = Hyrax::DerivativeService.for(file_metadata)
+    derivative_service.create_derivatives(file.disk_path)
+    # Trigger a reindex to get the thumbnail path.
+    Hyrax.publisher.publish('file.metadata.updated', metadata: file_metadata, user: nil)
+  end
+
+  private
+
+  def query_service
+    Hyrax.query_service
+  end
+
+  def storage_adapter
+    Hyrax.storage_adapter
+  end
+end

data/app/jobs/valkyrie_ingest_job.rb

@@ -1,56 +1,124 @@
 # frozen_string_literal: true
+
+##
+# Ingests a {Hyrax::UploadedFile} as file member of a {Hyrax::FileSet}.
+#
+# The {Hyrax::UploadedFile} is passed into {#perform}, and should have a
+# {Hyrax::UploadedFile#file_set_uri} identifying an existing {Hyrax::FileSet}.
 class ValkyrieIngestJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
   ##
-  # @param [Valkyrie::StorageAdapter::StreamFile] file
-  def perform(file)
-    ingest(file: file)
+  # @param [Hyrax::UploadedFile] file
+  # @param [RDF::URI] pcdm_use is the use/type to apply to the created FileMetadata
+  # @see Hyrax::FileMetadata::Use
+  def perform(file, pcdm_use: Hyrax::FileMetadata::Use::ORIGINAL_FILE)
+    ingest(file: file, pcdm_use: pcdm_use)
   end
 
   ##
-  # @param [Valkyrie::StorageAdapter::StreamFile] file
+  # @api private
   #
+  # @param [Hyrax::UploadedFile] file
+  # @param [RDF::URI] pcdm_use
+
   # @return [void]
-  def ingest(file:)
-    file_set = Hyrax.query_service.find_by(id: file.file_set_uri)
-    updated_metadata = upload_file(file: file, file_set: file_set)
+  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, pcdm_use: pcdm_use)
 
-    add_file_to_file_set(file_set: file_set, file_metadata: updated_metadata)
+    add_file_to_file_set(file_set: file_set,
+                         file_metadata: updated_metadata,
+                         user: file.user)
+
+    ValkyrieCreateDerivativesJob.perform_later(file_set.id.to_s, updated_metadata.id.to_s)
   end
 
   ##
-  # @todo this should publish something to allow the fileset
-  #   to reindex its membership
+  # @api private
+  #
   # @param [Hyrax::FileSet] file_set the file set to add to
   # @param [Hyrax::FileMetadata] file_metadata the metadata object representing
   #   the file to add
+  # @param [::User] user  the user performing the add
   #
   # @return [Hyrax::FileSet] updated file set
-  def add_file_to_file_set(file_set:, file_metadata:)
+  def add_file_to_file_set(file_set:, file_metadata:, user:)
     file_set.file_ids << file_metadata.id
+    set_file_use_ids(file_set, file_metadata)
+
     Hyrax.persister.save(resource: file_set)
+    Hyrax.publisher.publish('object.membership.updated', object: file_set, user: user)
   end
 
   ##
+  # @api private
+  #
   # @param [Hyrax::UploadedFile] file
   # @param [Hyrax::FileSet] file_set
+  # @param [RDF::URI] pcdm_use  the use/type to apply to the created FileMetadata
   #
   # @return [Hyrax::FileMetadata] the metadata representing the uploaded file
-  def upload_file(file:, file_set:)
+  def upload_file(file:, file_set:, pcdm_use:) # rubocop:disable Metrics/MethodLength
     carrier_wave_sanitized_file = file.uploader.file
+    # Pull file, since carrierwave files don't respond to a proper IO #read. See
+    # https://github.com/carrierwaveuploader/carrierwave/issues/1959
+    file_io = carrier_wave_sanitized_file.to_file
     uploaded = Hyrax.storage_adapter
                     .upload(resource: file_set,
-                            file: carrier_wave_sanitized_file,
+                            file: file_io,
                             original_filename: carrier_wave_sanitized_file.original_filename)
 
-    file_metadata = Hyrax.custom_queries.find_file_metadata_by(id: uploaded.id)
+    file_metadata = find_or_create_metadata(id: uploaded.id, file: carrier_wave_sanitized_file)
+
+    file_metadata.type << pcdm_use
     file_metadata.file_set_id = file.file_set_uri
     file_metadata.file_identifier = uploaded.id
     file_metadata.size = uploaded.size
 
-    Hyrax.publisher.publish("object.file.uploaded", metadata: file_metadata)
+    saved_metadata = Hyrax.persister.save(resource: file_metadata)
+    Hyrax.publisher.publish("object.file.uploaded", metadata: saved_metadata)
+    file_io.close
+
+    if pcdm_use == Hyrax::FileMetadata::Use::ORIGINAL_FILE
+      # Set file set label.
+      reset_title = file_set.title.first == file_set.label
+      # set title to label if that's how it was before this characterization
+      file_set.title = file_metadata.original_filename if reset_title
+      # always set the label to the original_name
+      file_set.label = file_metadata.original_filename
+    end
+
+    saved_metadata
+  end
+
+  ##
+  # @api private
+  def find_or_create_metadata(id:, file:)
+    Hyrax.custom_queries.find_file_metadata_by(id: id)
+  rescue Valkyrie::Persistence::ObjectNotFoundError => e
+    Hyrax.logger.warn "Failed to find existing metadata for #{id}:"
+    Hyrax.logger.warn e.message
+    Hyrax.logger.warn "Creating Hyrax::FileMetadata now"
+    Hyrax::FileMetadata.for(file: file)
+  end
 
-    file_metadata
+  ##
+  # @api private
+  def set_file_use_ids(file_set, file_metadata)
+    file_metadata.type.each do |type|
+      case type
+      when Hyrax::FileMetadata::Use::ORIGINAL_FILE
+        file_set.original_file_id = file_metadata.id
+      when Hyrax::FileMetadata::Use::THUMBNAIL
+        file_set.thumbnail_id = file_metadata.id
+      when Hyrax::FileMetadata::Use::EXTRACTED_TEXT
+        file_set.extracted_text_id = file_metadata.id
+      else
+        Rails.logger.warn "Unknown file use #{file_metadata.type} specified for #{file_metadata.file_identifier}"
+      end
+    end
   end
 end

data/app/models/admin_set.rb

@@ -87,12 +87,12 @@ class AdminSet < ActiveFedora::Base
   end
 
   ##
-  # @deprecated use PermissionTemplate#reset_access_controls instead
+  # @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 instead.")
+    Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls_for instead.")
 
     permission_template.reset_access_controls_for(collection: self)
   end

data/app/models/collection_branding_info.rb

@@ -14,16 +14,19 @@ class CollectionBrandingInfo < ApplicationRecord
     self.local_path = File.join(role, filename)
   end
 
-  def save(file_location, copy_file = true)
+  def save(file_location, upload_file = true)
     filename = File.split(local_path).last
     role_and_filename = File.join(role, filename)
 
-    storage.upload(resource: Hyrax::PcdmCollection.new(id: collection_id),
-                   file: File.open(file_location),
-                   original_filename: role_and_filename)
+    if upload_file
+      storage.upload(resource: Hyrax::PcdmCollection.new(id: collection_id),
+                     file: File.open(file_location),
+                     original_filename: role_and_filename)
+    end
+
     self.local_path = find_local_filename(collection_id, role, filename)
 
-    FileUtils.remove_file(file_location) if File.exist?(file_location) && copy_file
+    FileUtils.remove_file(file_location) if File.exist?(file_location) && upload_file
     super()
   end
 
@@ -35,7 +38,6 @@ class CollectionBrandingInfo < ApplicationRecord
          else
            local_path
          end
-
     storage.delete(id: id)
   end
 

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

@@ -121,12 +121,12 @@ module Hyrax
     end
 
     ##
-    # @deprecated use PermissionTemplate#reset_access_controls instead
+    # @deprecated use PermissionTemplate#reset_access_controls_for instead
     #
     # Calculate and update who should have read/edit access to the collections based on who
     # has access in PermissionTemplateAccess
     def reset_access_controls!
-      Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
+      Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls_for instead.")
 
       permission_template
         .reset_access_controls_for(collection: self, interpret_visibility: true)

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

@@ -29,7 +29,7 @@ module Hyrax
           :page_count, :file_title, :last_modified, :original_checksum,
           :duration, :sample_rate, :alpha_channels
         ]
-        self.characterization_proxy = :original_file
+        self.characterization_proxy = Hyrax.config.characterization_proxy
 
         delegate(*characterization_terms, to: :characterization_proxy)
 
@@ -64,6 +64,12 @@ module Hyrax
       end
 
       ActiveFedora::WithMetadata::DefaultMetadataClassFactory.file_metadata_schemas << AlphaChannelsSchema
+
+      # Add file_set_id for Valkyrie support.
+      class FileSetIdSchema < ActiveTriples::Schema
+        property :file_set_id, predicate: ::RDF::URI.new('http://vocabulary.samvera.org/ns#fileSetId')
+      end
+      ActiveFedora::WithMetadata::DefaultMetadataClassFactory.file_metadata_schemas << FileSetIdSchema
     end
   end
 end

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -52,6 +52,7 @@ module Hyrax
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
         attribute :admin_set, Solr::Array, "admin_set_tesim"
+        attribute :admin_set_id, Solr::Array, "admin_set_id_ssim"
         attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, "member_of_collection_ids_ssim"
         attribute :member_of_collections, Solr::Array, "member_of_collections_ssim"

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

@@ -65,7 +65,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def admin_set?
-      hydra_model == ::AdminSet
+      hydra_model == Hyrax.config.admin_set_class
     end
 
     ##
@@ -75,9 +75,9 @@ module Hyrax
     end
 
     # Method to return the model
-    def hydra_model(classifier: ActiveFedora.model_mapper)
+    def hydra_model(classifier: nil)
       first('has_model_ssim')&.safe_constantize ||
-        classifier.classifier(self).best_model
+        model_classifier(classifier).classifier(self).best_model
     end
 
     def depositor(default = '')
@@ -107,5 +107,11 @@ module Hyrax
     def collection_type_gid
       first(Hyrax.config.collection_type_index_field)
     end
+
+    private
+
+    def model_classifier(classifier)
+      classifier || ActiveFedora.model_mapper
+    end
   end
 end

data/app/models/hyrax/administrative_set.rb

@@ -1,18 +1,53 @@
 # frozen_string_literal: true
 
+require_dependency 'hyrax/administrative_set_name'
+
 module Hyrax
   ##
   # Valkyrie model for Admin Set domain objects.
+  #
+  # ## Relationships
+  #
+  # ### Administrative Set and Work
+  #
+  # * Defined: The relationship is defined by the inverse relationship stored in the
+  #   work's `:admin_set_id` attribute.
+  # * Tested: The work tests the relationship.
+  # * Administrative Set to Work: (1..m)  An admin set can have many works.
+  #
+  # @example Get works in an admin set:
+  #       works = Hyrax.query_service.find_inverse_references_by(id: admin_set.id, property: :admin_set_id)
+  #
+  # * Work to Administrative Set: (1..1)  A work must be in one and only one admin set.
+  #   * See Hyrax::Work for code to get and set the admin set for the work.
+  #
+  # @see Hyrax::Work
+  # @see Valkyrie query adapter's #find_inverse_references_by
+  #
   class AdministrativeSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
 
     attribute :alternative_title, Valkyrie::Types::Set.of(Valkyrie::Types::String)
     attribute :creator,           Valkyrie::Types::Set.of(Valkyrie::Types::String)
-    attribute :description,       Valkyrie::Types::Set.of(Valkyrie::Types::String)
+    attribute :description,       Valkyrie::Types::String
+
+    ##
+    # @return [Boolean] true
+    def collection?
+      true
+    end
 
     def collection_type_gid
       # allow AdministrativeSet to behave more like a regular PcdmCollection
       Hyrax::CollectionType.find_or_create_admin_set_type.to_global_id
     end
+
+    ##
+    # @api private
+    #
+    # @return [Class] an ActiveModel::Name compatible class
+    def self._hyrax_default_name_class
+      Hyrax::AdministrativeSetName
+    end
   end
 end

data/app/models/hyrax/collection_type.rb

@@ -109,9 +109,9 @@ module Hyrax
 
     ##
     # @return [Enumerable<Collection, PcdmCollection>]
-    def collections(use_valkyrie: false)
+    def collections(use_valkyrie: Hyrax.config.use_valkyrie?)
       return [] unless id
-      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id) if use_valkyrie
+      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id.to_s) if use_valkyrie
       ActiveFedora::Base.where(Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s)
     end
 

data/app/models/hyrax/file_metadata.rb

@@ -2,6 +2,10 @@
 
 module Hyrax
   class FileMetadata < Valkyrie::Resource
+    # Include mime-types for Hydra Derivatives mime-type checking. We may want
+    # to move this logic someday.
+    include Hydra::Works::MimeTypes
+
     GENERIC_MIME_TYPE = 'application/octet-stream'
 
     ##
@@ -42,7 +46,7 @@ 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)
+    attribute :type, ::Valkyrie::Types::Set.default([Use::ORIGINAL_FILE])
 
     # attributes set by fits
     attribute :format_label, ::Valkyrie::Types::Set

data/app/models/hyrax/file_set.rb

@@ -4,6 +4,30 @@ module Hyrax
   ##
   # Valkyrie model for `FileSet` domain objects in the Hydra Works model.
   #
+  # ## Relationships
+  #
+  # ### File Set and Work
+  #
+  # * Defined: The relationship is defined by the inverse relationship stored in the
+  #   work's `:member_ids` attribute.
+  # * Tested: The work tests the relationship.
+  # * File Set to Work: (1..1)  A file set must be in one and only one work.
+  #
+  # @example Get work for a file set:
+  #       work = Hyrax.custom_queries.find_parent_work(resource: file_set)
+  #
+  # * Work to File Set: (0..m)  A work can have many file sets.
+  #   * See Hyrax::Work for code to get and set file sets for the work.
+  #
+  # ### File Set and File (TBD)
+  #
+  # @see Hyrax::Work
+  # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
+  #
+  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
+  #   terminology to describe the relationships that is no longer used in code.
+  #   Update the model and link to it.  This can be a simple relationship diagram
+  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
@@ -15,11 +39,28 @@ module Hyrax
       end
     end
 
+    class_attribute :characterization_proxy
+    self.characterization_proxy = Hyrax.config.characterization_proxy
+
     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 :thumbnail_id, Valkyrie::Types::ID # id for FileMetadata resource
     attribute :extracted_text_id, Valkyrie::Types::ID # id for FileMetadata resource
 
+    ##
+    # @return [Valkyrie::ID]
+    def representative_id
+      id
+    end
+
+    ##
+    # @return [Valkyrie::ID]
+    # If one is set then return it, otherwise use self as the ID to allow for
+    # derivative generators to find the on-disk path for the thumbnail.
+    def thumbnail_id
+      self.[](:thumbnail_id) || id
+    end
+
     ##
     # @return [Boolean] true
     def pcdm_object?