hyrax 5.1.0 → 5.3.0

data/lib/hyrax/configuration.rb

@@ -133,8 +133,23 @@ module Hyrax
     attr_writer :analytics_reporting
     attr_reader :analytics_reporting
     def analytics_reporting?
-      @analytics_reporting ||=
+      @analytics_reporting ||= begin
+        required_env_vars = %w[
+          HYRAX_ANALYTICS_REPORTING
+          GOOGLE_ANALYTICS_ID
+          GOOGLE_ANALYTICS_PROPERTY_ID
+        ]
+
+        required_env_vars << if ENV['GOOGLE_ACCOUNT_JSON'].blank?
+                               'GOOGLE_ACCOUNT_JSON_PATH'
+                             else
+                               'GOOGLE_ACCOUNT_JSON'
+                             end
+
+        return false if required_env_vars.any? { |var| ENV.fetch(var, '').blank? }
+
         ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_ANALYTICS_REPORTING', false))
+      end
     end
 
     # Currently supports 'google' or 'matomo'
@@ -142,7 +157,7 @@ module Hyrax
     attr_writer :analytics_provider
     def analytics_provider
       @analytics_provider ||=
-        ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'google')
+        ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'ga4')
     end
 
     ##
@@ -293,6 +308,19 @@ module Hyrax
       file_set_model.constantize
     end
 
+    def valkyrie_file_set_class
+      file_set_class.ancestors.include?(ActiveFedora::Base) ? Hyrax::FileSet : file_set_class
+    end
+
+    ##
+    # @!attribute [rw] file_set_include_metadata
+    #   @return [Boolean] whether to include static metadata for file_sets
+    attr_writer :file_set_include_metadata
+    def file_set_include_metadata
+      @file_set_include_metadata ||= disable_include_metadata ? false : true
+    end
+    alias file_set_include_metadata? file_set_include_metadata
+
     ##
     # @!attribute [rw] file_set_file_service
     #   @return [Class] implementer of {Hyrax::FileSetFileService}
@@ -306,6 +334,105 @@ module Hyrax
       @fixity_service ||= Hyrax::Fixity::ActiveFedoraFixityService
     end
 
+    # This value determines whether to use flexible metadata / m3 profile ui or not
+    attr_writer :flexible
+    def flexible
+      @flexible ||=
+        ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_FLEXIBLE', false))
+    end
+    alias flexible? flexible
+
+    # See documentation/redirects.md for the redirects feature.
+    attr_writer :redirects_enabled
+    def redirects_enabled?
+      return @redirects_enabled if defined?(@redirects_enabled) && !@redirects_enabled.nil?
+      @redirects_enabled = ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_REDIRECTS_ENABLED', false))
+    end
+    alias redirects_enabled redirects_enabled?
+
+    # @return [Boolean] true when both feature gates are open. Single
+    #   source of truth for "is the redirects feature actively in use
+    #   right now?". Short-circuits on the config so the Flipflop call
+    #   is safe (the :redirects feature is only registered when the
+    #   config is on; calling Flipflop.redirects? otherwise raises).
+    def redirects_active?
+      redirects_enabled? && Flipflop.redirects?
+    end
+
+    # Path prefixes that may not be claimed as redirect aliases (Hyrax::RedirectValidator
+    # rejects any redirect path equal to or starting with one of these). Defaults to the
+    # routes Hyrax itself reserves; adopters can extend the list to cover host-app routes:
+    #
+    #   Hyrax.config do |config|
+    #     config.reserved_redirect_prefixes += ['/single_signon', '/some_host_route']
+    #   end
+    #
+    # See documentation/redirects.md for the redirects feature.
+    attr_writer :reserved_redirect_prefixes
+    def reserved_redirect_prefixes # rubocop:disable Metrics/MethodLength
+      @reserved_redirect_prefixes ||= %w[
+        /.well-known
+        /admin
+        /api
+        /assets
+        /batch_edits
+        /batch_uploads
+        /capabilitylist
+        /catalog
+        /changelist
+        /collections
+        /concern
+        /content_blocks
+        /dashboard
+        /downloads
+        /embargoes
+        /featured_works
+        /files
+        /leases
+        /notifications
+        /pages
+        /proxies
+        /rails
+        /resourcelist
+        /uploads
+        /users
+      ]
+    end
+
+    # This value determines whether to use m3 flexible metadata for core classes or not
+    attr_writer :flexible_classes
+    def flexible_classes
+      flexible_env = ENV.fetch('HYRAX_FLEXIBLE_CLASSES', nil)
+      flexible_env = flexible_env.split(',').map(&:strip) if flexible_env
+      flexible_env ||= if flexible?
+                         [
+                           Hyrax.config.collection_model,
+                           Hyrax.config.file_set_model,
+                           Hyrax.config.admin_set_model
+                         ]
+                       else
+                         []
+                       end
+      @flexible_classes ||= flexible_env
+    end
+
+    def admin_set_flexible?
+      flexible_classes.include?(admin_set_model) || (admin_set_class.respond_to?(:flexible?) && admin_set_class.flexible?)
+    end
+
+    def collection_flexible?
+      flexible_classes.include?(collection_model) || (collection_class.respond_to?(:flexible?) && collection_class.flexible?)
+    end
+
+    def file_set_flexible?
+      flexible_classes.include?(file_set_model) || (file_set_class.respond_to?(:flexible?) && file_set_class.flexible?)
+    end
+
+    attr_writer :disable_include_metadata
+    def disable_include_metadata
+      @disable_include_metadata ||= ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_DISABLE_INCLUDE_METADATA', false))
+    end
+
     # This value determines whether to use load the Freyja adapter in dassie
     attr_writer :valkyrie_transition
     attr_reader :valkyrie_transition
@@ -318,6 +445,16 @@ module Hyrax
     def max_days_between_fixity_checks
       @max_days_between_fixity_checks ||= 7
     end
+
+    attr_writer :solr_rows_per_request
+    def solr_rows_per_request
+      @solr_rows_per_request ||= 1_000
+    end
+
+    attr_writer :solr_max_results
+    def solr_max_results
+      @solr_max_results ||= 10_000
+    end
     # @!endgroup
     # @!group Groups
 
@@ -387,6 +524,8 @@ module Hyrax
     attr_writer :iiif_info_url_builder
     attr_writer :iiif_metadata_fields
     attr_writer :iiif_manifest_cache_duration
+    attr_writer :iiif_manifest_factory
+    attr_writer :iiif_av_viewer
     attr_writer :rendering_predicate
 
     # Enable IIIF image service. This is required to use the
@@ -454,6 +593,25 @@ module Hyrax
       @iiif_manifest_cache_duration ||= 30.days.to_i
     end
 
+    ##
+    # Factory class for generating IIIF manifests
+    #
+    # @see Hyrax::ManifestBuilderService
+    #
+    # @return [Class]
+    def iiif_manifest_factory
+      @iiif_manifest_factory ||= ::IIIFManifest::ManifestFactory
+    end
+
+    ##
+    # A symbol that represents the viewer to render for AV items.
+    # Defaults to :universal_viewer but hopefully we can develop more options
+    #
+    # @return [:symbol] viewer partial name
+    def iiif_av_viewer
+      @iiif_av_viewer ||= :universal_viewer
+    end
+
     ##
     # Set predicate for rendering to dc:hasFormat as defined in
     # IIIF Presentation API context:  http://iiif.io/api/presentation/2/context.json
@@ -478,31 +636,31 @@ module Hyrax
     # Path on the local file system where derivatives will be stored
     attr_writer :derivatives_path
     def derivatives_path
-      @derivatives_path ||= ENV.fetch('HYRAX_DERIVATIVES_PATH', Rails.root.join('tmp', 'derivatives'))
+      @derivatives_path ||= Pathname.new(ENV.fetch('HYRAX_DERIVATIVES_PATH', Rails.root.join('tmp', 'derivatives')))
     end
 
     # Path on the local file system where originals will be staged before being ingested into Fedora.
     attr_writer :working_path
     def working_path
-      @working_path ||= ENV.fetch('HYRAX_UPLOAD_PATH', Rails.root.join('tmp', 'uploads'))
+      @working_path ||= Pathname.new(ENV.fetch('HYRAX_UPLOAD_PATH', Rails.root.join('tmp', 'uploads')))
     end
 
     # @todo do we use both upload_path and working path?
     # Path on the local file system where originals will be staged before being ingested into Fedora.
     attr_writer :upload_path
     def upload_path
