hyrax 4.0.0.rc2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24e7e9d00de4eebd2f2dfaf96bcd1a09ac9589b17e94ddcc0bf5681d3c93b0c4
-  data.tar.gz: 92753b2fbb1271cfec93e2eddd07d11da1091eaf8b36494e754ac3400a83a6a1
+  metadata.gz: c53f04239ef92492dd8a98a52c8f13cb446c18ba4ad04d22e5b78673e688aa8c
+  data.tar.gz: a804bc525628fbe33352617f8f8c0074d454def18a5e90c4d82e6c6a46aa25c2
 SHA512:
-  metadata.gz: 16a328b5b11d826f8149f0b260675ffe913d7e41a4b5c37035696cb32741b650a9f4bf9fa0d70ed08a1be712ddc8b452824bfb5be60a99b1a9d52ead57d8b7f3
-  data.tar.gz: bff8a0b37d073e1014f9566472030bb2b22e16a19fc1413dec6405cf21d6c3f178b0644ecbb48ee8ed0d259fe4f1b0422e747a5f3192c63753dc76d89ba8cb33
+  metadata.gz: 968a88b13e65cc3f88d30c142d4a69d39e5e21930c04a03f86af4ec2625443741da5e73662db261dc5758e770e669b521b866a1274d5d0bdfba8fcd2ef1b05c0
+  data.tar.gz: aa1568f4a0b53f442682f87721dc4c7d458716af085df77ef3523eedae5e0e663bf708f04ef6a02f06ddf3aa143d4fd73fe513f6bbe23b1e43402438abc10ff1

data/.dassie/Gemfile

@@ -8,8 +8,6 @@ else
 end
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '3.2.1'
-
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.0'
 # Use postgresql as the database for Active Record

data/.dassie/config/analytics.yml

@@ -3,11 +3,11 @@ analytics:
     analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
     app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME'] %>
     app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION'] %>
+    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE'] %>
     privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
     privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
     client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL'] %>
-  matomo: 
+  matomo:
     base_url: <%= ENV['MATOMO_BASE_URL'] %>
     site_id: <%= ENV['MATOMO_SITE_ID'] %>
     auth_token: <%= ENV['MATOMO_AUTH_TOKEN'] %>
-    

