hyrax 3.4.1 → 3.5.0

data/app/models/hyrax/file_set.rb

@@ -31,12 +31,10 @@ 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 ||= begin
-        name_class.new(self, nil, 'FileSet')
-      end
+      @_model_name ||= name_class.new(self, nil, 'FileSet')
     end
 
     class_attribute :characterization_proxy
@@ -44,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/group.rb

@@ -7,12 +7,31 @@ module Hyrax
       DEFAULT_NAME_PREFIX
     end
 
+    ##
+    # @return [Hyrax::Group]
+    def self.from_agent_key(key)
+      new(key.delete_prefix(name_prefix))
+    end
+
     def initialize(name)
       @name = name
     end
 
     attr_reader :name
 
+    ##
+    # @return [Boolean]
+    def ==(other)
+      other.class == self.class && other.name == name
+    end
+
+    ##
+    # @return [String] a local identifier for this group; for use (e.g.) in ACL
+    #   data
+    def agent_key
+      self.class.name_prefix + name
+    end
+
     def to_sipity_agent
       sipity_agent || create_sipity_agent!
     end

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/hyrax/pcdm_collection.rb

@@ -41,7 +41,6 @@ module Hyrax
   #
   class PcdmCollection < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
-    include Hyrax::Schema(:basic_metadata)
 
     attribute :collection_type_gid, Valkyrie::Types::String
     attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)

data/app/models/job_io_wrapper.rb

@@ -94,7 +94,7 @@ class JobIoWrapper < ApplicationRecord
 
   def extracted_original_name
     eon = uploaded_file.uploader.filename if uploaded_file
-    eon ||= File.basename(path) if path.present? # note: uploader.filename is `nil` with uncached remote files (e.g. AWSFile)
+    eon ||= File.basename(path) if path.present? # NOTE: uploader.filename is `nil` with uncached remote files (e.g. AWSFile)
     eon
   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/member_presenter_factory.rb

@@ -47,13 +47,11 @@ module Hyrax
     # in order.
     # Arbitrarily maxed at 10 thousand; had to specify rows due to solr's default of 10
     def file_set_ids
