hyrax 5.0.0.rc1 → 5.0.0.rc3

data/app/presenters/hyrax/version_presenter.rb

@@ -15,14 +15,29 @@ module Hyrax
       @current = true
     end
 
+    def label
+      version.try(:label) || version.version_id.to_s
+    end
+
+    def uri
+      version.try(:uri) || version.version_id.to_s
+    end
+
     def created
-      @created ||= version.created.in_time_zone.to_formatted_s(:long_ordinal)
+      @created ||= created_time&.in_time_zone&.to_formatted_s(:long_ordinal) || "Unknown"
     end
 
-    def committer
+    def created_time
+      version.try(:created) || version_committer.try(:created_at)
+    end
+
+    def version_committer
       Hyrax::VersionCommitter
-        .find_by(version_id: @version.uri)
-        &.committer_login
+        .find_by(version_id: @version.try(:uri) || @version.try(:version_id))
+    end
+
+    def committer
+      version_committer&.committer_login
     end
   end
 end

data/app/search_builders/hyrax/admin_set_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     # This overrides the models in FilterByType
     def models
-      [::AdminSet, Hyrax::AdministrativeSet]
+      Hyrax::ModelRegistry.admin_set_classes
     end
 
     # Overrides Hydra::AccessControlsEnforcement

data/app/search_builders/hyrax/catalog_search_builder.rb

@@ -78,8 +78,8 @@ class Hyrax::CatalogSearchBuilder < Hyrax::SearchBuilder
     "{!dismax v=$user_query}"
   end
 
-  # join from file id to work relationship solrized file_set_ids_ssim
+  # join from file id to work relationship solrized member_ids_ssim
   def join_for_works_from_files
-    "{!join from=#{Hyrax.config.id_field} to=file_set_ids_ssim}#{dismax_query}"
+    "{!join from=#{Hyrax.config.id_field} to=member_ids_ssim v=has_model_ssim:*FileSet}#{dismax_query}"
   end
 end

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

@@ -9,7 +9,7 @@ module Hyrax
 
       # This overrides the models in FilterByType
       def models
-        [::AdminSet, Hyrax::AdministrativeSet, ::Collection, Hyrax.config.collection_class].uniq.compact
+        Hyrax::ModelRegistry.admin_set_classes + Hyrax::ModelRegistry.collection_classes
       end
 
       # adds a filter to exclude collections and admin sets created by the
@@ -18,9 +18,11 @@ module Hyrax
       def show_only_managed_collections_for_non_admins(solr_parameters)
         return if current_ability.admin?
         clauses = [
-          '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: current_user_key),
-          '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: Hyrax.config.admin_set_model, creator: current_user_key)
+          '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: current_user_key)
         ]
+        Hyrax::ModelRegistry.admin_set_rdf_representations.each do |has_model|
+          clauses += ['-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: has_model, creator: current_user_key)]
+        end
         solr_parameters[:fq] ||= []
         solr_parameters[:fq] += ["(#{clauses.join(' OR ')})"]
       end

data/app/search_builders/hyrax/exposed_models_relation.rb

@@ -3,7 +3,7 @@ module Hyrax
   # A relation that scopes to all user visible models (e.g. works + collections + file sets)
   class ExposedModelsRelation < AbstractTypeRelation
     def allowable_types
-      (Hyrax.config.curation_concerns + [Hyrax.config.collection_class, ::Collection, ::FileSet]).uniq
+      Hyrax::ModelRegistry.work_classes + Hyrax::ModelRegistry.collection_classes + Hyrax::ModelRegistry.file_set_classes
     end
   end
 end

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, ::Hyrax::FileSet]
+      Hyrax::ModelRegistry.file_set_classes
     end
   end
 end

data/app/search_builders/hyrax/filter_by_type.rb

@@ -43,7 +43,7 @@ module Hyrax
     # types from appearing in search results
     # @return [Array<Class>] the list of work types to include in searches
     def work_types
-      Hyrax.config.curation_concerns
+      Hyrax::ModelRegistry.work_classes
     end
 
     def work_classes
@@ -53,7 +53,8 @@ module Hyrax
 
     def collection_classes
       return [] if only_works?
-      [::Collection, Hyrax.config.collection_class].uniq
+
+      Hyrax::ModelRegistry.collection_classes
     end
   end
 end

data/app/search_builders/hyrax/member_with_files_search_builder.rb