data/.dassie/config/initializers/redis_config.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 require 'redis'
+require 'connection_pool'
 config = YAML.safe_load(ERB.new(IO.read(Rails.root.join('config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
-Redis.current = Redis.new(config.merge(thread_safe: true))
+
+size = ENV.fetch("HYRAX_REDIS_POOL_SIZE", 5)
+timeout = ENV.fetch("HYRAX_REDIS_TIMEOUT", 5)
+
+Hyrax.config.redis_connection =
+  ConnectionPool::Wrapper.new(size: size, timeout: timeout) { Redis.new(config) }

data/.github/ISSUE_TEMPLATE.md

@@ -1,20 +1,25 @@
 ### Descriptive summary
 
-Include what version of Hyrax relates to this issue (7.x, 6.x, HEAD, etc.) if appropriate, and any relevant tracebacks if you're reporting a bug.
+Present tense short summary (30 words or less)
 
-### Rationale
+### Steps to reproduce the behavior in User Interface (UI)
 
-Provide the rationale or user story that describes "why" this issue should be addressed. Especially if this is a new feature or significant change to the existing implementation.
+1. Do this
+2. Then do this...
+3. Include note here if not testable in UI
 
-### Expected behavior
+### Actual behavior (include screenshots if available)
 
-### Actual behavior
+Include what version of Hyrax relates to this issue (3.x, 4.x, main branch, etc.) if appropriate, and any relevant error messages/tracebacks if you're reporting a bug.
 
-### Steps to reproduce the behavior
+### Acceptance Criteria/Expected Behavior
 
-1. Do this
-2. Then do this...
+- [ ] Create checkbox list of what done looks like...
+
+### Rationale (for feature request only)
+
+Provide the rationale or user story that describes "why" this issue should be addressed. Especially if this is a new feature or significant change to the existing implementation.
 
 ### Related work
 
-Link to related tickets or prior related work here.
+Link to related issues or prior related work here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,28 @@
+### Fixes
+
 Fixes #issuenumber ; refs #issuenumber
 
+### Summary
+
 Present tense short summary (50 characters or less)
 
+### Guidance for testing, such as acceptance criteria or new user interface behaviors:
+*
+*
+*
+
+### Type of change (for release notes)
+
+- [ ] Major Changes (Potentially breaking changes)
+- [ ] New Features
+- [ ] Deprecations
+- [ ] Bug Fixes
+- [ ] Valkyrie Progress
+- [ ] Documentation
+- [ ] Containerization
+
+### Detailed Description
+
 More detailed description, if necessary. Try to be as descriptive as you can: even if you think that the PR content is obvious, it may not be obvious to others. Include tracebacks if helpful, and be sure to call out any bits of the PR that may be work-in-progress.
 
 Description can have multiple paragraphs and you can use code examples inside:
@@ -14,12 +35,7 @@ class PostsController
 end
 ```
 
-Changes proposed in this pull request:
-*
-*
-*
-
-Guidance for testing, such as acceptance criteria or new user interface behaviors:
+### Changes proposed in this pull request:
 *
 *
 *

data/.koppie/Gemfile

@@ -6,8 +6,6 @@ else
 end
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.7.7'
-
 gem 'bootsnap', '>= 1.1.0', require: false
 gem 'bootstrap', '~> 4.0'
 gem 'coffee-rails', '~> 4.2'

data/.koppie/README.md

@@ -1,18 +1,18 @@
 # Koppie
 
-> Isolated granite outcrops in Southern Africa that are a favored habitat for hyraxes. 
+> Isolated granite outcrops in Southern Africa that are a favored habitat for hyraxes.
 
 Koppie is an application used for testing the state of [Hyrax](https://github.com/samvera/hyrax)
-using Postgres as the metadata store for objects.  This is similar to the Dassie test application 
+using Postgres as the metadata store for objects.  This is similar to the Dassie test application
 that lives in `.dassie`, however in this application Fedora is
-not used for storing object metadata or files. The Hyrax gem is sourced from the local hyrax 
+not used for storing object metadata or files. The Hyrax gem is sourced from the local hyrax
 directory one level up from `.koppie` for development purposes.
 
 ## Known Issues
 
 Collection model
 * `/app/models/collection.rb` - is_a `ActiveFedora::Base`
-* if `Collection` is changed to `Valkyrie::Resource`, there is an infinite loop while loading 
+* if `Collection` is changed to `Valkyrie::Resource`, there is an infinite loop while loading
   due to reference to ::Collection in `lib/hyrax/collection_name.rb` in the hyrax engine
 
 Default Admin Set
@@ -21,14 +21,14 @@ Default Admin Set
 
 ## Questions
 
-Please direct questions about this code or the servers where it runs to the `#hyrax-valkyrie` 
+Please direct questions about this code or the servers where it runs to the `#hyrax-valkyrie`
 channel on Samvera slack.
 
 ## Contributing
 
 If you're working on a PR for this project, create a feature branch off of `main`.
 
-This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) 
+This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct)
 and [language recommendations](https://github.com/samvera/maintenance/blob/master/templates/CONTRIBUTING.md#language).
 Please ***do not*** create a branch called `master` for this repository or as part of your pull request; the branch will
 either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.
@@ -46,10 +46,10 @@ git clone https://github.com/samvera/hyrax.git
 Execute the following commands from the hyrax root to start the app using Docker.
 
 ```
-docker-compose -f docker-compose-koppie.yml build
-docker-compose -f docker-compose-koppie.yml up
+docker compose -f docker-compose-koppie.yml build
+docker compose -f docker-compose-koppie.yml up
 ```
 
-You can find help with additional commands in Hyrax' [FAQ-for-Dassie-Docker-Test-App](https://github.com/samvera/hyrax/wiki/FAQ-for-Dassie-Docker-Test-App).  
-Most commands can be used directly as described in the FAQ.  A few might require 
-a slight adjustment to work with koppie as a Docker app. 
+You can find help with additional commands in Hyrax' [FAQ-for-Dassie-Docker-Test-App](https://github.com/samvera/hyrax/wiki/FAQ-for-Dassie-Docker-Test-App).
+Most commands can be used directly as described in the FAQ.  A few might require
+a slight adjustment to work with koppie as a Docker app.

data/.koppie/config/analytics.yml

@@ -3,6 +3,7 @@ analytics:
     analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
     app_name: <%= ENV.fetch('GOOGLE_OAUTH_APP_NAME', 'nurax-pg') %>
     app_version: <%= ENV.fetch['GOOGLE_OAUTH_APP_VERSION'] %>
+    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE'] %>
     privkey_path: <%= ENV.fetch['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
     privkey_secret: <%= ENV.fetch['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
     client_email: <%= ENV.fetch['GOOGLE_OAUTH_CLIENT_EMAIL'] %>

data/.koppie/config/initializers/redis_config.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 require 'redis'
+require 'connection_pool'
 config = YAML.safe_load(ERB.new(IO.read(Rails.root.join('config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
-Redis.current = Redis.new(config.merge(thread_safe: true))
+
+size = ENV.fetch("HYRAX_REDIS_POOL_SIZE", 5)
+timeout = ENV.fetch("HYRAX_REDIS_TIMEOUT", 5)
+
+Hyrax.config.redis_connection =
+  ConnectionPool::Wrapper.new(size: size, timeout: timeout) { Redis.new(config) }

data/.regen

@@ -1,2 +1,2 @@
 # When updating CI regen seed, set to current date.
-2023-04-11T16:25:55
+2023-05-24T10:43:07

data/CONTAINERS.md

@@ -13,7 +13,7 @@ There are two options for development environments to run:
 <!-- NOTE: This title is referenced in the top-level README.md. Keep that in mind if you change it. -->
 ## Hyrax Engine Development
 
-We support a `docker-compose`-based development environment for folks working on
+We support a `docker compose`-based development environment for folks working on
 the Hyrax engine. This environment is substantially more like a Hyrax production
 setup than the older `fedora_wrapper`/`solr_wrapper` approach.
 
@@ -24,8 +24,8 @@ First, make sure you have installed [Docker](https://www.docker.com/).  Then clo
 Within your cloned repository, tell Docker to get started installing your development environment:
 
 ```sh
-docker-compose build
-docker-compose up
+docker compose build
+docker compose up
 ```
 
 This starts containers for:
@@ -40,24 +40,24 @@ This starts containers for:
 
 It also runs database migrations. This will also bring up a development application on `http://localhost:3000`.
 
-To stop the containers for the Hyrax-based application, type <kbd>Ctrl</kbd>+<kbd>c</kbd>. To restart the containers you need only run `docker-compose up`.
+To stop the containers for the Hyrax-based application, type <kbd>Ctrl</kbd>+<kbd>c</kbd>. To restart the containers you need only run `docker compose up`.
 
 _**Note:** Starting and stopping Docker in this way will preserve your data between restarts._
 
 #### Code Changes and Testing
 
-With `docker-compose up` running, any changes you make to your cloned Hyrax code-base should show up in `http://localhost:3000`; There may be cases where you need to restart your test application (e.g. stop the containers and start them up again).
+With `docker compose up` running, any changes you make to your cloned Hyrax code-base should show up in `http://localhost:3000`; There may be cases where you need to restart your test application (e.g. stop the containers and start them up again).
 
 Any changes you make to Hyrax should be tested. You can run the full test suite using the following command:
 
 ```sh
-docker-compose exec -w /app/samvera/hyrax-engine app sh -c "bundle exec rspec"
+docker compose exec -w /app/samvera/hyrax-engine app sh -c "bundle exec rspec"
 ```
 
 Let's break down the above command:
 
 <dl>
-<dt><code>docker-compose exec</code></dt>
+<dt><code>docker compose exec</code></dt>
 <dd>Tell docker to run the following:</dd>
 <dt><code>-w /app/samvera/hyrax-engine</code></dt>
 <dd>In the working directory "/app/samvera/hyrax-engine" (e.g. your cloned Hyrax repository)</dd>
@@ -86,13 +86,13 @@ bind mount to `/app/samvera/hyrax-webapp`, and your local development copy of Hy
 What does this structure mean? Let's look at an example. The following command will list the rake tasks for the Hyrax-based application running in Docker:
 
 ```sh
-docker-compose exec -w /app/samvera/hyrax-webapp app sh -c "bundle exec rake -T"
+docker compose exec -w /app/samvera/hyrax-webapp app sh -c "bundle exec rake -T"
 ```
 
 And this command lists the rake tasks for the Hyrax engine that is in Docker:
 
 ```sh
-docker-compose exec -w /app/samvera/hyrax-engine app sh -c "bundle exec rake -T"
+docker compose exec -w /app/samvera/hyrax-engine app sh -c "bundle exec rake -T"
 ```
 
 In the two examples, note the difference in the `-w` switch. In the first case, it's referencing the Hyrax-based application. In the latter case, it's referencing the Hyrax engine.
@@ -101,7 +101,7 @@ In the two examples, note the difference in the `-w` switch. In the first case,
 
 If you are interested in running Hyrax in debug mode, this requires a somewhat different approach than running Hyrax bare-metal.  You need to use `docker attach` to debug the running docker instance.
 
-1. With `docker-compose up` running open a new Terminal session.
+1. With `docker compose up` running open a new Terminal session.
 2. In that new Terminal session, using `docker container ls` find the "CONTAINER ID" for the `hyrax-engine-dev`.
 3. With the "CONTAINER ID", run `docker attach <CONTAINER ID>`.
 
@@ -111,7 +111,7 @@ This advice comes from [Debugging Rails App With Docker Compose: How to use Byeb
 
 ##### Bad Address SOLR
 
-With `docker-compose up` running, if you see the following, then there may be issues with file permissions:
+With `docker compose up` running, if you see the following, then there may be issues with file permissions:
 
 ```
 db_migrate_1  | waiting for solr:8983
@@ -125,15 +125,15 @@ Executing /opt/docker-solr/scripts/precreate-core hyrax_test /opt/solr/server/co
 cp: cannot create directory '/var/solr/data/hyrax_test': Permission denied
 ```
 
-The solution that appears to work is to `docker-compose down --volumes`; This will tear down the docker instance, and remove the volumes.  You can then run `docker-compose up` to get back to work.  _**Note:** the `--volumes` switch will remove all custom data._
+The solution that appears to work is to `docker compose down --volumes`; This will tear down the docker instance, and remove the volumes.  You can then run `docker compose up` to get back to work.  _**Note:** the `--volumes` switch will remove all custom data._
 
 ##### Errors building the Docker image
 
-If you encounter errors running `docker-compose build`, try running `bundle update` in `./hyrax` as well as within `./hyrax/.dassie`. That can help clear up the problem of a failure to build a particular gem.
+If you encounter errors running `docker compose build`, try running `bundle update` in `./hyrax` as well as within `./hyrax/.dassie`. That can help clear up the problem of a failure to build a particular gem.
 
 ##### Containers do not all start
 
-If any of the services fail to start on `docker-compose up`, try clearing out any `Gemfile.lock` files that might exist in `./hyrax` or `./hyrax/.dassie` and run `docker-compose build` again, then `docker-compose up` again.
+If any of the services fail to start on `docker compose up`, try clearing out any `Gemfile.lock` files that might exist in `./hyrax` or `./hyrax/.dassie` and run `docker compose build` again, then `docker compose up` again.
 
 ### Koppie Internal Test App with Valkyrie Connector to Postgres
 
@@ -191,7 +191,7 @@ We publish several Hyrax images to the [GitHub container registry][ghcr] under
 the [Samvera organization][samvera-packages].  To build them:
 
 ```sh
-export HYRAX_VERSION=v4.0.0.rc2 # or desired version
+export HYRAX_VERSION=v4.0.0 # or desired version
 git checkout hyrax-$HYRAX_VERSION
 
 docker build --target hyrax-base --tag ghcr.io/samvera/hyrax/hyrax-base:$(git rev-parse HEAD) .

data/README.md

@@ -42,7 +42,7 @@ Hyrax offers the ability to:
 
 More detailed documentation about Hyrax is available on the [Hyrax Github Wiki](https://github.com/samvera/hyrax/wiki) but if you have questions or need help, please email the [Samvera community tech list](https://samvera.atlassian.net/wiki/spaces/samvera/pages/1171226735/Samvera+Community+Email+Lists#Samvera-Tech-(15-20-messages-per-week-on-average)) or stop by the #dev channel in the [Samvera community Slack team](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211682/Getting+Started+in+the+Samvera+Community#Join-the-Samvera-Slack-workspace). You can also get in touch with the [Hyrax Maintenance Working Group](https://samvera.atlassian.net/wiki/spaces/samvera/pages/496632295/Hyrax+Maintenance+Working+Group), including the Hyrax Product Owner and Hyrax Tech Lead.
 
-[Reporting Issues](./.github/SUPPORT.md) 
+[Reporting Issues](./.github/SUPPORT.md)
 
 ## How to Run the Code
 
@@ -79,4 +79,4 @@ This software has been developed by and is brought to you by the Samvera communi
 
 ## License
 
-Hyrax is available under [the Apache 2.0 license](LICENSE).
+Hyrax is available under [the Apache 2.0 license](LICENSE).

data/app/builders/hyrax/bootstrap_breadcrumbs_builder.rb

@@ -12,7 +12,7 @@ class Hyrax::BootstrapBreadcrumbsBuilder < BreadcrumbsOnRails::Breadcrumbs::Buil
   def render
     return "" if @elements.blank?
 
-    @context.tag.nav(breadcrumbs_options) do
+    @context.tag.nav(**breadcrumbs_options) do
       @context.tag.ol do
         safe_join(@elements.uniq.collect { |e| render_element(e) })
       end

data/app/services/hyrax/analytics/google.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
+
 require 'oauth2'
 require 'signet/oauth_2/client'
 
-# rubocop:disable Metrics/ModuleLength
 module Hyrax
   module Analytics
+    # rubocop:disable Metrics/ModuleLength
     module Google
       extend ActiveSupport::Concern
       # rubocop:disable Metrics/BlockLength
       class_methods do
-        # Loads configuration options from config/analytics.yml. Expected structure:
+        # Loads configuration options from config/analytics.yml. You only need PRIVATE_KEY_PATH or
+        # PRIVATE_KEY_VALUE. VALUE takes precedence.
+        # Expected structure:
         # `analytics:`
         # `  google:`
         # `    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
         # `    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
         # `    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
+        # `    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE']`
         # `    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
         # `    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
         # @return [Config]
@@ -41,7 +45,8 @@ module Hyrax
             new config
           end
 
-          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_path privkey_secret client_email].freeze
+          KEYS = %w[analytics_id app_name app_version privkey_path privkey_value privkey_secret client_email].freeze
+          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_secret client_email].freeze
 
           def initialize(config)
             @config = config
@@ -49,18 +54,16 @@ module Hyrax
 
           # @return [Boolean] are all the required values present?
           def valid?
-            config_keys = @config.keys
-            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
-          end
+            return false unless @config['privkey_value'].present? || @config['privkey_path'].present?
 
-          REQUIRED_KEYS.each do |key|
-            class_eval %{ def #{key};  @config.fetch('#{key}'); end }
+            REQUIRED_KEYS.all? { |required| @config[required].present? }
           end
 
-          # This method allows setting the analytics id in the initializer
-          # @deprecated set the analytics id in either ENV['GOOGLE_ANALYTICS_ID'] or config/analytics.yaml
-          def analytics_id=(value)
-            @config['analytics_id'] = value
+          KEYS.each do |key|
+            # rubocop:disable Style/EvalWithLocation
+            class_eval %{ def #{key}; @config.fetch('#{key}'); end }
+            class_eval %{ def #{key}=(value); @config['#{key}'] = value; end }
+            # rubocop:enable Style/EvalWithLocation
           end
         end
 
@@ -77,8 +80,12 @@ module Hyrax
         end
 
         def auth_client(scope)
-          raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
-          private_key = File.read(config.privkey_path)
+          private_key = Base64.decode64(config.privkey_value) if config.privkey_value.present?
+          if private_key.blank?
+            raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
+
+            private_key = File.read(config.privkey_path)
+          end
           Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
                                      audience: 'https://accounts.google.com/o/oauth2/token',
                                      scope: scope,
@@ -123,7 +130,7 @@ module Hyrax
 
           [start_date, end_date]
         end
-        # rubocop:enabl e Metrics/MethodLength
+        # rubocop:enable Metrics/MethodLength
 
         def keyword_conversion(date)
           case date
@@ -199,6 +206,7 @@ module Hyrax
       end
       # rubocop:enable Metrics/BlockLength
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end
 # rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/analytics/matomo.rb

@@ -11,15 +11,16 @@ module Hyrax
         # Loads configuration options from config/analytics.yml. Expected structure:
         # `analytics:`
         # `  matomo:`
-        # `    base_url: <%= ENV['MATOMOT_BASE_URL']`
-        # `    site_id: <%= ENV['MATOMOT_SITE_ID']`
-        # `    auth_token: <%= ENV['MATOMOT_AUTH_TOKEN']`
+        # `    base_url: <%= ENV['MATOMO_BASE_URL']`
+        # `    site_id: <%= ENV['MATOMO_SITE_ID']`
+        # `    auth_token: <%= ENV['MATOMO_AUTH_TOKEN']`
         # @return [Config]
         def config
           @config ||= Config.load_from_yaml
         end
 
         class Config
+          # TODO: test matomo and see if it needs any of the updates from https://github.com/samvera/hyrax/pull/6063
           def self.load_from_yaml
             filename = Rails.root.join('config', 'analytics.yml')
             yaml = YAML.safe_load(ERB.new(File.read(filename)).result)

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

@@ -80,10 +80,7 @@ module Hyrax
           files =
             query_service.custom_queries.find_many_file_metadata_by_use(resource: file_set, use: use)
 
-          raise Valkyrie::Persistence::ObjectNotFoundError, "FileSet #{file_set.id}'s #{use.fragment} is missing." if
-            files.empty?
-
-          files.first
+          files.first || raise(Valkyrie::Persistence::ObjectNotFoundError, "FileSet #{file_set.id}'s #{use.fragment} is missing.")
         end
       end
     end

data/app/services/hyrax/lock_manager.rb

@@ -4,24 +4,54 @@ module Hyrax
   class LockManager
     class UnableToAcquireLockError < StandardError; end
 
-    attr_reader :client
-
+    ##
     # @param [Fixnum] time_to_live How long to hold the lock in milliseconds
     # @param [Fixnum] retry_count How many times to retry to acquire the lock before raising UnableToAcquireLockError
     # @param [Fixnum] retry_delay Maximum wait time in milliseconds before retrying. Wait time is a random value between 0 and retry_delay.
     def initialize(time_to_live, retry_count, retry_delay)
       @ttl = time_to_live
-      @client = Redlock::Client.new([Redis.current], retry_count: retry_count, retry_delay: retry_delay)
+      @retry_count = retry_count
+      @retry_delay = retry_delay
     end
 
+    ##
     # Blocks until lock is acquired or timeout.
     def lock(key)
       returned_from_block = nil
-      client.lock(key, @ttl) do |locked|
-        raise UnableToAcquireLockError unless locked
-        returned_from_block = yield
+
+      pool.then do |conn|
+        client(conn).lock(key, @ttl) do |locked|
+          raise UnableToAcquireLockError unless locked
+          returned_from_block = yield
+        end
       end
+
       returned_from_block
+    rescue ConnectionPool::TimeoutError => err
+      Hyrax.logger.error(err.message)
+      raise(ConnectionPool::TimeoutError,
+            "Failed to aquire a lock from Redlock due to a Redis connection " /
+            "timeout: #{err}. If you are using Redis via `ConnectionPool` " /
+            "you may wish to increase the pool size.")
+    end
+
+    private
+
+    ##
+    # @api_private
+    def client(conn)
+      Redlock::Client.new([conn], retry_count: @retry_count, retry_delay: @retry_delay)
+    end
+
+    ##
+    # @api private
+    #
+    # @note support both a ConnectionPool and a raw Redis client for now.
+    #   we should drop support for `Redis.current` in 5.0.0.
+    #   `#then` supports both options. for a ConnectionPool it will block
+    #   until a connection is available.
+    def pool
+      Hyrax.config.redis_connection || Redis.current
     end
   end
 end

data/app/views/hyrax/base/_form_files.html.erb

@@ -4,9 +4,14 @@
         <!-- The table listing the files available for upload/download -->
         <table role="presentation" class="table table-striped"><tbody class="files"></tbody></table>
         <% if Hyrax.config.browse_everything? %>
-          <%= t('hyrax.base.form_files.local_upload_browse_everything_html', contact_href: link_to(t("hyrax.upload.alert.contact_href_text"), hyrax.contact_form_index_path)) %>
+          <%= t('hyrax.base.form_files.local_upload_browse_everything_html',
+                contact_href: link_to(t("hyrax.upload.alert.contact_href_text"), hyrax.contact_form_index_path),
+                upload_file_limit: Hyrax.config.uploader[:maxNumberOfFiles],
+                upload_size_limit: Hyrax.config.uploader[:maxFileSize] / 1.megabytes) %>
         <% else %>
-          <%= t('hyrax.base.form_files.local_upload_html') %>
+          <%= t('hyrax.base.form_files.local_upload_html',
+                upload_file_limit: Hyrax.config.uploader[:maxNumberOfFiles],
+                upload_size_limit: Hyrax.config.uploader[:maxFileSize] / 1.megabytes) %>
         <% end %>
         <!-- The fileupload-buttonbar contains buttons to add/delete files and start/cancel the upload -->
         <div class="fileupload-buttonbar">

data/app/views/hyrax/file_sets/_versioning.html.erb

@@ -41,7 +41,7 @@
                    name: "update_versioning",
                    id: "upload_submit",
                    onclick: "confirmation_needed = false;",
-                   class: "btn btn-primary" do %>
+                   class: "btn btn-primary text-white" do %>
         <%= t('.upload') %>
       <% end %>
 

data/app/views/layouts/hyrax/dashboard.html.erb

@@ -16,7 +16,7 @@
         <%= render 'hyrax/dashboard/sidebar' %>
       </div>
       <div class="main-content maximized<%= " admin-stats" if request.fullpath.include? '/admin/stats' %>">
-        <%= render_breadcrumbs builder: Hyrax::BootstrapBreadcrumbsBuilder %>
+        <%= render_breadcrumbs builder: Hyrax.config.breadcrumb_builder %>
         <%= render '/flash_msg' %>
         <% if content_for?(:page_header) %>
           <div class="row">

data/app/views/layouts/hyrax.html.erb

@@ -15,7 +15,7 @@
     <div id="content-wrapper" class="container" role="main">
       <%= content_for(:container_header) %>
       <%= render '/flash_msg' %>
-      <%= render_breadcrumbs builder: Hyrax::BootstrapBreadcrumbsBuilder %>
+      <%= render_breadcrumbs builder: Hyrax.config.breadcrumb_builder %>
       <% if content_for?(:page_header) %>
         <div class="row">
           <div class="col-12 main-header">

data/config/locales/hyrax.de.yml

@@ -542,8 +542,16 @@ de:
         add_folder: Ordner hinzufügen
         cancel_upload: Upload abbrechen
         dropzone: Dateien hier hinziehen.
-        local_upload_browse_everything_html: "<p>Sie können eine oder mehre Dateien von Ihrem lokalen System oder einem Cloudanbieter hinzufügen, welche mit dieser Arbeit\nverknüpft werden sollen.</p>\n<p>Bitte beachten Sie, dass der Cloud-Anbieter möglicherweise nicht in der Lage ist Ihrer Anfrage nachzukommen, wenn Sie eine große Anzahl von Dateien\ninnerhalb einer kurzen Zeitspanne hochladen. \nWenn Sie\nirgendwelche Fehler beim Hochladen aus der Cloud erhalten, teilen Sie uns dies \nbitte über %{contact_href} mit.</p>\n"
-        local_upload_html: "<p> Sie können eine oder mehrere Dateien hinzufügen, die dieser Arbeit zugeordnet werden sollen. </p>"
+        local_upload_browse_everything_html: |
+          <p>Sie können eine oder mehre Dateien von Ihrem lokalen System oder einem Cloudanbieter hinzufügen, welche mit
+          dieser Arbeit verknüpft werden sollen.</p>
+          <p>Bitte beachten Sie, dass der Cloud-Anbieter möglicherweise nicht in der Lage ist Ihrer Anfrage 
+          nachzukommen, wenn Sie eine große Anzahl von Dateien innerhalb einer kurzen Zeitspanne hochladen. 
+          Wenn Sie irgendwelche Fehler beim Hochladen aus der Cloud erhalten, teilen Sie uns dies bitte über %{contact_href} mit.</p>
+          <p>Das Hochladen ist auf %{upload_file_limit} Dateien mit jeweils %{upload_size_limit} MB begrenzt.</p>
+        local_upload_html: |
+          <p>Sie können eine oder mehrere Dateien hinzufügen, die dieser Arbeit zugeordnet werden sollen.</p>
+          <p>Das Hochladen ist auf %{upload_file_limit} Dateien mit jeweils %{upload_size_limit} MB begrenzt.</p>
       form_member_of_collections:
         actions:
           remove: Aus der Sammlung entfernen
@@ -1301,7 +1309,7 @@ de:
         restore: Vorherige Version wiederherstellen
         restore_from: Wiederherstellen von
         save: Überarbeitete Version speichern
-        save_your_note: Sie müssen auf & quot; Revision speichern & quot; klicken. um eine frühere Version dieser Datei wiederherzustellen
+        save_your_note: Sie müssen auf "Revision speichern" klicken. um eine frühere Version dieser Datei wiederherzustellen
         upload: Neue Version hochladen
     help:
       header: Benutzer-Support

data/config/locales/hyrax.en.yml

@@ -535,7 +535,10 @@ en:
           files within a short period of time, the provider may not be able to
           accommodate your request. If you experience errors uploading from the
           cloud, let us know via the %{contact_href}.</p>
-        local_upload_html: "<p>You can add one or more files to associate with this work.</p>"
+          <p>Uploads are limited to %{upload_file_limit} files, %{upload_size_limit} MB each.</p>
+        local_upload_html: |
+          <p>You can add one or more files to associate with this work.</p>
+          <p>Uploads are limited to %{upload_file_limit} files, %{upload_size_limit} MB each.</p>
       form_member_of_collections:
         actions:
           remove: Remove from collection
@@ -1290,7 +1293,7 @@ en:
         restore: Restore Previous Version
         restore_from: Restore From
         save: Save Revision
-        save_your_note: You must click &quot;Save Revision&quot; to revert a previous version of this file
+        save_your_note: You must click "Save Revision" to revert a previous version of this file
         upload: Upload New Version
     help:
       header: User Support

data/config/locales/hyrax.es.yml

@@ -548,7 +548,10 @@ es:
           de tiempo, el proveedor en la nube podría no ser capaz de resolver la
           petición. Si se experimentan errores durante la carga, por favor,
           comuníquese con nosotros a través de %{contact_href}.</p>
-        local_upload_html: "<p>Puede agregar uno o más archivos para asociar con esta obra.</p>"
+          <p>Las cargas están limitadas a %{upload_file_limit} archivos, %{upload_size_limit} MB cada uno.</p>
+        local_upload_html: |
+          <p>Puede agregar uno o más archivos para asociar con esta obra.</p>
+          <p>Las cargas están limitadas a %{upload_file_limit} archivos, %{upload_size_limit} MB cada uno.</p>
       form_member_of_collections:
         actions:
           remove: Eliminar de la colección

data/config/locales/hyrax.fr.yml

@@ -549,7 +549,10 @@ fr:
           répondre à votre demande. Si vous rencontrez des erreurs de
           téléchargement depuis le nuage, faites-nous savoir via le
           %{contact_href}.</p>
-        local_upload_html: "<p>Vous pouvez ajouter un ou plusieurs fichiers à associer à ce travail.</p>"
+          <p>Les téléchargements sont limités à %{upload_file_limit} fichiers de %{upload_size_limit} Mo chacun.</p>
+        local_upload_html: |
+          <p>Vous pouvez ajouter un ou plusieurs fichiers à associer à ce travail.</p>
+          <p>Les téléchargements sont limités à %{upload_file_limit} fichiers de %{upload_size_limit} Mo chacun.</p>
       form_member_of_collections:
         actions:
           remove: Supprimer de la collection

data/config/locales/hyrax.it.yml

@@ -548,7 +548,10 @@ it:
           periodo di tempo, il provider di cloud potrebbe non essere in grado di
           accogliere la tua richiesta. Se si verificano errori di caricamento
           dalla nube, fateci sapere tramite %{contact_href}.</p>
-        local_upload_html: "<p>È possibile aggiungere uno o più file da associare a questo lavoro.</p>"
+          <p>I caricamenti sono limitati a %{upload_file_limit} file, %{upload_size_limit} MB ciascuno.</p>
+        local_upload_html: |
+          <p>È possibile aggiungere uno o più file da associare a questo lavoro.</p>
+          <p>I caricamenti sono limitati a %{upload_file_limit} file, %{upload_size_limit} MB ciascuno.</p>
       form_member_of_collections:
         actions:
           remove: Rimuovi dalla raccolta
@@ -1306,7 +1309,7 @@ it:
         restore: Ripristina la versione precedente
         restore_from: Ripristina da
         save: Salva revisione
-        save_your_note: Devi fare clic su & quot; Salva revisione & quot; per ripristinare una versione precedente di questo file
+        save_your_note: Devi fare clic su "Salva revisione" per ripristinare una versione precedente di questo file
         upload: Carica nuova versione
     help:
       header: Supporto utente

data/config/locales/hyrax.pt-BR.yml

@@ -542,8 +542,15 @@ pt-BR:
         add_folder: Adicionar pasta
         cancel_upload: Cancelar upload
         dropzone: Largue os arquivos aqui.
-        local_upload_browse_everything_html: "<p>Você pode associar um ou mais arquivos a esta obra. Associe arquivos de seu sistema local ou um provedor de nuvem.</p> <p>Note que se você carregar uma grande quantidade de arquivos dentro de um curto período de tempo, o fornecedor de nuvem pode não ser capaz de acomodar a sua solicitação. Se você tiver algum erro ao carregar da nuvem, avise-nos através do %{contact_href}.<p>"
-        local_upload_html: "<p>Você pode acrescentar um ou mais arquivos para associar a esta obra.</p>"
+        local_upload_browse_everything_html: |
+          <p>Você pode associar um ou mais arquivos a esta obra. Associe arquivos de seu sistema local ou um provedor de nuvem.</p>
+          <p>Note que se você carregar uma grande quantidade de arquivos dentro de um curto período de tempo, 
+          o fornecedor de nuvem pode não ser capaz de acomodar a sua solicitação. Se você tiver algum erro ao carregar 
+          da nuvem, avise-nos através do %{contact_href}.<p>
+          <p>Os uploads são limitados a %{upload_file_limit} arquivos, %{upload_size_limit} MB cada.</p>
+        local_upload_html: |
+          <p>Você pode acrescentar um ou mais arquivos para associar a esta obra.</p>
+          <p>Os uploads são limitados a %{upload_file_limit} arquivos, %{upload_size_limit} MB cada.</p>
       form_member_of_collections:
         actions:
           remove: Remover da coleção

data/config/locales/hyrax.zh.yml

@@ -546,7 +546,10 @@ zh:
           <p>您可以添加一个或多个文件与该工作相关联。</p>
           <p>请注意如果您在短时间内上传了大量文件, 云提供商可能不能满足您的请求。
            如果您上传中遇到问题，请用%{contact_href}报告。</p>
-        local_upload_html: "<p>您可以添加一个或多个文件与该工作相关联。</p>"
+          <p>上传限制为 %{upload_file_limit} 个文件，每个文件 %{upload_size_limit} MB。</p>
+        local_upload_html: |
+          <p>您可以添加一个或多个文件与该工作相关联。</p>
+          <p>上传限制为 %{upload_file_limit} 个文件，每个文件 %{upload_size_limit} MB。</p>
       form_member_of_collections:
         actions:
           remove: 从收藏中删除

data/docker-compose-koppie.yml

@@ -104,7 +104,6 @@ services:
 
   postgres:
     image: postgres:latest
-    restart: always
     env_file:
       - .koppie/.env
     ports:

data/docker-compose.yml

@@ -99,7 +99,6 @@ services:
 
   postgres:
     image: postgres:latest
-    restart: always
     environment:
       - POSTGRES_USER=hyrax_user
       - POSTGRES_PASSWORD=hyrax_password

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
-v4.0.0.rc2__. If you are looking for instructions on installing a different
+v4.0.0__. 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.
 
@@ -139,11 +139,11 @@ Starting up Redis will depend on your operating system, and may in fact already
 
 ## Rails
 
-Hyrax requires Rails 5. We recommend the latest Rails 5.2 release.
+Hyrax requires Rails 6. We recommend the latest Rails 6.1 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.2.6
+gem install rails -v 6.1.7.3
 ```
 
 ### JavaScript runtime
@@ -159,7 +159,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 _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc2/template.rb
+rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/hyrax.gemspec

@@ -41,6 +41,7 @@ SUMMARY
   spec.add_dependency 'browse-everything', '>= 0.16', '< 2.0'
   spec.add_dependency 'carrierwave', '~> 1.0'
   spec.add_dependency 'clipboard-rails', '~> 1.5'
+  spec.add_dependency 'connection_pool', '~> 2.4'
   spec.add_dependency 'draper', '~> 4.0'
   spec.add_dependency 'dry-events', '~> 0.2.0'
   spec.add_dependency 'dry-equalizer', '~> 0.2'

data/lib/generators/hyrax/templates/config/analytics.yml

@@ -6,6 +6,7 @@ analytics:
     analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
     app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME'] %>
     app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION'] %>
+    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE'] %>
     privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
     privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
     client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL'] %>

data/lib/generators/hyrax/templates/config/initializers/redis_config.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 require 'redis'
+require 'connection_pool'
 config = YAML.safe_load(ERB.new(IO.read(Rails.root.join('config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
-Redis.current = Redis.new(config.merge(thread_safe: true))
+
+size = ENV.fetch("HYRAX_REDIS_POOL_SIZE", 5)
+timeout = ENV.fetch("HYRAX_REDIS_TIMEOUT", 5)
+
+Hyrax.config.redis_connection =
+  ConnectionPool::Wrapper.new(size: size, timeout: timeout) { Redis.new(config) }

data/lib/hyrax/configuration.rb

@@ -393,6 +393,11 @@ module Hyrax
       @banner_image ||= 'https://user-images.githubusercontent.com/101482/29949206-ffa60d2c-8e67-11e7-988d-4910b8787d56.jpg'
     end
 
+    attr_writer :breadcrumb_builder
+    def breadcrumb_builder
+      @breadcrumb_builder ||= Hyrax::BootstrapBreadcrumbsBuilder
+    end
+
     ##
     # @return [Boolean]
     def disable_wings
@@ -611,9 +616,10 @@ module Hyrax
       @persistent_hostpath ||= "http://localhost/files/"
     end
 
+    attr_accessor :redis_connection
     attr_writer :redis_namespace
     def redis_namespace
-      @redis_namespace ||= "hyrax"
+      @redis_namespace ||= ENV.fetch("HYRAX_REDIS_NAMESPACE", "hyrax")
     end
 
     attr_writer :libreoffice_path

data/lib/hyrax/redis_event_store.rb

@@ -7,9 +7,11 @@ module Hyrax
     class << self
       # @return [Fixnum, nil] the id of the event, or `nil` on failure(?!)
       def create(action, timestamp)
-        event_id = instance.incr("events:latest_id")
-        instance.hmset("events:#{event_id}", "action", action, "timestamp", timestamp)
-        event_id
+        instance.then do |redis|
+          event_id = redis.incr("events:latest_id")
+          redis.hmset("events:#{event_id}", "action", action, "timestamp", timestamp)
+          event_id
+        end
       rescue Redis::CommandError => e
         logger.error("unable to create event: #{e}")
         nil
@@ -23,12 +25,16 @@ module Hyrax
       #
       # @return [Redis]
       def instance
-        if Redis.current.is_a? Redis::Namespace
-          Redis.current.namespace = namespace
+        connection = Hyrax.config.redis_connection || Redis.current
+
+        if connection.is_a? Redis::Namespace
+          connection.namespace = namespace
+          connection
+        elsif connection == Redis.current
+          Redis.current = Redis::Namespace.new(namespace, redis: connection)
         else
-          Redis.current = Redis::Namespace.new(namespace, redis: Redis.current)
+          connection
         end
-        Redis.current
       end
 
       ##
@@ -44,11 +50,13 @@ module Hyrax
     #
     # @return [Enumerable<Hash<Symbol, String>>]
     def fetch(size)
-      RedisEventStore.instance.lrange(@key, 0, size).map do |event_id|
-        {
-          action: RedisEventStore.instance.hget("events:#{event_id}", "action"),
-          timestamp: RedisEventStore.instance.hget("events:#{event_id}", "timestamp")
-        }
+      Hyrax::RedisEventStore.instance.then do |redis|
+        redis.lrange(@key, 0, size).map do |event_id|
+          {
+            action: redis.hget("events:#{event_id}", "action"),
+            timestamp: redis.hget("events:#{event_id}", "timestamp")
+          }
+        end
       end
     rescue Redis::CommandError, Redis::CannotConnectError
       RedisEventStore.logger.error("unable to fetch event: #{@key}")
@@ -62,7 +70,7 @@ module Hyrax
     #
     # @return [Integer, nil] the value successfully pushed; or `nil` on failure(!?)
     def push(value)
-      RedisEventStore.instance.lpush(@key, value)
+      Hyrax::RedisEventStore.instance.then { |r| r.lpush(@key, value) }
     rescue Redis::CommandError, Redis::CannotConnectError
       RedisEventStore.logger.error("unable to push event: #{@key}")
       nil

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '4.0.0.rc2'
+  VERSION = '4.0.0'
 end

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', '4.0.0.rc2'
+gem 'hyrax', '4.0.0'
 run 'bundle install'
 generate 'hyrax:install', '-f'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc2
+  version: 4.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: draper
   requirement: !ruby/object:Gem::Requirement
@@ -3292,9 +3306,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.12
 signing_key: