hyrax 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fa4543b3224a41244d522ea1eedff364bc5a611766952b7f75472c438b4fff1
-  data.tar.gz: 19c28428038b672908944c5ad30dd144eabc934e80ecfa5c1d080d6144e7df9d
+  metadata.gz: 865d623446e36dc64e73cf82ef855955e83d8d8f730a65f439b9b89664641c3f
+  data.tar.gz: 87aec067e009093bbd119d6d39639c5c6927b2b26173088ca7000b1241f71caa
 SHA512:
-  metadata.gz: 697a6d11f891fe1a0c42997fb80d49ab94810779745c7472670b9c32bd09d49283ceddb5736d1d5652efc9d5ac21e9dffb416fa2e75c300954c5cb529034a82c
-  data.tar.gz: efe3443f9e7e285713ff9c53661f5202748fc0613c9282dc07d834e8802c052a3551d617460d2b1975493b9ab065b0d9c66e9bfd0561fe1aef996821093f6526
+  metadata.gz: d75dbf03372ee072f394a88af8449ff947ff42b21de9b10a83428ac98af5d01783f21e7f123ee00e3c0dd7b6d3808d4e7d59f0238e1fda703da8358d2b567447
+  data.tar.gz: 6dae952fde3a2f2fdc329775d8efe14929e23c0f92284d1848abfa8a7a8a041e4b5a197a4fa0581d3934ddc9267d0e3ca64c455a5f65b81f5287bde8110fb19e

data/.dassie/.env

@@ -1,3 +1,4 @@
 MEMCACHED_HOST=memcached
 REDIS_PROVIDER=SIDEKIQ_REDIS_URL
-SIDEKIQ_REDIS_URL=redis://redis:6379/0
+SIDEKIQ_REDIS_URL=redis://redis:6379/0
+SEED_DASSIE=true

data/.dassie/db/seeds.rb

@@ -1,22 +1,77 @@
-# This file should contain all the record creation needed to seed the database with its default values.
-# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
-#
-# Examples:
-#
-#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
-#   Character.create(name: 'Luke', movie: movies.first)
+wipe_data = ActiveModel::Type::Boolean.new.cast(ENV.fetch('WIPE_DATA', false))
+seed_release_testing = ActiveModel::Type::Boolean.new.cast(ENV.fetch('SEED_RELEASE_TESTING', false))
+seed_dassie = ActiveModel::Type::Boolean.new.cast(ENV.fetch('SEED_DASSIE', false))
 
-Hyrax::Engine.load_seed unless ActiveModel::Type::Boolean.new.cast(ENV["SKIP_HYRAX_ENGINE_SEED"])
+unless wipe_data || seed_release_testing
+  puts 'NAME'
+  puts '     rails db:seed (Hyrax)'
+  puts
+  puts 'SYNOPSIS'
+  puts '     bundle exec rails db:seed [WIPE_DATA=true|false] [SEED_RELEASE_TESTING=true|false] [SEED_DASSIE=true|false]'
+  puts
+  puts 'DESCRIPTION'
+  puts '     Hyrax defined db:seed provides a means to clear repository metadata from the datastore (e.g. Fedora, Postgres) and from Solr.'
+  puts '     Seeds can be run to pre-populate metadata to help with release testing and local development testing.'
+  puts
+  puts '     NOTE: Options can be passed in with the command on the command line or set as ENV variables.'
+  puts
+  puts '     The options are as follows:'
+  puts
+  puts '     WIPE_DATA'
+  puts '             USE WITH CAUTION - Deleted data cannot be recovered.'
+  puts
+  puts '             When true, it will clear all repository metadata from the datastore (e.g. Fedora, Postgres) and from Solr.  It also'
+  puts '             clears data from the application database that are tightly coupled to repository metadata.  See Hyrax::DataMaintenance'
+  puts '             for more information on what data will be destroyed by this process.'
+  puts
+  puts '             The wipe_data process will also restore required repository metadata including collection types and the default admin'
+  puts '             set.  See Hyrax::RequiredDataSeeder for more information on what data will be created by this process.'
+  puts
+  puts '     SEED_RELEASE_TESTING'
+  puts '             When true, it will run the set of seeds for release testing creating a repository metadata and support data, including'
+  puts '             test users, collection types, collections, and works with and without files.  See Hyrax::TestDataSeeder for more information'
+  puts '             on what data will be created by this process.'
+  puts
+  puts '     SEED_DASSIE'
+  puts '             When true, it will run a minimal set of seeds for dassie test app, including required collection types, default admin set,'
+  puts '             and test users.'
+  puts
+  puts '     ALLOW_RELEASE_SEEDING_IN_PRODUCTION'
+  puts '             USE WITH EXTERME CAUTION WHEN USED IN PRODUCTION - Deleted data cannot be recovered.  Attempts are made to not overwrite'
+  puts '             existing data, but use in production is not recommended.'
+  puts
+  puts '             If this is NOT true, the process will abort when Rails environment is production.'
+  puts
+end
+
+allow_release_seeding_in_production = ActiveModel::Type::Boolean.new.cast(ENV.fetch('ALLOW_RELEASE_SEEDING_IN_PRODUCTION', false))
+
+if Rails.env == 'production' && !allow_release_seeding_in_production
+  puts "Seeding data for release testing is not for use in production!"
+  exit
+end
+
+if wipe_data
+  puts '####################################################################################'
+  puts
+  puts 'WARNING: You are about to clear all repository metadata from the datastore and solr.'
+  puts 'Are you sure? [YES|n]'
+  answer = STDIN.gets.chomp
+  unless answer == 'YES'
+    puts '   Aborting!'
+    puts '####################################################################################'
+    exit
+  end
 