-      @upload_path ||= ->() { ENV.fetch('HYRAX_UPLOAD_PATH') { Rails.root.join('tmp', 'uploads') } }
+      @upload_path ||= ->() { Pathname.new(ENV.fetch('HYRAX_UPLOAD_PATH') { Rails.root.join('tmp', 'uploads') }) }
     end
 
     attr_writer :cache_path
     def cache_path
-      @cache_path ||= ->() { ENV.fetch('HYRAX_CACHE_PATH') { Rails.root.join('tmp', 'cache') } }
+      @cache_path ||= ->() { Pathname.new(ENV.fetch('HYRAX_CACHE_PATH') { Rails.root.join('tmp', 'cache') }) }
     end
 
     # Path on the local file system where where log and banners will be stored.
     attr_writer :branding_path
     def branding_path
-      @branding_path ||= ENV.fetch('HYRAX_BRANDING_PATH', Rails.root.join('public', 'branding'))
+      @branding_path ||= Pathname.new(ENV.fetch('HYRAX_BRANDING_PATH', Rails.root.join('public', 'branding')))
     end
 
     # @!endgroup
@@ -857,6 +1015,35 @@ module Hyrax
       @admin_set_predicate ||= ::RDF::Vocab::DC.isPartOf
     end
 
+    ##
+    # @!attribute [rw] work_include_metadata
+    #   @return [Boolean] whether to include static metadata for works
+    attr_writer :work_include_metadata
+    def work_include_metadata
+      @work_include_metadata ||= disable_include_metadata ? false : true
+    end
+    alias work_include_metadata? work_include_metadata
+
+    ##
+    # @!attribute [rw] work_default_metadata
+    #   this is deprecated and will be removed in a future release
+    #   @return [Boolean] whether to include static metadata for works
+    attr_writer :work_default_metadata
+    def work_default_metadata
+      return @work_default_metadata if @work_default_metadata
+      @work_default_metadata ||= flexible? ? false : true
+      if @work_default_metadata
+        warning = <<-WARN
+          globally including `Hyrax::Schema(:core_metadata)` at the work level is deprecated.
+          Add `include Hyrax::Schema(:core_metadata)` to your individual work classes or set
+          up flexible metadata, then set `work_default_metadata = false` in config/hyrax.rb to remove this warning.
+        WARN
+        Deprecation.warn warning
+      end
+      @work_default_metadata
+    end
+    alias work_default_metadata? work_default_metadata
+
     attr_writer :work_requires_files
     def work_requires_files?
       return true if @work_requires_files.nil?
@@ -905,6 +1092,15 @@ module Hyrax
       collection_model.safe_constantize
     end
 
+    ##
+    # @!attribute [rw] collection_include_metadata
+    #   @return [Boolean] whether to include static metadata for collections
+    attr_writer :collection_include_metadata
+    def collection_include_metadata
+      @collection_include_metadata ||= disable_include_metadata ? false : true
+    end
+    alias collection_include_metadata? collection_include_metadata
+
     ##
     # @api private
     #
@@ -949,6 +1145,15 @@ module Hyrax
       Hyrax::AdministrativeSet
     end
 
+    ##
+    # @!attribute [rw] admin_set_include_metadata
+    #   @return [Boolean] whether to include static metadata for admin_sets
+    attr_writer :admin_set_include_metadata
+    def admin_set_include_metadata
+      @admin_set_include_metadata ||= disable_include_metadata ? false : true
+    end
+    alias admin_set_include_metadata? admin_set_include_metadata
+
     ##
     # @return [String] the default admin set id
     def default_admin_set_id
@@ -1155,7 +1360,9 @@ module Hyrax
       @visibility_map ||= Hyrax::VisibilityMap.instance
     end
 
-    attr_writer :simple_schema_loader_config_search_paths
+    attr_writer :schema_loader_config_search_paths
+    alias simple_schema_loader_config_search_paths= schema_loader_config_search_paths=
+    alias m3_schema_loader_config_search_paths= schema_loader_config_search_paths=
     # A configuration for modifying the SimpleSchemaLoader#config_search_paths
     # which will allow gems to add their own metadata yaml files and easily keep
     # them within the gem.
@@ -1169,9 +1376,11 @@ module Hyrax
     #
     #   Hyrax.config.simple_schema_loader_config_search_paths
     #   => [#<Pathname:/app/samvera>, #<Pathname:/app/samvera/hyrax-webapp>, #<Pathname:/app/samvera/hyrax-webapp/gems/hyrax>]
-    def simple_schema_loader_config_search_paths
-      @simple_schema_loader_config_search_paths ||= [Rails.root, Hyrax::Engine.root]
+    def schema_loader_config_search_paths
+      @schema_loader_config_search_paths ||= [Rails.root, Hyrax::Engine.root]
     end
+    alias simple_schema_loader_config_search_paths schema_loader_config_search_paths
+    alias m3_schema_loader_config_search_paths schema_loader_config_search_paths
 
     private
 

data/lib/hyrax/controlled_vocabulary/importer/language.rb

@@ -13,7 +13,11 @@ module Hyrax
           stdout_logger.formatter = proc do |_severity, _datetime, _progname, msg|
             "#{msg}\n"
           end
-          ActiveSupport::BroadcastLogger.new(Hyrax.logger, stdout_logger)
+          if Rails.version >= '7.1'
+            ActiveSupport::BroadcastLogger.new(Hyrax.logger, stdout_logger)
+          else
+            Hyrax.logger.extend(ActiveSupport::Logger.broadcast(stdout_logger))
+          end
         end
 
         def import

data/lib/hyrax/deprecation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # Provides version-specific deprecators for Hyrax
+  #
+  # @example Standard usage for next major version
+  #   Hyrax.deprecator.warn("This will be removed in Hyrax 6.0")
+  #
+  # @example Specific version targeting
+  #   Hyrax.deprecator(7).warn("This will be removed in Hyrax 7.0")
+  #
+  # @example Marking technical debt
+  #   Hyrax.deprecator(4).warn("This should have been removed in Hyrax 4.0")
+  def self.deprecator(major_version = nil)
+    @deprecators ||= {}
+
+    # Default to next major version if not specified
+    major_version ||= 6 # Update this when 6.0 is released
+
+    @deprecators[major_version] ||= begin
+      dep = ActiveSupport::Deprecation.new("#{major_version}.0", "Hyrax")
+      dep.behavior = Rails.application.config.active_support.deprecation
+      dep
+    end
+  end
+
+  # Alias for backwards compatibility
+  def self.deprecation
+    deprecator
+  end
+end

data/lib/hyrax/engine.rb

@@ -5,6 +5,7 @@ module Hyrax
 
     require 'almond-rails'
     require 'awesome_nested_set'
+    require 'blacklight_dynamic_sitemap'
     require 'breadcrumbs_on_rails'
     require 'clipboard/rails'
     require 'draper'
@@ -21,6 +22,7 @@ module Hyrax
     require 'valkyrie'
     require 'cancancan'
     require 'blacklight'
+    require 'json_schemer'
 
     require 'hydra/derivatives'
     require 'hyrax/active_fedora_dummy_model'

data/lib/hyrax/form_fields.rb

@@ -16,7 +16,7 @@ module Hyrax
   #
   # @see .FormFields
   class FormFields < Module
-    attr_reader :name
+    attr_reader :name, :version, :contexts
 
     ##
     # @api private
@@ -25,15 +25,17 @@ module Hyrax
     # @param [#form_definitions_for] definition_loader
     #
     # @note use Hyrax::FormFields(:my_schema) instead
-    def initialize(schema_name, definition_loader: SimpleSchemaLoader.new)
-      @name = schema_name
+    def initialize(schema_name, definition_loader: SimpleSchemaLoader.new, version: 1, contexts: nil)
+      @contexts = contexts
       @definition_loader = definition_loader
+      @name = schema_name
+      @version = version
     end
 
     ##
     # @return [Hash{Symbol => Hash{Symbol => Object}}]
     def form_field_definitions
-      @definition_loader.form_definitions_for(schema: name)
+      @definition_loader.form_definitions_for(schema: name, version:, contexts:)
     end
 
     ##
@@ -44,8 +46,10 @@ module Hyrax
 
     private
 
+    # rubocop:disable Metrics/MethodLength
     def included(descendant)
       super
+      return if @definition_loader.is_a?(Hyrax::M3SchemaLoader)
       form_field_definitions.each do |field_name, options|
         descendant.property field_name.to_sym, options.merge(display: options.fetch(:display, true), default: [])
         descendant.validates field_name.to_sym, presence: true if options.fetch(:required, false)