@@ -9,7 +9,7 @@ module Hyrax
     # This is like include_collection_ids, but it also joins the files.
     def include_contained_files(solr_parameters)
       solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << "{!join from=file_set_ids_ssim to=id}{!join from=child_object_ids_ssim to=id}id:#{collection_id}"
+      solr_parameters[:fq] << "{!join from=member_ids_ssim to=id}{!join from=child_object_ids_ssim to=id}id:#{collection_id}"
     end
 
     # include filters into the query to only include the collection memebers

data/app/search_builders/hyrax/my/collections_search_builder.rb

@@ -18,7 +18,7 @@ class Hyrax::My::CollectionsSearchBuilder < ::Hyrax::CollectionSearchBuilder
   # This overrides the models in FilterByType
   # @return [Array<Class>] a list of classes to include
   def models
-    [::AdminSet, Hyrax::AdministrativeSet, ::Collection, Hyrax.config.collection_class].uniq.compact
+    Hyrax::ModelRegistry.admin_set_classes + Hyrax::ModelRegistry.collection_classes
   end
 
   private
@@ -26,7 +26,7 @@ class Hyrax::My::CollectionsSearchBuilder < ::Hyrax::CollectionSearchBuilder
   def query_for_my_collections
     query_service = Hyrax::SolrQueryService.new
     query_service.with_field_pairs(field_pairs: { depositor_ssim: current_user_key }, type: 'terms')