-puts "\n== Loading users"
-User.where(email: 'admin@example.com').first_or_create do |f|
-  f.password = 'admin_password'
+  Hyrax::DataMaintenance.new.destroy_repository_metadata_and_related_data
+  Hyrax::RequiredDataSeeder.new.generate_seed_data
 end
 
-User.where(email: 'basic_user@example.com').first_or_create do |f|
-  f.password = 'password'
+if seed_dassie
+  Hyrax::RequiredDataSeeder.new.generate_seed_data
+  Hyrax::TestDataSeeders::UserSeeder.generate_seeds
 end
 
-User.where(email: 'another_user@example.com').first_or_create do |f|
-  f.password = 'password'
+if seed_release_testing
+  Hyrax::TestDataSeeder.new.generate_seed_data
 end

data/.github/release.yml

@@ -0,0 +1,26 @@
+changelog:
+  categories:
+    - title: Major Changes (Potentially breaking changes)
+      labels:
+        - notes-major
+    - title: New Features
+      labels:
+        - notes-minor
+    - title: Deprecations
+      labels:
+        - notes-deprecation
+    - title: Bug Fixes
+      labels:
+        - notes-bugfix
+    - title: Valkyrie Progress
+      labels:
+        - notes-valkyrie
+    - title: Documentation
+      labels:
+        - notes-docs
+    - title: Containerization
+      labels:
+        - notes-container
+    - title: Other
+      labels:
+        - "*"

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

@@ -171,7 +171,7 @@ module Hyrax
       # @return [Fixnum] the largest number of collections in a path nested
       #   under this collection (including this collection)
       def self.child_nesting_depth(child:, scope:)
-        return 1 if child.nil?
+        return 1 unless child
         # The nesting depth of a child collection is found by finding the largest nesting depth
         # among all collections and works which have the child collection in the paths, and
         # subtracting the nesting depth of the child collection itself.