@@ -54,7 +58,15 @@ module Hyrax
       schema_name = name.to_s.camelcase
       behavior = "#{schema_name}FormFieldsBehavior".safe_constantize ||
                  "Hyrax::#{schema_name}FormFieldsBehavior".safe_constantize
-      descendant.include(behavior) if behavior
+      return unless behavior
+      warning = <<-WARN
+        Auto including a FormFieldsBehavior class based on name of the schema is depreciated.
+        We are removing it from Hyrax as it has proven hard to debug or trace.
+        Please include form field behaviors in your form classes directly.
+      WARN
+      Deprecation.warn warning
+      descendant.include(behavior)
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/hyrax/indexer.rb

@@ -18,9 +18,15 @@ module Hyrax
   #     include Hyrax::Indexer(:core_metadata)
   #   end
   #
+  # @example building a module as a mixin with flexible metadata
+  #
+  #   class MyIndexer < Hyrax::Indexers::ResourceIndexer
+  #     include Hyrax::Indexer(:MyResource, index_loader: M3SchemaLoader.new)
+  #   end
+  #
   # @since 3.0.0
   def self.Indexer(schema_name, index_loader: SimpleSchemaLoader.new)
-    Indexer.new(index_loader.index_rules_for(schema: schema_name))
+    Indexer.new(schema_name: schema_name, index_loader: index_loader)
   end
 
   ##
@@ -28,11 +34,34 @@ module Hyrax
   #
   # @see .Indexer
   class Indexer < Module
+    attr_accessor :schema_name, :index_loader
+
     ##
     # @param [Hash{Symbol => Symbol}] rules
-    def initialize(rules)
+    # @param [Symbol] schema_name
+    # @param [#index_rule_for] index_loader
+    #
+    # @return [Module]
+    def initialize(rules = nil, schema_name: nil, index_loader: nil)
+      super()
+      @schema_name = schema_name
+      @index_loader = index_loader
+      @rules = rules
+      define_solr_method(schema_name:, index_loader:)
+    end
+
+    def define_solr_method(schema_name:, index_loader:) # rubocop:disable Metrics/MethodLength
       define_method :to_solr do |*args|
         super(*args).tap do |document|
+          schema_args = if index_loader.is_a?(Hyrax::M3SchemaLoader)
+                          document['schema_version_ssi'] = resource.schema_version
+                          document['contexts_ssim'] = resource.contexts
+                          { schema: resource.class.name, version: resource.schema_version, contexts: resource.contexts }
+                        else
+                          { schema: schema_name }
+                        end
+          rules = @rules || index_loader.index_rules_for(**schema_args)
+
           rules.each do |index_key, method|
             document[index_key] = resource.try(method)
           end

data/lib/hyrax/resource_sync/resource_list_writer.rb

@@ -6,9 +6,12 @@ module Hyrax
     # items, so if we require more than that, we must have multiple Resource
     # lists and add a Resource List Index to point to all of them.
     class ResourceListWriter
+      Hyrax.deprecator.deprecate_methods(self, write: "Use BlacklightDynamicSitemap instead.")
       attr_reader :resource_host, :capability_list_url
 
       def initialize(resource_host:, capability_list_url:)
+        Hyrax.deprecator.warn("Hyrax::ResourceSync::ResourceListWriter is deprecated. Use BlacklightDynamicSitemap instead.")
+
         @resource_host = resource_host
         @capability_list_url = capability_list_url
       end

data/lib/hyrax/schema.rb

@@ -56,7 +56,16 @@ module Hyrax
     ##
     # @!attribute [r] name
     #   @return [Symbol]
-    attr_reader :name
+    attr_reader :name, :version, :contexts
+
+    ##
+    def self.m3_schema_loader
+      M3SchemaLoader.new
+    end
+
+    def self.simple_schema_loader
+      SimpleSchemaLoader.new
+    end
 
     ##
     # @param [Symbol] schema_name
@@ -64,15 +73,17 @@ module Hyrax
     # @note use Hyrax::Schema(:my_schema) instead
     #
     # @api private
-    def initialize(schema_name, schema_loader: SimpleSchemaLoader.new)
-      @name = schema_name
+    def initialize(schema_name, schema_loader: Hyrax::Schema.simple_schema_loader, schema_version: nil, contexts: [])
+      @name = schema_name.to_s
+      @version = schema_version || schema_loader.current_version
       @schema_loader = schema_loader
+      @contexts = contexts
     end
 
     ##
     # @return [Hash{Symbol => Dry::Types::Type}]
     def attributes
-      @schema_loader.attributes_for(schema: name)
+      @schema_loader.attributes_for(schema: name, version:, contexts:)
     end
 
     ##

data/lib/hyrax/specs/shared_specs/factories/administrative_sets.rb

@@ -15,6 +15,7 @@ FactoryBot.define do
 
     transient do
       with_permission_template { false }
+      with_active_workflow { false }
       user { FactoryBot.create(:user) }
       access_grants { [] }
       with_index { true }
@@ -34,6 +35,12 @@ FactoryBot.define do
 
       if evaluator.with_permission_template
         template = Hyrax::PermissionTemplate.find_or_create_by(source_id: admin_set.id.to_s)
+
+        if evaluator.with_active_workflow
+          workflow = create(:workflow, active: true, permission_template: template)
+          create(:workflow_action, workflow: workflow) # Need to create a single action that can be taken
+        end
+
         evaluator.access_grants.each do |grant|
           Hyrax::PermissionTemplateAccess.find_or_create_by(permission_template_id: template.id,
                                                             agent_type: grant[:agent_type],
@@ -59,6 +66,11 @@ FactoryBot.define do
     end
   end
 
+  trait :with_active_workflow do
+    with_active_workflow { true }
+    with_permission_template
+  end
+
   factory :invalid_hyrax_admin_set, class: 'Hyrax::AdministrativeSet' do
     # Title is required.  Without title, the admin set is invalid.
   end

data/lib/hyrax/specs/shared_specs/factories/hyrax_embargo.rb

@@ -16,7 +16,7 @@ FactoryBot.define do
     end
 
     trait :expired do
-      embargo_release_date { (Time.zone.today - 1).to_datetime }
+      embargo_release_date { (Time.zone.today).to_datetime }
     end
   end
 end

data/lib/hyrax/specs/shared_specs/factories/hyrax_file_set.rb

@@ -77,6 +77,19 @@ FactoryBot.define do
       end
     end
 
+    trait :with_expiring_enforced_lease do
+      after(:build) do |fs, _evaluator|
+        fs.lease = FactoryBot.valkyrie_create(:hyrax_lease, :expiring)
+      end
+
+      after(:create) do |fs, _evaluator|
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_return(10.days.ago)
+        Hyrax::LeaseManager.new(resource: fs).apply
+        fs.permission_manager.acl.save
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_call_original
+      end
+    end
+
     trait :with_expired_enforced_lease do
       after(:build) do |fs, _evaluator|
         fs.lease = FactoryBot.valkyrie_create(:hyrax_lease, :expired)

data/lib/hyrax/specs/shared_specs/factories/hyrax_lease.rb

@@ -15,8 +15,12 @@ FactoryBot.define do
       saved_instance
     end
 
+    trait :expiring do
+      lease_expiration_date { (Time.zone.today + 1).to_datetime }
+    end
+
     trait :expired do
-      lease_expiration_date { (Time.zone.today - 2).to_datetime }
+      lease_expiration_date { (Time.zone.today - 1.day).to_datetime }
     end
   end
 end

data/lib/hyrax/specs/shared_specs/factories/hyrax_work.rb

@@ -2,6 +2,7 @@
 
 ##
 # Use this factory for generic Hyrax/HydraWorks Works in valkyrie.
+# rubocop:disable Metrics/BlockLength
 FactoryBot.define do
   factory :hyrax_work, class: 'Hyrax::Test::SimpleWork' do
     trait :under_embargo do
@@ -35,6 +36,19 @@ FactoryBot.define do
       end
     end
 
+    trait :with_expiring_enforced_lease do
+      after(:build) do |work, _evaluator|
+        work.lease = FactoryBot.valkyrie_create(:hyrax_lease, :expiring)
+      end
+
+      after(:create) do |work, _evaluator|
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_return(10.days.ago)
+        Hyrax::LeaseManager.new(resource: work).apply
+        work.permission_manager.acl.save
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_call_original
+      end
+    end
+
     trait :with_expired_enforced_lease do
       after(:build) do |work, _evaluator|
         work.lease = FactoryBot.valkyrie_create(:hyrax_lease, :expired)