-      @file_set_ids ||= begin
-                          Hyrax::SolrService.query("{!field f=has_model_ssim}FileSet",
+      @file_set_ids ||= Hyrax::SolrService.query("{!field f=has_model_ssim}FileSet",
                                                    rows: 10_000,
                                                    fl: Hyrax.config.id_field,
                                                    fq: "{!join from=ordered_targets_ssim to=id}id:\"#{id}/list_source\"")
-                                            .flat_map { |x| x.fetch(Hyrax.config.id_field, []) }
-                        end
+                                          .flat_map { |x| x.fetch(Hyrax.config.id_field, []) }
     end
 
     def presenter_factory_arguments

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/presenters/hyrax/work_show_presenter.rb

@@ -154,9 +154,9 @@ module Hyrax
     def grouped_presenters(filtered_by: nil, except: nil)
       # TODO: we probably need to retain collection_presenters (as parent_presenters)
       #       and join this with member_of_collection_presenters
-      grouped = member_of_collection_presenters.group_by(&:model_name).transform_keys { |key| key.to_s.underscore }
-      grouped.select! { |obj| obj.downcase == filtered_by } unless filtered_by.nil?
-      grouped.except!(*except) unless except.nil?
+      grouped = member_of_collection_presenters.group_by(&:model_name).transform_keys(&:human)
+      grouped.select! { |obj| obj.casecmp(filtered_by).zero? } unless filtered_by.nil?
+      grouped.reject! { |obj| except.map(&:downcase).include? obj.downcase } unless except.nil?
       grouped
     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

data/app/services/hyrax/access_control_list.rb

@@ -200,13 +200,14 @@ module Hyrax
 
       private
 
+      ##
+      # Returns the identifier used by ACLs to identify agents.
+      #
+      # This defaults to the `:agent_key`, but if that method doesn’t exist,
+      # `:user_key` will be used as a fallback.
       def id_for(agent:)
-        case agent
-        when Hyrax::Group
-          "#{Hyrax::Group.name_prefix}#{agent.name}"
-        else
-          agent.user_key.to_s
-        end
+        key = agent.try(:agent_key) || agent.user_key
+        key.to_s
       end
     end
 

data/app/services/hyrax/adapters/nesting_index_adapter.rb

@@ -60,7 +60,7 @@ module Hyrax
           object = ActiveFedora::Base.find(id)
           parent_ids = object.try(:member_of_collection_ids) || []
 
-          # note: we do not yield when the object has parents. Calling the nested indexer for the
+          # NOTE: we do not yield when the object has parents. Calling the nested indexer for the
           # top id will reindex all descendants as well.
           if object.try(:use_nested_reindexing?)
             yield(id, parent_ids) if parent_ids.empty?
@@ -119,11 +119,11 @@ module Hyrax
       # @yield Samvera::NestingIndexer::Documents::IndexDocument
       #
       # @return [void]
-      def self.each_child_document_of(document:, extent:, &block)
+      def self.each_child_document_of(document:, extent:, &block) # rubocop:disable Lint/UnusedMethodArgument
         raw_child_solr_documents_of(parent_document: document).each do |solr_document|
           child_document = coerce_solr_document_to_index_document(original_solr_document: solr_document, id: solr_document.fetch('id'))
           # during light reindexing, we want to reindex the child only if fields aren't already there
-          block.call(child_document) if full_reindex?(extent: extent) || child_document.pathnames.empty?
+          yield(child_document) if full_reindex?(extent: extent) || child_document.pathnames.empty?
         end
       end
 

data/app/services/hyrax/characterization/valkyrie_characterization_service.rb

@@ -91,11 +91,9 @@ class Hyrax::Characterization::ValkyrieCharacterizationService
     h = {}
 
     doc.class.terminology.terms.each_pair do |key, _target|
-      begin
-        h[key] = doc.public_send(key)
-      rescue NoMethodError
-        next
-      end
+      h[key] = doc.public_send(key)
+    rescue NoMethodError
+      next
     end
 
     h.compact

data/app/services/hyrax/collections/collection_member_service.rb

@@ -83,11 +83,9 @@ module Hyrax
         def add_members(collection_id:, new_members:, user:)
           messages = []
           new_members.map do |new_member|
-            begin
-              add_member(collection_id: collection_id, new_member: new_member, user: user)
-            rescue Hyrax::SingleMembershipError => err
-              messages += [err.message]
-            end
+            add_member(collection_id: collection_id, new_member: new_member, user: user)
+          rescue Hyrax::SingleMembershipError => err
+            messages += [err.message]
           end
           raise Hyrax::SingleMembershipError, messages if messages.present?
         end

data/app/services/hyrax/collections/nested_collection_query_service.rb

@@ -86,7 +86,7 @@ module Hyrax
       #   id is in the response. Useful for validation.
       # @param nest_direction [Symbol] :as_child or :as_parent
       def self.query_solr(collection:, access:, scope:, limit_to_id:, nest_direction:)
-        nesting_attributes = NestingAttributes.new(id: collection.id.to_s, scope: scope)
+        nesting_attributes = (Hyrax.config.use_solr_graph_for_collection_nesting ? nil : NestingAttributes.new(id: collection.id.to_s, scope: scope))
         query_builder = Hyrax::Dashboard::NestedCollectionsSearchBuilder.new(
           access: access,
           collection: collection,

data/app/services/hyrax/edit_permissions_service.rb

@@ -20,17 +20,35 @@ module Hyrax
     # @note
     #   +form object.class = SimpleForm::FormBuilder+
     #    For works (i.e. GenericWork):
-    #    * form object.object = Hyrax::GenericWorkForm
-    #    * form object.object.model = GenericWork
+    #    * form_object.object = Hyrax::GenericWorkForm
+    #    * form_object.object.model = GenericWork
     #    * use the work itself
     #    For file_sets:
-    #    * form object.object.class = FileSet
+    #    * form_object.object.class = FileSet
+    #    * use work the file_set is in
+    #    For file set forms:
+    #    * form_object.object.class = Hyrax::Forms::FileSetForm OR
+    #      Hyrax::Forms::FileSetEditForm
+    #    * form_object.object.model = FileSet
     #    * use work the file_set is in
     #    No other object types are supported by this view.
     def self.build_service_object_from(form:, ability:)
       if form.object.respond_to?(:model) && form.object.model.work?
+        # The provided form object is a work form.
         new(object: form.object, ability: ability)
+      elsif form.object.respond_to?(:model) && form.object.model.file_set?
+        # The provided form object is a FileSet form. For Valkyrie forms
+        # (+Hyrax::Forms::FileSetForm+), +:in_works_ids+ is prepopulated onto
+        # the form object itself. For +Hyrax::Forms::FileSetEditForm+, the
+        # +:in_works+ method is present on the wrapped +:model+.
+        if form.object.is_a?(Hyrax::Forms::FileSetForm)
+          object_id = form.object.in_works_ids.first
+          new(object: Hyrax.query_service.find_by(id: object_id), ability: ability)
+        else
+          new(object: form.object.model.in_works.first, ability: ability)
+        end
       elsif form.object.file_set?
+        # The provided form object is a FileSet.
         new(object: form.object.in_works.first, ability: ability)
       end
     end

data/app/services/hyrax/embargo_manager.rb

@@ -161,6 +161,15 @@ module Hyrax
       resource.embargo || Embargo.new
     end
 
+    ##
+    # Drop the embargo by setting its release date to `nil`.
+    #
+    # @return [void]
+    def nullify
+      return unless under_embargo?
+      embargo.embargo_release_date = nil
+    end
+
     ##
     # Sets the visibility of the resource to the embargo's visibility condition.
     # no-op if the embargo period is current.

data/app/services/hyrax/file_set_file_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A service for accessing specific Hyrax::FileMetadata objects referenced by a
+  # Hyrax::FileSet.
+  class FileSetFileService
+    ##
+    # @!attribute [r] file_set
+    #   @return [Hyrax::FileSet]
+    attr_reader :file_set
+
+    ##
+    # @!attribute [r] query_service
+    #   @return [#find_by]
+    attr_reader :query_service
+
+    ##
+    # @param resource [Hyrax::FileSet]
+    def initialize(file_set:, query_service: Hyrax.query_service)
+      @query_service = query_service
+      @file_set = file_set
+    end
+
+    ##
+    # Return the Hyrax::FileMetadata which should be considered “original” for
+    # indexing and version‐tracking.
+    #
+    # If +file_set.original_file_id+ is defined, it will be used; otherwise,
+    # this requires a custom query. The ultimate fallback, if no
+    # pcdm:OriginalFile is associated with the :file_set, is to just use the
+    # first file in its :file_ids.
+    #
+    # @return [Hyrax::FileMetadata]
+    def original_file
+      if file_set.original_file_id
+        # Always just use original_file_id if it is defined.
+        #
+        # NOTE: This needs to use :find_file_metadata_by, not :find_by, because
+        # at time of writing the latter does not work in Wings.
+        query_service.custom_queries.find_file_metadata_by(id: file_set.original_file_id)
+      else
+        # Cache the fallback to avoid needing to do this query twice.
+        #
+        # See NOTE above regarding use of :find_file_metadata_by.
+        @original_file ||= begin
+                             query_service.custom_queries.find_original_file(file_set: file_set)
+                           rescue Valkyrie::Persistence::ObjectNotFoundError
+                             fallback_id = file_set.file_ids.first
+                             query_service.custom_queries.find_file_metadata_by(id: fallback_id) if fallback_id
+                           end
+      end
+    end
+  end
+end

data/app/services/hyrax/lease_manager.rb

@@ -89,6 +89,15 @@ module Hyrax
       resource.lease || Lease.new
     end
 
+    ##
+    # Drop the lease by setting its release date to `nil`.
+    #
+    # @return [void]
+    def nullify
+      return unless under_lease?
+      lease.lease_expiration_date = nil
+    end
+
     ##
     # @return [Boolean]
     def release

data/app/services/hyrax/listeners/file_metadata_listener.rb

@@ -5,6 +5,17 @@ module Hyrax
     ##
     # Listens for events related to {Hyrax::FileMetadata}
     class FileMetadataListener
+      ##
+      # Called when 'file.characterized' event is published;
+      # allows post-characterization handling, like derivatives generation.
+      #
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_characterized(event)
+        CreateDerivativesJob
+          .perform_later(event[:file_set], event[:file_id], event[:path_hint])
+      end
+
       ##
       # Called when 'file.metadata.updated' event is published; reindexes a
       # {Hyrax::FileSet} when a file claiming to be its `pcdm_use:OriginalFile`

data/app/services/hyrax/listeners/member_cleanup_listener.rb

@@ -13,15 +13,13 @@ module Hyrax
         return if event[:object].is_a?(ActiveFedora::Base) # handled by legacy code
 
         Hyrax.custom_queries.find_child_file_sets(resource: event[:object]).each do |file_set|
-          begin
-            Hyrax.persister.delete(resource: file_set)
-            Hyrax.publisher
-                 .publish('object.deleted', object: file_set, id: file_set.id, user: event[:user])
-          rescue StandardError # we don't uncaught errors looping filesets
-            Hyrax.logger.warn "Failed to delete #{file_set.class}:#{file_set.id} " \
-                              "during cleanup for resource: #{event[:object]}. " \
-                              'This member may now be orphaned.'
-          end
+          Hyrax.persister.delete(resource: file_set)
+          Hyrax.publisher
+               .publish('object.deleted', object: file_set, id: file_set.id, user: event[:user])
+        rescue StandardError # we don't uncaught errors looping filesets
+          Hyrax.logger.warn "Failed to delete #{file_set.class}:#{file_set.id} " \
+                            "during cleanup for resource: #{event[:object]}. " \
+                            'This member may now be orphaned.'
         end
       end
 
@@ -33,15 +31,13 @@ module Hyrax
         return if event[:collection].is_a?(ActiveFedora::Base) # handled by legacy code
 
         Hyrax.custom_queries.find_members_of(collection: event[:collection]).each do |resource|
-          begin
-            resource.member_of_collection_ids -= [event[:collection].id]
-            Hyrax.persister.save(resource: resource)
-            Hyrax.publisher
-                 .publish('collection.membership.updated', collection: event[:collection], user: event[:user])
-          rescue StandardError
-            Hyrax.logger.warn "Failed to remove collection reference from #{work.class}:#{work.id} " \
-                              "during cleanup for collection: #{event[:collection]}. "
-          end
+          resource.member_of_collection_ids -= [event[:collection].id]
+          Hyrax.persister.save(resource: resource)
+          Hyrax.publisher
+               .publish('collection.membership.updated', collection: event[:collection], user: event[:user])
+        rescue StandardError
+          Hyrax.logger.warn "Failed to remove collection reference from #{work.class}:#{work.id} " \
+                            "during cleanup for collection: #{event[:collection]}. "
         end
       end
     end

data/app/services/hyrax/multiple_membership_checker.rb

@@ -21,7 +21,9 @@ module Hyrax
     # also belong to other collections of the same type.
     #
     # @return [True, String] true if no conflicts; otherwise, an error message string
+    # @deprecated Use #check instead; for removal in 4.0.0
     def validate
+      Deprecation.warn "#{self.class}##{__method__} is deprecated; use #check instead."
       return true if item.member_of_collection_ids.empty? || item.member_of_collection_ids.count <= 1
       return true unless single_membership_collection_types_exist?
 

data/app/services/hyrax/user_stat_importer.rb

@@ -84,6 +84,8 @@ module Hyrax
     rescue StandardError => exception
       log_message fail_message
       log_message "Last exception #{exception}"
+      # Without returning false, we return the results of log_message; which is true.
+      false
     end
 
     def date_since_last_cache(user)

data/app/services/hyrax/valkyrie_persist_derivatives.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Hyrax
+  class ValkyriePersistDerivatives < Hydra::Derivatives::PersistOutputFileService
+    # Persists a derivative using the defined Valkyrie storage adapter
+    #
+    # This Service conforms to the signature of `Hydra::Derivatives::PersistOutputFileService`.
+    # This service is a Valkyrized alternative to the default Hydra::Derivatives::PersistOutputFileService.
+    # This service will always update existing and does not do versioning of persisted files.
+    #
+    # to replace the default AF derivative pipeline, set
+    #     ```
+    #     Hydra::Derivatives.config.output_file_service = Hyrax::ValkyriePersistDerivatives
+    #     Hydra::Derivatives.config.source_file_service = Hyrax::LocalFileService
+    #     ```
+    #
+    # @param [#read] stream the derivative filestream
+    # @param [Hash] directives
+    # @option directives [String] :url a url to the file destination
+    def self.call(stream, directives)
+      filepath = URI(directives.fetch(:url)).path
+      fileset_id = fileset_id_from_path(filepath)
+      fileset = Hyrax.metadata_adapter.query_service.find_by(id: fileset_id)
+
+      # Valkyrie storage adapters will typically expect an IO-like object that
+      # responds to #path -- here we only have a StringIO, so some
+      # transformation is in order
+      tmpfile = Tempfile.new(fileset_id, encoding: 'ascii-8bit')
+      tmpfile.write stream.read
+
+      Rails.logger.debug "Uploading thumbnail for FileSet #{fileset_id} as #{filepath}"
+      Hyrax.config.derivatives_storage_adapter.upload(
+        file: tmpfile,
+        original_filename: filepath,
+        resource: fileset
+      )
+    end
+
+    # The filepath will look something like
+    # /app/samvera/hyrax-webapp/derivatives/95/93/tv/12/3-thumbnail.jpeg and
+    # we want to extract the FileSet id, which in this case would be 9593tv123
+    #
+    # @param [String] path
+    # @return [String]
+    def self.fileset_id_from_path(path)
+      path.sub(Hyrax.config.derivatives_path.to_s, "")
+          .sub(/-[^\/]+\..*$/, "")
+          .delete("/")
+    end
+  end
+end

data/app/services/hyrax/valkyrie_upload.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Hyrax::ValkyrieUpload
+  # @param [IO] io
+  # @param [String] filename
+  # @param [Hyrax::FileSet] file_set
+  # @param [RDF::URI] use
+  # @param [User] user
+  #
+  # @see Hyrax::FileMetadata::Use
+  # @return [Hyrax::FileMetadata] the metadata representing the uploaded file
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/ParameterLists
+  def self.file(
+    filename:,
+    file_set:,
+    io:,
+    storage_adapter: Hyrax.storage_adapter,
+    use: Hyrax::FileMetadata::Use::ORIGINAL_FILE,
+    user: nil
+  )
+
+    streamfile = storage_adapter.upload(
+      file: io,
+      original_filename: filename,
+      resource: file_set,
+      use: use
+    )
+    io.close
+
+    file_metadata = Hyrax::FileMetadata(streamfile)
+    file_metadata.file_set_id = file_set.id
+
+    case use
+    when 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
+    when Hyrax::FileMetadata::Use::THUMBNAIL
+      # TODO: the parent work's thumbnail_id remains incorrect (it's set to the
+      # FileSet ID, rather than the ID of this thumbnail FileMetadata; but
+      # trying to update the parent attributes here doesn't seem to stick
+      file_set.thumbnail_id = file_metadata.id
+    end
+
+    saved_metadata = Hyrax.persister.save(resource: file_metadata)
+    Hyrax.publisher.publish("object.file.uploaded", metadata: saved_metadata)
+
+    add_file_to_file_set(file_set: file_set,
+                         file_metadata: saved_metadata,
+                         user: user)
+
+    Hyrax.publisher.publish('file.metadata.updated', metadata: saved_metadata, user: user)
+
+    saved_metadata
+  end
+
+  # @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 self.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::FileSet] file_set the file set to add to
+  # @param [Hyrax::FileMetadata] file_metadata the metadata object representing
+  #   the file to add
+  # @return [void]
+  def self.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