data/app/utils/hyrax/data_destroyers/collection_branding_destroyer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Collection branding info is tightly coupled to collections.  When they are
+    # removed using wipe!, the associated database entries for collection branding
+    # also have to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    # @todo This destroys branding info in the database.  Should it also delete
+    #   related banner and logo files?
+    class CollectionBrandingDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("CollectionBrandingDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying collection branding...")
+
+          Hyrax::CollectionBrandingInfo.destroy_all
+          logger.info("   collection branding -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/collection_types_destroyer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Collection types are recreated by the release seed data.  Clear out here to
+    # start with a fresh set.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class CollectionTypesDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("CollectionTypesDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying collection types...")
+
+          Hyrax::CollectionType.destroy_all
+          logger.info("   collection types -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/default_admin_set_id_cache_destroyer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # When the default admin set is removed using wipe!, the cache of the default
+    # admin set id also needs to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class DefaultAdminSetIdCacheDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("DefaultAdminSetIdCacheDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying default admin set id cache...")
+
+          Hyrax::DefaultAdministrativeSet.destroy_all
+          logger.info("   default admin set id cache -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/featured_works_destroyer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Featured works are tightly coupled to works in the repository. When they
+    # are removed using wipe!, the associated database entries for featured
+    # works also need to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class FeaturedWorksDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("FeaturedWorksDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying featured works...")
+
+          FeaturedWork.destroy_all
+          logger.info("   featured works -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/permission_templates_destroyer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # PermissionTemplates are tightly coupled to admin sets and collections.
+    # When they are removed using wipe!, the associated database entries for
+    # permission templates also have to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class PermissionTemplatesDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("PermissionTemplatesDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying permission templates...")
+
+          Hyrax::PermissionTemplateAccess.destroy_all
+          logger.info("   permission templates access -- DESTROYED")
+
+          Hyrax::PermissionTemplate.destroy_all
+          logger.info("   permission templates -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/repository_metadata_destroyer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Clear all repository metadata from the datastore (e.g. Fedora, Postgres)
+    # and from Solr.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    # @note When using Wings adapter, which wraps ActiveFedora, the persister wipe!
+    #   method clears both Fedora and Solr.  Optionally, an index_adapter may also
+    #   be set to use Valkyrie to write to a second Solr core.  If the Hyrax index
+    #   adapter is the NullIndexingAdapter, that means that Valkyrie is not being
+    #   used to index the repository metadata and does not need to be cleared using
+    #   the Hyrax index adapter.
+    #
+    #   When using other Valkyrie persistence adapters, wipe! only clears the repository
+    #   metadata from the datastore (e.g. ORM table in Postgres).  The index adapter
+    #   is used to clear metadata from Solr.
+    #
+    class RepositoryMetadataDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_metadata(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("RepositoryMetadataDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying all repository metadata...")
+
+          unless Hyrax.index_adapter.is_a? Valkyrie::Indexing::NullIndexingAdapter
+            conn = Hyrax.index_adapter.connection
+            conn.delete_by_query('*:*', params: { 'softCommit' => true })
+          end
+          Hyrax.persister.wipe!
+
+          logger.info("   repository metadata -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/stats_destroyer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Stats are tightly coupled to works and files in the repository. When they
+    # are removed using wipe!, the associated database entries for stats also
+    # need to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class StatsDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("StatsDataDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying stats...")
+
+          FileDownloadStat.destroy_all
+          logger.info("   file download stats -- DESTROYED")
+
+          FileViewStat.destroy_all
+          logger.info("   file view stats -- DESTROYED")
+
+          WorkViewStat.destroy_all
+          logger.info("   work view stats -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_maintenance.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # These methods created for use in rake tasks and db/seeds.rb  They can be used to:
+  # * clear repository metadata and related data and files
+  # * clear temporary files
+  # * clear logs
+  #
+  # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+  #   Data can not be recovered.
+  #
+  class DataMaintenance
+    attr_accessor :logger, :allow_destruction_in_production
+
+    def initialize(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+      raise("Destruction of data is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+      @logger = logger
+      @allow_destruction_in_production = allow_destruction_in_production
+    end
+
+    # Clear repository metadata and related data
+    # * clear repository metadata from the datastore (e.g. Fedora, Postgres) and from Solr
+    # * clear targeted application data that is tightly coupled to repository metadata
+    # * delete files that are tightly coupled to repository metadata
+    def destroy_repository_metadata_and_related_data
+      Hyrax::DataDestroyers::RepositoryMetadataDestroyer.destroy_metadata(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::StatsDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::FeaturedWorksDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::PermissionTemplatesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::CollectionBrandingDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::DefaultAdminSetIdCacheDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::CollectionTypesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+
+      # TODO: Stubbed until RepositoryFilesDestroyer is written
+      # Hyrax::DataDestroyers::RepositoryFilesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+    end
+
+    # @todo write code to clear out log files
+    def destroy_log_files
+      # Stubbed until LogFilesDestroyer is written
+      # Hyrax::DataDestroyers::LogFilesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+    end
+
+    # @todo write code to delete tmp files
+    def destroy_tmp_files
+      # Stubbed until TmpFilesDestroyer is written
+      # Hyrax::DataDestroyers::TmpFilesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+    end
+  end
+end

data/app/utils/hyrax/required_data_seeder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Hyrax
+  # This class was created for use in rake tasks and db/seeds.rb.  It generates
+  # required repository metadata including Admin Set and User collection types and
+  # the default admin set.
+  #
+  # Seeders of required data are non-destructive.  If the data already exists,
+  # it will not be replaced.
+  class RequiredDataSeeder
+    attr_accessor :logger
+
+    def initialize(logger: Logger.new(STDOUT))
+      @logger = logger
+    end
+
+    def generate_seed_data
+      Hyrax::RequiredDataSeeders::CollectionTypeSeeder.generate_seeds(logger: logger)
+      Hyrax::RequiredDataSeeders::CollectionSeeder.generate_seeds(logger: logger)
+    end
+  end
+end

data/app/utils/hyrax/required_data_seeders/collection_seeder.rb

@@ -0,0 +1,26 @@
+
+
+# frozen_string_literal: true
+module Hyrax
+  module RequiredDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # collections that are required for all Hyrax applications.
+    #
+    # Seeders of required data are non-destructive.  If the data already exists,
+    # it will not be replaced.
+    class CollectionSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT))
+          @logger = logger
+
+          logger.info("Adding required collections...")
+
+          default_admin_set = Hyrax::AdminSetCreateService.find_or_create_default_admin_set
+          logger.info "   #{default_admin_set.title.first} -- FOUND OR CREATED"
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/required_data_seeders/collection_type_seeder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module Hyrax
+  module RequiredDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # collection types that are required for all Hyrax applications.
+    #
+    # Seeders of required data are non-destructive.  If the data already exists,
+    # it will not be replaced.
+    class CollectionTypeSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT))
+          @logger = logger
+
+          logger.info("Adding required collection types...")
+
+          as_ct = Hyrax::CollectionType.find_or_create_admin_set_type
+          set_badge_color(as_ct, '#990000')
+          logger.info("   #{as_ct.title} -- FOUND OR CREATED")
+
+          user_ct = Hyrax::CollectionType.find_or_create_default_collection_type
+          set_badge_color(user_ct, '#0099cc')
+          logger.info("   #{user_ct.title} -- FOUND OR CREATED")
+        end
+
+        private
+
+        def set_badge_color(collection_type, badge_color = nil)
+          collection_type.badge_color = badge_color
+          collection_type.save
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/test_data_seeder.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # This class was created for use in rake tasks and db/seeds.rb.  It generates
+  # repository metadata needed for release testing.  This data can also be helpful
+  # for local development testing.
+  class TestDataSeeder
+    attr_accessor :logger, :allow_seeding_in_production
+
+    def initialize(logger: Logger.new(STDOUT), allow_seeding_in_production: false)
+      raise("TestDataSeeder is not for use in production!") if Rails.env.production? && !allow_seeding_in_production
+      @logger = logger
+      @allow_seeding_in_production = allow_seeding_in_production
+    end
+
+    def generate_seed_data
+      Hyrax::TestDataSeeders::UserSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+      Hyrax::TestDataSeeders::CollectionTypeSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+      Hyrax::TestDataSeeders::CollectionSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+      # TODO: add work seeder
+      # Hyrax::TestDataSeeders::WorkSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+    end
+  end
+end

data/app/utils/hyrax/test_data_seeders/collection_seeder.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+module Hyrax
+  module TestDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # collection that can be used in release testing.  This data can also be helpful
+    # for local development testing.
+    #
+    # Adding collections is non-destructive.  But it may create an additional
+    # collection of the same.
+    #
+    # @todo Do we want to assume that if a collection of the same name exists, then
+    #   it is the collection we want for release testing?
+    class CollectionSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT), allow_seeding_in_production: false) # rubocop:disable Metrics/AbcSize
+          raise("TestDataSeeders are not for use in production!") if Rails.env.production? && !allow_seeding_in_production
+          @logger = logger
+
+          logger.info("Adding collections...")
+
+          create_collection("Grand Parent Collection", collection_types['Nestable only'])
+          create_collection("Parent Collection", collection_types['Nestable only'])
+          create_collection("Child Collection", collection_types['Nestable only'])
+          create_collection("Branded Collection", collection_types['Brandable only'])
+          create_collection("Discoverable Collection", collection_types['Discoverable only'])
+          create_collection("Shared", collection_types['Sharable only'])
+          create_collection("Share Applies to Works", collection_types['Sharable only (and works)'])
+          create_collection("(SM1) Single Membership Collection", collection_types['Single Membership 1'])
+          create_collection("(SM1) Another Single Membership Collection", collection_types['Single Membership 1'])
+          create_collection("(SM2) Single Membership Collection", collection_types['Single Membership 2'])
+          create_collection("(SM2) Another Single Membership Collection", collection_types['Single Membership 2'])
+        end
+
+        ##
+        # @api private
+        class NullUser
+          ##
+          # @return [nil]
+          def user_key
+            nil
+          end
+        end
+
+        private
+
+        def create_collection(title, collection_type_gid)
+          return unless valid_collection_type?(title, collection_type_gid)
+          return if exists?(title, collection_type_gid)
+
+          collection = Hyrax::PcdmCollection.new(title: title, collection_type_gid: collection_type_gid)
+          Hyrax.persister.save(resource: collection)
+          Hyrax.publisher.publish('collection.metadata.updated', collection: collection, user: seed_user)
+          logger.info("   #{collection.title.first} -- CREATED")
+        end
+
+        def seed_user
+          @seed_user ||= NullUser.new
+        end
+
+        def collection_types
+          @collection_types ||=
+            Hyrax::CollectionType.all
+                                 .each_with_object({}) { |ct, hsh| hsh[ct.title] = ct.to_global_id.to_s }
+        end
+
+        def valid_collection_type?(title, collection_type_gid)
+          return true if collection_type_gid.present? && collection_types.value?(collection_type_gid.to_s)
+
+          msg = "   #{title} -- NOT CREATED -- Collection type gid (#{collection_type_gid}) " \
+                  "is invalid or doesn't exist."
+          logger.info(msg)
+          false
+        end
+
+        def existing_collections
+          @existing_collections ||=
+            Hyrax.query_service.find_all_of_model(model: Hyrax::PcdmCollection)
+                 .each_with_object({}) { |col, hsh| hsh[col.title&.first] = col.collection_type_gid.to_s }
+        end
+
+        def exists?(title, collection_type_gid)
+          return false unless existing_collections[title] == collection_type_gid.to_s
+          logger.info("   #{title} -- ALREADY EXISTS")
+          true
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/test_data_seeders/collection_type_seeder.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module Hyrax
+  module TestDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # collection types that can be used in release testing.  This data can also be
+    # helpful for local development testing.
+    #
+    # Adding collection types is non-destructive.  If a collection type with the
+    # title already exists, it will not be replaced.
+    class CollectionTypeSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT), allow_seeding_in_production: false) # rubocop:disable Metrics/MethodLength
+          raise("TestDataSeeders are not for use in production!") if Rails.env.production? && !allow_seeding_in_production
+          @logger = logger
+
+          logger.info("Adding collection types...")
+
+          create_collection_type(title: "Nestable only", badge_color: "#282D3C", nestable: true,
+                                 description: "Collections of this type can be nested.")
+          create_collection_type(title: "Brandable only", badge_color: "#ff6600", brandable: true,
+                                 description: "Collections of this type can have branding images.")
+          create_collection_type(title: "Discoverable only", badge_color: "#00A170", discoverable: true,
+                                 description: "Collections of this type can have visibility settings modified.")
+          create_collection_type(title: "Sharable only", badge_color: "#ff0066", sharable: true, share_applies_to_new_works: false,
+                                 description: "Collections of this type are sharable.  Works " \
+                                              "do NOT inherit sharable settings when they are created.")
+          create_collection_type(title: "Sharable only (and works)", badge_color: "#0072B5", sharable: true, share_applies_to_new_works: true,
+                                 description: "Collections of this type are sharable.  Works " \
+                                              "inherit sharable settings when they are created.")
+          create_collection_type(title: "Single Membership 1", badge_color: "#b34700", allow_multiple_membership: false,
+                                 description: "This Single Membership 1 collection type restricts collection membership. " \
+                                              "Collections of this type do not allow works to live in multiple collections of this type.")
+          create_collection_type(title: "Single Membership 2", badge_color: "#926AA6", allow_multiple_membership: false,
+                                 description: "This Single Membership 2 collection type restricts collection membership. " \
+                                              "Collections of this type do not allow works to live in multiple collections of this type.")
+        end
+
+        private
+
+        def collection_type_titles
+          @collection_type_titles ||= Hyrax::CollectionType.all.map(&:title)
+        end
+
+        def create_collection_type(options = {})
+          title = options[:title]
+          return logger.info("   #{title} -- ALREADY EXISTS") if collection_type_titles.include? title
+
+          defaults_for_options(options)
+          Hyrax::CollectionType.new(options).save
+          logger.info("   #{title} -- CREATED")
+        end
+
+        def defaults_for_options(options = {})
+          options[:nestable] ||= false
+          options[:brandable] ||= false
+          options[:discoverable] ||= false
+          options[:sharable] ||= false
+          options[:share_applies_to_new_works] ||= false
+          options[:allow_multiple_membership] ||= true
+
+          # These should always false unless the collection type is Admin Set.
+          # Admin Set collection type is created by required_data_seeders
+          options[:require_membership] = false
+          options[:assigns_workflow] = false
+          options[:assigns_visibility] = false
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/test_data_seeders/user_seeder.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+module Hyrax
+  module TestDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # users that can be used in release testing.  This data can also be helpful
+    # for local development testing.
+    #
+    # Adding users is non-destructive.  If a user with the email already exists,
+    # they will not be replaced.
+    class UserSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT), allow_seeding_in_production: false)
+          raise("TestDataSeeders are not for use in production!") if Rails.env.production? && !allow_seeding_in_production
+          @logger = logger
+
+          logger.info("Adding users...")
+
+          add_user('admin@example.com', 'admin_password', admin_role)
+          add_user('basic_user@example.com', 'password')
+          add_user('another_user@example.com', 'password')
+        end
+
+        private
+
+        def admin_role
+          unless defined? Role
+            logger.warn("Cannot create `Role` because the `hyrda-role-management` gem, or " \
+                        "other gem providing a definition for a Role class, is not installed.  " \
+                        "For development, you can edit `config/role_map.yml` and add the user's " \
+                        "email under the role you want to assign.")
+            return
+          end
+          @admin_role ||= Role.find_by(name: Hyrax.config.admin_user_group_name)
+        end
+
+        def add_user(email, password, role = nil)
+          created = false
+          user = ::User.find_or_create_by(email: email) do |f|
+            created = true
+            f.password = password
+          end
+          logger.info("   #{email} -- #{created ? 'CREATED' : 'ALREADY EXISTS'}")
+          return unless role && !user.roles.include?(role)
+          user.roles << role
+          user.save
+        end
+      end
+    end
+  end
+end

data/app/views/hyrax/my/_facet_pagination.html.erb

@@ -1,13 +1,16 @@
-    <div class="prev_next_links btn-group pull-left">
-      <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), route_set: hyrax, params: search_state.to_h, param_name: Blacklight::Solr::FacetPaginator.request_keys[:page], class: 'btn btn-link', data: {ajax_modal: "preserve"} do %>
-       <span class="disabled btn btn-disabled"><%= raw(t('views.pagination.previous')) %></span>
-     <% end %>
-      <%= link_to_next_page @pagination, raw(t('views.pagination.next')), route_set: hyrax, params: search_state.to_h, param_name: Blacklight::Solr::FacetPaginator.request_keys[:page], class: 'btn btn-link',  data: {ajax_modal: "preserve"} do %>
+  <div class="prev_next_links btn-group pull-left">
+    <% if @pagination.first_page? %>
+      <span class="disabled btn btn-disabled"><%= raw(t('views.pagination.previous')) %></span>
+    <% else %>
+      <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), route_set: hyrax, params: search_state.to_h, param_name: Blacklight::Solr::FacetPaginator.request_keys[:page], class: 'btn btn-link', data: {ajax_modal: "preserve"} %>
+    <% end %>
 