-    query_service.with_field_pairs(field_pairs: { has_model_ssim: Hyrax.config.admin_set_model,
+    query_service.with_field_pairs(field_pairs: { has_model_ssim: Hyrax::ModelRegistry.admin_set_rdf_representations.join(','),
                                                   creator_ssim: current_user_key }, type: 'terms')
     query_service.build(join_with: 'OR')
   end

data/app/search_builders/hyrax/my/find_works_search_builder.rb

@@ -20,11 +20,11 @@ class Hyrax::My::FindWorksSearchBuilder < Hyrax::My::SearchBuilder
 
   def show_only_other_works(solr_parameters)
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += ["-#{Hyrax::SolrQueryBuilderService.construct_query_for_ids([@id])}"]
+    solr_parameters[:fq] += ["-#{Hyrax::SolrQueryBuilderService.construct_query_for_ids([parsed_id])}"]
   end
 
   def show_only_works_not_child(solr_parameters)
-    ids = Hyrax::SolrService.query("{!field f=id}#{@id}", fl: "member_ids_ssim", rows: 10_000).flat_map { |x| x.fetch("member_ids_ssim", []) }
+    ids = Hyrax::SolrService.query("{!field f=id}#{parsed_id}", fl: "member_ids_ssim", rows: 10_000).flat_map { |x| x.fetch("member_ids_ssim", []) }
     solr_parameters[:fq] ||= []
     solr_parameters[:fq] += ["-#{Hyrax::SolrQueryBuilderService.construct_query_for_ids([ids])}"]
   end
@@ -32,11 +32,16 @@ class Hyrax::My::FindWorksSearchBuilder < Hyrax::My::SearchBuilder
   def show_only_works_not_parent(solr_parameters)
     solr_parameters[:fq] ||= []
     solr_parameters[:fq]  += [
-      "-" + Hyrax::SolrQueryBuilderService.construct_query(member_ids_ssim: @id)
+      "-" + Hyrax::SolrQueryBuilderService.construct_query(member_ids_ssim: parsed_id)
     ]
   end
 
   def only_works?
     true
   end
+
+  # Since Valkyrie objects pass is an Id object, additional parsing is needed.
+  def parsed_id
+    @id.is_a?(String) ? @id : @id.id
+  end
 end

data/app/services/hyrax/access_control_list.rb

@@ -48,14 +48,24 @@ module Hyrax
   #   # => #<Set: {#<Hyrax::Permission access_to=#<Valkyrie::ID:0x000055628b0ae0b8 @id="my_id"> agent="group/public" mode=:read>}>
   class AccessControlList
     ##
-    # @!attribute [rw] resource
+    # @!attribute [r] resource
     #   @return [Valkyrie::Resource]
     # @!attribute [r] persister
     #   @return [#save]
     # @!attribute [r] query_service
     #   @return [#find_inverse_references_by]
     attr_reader :persister, :query_service
-    attr_accessor :resource
+    attr_reader :resource
+
+    ##
+    # @param value [Valkyrie::Resource]
+    # @return [Valkyrie::Resource]
+    def resource=(value)
+      # We need to remove the memoization as the @resource has changed.
+      @change_set = nil
+      @access_control_model = nil
+      @resource = value
+    end
 
     ##
     # @api public
@@ -167,7 +177,14 @@ module Hyrax
       return true unless pending_changes?
 
       change_set.sync
-      persister.save(resource: change_set.resource)
+
+      # change_set.resource is a Hyrax::AccessControl
+      #
+      # We're setting the once fetched access_control_model to what was returned, so as to avoid
+      # a refetch
+      @access_control_model = persister.save(resource: change_set.resource)
+
+      # self.resource is a Hyrax::Resource
       Hyrax.publisher.publish('object.acl.updated', acl: self, result: :success)
       @change_set = nil
 
@@ -251,7 +268,7 @@ module Hyrax
     ##
     # @api private
     def access_control_model
-      AccessControl.for(resource: resource, query_service: query_service)
+      @access_control_model ||= AccessControl.for(resource: resource, query_service: query_service)
     end
 
     ##

data/app/services/hyrax/action/create_valkyrie_work.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Action
+    ##
+    # @since 5.0.0
+    # @api public
+    #
+    # Encapsulating the logic of several interacting objects.  Namely the idea of using a form to
+    # {#validate} given parameters then to {#perform} the action by leveraging the {#transactions}'s
+    # {#transaction_name} configured with appropriate {#step_args} and ultimately providing the
+    # {#form} to then perform that work.
+    class CreateValkyrieWork
+      ##
+      # @!group Class Attributes
+      #
+      # @!attribute transaction_name
+      #   @return [String] the name of the transaction that we call for the CreateValkyrieWorkAction.
+      class_attribute :transaction_name, default: 'change_set.create_work'
+      # @!endgroup Class Attributes
+      ##
+
+      ##
+      # @param form [Object] the form that we'll use for validation and performing the action.
+      # @param transactions [Hyrax::Transactions::Container] the transactions
+      # @param user [User] the person performing the action
+      # @param params [Hash] the contextual parameters for the action; ApplicationController#params
+      #        if you will.
+      # @param work_attribute_key [String] the name of the key within the params that contains
+      #        the work's attributes
+      def initialize(form:, transactions:, user:, params:, work_attributes_key:)
+        @form = form
+        @transactions = transactions
+        @user = user
+        @params = params
+        @work_attributes_key = work_attributes_key
+        @work_attributes = @params.fetch(work_attributes_key, {})
+      end
+
+      attr_reader :form, :transactions, :user, :parent_id, :work_attributes, :uploaded_files, :params, :work_attributes_key
+
+      ##
+      # @api public
+      # @return [TrueClass] when the object is valid.
+      # @return [FalseClass] when the object is valid.
+      def validate
+        form.validate(work_attributes)
+      end
+
+      ##
+      # @api public
+      # @return [#value_or] the resulting created work, when successful.  When not successful, the
+      #         returned value call the given block.
+      def perform
+        transactions[transaction_name].with_step_args(**step_args).call(form)
+      end
+
+      ##
+      # @api public
+      #
+      # @return [Hash<String,Hash>] the step args to use for the given {#transactions}'s
+      #         {.transaction_name}
+      def step_args
+        {
+          'work_resource.add_to_parent' => { parent_id: params[:parent_id], user: user },
+          'work_resource.add_file_sets' => { uploaded_files: uploaded_files, file_set_params: work_attributes[:file_set] },
+          'change_set.set_user_as_depositor' => { user: user },
+          'work_resource.change_depositor' => { user: ::User.find_by_user_key(form.on_behalf_of) },
+          'work_resource.save_acl' => { permissions_params: form.input_params["permissions"] }
+        }
+      end
+
+      # rubocop:disable Lint/DuplicateMethods
+      def uploaded_files
+        UploadedFile.find(params.fetch(:uploaded_files, []))
+      end
+      # rubocop:enable Lint/DuplicateMethods
+    end
+  end
+end

data/app/services/hyrax/admin_set_create_service.rb

@@ -18,23 +18,6 @@ module Hyrax
     self.default_admin_set_persister = Hyrax::DefaultAdministrativeSet
 
     class << self
-      # @api public
-      # Creates the default Hyrax::AdministrativeSet and corresponding data
-      # @param admin_set_id [String] The default admin set ID
-      # @param title [Array<String>] The title of the default admin set
-      # @return [TrueClass]
-      # @see Hyrax::AdministrativeSet
-      # @deprecated
-      # TODO: When this deprecated method is removed, update private method
-      #       .create_default_admin_set! to remove the parameters.
-      def create_default_admin_set(admin_set_id: DEFAULT_ID, title: DEFAULT_TITLE)
-        Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                         "Instead, use 'Hyrax::AdminSetCreateService.find_or_create_default_admin_set'.")
-        create_default_admin_set!(admin_set_id: admin_set_id, title: title).present?
-      rescue RuntimeError => _err
-        false
-      end
-
       # @api public
       # Finds the default AdministrativeSet if it exists; otherwise, creates it and corresponding data
       # @return [Hyrax::AdministrativeSet] The default admin set.
@@ -101,12 +84,16 @@ module Hyrax
       # Create an instance of `Hyrax::AdministrativeSet` with the suggested_id if supported.
       # @return [Hyrax::AdministrativeSet] the new admin set
       def create_admin_set(suggested_id:, title:)
-        if suggested_id.blank? || Hyrax.config.disable_wings || !Hyrax.metadata_adapter.is_a?(Wings::Valkyrie::MetadataAdapter)
+        # Leverage the configured admin class, if it is a Valkyrie resource, otherwise fallback.
+        # Until we have fully moved to Valkyrie, we will need this logic.  Once past, we can
+        # use `Hyrax.config.admin_set_class`
+        klass = Hyrax.config.admin_set_class < Valkyrie::Resource ? Hyrax.config.admin_set_class : Hyrax::AdministrativeSet
+        if suggested_id.blank? || Hyrax.config.disable_wings
           # allow persister to assign id
-          Hyrax::AdministrativeSet.new(title: Array.wrap(title))
+          klass.new(title: Array.wrap(title))
         else
           # use suggested_id
-          Hyrax::AdministrativeSet.new(id: suggested_id, title: Array.wrap(title))
+          klass.new(id: suggested_id, title: Array.wrap(title))
         end
       end
 

data/app/services/hyrax/admin_set_service.rb

@@ -52,8 +52,8 @@ module Hyrax
     def count_files(admin_sets)
       file_counts = Hash.new(0)
       admin_sets.each do |admin_set|
-        query = "{!join from=file_set_ids_ssim to=id}isPartOf_ssim:#{admin_set.id}"
-        file_results = Hyrax::SolrService.get(fq: [query, "has_model_ssim:FileSet"], rows: 0)
+        query = "{!join from=member_ids_ssim to=id}isPartOf_ssim:#{admin_set.id}"
+        file_results = Hyrax::SolrService.get(fq: [query, "{!terms f=has_model_ssim}FileSet,Hyrax::FileSet"], rows: 0)
         file_counts[admin_set.id] = file_results['response']['numFound']
       end
       file_counts

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

@@ -15,6 +15,11 @@ class Hyrax::Characterization::ValkyrieCharacterizationService
     new(metadata: metadata, file: file, **options).characterize
     saved = Hyrax.persister.save(resource: metadata)
     Hyrax.publisher.publish('file.metadata.updated', metadata: saved, user: user)
+
+    Hyrax.publisher.publish('file.characterized',
+                            file_set: Hyrax.query_service.find_by(id: saved.file_set_id),
+                            file_id: saved.id.to_s,
+                            path_hint: saved.file_identifier.to_s)
   end
 
   ##

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

@@ -46,8 +46,10 @@ module Hyrax
       #
       # @return [Blacklight::Solr::Response]
       def available_member_works
+        sort_field = user_params[:sort]
         response, _docs = search_results do |builder|
           builder.search_includes_models = :works
+          builder.merge(sort: sort_field)
           builder
         end
         response

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

@@ -106,7 +106,7 @@ module Hyrax
         def add_member(collection_id:, new_member:, user:)
           message = Hyrax::MultipleMembershipChecker.new(item: new_member).check(collection_ids: [collection_id], include_current_members: true)
           raise Hyrax::SingleMembershipError, message if message.present?
-          new_member.member_of_collection_ids << collection_id # only populate this direction
+          new_member.member_of_collection_ids += [collection_id] # only populate this direction
           new_member = Hyrax.persister.save(resource: new_member)
           publish_metadata_updated(new_member, user)
           new_member

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   module Collections
+    # rubocop:disable Metrics/ClassLength
     class PermissionsService
       # @api private
       #
@@ -20,17 +21,34 @@ module Hyrax
       end
       private_class_method :source_ids_for_user
 
+      # rubocop:disable Metrics/MethodLength
       def self.filter_source(source_type:, ids:)
         return [] if ids.empty?
-        model = case source_type
-                when 'admin_set'
-                  Hyrax::AdministrativeSet
-                when 'collection'
-                  Hyrax::PcdmCollection
-                end
+        models = case source_type
+                 when 'admin_set'
+                   Hyrax::ModelRegistry.admin_set_classes
+                 when 'collection'
+                   Hyrax::ModelRegistry.collection_classes
+                 end
 
-        Hyrax.custom_queries.find_ids_by_model(model: model, ids: ids).to_a
+        # Antics to cope with all of the how the custom queries work.
+        if defined?(Wings::ModelRegistry)
+          models = models.map do |model|
+            Wings::ModelRegistry.reverse_lookup(model)
+                   rescue NoMethodError
+                     nil
+          end.compact
+        end
+
+        models.flat_map do |model|
+          if model
+            Hyrax.custom_queries.find_ids_by_model(model: model, ids: ids).to_a
+          else
+            []
+          end
+        end.uniq
       end
+      # rubocop:enable Metrics/MethodLength
       private_class_method :filter_source
 
       # @api private
@@ -203,7 +221,7 @@ module Hyrax
       end
       private_class_method :deposit_access_to_collection?
 
-      # @api private
+      # @api public
       #
       # Determine if the given user has :manage access for the given collection
       #
@@ -215,7 +233,6 @@ module Hyrax
       def self.manage_access_to_collection?(collection_id:, ability:, exclude_groups: [])
         access_to_collection?(collection_id: collection_id, access: 'manage', ability: ability, exclude_groups: exclude_groups)
       end
-      private_class_method :manage_access_to_collection?
 
       # @api private
       #
@@ -250,5 +267,6 @@ module Hyrax
       end
       private_class_method :access_to_collection?
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/app/services/hyrax/custom_queries/find_collections_by_type.rb

@@ -30,7 +30,7 @@ module Hyrax
       # @return [Enumerable<PcdmCollection>]
       def find_collections_by_type(global_id:)
         query_service
-          .find_all_of_model(model: PcdmCollection)
+          .find_all_of_model(model: Hyrax.config.collection_model.safe_constantize)
           .select { |collection| collection.collection_type_gid == global_id }
       end
     end

data/app/services/hyrax/custom_queries/find_file_metadata.rb

@@ -64,7 +64,7 @@ module Hyrax
       # @example
       #   Hyrax.query_service.find_file_metadata_by_use(use: ::RDF::URI("http://pcdm.org/ExtractedText"))
       def find_many_file_metadata_by_use(resource:, use:)
-        return [] unless resource.try(:file_ids)
+        return [] if resource.try(:file_ids).blank?
 
         results = find_many_file_metadata_by_ids(ids: resource.file_ids)
         results.select { |fm| fm.pcdm_use.include?(use) }

data/app/services/hyrax/custom_queries/navigators/find_files.rb

@@ -65,7 +65,7 @@ module Hyrax
         def find_thumbnail(file_set:)
           find_exactly_one_file_by_use(
             file_set: file_set,
-            use: Hyrax::FileMetadata::Use::THUMBNAIL
+            use: Hyrax::FileMetadata::Use::THUMBNAIL_IMAGE
           )
         end
 

data/app/services/hyrax/custom_queries/navigators/parent_work_navigator.rb

@@ -33,7 +33,7 @@ module Hyrax
           if results.count > 1
             Hyrax.logger.warn("#{resource.work? ? 'Work' : 'File set'} " \
                               "#{resource.id} is in #{results.count} works when it " \
-                              "should be in no more than one.")
+                              "should be in no more than one. Found in #{results.map(&:id).join(', ')}.")
           end
           results.first
         end

data/app/services/hyrax/edit_permissions_service.rb

@@ -215,7 +215,7 @@ module Hyrax
     # @todo Refactor inner working of code as there's lots of branching logic with potential hidden assumptions.
     def qualifies_as_unauthorized_collection?(resource:)
       case resource
-      when AdminSet, Hyrax::AdministrativeSet
+      when *Hyrax::ModelRegistry.admin_set_classes
         # Prior to this refactor, we looked at AdminSet only; However with the advent of the
         # Hyrax::AdministrativeSet, we need to test both cases.
         true

data/app/services/hyrax/embargo_manager.rb

@@ -12,12 +12,13 @@ module Hyrax
   #       date is today or later.
   #    - "Applied" means the embargo's pre-release visibility has been set on
   #      the resource.
-  #    - "Released" means the embargo's post-release visibility has been set on
-  #      the resource.
   #    - "Enforced" means the object's visibility matches the pre-release
   #      visibility of the embargo; i.e. the embargo has been applied,
   #      but not released.
-  #    - "Deactivate" means that the existing embargo will be removed
+  #    - "Released" means the embargo's post-release visibility has been set on
+  #      the resource.
+  #    - "Deactivate" means that the existing embargo will be removed, even
+  #      if it active.
   #
   # Note that an resource may be `#under_embargo?` even if the embargo is not
   # be `#enforced?` (in this case, the application should seek to apply the
@@ -109,11 +110,25 @@ module Hyrax
           .embargo
       end
 
+      # @return [Boolean]
+      def deactivate_embargo_for(resource:, query_service: Hyrax.query_service)
+        new(resource: resource, query_service: query_service)
+          .deactivate
+      end
+
+      # @return [Boolean]
+      def deactivate_embargo_for!(resource:, query_service: Hyrax.query_service)
+        new(resource: resource, query_service: query_service)
+          .deactivate!
+      end
+
+      # @return [Boolean]
       def release_embargo_for(resource:, query_service: Hyrax.query_service)
         new(resource: resource, query_service: query_service)
           .release
       end
 
+      # @return [Boolean]
       def release_embargo_for!(resource:, query_service: Hyrax.query_service)
         new(resource: resource, query_service: query_service)
           .release!
@@ -149,20 +164,20 @@ module Hyrax
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
     end
 
-    # Deactivates the embargo and logs a message to the embargo_history property
-    def deactivate!
-      embargo_state = embargo.active? ? 'active' : 'expired'
-      embargo_record = embargo_history_message(
-        embargo_state,
-        Time.zone.today,
-        embargo.embargo_release_date,
-        embargo.visibility_during_embargo,
-        embargo.visibility_after_embargo
-      )
+    ##
+    # Deactivates the embargo
+    # @return [Boolean]
+    def deactivate
+      release(force: true) &&
+        nullify(force: true)
+    end
 