-       <span class="disabled btn  btn-disabled"><%= raw(t('views.pagination.next')) %></span>
-      <% end %>
-
-    </div>
+    <% if @pagination.last_page? %>
+      <span class="disabled btn  btn-disabled"><%= raw(t('views.pagination.next')) %></span>
+    <% else %>
+      <%= link_to_next_page @pagination, raw(t('views.pagination.next')), route_set: hyrax, params: search_state.to_h, param_name: Blacklight::Solr::FacetPaginator.request_keys[:page], class: 'btn btn-link',  data: {ajax_modal: "preserve"} %>
+    <% end %>
+  </div>
 
   <div class="sort_options btn-group pull-right">
     <% if @pagination.sort == 'index' -%>

data/documentation/developing-your-hyrax-based-app.md

@@ -125,7 +125,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.4.0/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.4.1/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/documentation/legacyREADME.md

@@ -50,7 +50,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v3.4.0__. If you are looking for instructions on installing a different
+v3.4.1__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 

data/lib/hyrax/schema.rb

@@ -4,24 +4,27 @@ module Hyrax
   ##
   # @api public
   #
-  # Builds a schema module for a Valkyrie resource. The schema itself is
-  # resolved by schema loader, which must respond to
-  # `#attributes_for(schema: :name)` with a hash from attribute names to
-  # `Dry::Type` types.
+  # Builds a schema module for a +Valkyrie::Resource+. The schema itself is
+  # resolved by a schema loader instance, which must implement
+  # {SimpleSchemaLoader#attributes_for}, with a hash from attribute names to
+  # +Dry::Type+ types.
   #
   # For the default schema loader, configuration is loaded from
-  # `config/metadata/[name]}.yaml`. Custom schema loaders can be provided
-  # for other types.
+  # +config/metadata/{name}.yaml+. A custom schema loader can be provided as
+  # +:schema_loader+ to
+  # resolve the schema in other ways.
   #
-  # @note `Valkyrie::Resources`/`Hyrax::Resources` are not required to use this
-  # interface, and may define custom attributes using the base
-  # `Valkyrie::Resource.attribute` interface. This mechanism is provided to
-  # allow schemas to be defined in a unified way that don't require programmer
-  # intervention ("configurable schemas"). While the default usage defines
-  # schemas in application configuration, they could also be held in repository
-  # storage, an external schema service, etc... by using a custom schema loader.
+  # @note +Valkyrie::Resource+ and {Hyrax::Resource} classes are not required to
+  #   use this interface, and may define custom attributes using the base
+  #   +Valkyrie::Resource.attribute+ interface. This mechanism is provided to
+  #   allow schemas to be defined in a unified way that don't require programmer
+  #   intervention ("configurable schemas"). While the default schema loader derives
+  #   schemas from configuration files, alternate implementations could provide
+  #   schema definitions pulled from repository storage, an external schema service,
+  #   etc...
   #
   # @param [Symbol] schema_name
+  # @param [#attributes_for] schema_loader
   #
   # @return [Module] a module that, when included, applies a schema to a
   #   `Valkyire::Resource`

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '3.4.0'
+  VERSION = '3.4.1'
 end

data/lib/wings/valkyrie/persister.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'active_fedora/cleaner'
+
 module Wings
   module Valkyrie
     ##

data/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Hack for https://github.com/rails/rails/issues/35153
 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '3.4.0'
+gem 'hyrax', '3.4.1'
 run 'bundle install'
 generate 'hyrax:install', '-f'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -1461,6 +1461,7 @@ files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/SUPPORT.md"
+- ".github/release.yml"
 - ".github/stale.yml"
 - ".github/workflows/main.yml"
 - ".github/workflows/release.yml"
@@ -2271,6 +2272,21 @@ files:
 - app/strategies/hyrax/strategies/yaml_strategy.rb
 - app/uploaders/hyrax/avatar_uploader.rb
 - app/uploaders/hyrax/uploaded_file_uploader.rb
+- app/utils/hyrax/data_destroyers/collection_branding_destroyer.rb
+- app/utils/hyrax/data_destroyers/collection_types_destroyer.rb
+- app/utils/hyrax/data_destroyers/default_admin_set_id_cache_destroyer.rb
+- app/utils/hyrax/data_destroyers/featured_works_destroyer.rb
+- app/utils/hyrax/data_destroyers/permission_templates_destroyer.rb
+- app/utils/hyrax/data_destroyers/repository_metadata_destroyer.rb
+- app/utils/hyrax/data_destroyers/stats_destroyer.rb
+- app/utils/hyrax/data_maintenance.rb
+- app/utils/hyrax/required_data_seeder.rb
+- app/utils/hyrax/required_data_seeders/collection_seeder.rb
+- app/utils/hyrax/required_data_seeders/collection_type_seeder.rb
+- app/utils/hyrax/test_data_seeder.rb
+- app/utils/hyrax/test_data_seeders/collection_seeder.rb
+- app/utils/hyrax/test_data_seeders/collection_type_seeder.rb
+- app/utils/hyrax/test_data_seeders/user_seeder.rb
 - app/validators/hyrax/collection_membership_validator.rb
 - app/validators/hyrax/has_one_title_validator.rb
 - app/values/hyrax/chart_data.rb