+    ##
+    # Deactivates the embargo
+    # @return [Boolean]
+    def deactivate!
       release(force: true)
       nullify(force: true)
-      embargo.embargo_history += [embargo_record]
     end
 
     ##
@@ -211,15 +226,16 @@ module Hyrax
     ##
     # Drop the embargo by setting its release date and visibility settings to `nil`.
     #
-    # @param force [boolean] force the nullify even when the embargo period is current
+    # @param force [Boolean] force the nullify even when the embargo period is current
     #
-    # @return [void]
+    # @return [Boolean]
     def nullify(force: false)
       return false if !force && under_embargo?
 
       embargo.embargo_release_date = nil
       embargo.visibility_during_embargo = nil
       embargo.visibility_after_embargo = nil
+      true
     end
 
     ##
@@ -231,6 +247,17 @@ module Hyrax
     # @return [Boolean] truthy if the embargo has been applied
     def release(force: false)
       return false if !force && under_embargo?
+
+      embargo_state = embargo.active? ? 'active' : 'expired'
+      history_record = embargo_history_message(
+        embargo_state,
+        Hyrax::TimeService.time_in_utc,
+        embargo.embargo_release_date,
+        embargo.visibility_during_embargo,
+        embargo.visibility_after_embargo
+      )
+      embargo.embargo_history += [history_record]
+
       return true if embargo.visibility_after_embargo.nil?
 
       resource.visibility = embargo.visibility_after_embargo
@@ -266,7 +293,7 @@ module Hyrax
 
     protected
 
-    # Create the log message used when deactivating an embargo
+    # Create the log message used when releasing an embargo
     def embargo_history_message(state, deactivate_date, release_date, visibility_during, visibility_after)
       I18n.t 'hydra.embargo.history_message',
               state: state,