hyrax 5.0.0.rc1 → 5.0.0.rc2

data/docker-compose-sirenia.yml

@@ -0,0 +1,202 @@
+# Requires Docker Compose v2
+name: sirenia
+services:
+  app: &app
+    build:
+      context: .
+      target: hyrax-engine-dev
+      args:
+        - EXTRA_APK_PACKAGES=git less
+        - APP_PATH=.koppie
+    image: samvera/koppie
+    entrypoint: dev-entrypoint.sh
+    command: sh -c 'bundle exec puma -v -b tcp://0.0.0.0:3000'
+    stdin_open: true
+    tty: true
+    user: root
+    env_file:
+      - .koppie/.env
+    environment:
+      - APP_NAME=sirenia
+      - RAILS_ROOT=/app/samvera/hyrax-webapp
+      - VALKYRIE_METADATA_ADAPTER=fedora_metadata
+      - VALKYRIE_STORAGE_ADAPTER=fedora_storage
+    depends_on:
+      - chrome
+      - db_migrate
+      - memcached
+      - postgres
+      - redis
+      - solr
+    ports:
+      - 3002:3000
+      - 9878:9876
+      - 1050:1048
+    volumes:
+      - ./bin:/app/samvera
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
+      - hyrax-storage:/app/samvera/hyrax-webapp/storage
+      - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
+      - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - sirenia
+
+  sidekiq:
+    image: samvera/koppie
+    entrypoint: dev-entrypoint.sh
+    command: sh -c 'bundle exec sidekiq'
+    user: root
+    env_file:
+      - .koppie/.env
+    environment:
+      - APP_NAME=sirenia
+      - VALKYRIE_METADATA_ADAPTER=fedora_metadata
+      - VALKYRIE_STORAGE_ADAPTER=fedora_storage
+    depends_on:
+      - db_migrate
+      - memcached
+      - postgres
+      - redis
+      - solr
+    volumes:
+      - ./bin:/app/samvera
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
+      - hyrax-storage:/app/samvera/hyrax-webapp/storage
+      - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
+      - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - sirenia
+
+  db_migrate:
+    image: samvera/koppie
+    user: root
+    env_file:
+      - .koppie/.env
+    environment:
+      - APP_NAME=sirenia
+      - VALKYRIE_METADATA_ADAPTER=fedora_metadata
+      - VALKYRIE_STORAGE_ADAPTER=fedora_storage
+    entrypoint: dev-entrypoint.sh
+    command: db-migrate-seed.sh
+    depends_on:
+      - postgres
+      - solr
+    volumes:
+      - ./bin:/app/samvera
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - sirenia
+
+  chrome:
+    image: seleniarm/standalone-chromium:114.0
+    environment:
+      - START_XVFB=false
+    logging:
+      driver: none
+    volumes:
+      - /dev/shm:/dev/shm
+    shm_size: 2G
+    ports:
+      - "4447:4444"
+      - "5962:5900"
+    networks:
+      - sirenia
+
+  postgres:
+    image: postgres:15
+    env_file:
+      - .koppie/.env
+    ports:
+      - "5434:5432"
+    volumes:
+      - db:/var/lib/postgresql/data
+    networks:
+      - sirenia
+
+  fcrepo:
+    image: fcrepo/fcrepo:6.4.0
+    environment:
+      - >-
+        CATALINA_OPTS=-Dfcrepo.home=/fcrepo-home -Djava.awt.headless=true -Dfile.encoding=UTF-8 
+        -server -Xms512m -Xmx1024m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m 
+        -XX:MaxPermSize=256m -XX:+DisableExplicitGC -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
+      - JAVA_OPTS=-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
+    volumes:
+      - fcrepo:/fcrepo-home
+    ports:
+      - 8081:8080
+    networks:
+      - sirenia
+
+  fits:
+    image: ghcr.io/samvera/fitsservlet:1.6.0
+    ports:
+      - 9082:8080
+    networks:
+      - sirenia
+
+  memcached:
+    image: bitnami/memcached
+    ports:
+      - '11213:11211'
+    networks:
+      - sirenia
+
+  redis:
+    image: bitnami/redis:6.2
+    env_file:
+      - .koppie/.env
+    volumes:
+      - redis:/bitnami/redis/data
+    networks:
+      - sirenia
+
+  solr:
+    image: solr:8.11
+    ports:
+      - 8985:8983
+    command:
+      - sh
+      - "-c"
+      - "precreate-core koppie_test /opt/solr/server/configsets/hyraxconf; solr-precreate koppie /opt/solr/server/configsets/hyraxconf"
+    volumes:
+      - solr_home:/var/solr/data:cached
+      - .koppie/solr/conf:/opt/solr/server/configsets/hyraxconf
+    ulimits:
+      nofile:
+        soft: 65536
+        hard: 524288
+    networks:
+      - sirenia
+
+volumes:
+  bundle:
+  db:
+  fcrepo:
+  hyrax-storage:
+  hyrax-derivatives:
+  hyrax-uploads:
+  rails-public:
+  rails-tmp:
+  redis:
+  sidekiq-public:
+  sidekiq-tmp:
+  solr_home:
+
+networks:
+  sirenia:
+    driver: bridge
+    driver_opts:
+      com.docker.network.bridge.name: br-sirenia

data/docker-compose.yml

@@ -6,9 +6,11 @@ services:
       context: .
       target: hyrax-engine-dev
       args:
-        - EXTRA_APK_PACKAGES=git less chromium
-    image: ghcr.io/samvera/dassie
-    command: sh -c 'bundle && bundle exec puma -v -b tcp://0.0.0.0:3000'
+        - EXTRA_APK_PACKAGES=git less
+        - BUNDLE_GEMFILE=Gemfile.dassie
+    image: samvera/dassie
+    entrypoint: dev-entrypoint.sh
+    command: sh -c 'bundle exec puma -v -b tcp://0.0.0.0:3000'
     stdin_open: true
     tty: true
     user: root
@@ -28,8 +30,10 @@ services:
       - 3000:3000
       - 9876:9876
     volumes:
+      - ./bin:/app/samvera
       - .dassie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
       - rails-public:/app/samvera/hyrax-webapp/public
@@ -38,11 +42,9 @@ services:
       - hyrax
 
   sidekiq:
-    build:
-      context: .
-      target: hyrax-engine-dev-worker
-    image: ghcr.io/samvera/dassie-worker
-    command: sh -c 'bundle && bundle exec sidekiq'
+    image: samvera/dassie
+    entrypoint: dev-entrypoint.sh
+    command: sh -c 'bundle exec sidekiq'
     user: root
     env_file:
       - .dassie/.env
@@ -54,31 +56,31 @@ services:
       - redis
       - solr
     volumes:
+      - ./bin:/app/samvera
       - .dassie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
-      - sidekiq-public:/app/samvera/hyrax-webapp/public
-      - sidekiq-tmp:/app/samvera/hyrax-webapp/tmp
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
     networks:
       - hyrax
 
   db_migrate:
-    build:
-      context: .
-      target: hyrax-engine-dev
-      args:
-        - EXTRA_APK_PACKAGES=git less
-    image: ghcr.io/samvera/dassie
+    image: samvera/dassie
     user: root
     env_file:
       - .dassie/.env
-    command: sh -c 'bundle && db-migrate-seed.sh'
+    entrypoint: dev-entrypoint.sh
+    command: db-migrate-seed.sh
     depends_on:
       - postgres
     volumes:
+      - ./bin:/app/samvera
       - .dassie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
       - rails-public:/app/samvera/hyrax-webapp/public
       - rails-tmp:/app/samvera/hyrax-webapp/tmp
     networks:
@@ -100,7 +102,7 @@ services:
       - hyrax
 
   postgres:
-    image: postgres:latest
+    image: postgres:15
     environment:
       - POSTGRES_USER=hyrax_user
       - POSTGRES_PASSWORD=hyrax_password
@@ -123,7 +125,7 @@ services:
       - hyrax
 
   fits:
-    image: harvardlts/fitsservlet_container:1.5.0
+    image: ghcr.io/samvera/fitsservlet:1.6.0
     ports:
       - 8080
     networks:
@@ -137,14 +139,16 @@ services:
       - hyrax
 
   redis:
-    image: redis:5-alpine
+    image: bitnami/redis:6.2
+    env_file:
+      - .dassie/.env
     volumes:
-      - redis:/data
+      - redis:/bitnami/redis/data
     networks:
       - hyrax
 
   solr:
-    image: solr:8.11.1
+    image: solr:8.11
     ports:
       - 8983:8983
     command:
@@ -162,6 +166,7 @@ services:
       - hyrax
 
 volumes:
+  bundle:
   db:
   fcrepo:
   hyrax-derivatives:
@@ -169,8 +174,6 @@ volumes:
   rails-public:
   rails-tmp:
   redis:
-  sidekiq-public:
-  sidekiq-tmp:
   solr_home:
 
 networks:

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

@@ -30,7 +30,7 @@ A Hyrax-based application includes lots of dependencies. We provide a [Docker im
 You can also try [Running Hyrax-based application in local VM](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide#running-hyrax-based-application-in-local-vm) which uses Ubuntu.
 
 This document contains instructions specific to setting up an app with __Hyrax
-v5.0.0.rc1__. If you are looking for instructions on installing a different
+v5.0.0.rc2__. 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.
 
@@ -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 _6.1.7.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.0.0.rc1/template.rb
+rails _6.1.7.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.0.0.rc2/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

@@ -30,7 +30,7 @@ SUMMARY
   # NOTE: rails does not follow sem-ver conventions, it's
   # minor version releases can include breaking changes; see
   # http://guides.rubyonrails.org/maintenance_policy.html
-  spec.add_dependency 'rails', '~> 6.0'
+  spec.add_dependency 'rails', '~> 6.1'
 
   spec.add_dependency 'active-fedora', '~> 14.0'
   spec.add_dependency 'almond-rails', '~> 0.1'
@@ -41,13 +41,15 @@ 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 'concurrent-ruby', '~> 1.0'
   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'
-  spec.add_dependency 'dry-monads', '~> 1.5'
-  spec.add_dependency 'dry-struct', '~> 1.0'
-  spec.add_dependency 'dry-validation', '~> 1.3'
+  spec.add_dependency 'dry-logic', '~> 1.5'
+  spec.add_dependency 'dry-container', '~> 0.11'
+  spec.add_dependency 'dry-events', '~> 1.0', '>= 1.0.1'
+  spec.add_dependency 'dry-monads', '~> 1.6'
+  spec.add_dependency 'dry-struct', '~> 1.6'
+  spec.add_dependency 'dry-validation', '~> 1.10'
   spec.add_dependency 'flipflop', '~> 2.3'
   # Pin more tightly because 0.x gems are potentially unstable
   spec.add_dependency 'flot-rails', '~> 0.0.6'
@@ -80,7 +82,7 @@ SUMMARY
   spec.add_dependency 'retriable', '>= 2.9', '< 4.0'
   spec.add_dependency 'signet'
   spec.add_dependency 'tinymce-rails', '~> 5.10'
-  spec.add_dependency 'valkyrie', '~> 3.0.1'
+  spec.add_dependency 'valkyrie', '~> 3.1.1'
   spec.add_dependency 'view_component', '~> 2.74.1' # Pin until blacklight is updated with workaround for https://github.com/ViewComponent/view_component/issues/1565
   spec.add_dependency 'sprockets', '~> 3.7'
   spec.add_dependency 'sass-rails', '~> 6.0'
@@ -89,16 +91,14 @@ SUMMARY
   spec.add_development_dependency "capybara", '~> 3.29'
   spec.add_development_dependency 'capybara-screenshot', '~> 1.0'
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
-  spec.add_development_dependency 'engine_cart', '~> 2.5'
   spec.add_development_dependency "equivalent-xml", '~> 0.5'
   spec.add_development_dependency "factory_bot", '~> 4.4'
-  spec.add_development_dependency 'fcrepo_wrapper', '~> 0.5', '>= 0.5.1'
   spec.add_development_dependency 'mida', '~> 0.3'
   spec.add_development_dependency 'okcomputer'
   spec.add_development_dependency 'pg', '~> 1.2'
   spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
   spec.add_development_dependency 'rspec-its', '~> 1.1'
-  spec.add_development_dependency 'rspec-rails', '~> 5.0'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency "selenium-webdriver", '~> 4.4'
   spec.add_development_dependency 'i18n-debug'
@@ -108,6 +108,5 @@ SUMMARY
   spec.add_development_dependency 'bixby', '~> 5.0', '>= 5.0.2' # bixby 5 briefly dropped Ruby 2.5
   spec.add_development_dependency 'shoulda-callback-matchers', '~> 1.1.1'
   spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
-  spec.add_development_dependency 'webdrivers', '~> 4.4'
   spec.add_development_dependency 'webmock'
 end

data/karma.conf.js

@@ -23,7 +23,7 @@ module.exports = function(config) {
     },
 
     // list of files / patterns to load in the browser
-    // uses dotenv to allow for .internal_test_app or .dassie as the Rails root
+    // uses dotenv to allow for .dassie as the Rails root
 
     files: [
       {pattern: 'spec/javascripts/fixtures/*.html', watched: true, included: false, served: true},

data/lib/generators/hyrax/collection_resource/templates/collection_metadata.yaml

@@ -2,6 +2,8 @@
 # index key names, and form properties.
 #
 # Attributes must have a type but all other configuration options are optional.
+# Please note: If using Valkyrie's Fedora Metadata Adapter, predicates for attributes
+# must be placed here.
 #
 # attributes:
 #   attribute_name:

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

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-ActiveSupport::Reloader.to_prepare do
-  Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
+Rails.application.reloader.to_prepare do
   Riiif::Image.info_service = lambda do |id, _file|
     # id will look like a path to a pcdm:file
     # (e.g. rv042t299%2Ffiles%2F6d71677a-4f80-42f1-ae58-ed1063fd79c7)
     # but we just want the id for the FileSet it's attached to.
 
-    # Capture everything before the first slash
     fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
     resp = Hyrax::SolrService.get("id:#{fs_id}")
     doc = resp['response']['docs'].first
@@ -14,26 +12,22 @@ ActiveSupport::Reloader.to_prepare do
     { height: doc['height_is'], width: doc['width_is'], format: doc['mime_type_ssi'], channels: doc['alpha_channels_ssi'] }
   end
 
-  Riiif::Image.file_resolver.id_to_uri = if Hyrax.config.use_valkyrie?
-                                           # Use Valkyrie adapter to make sure file is available locally. Riiif will just open it then
-                                           # id comes in with the format "FILE_SET_ID/files/FILE_ID"
-                                           lambda do |id|
-                                             file_metadata = Hyrax.query_service.find_by(id: id.split('/').last)
-                                             file = Hyrax.storage_adapter.find_by(id: file_metadata.file_identifier)
-                                             file.disk_path.to_s
-                                           end
-                                         else
-                                           lambda do |id|
-                                             Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
-                                               Rails.logger.info "Riiif resolved #{id} to #{url}"
-                                             end
-                                           end
-                                         end
+  if Hyrax.config.use_valkyrie?
+    Riiif::Image.file_resolver = Hyrax::RiiifFileResolver.new
+  else
+    Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
+
+    Riiif::Image.file_resolver.id_to_uri = lambda do |id|
+      Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
+        Rails.logger.info "Riiif resolved #{id} to #{url}"
+      end
+    end
+  end
 
   Riiif::Image.authorization_service = Hyrax::IiifAuthorizationService
 
   Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
   Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
 
-  Riiif::Engine.config.cache_duration = 365.days
+  Riiif::Engine.config.cache_duration = 1.month
 end

data/lib/generators/hyrax/templates/db/migrate/20230725222727_create_hyrax_counter_metrics.rb.erb

@@ -0,0 +1,14 @@
+class CreateHyraxCounterMetrics < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :hyrax_counter_metrics do |t|
+      t.string :worktype
+      t.string :resource_type
+      t.integer :work_id
+      t.date :date
+      t.integer :total_item_investigations
+      t.integer :total_item_requests
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/hyrax/templates/db/migrate/20230803165135_change_work_id_to_string.rb.erb

@@ -0,0 +1,5 @@
+class ChangeWorkIdToString < ActiveRecord::Migration<%= migration_version %>
+  def change
+    change_column :hyrax_counter_metrics, :work_id, :string
+  end
+end

data/lib/generators/hyrax/templates/db/migrate/20230808102105_add_indices_to_hyrax_counter_metrics.rb.erb

@@ -0,0 +1,8 @@
+class AddIndicesToHyraxCounterMetrics < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_index :hyrax_counter_metrics, :worktype
+    add_index :hyrax_counter_metrics, :resource_type
+    add_index :hyrax_counter_metrics, :work_id
+    add_index :hyrax_counter_metrics, :date
+  end
+end

data/lib/generators/hyrax/templates/db/migrate/20230821153635_add_fields_to_counter_metric.rb.erb

@@ -0,0 +1,8 @@
+class AddFieldsToCounterMetric < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :hyrax_counter_metrics, :title, :string
+    add_column :hyrax_counter_metrics, :year_of_publication, :integer, index: true
+    add_column :hyrax_counter_metrics, :publisher, :string, index: true
+    add_column :hyrax_counter_metrics, :author, :string, index: true
+  end
+end

data/lib/generators/hyrax/templates/db/seeds.rb

@@ -7,7 +7,7 @@
 #   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
 #   Character.create(name: 'Luke', movie: movies.first)
 #
-# To use this file, run the following command in the .internal_test_app:
+# To use this file, run the following command in the test app:
 #   rails generate hyrax:sample_data
 #
 # To re-use this file, you will likely want to clean out the test app content

data/lib/generators/hyrax/work_resource/templates/form.rb.erb

@@ -5,7 +5,7 @@
 #
 # @see https://github.com/samvera/hyrax/wiki/Hyrax-Valkyrie-Usage-Guide#forms
 # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
-class <%= class_name %>Form < Hyrax::Forms::ResourceForm(<%= class_name %>)
+class <%= class_name %>Form < Hyrax::Forms::PcdmObjectForm(<%= class_name %>)
   include Hyrax::FormFields(:basic_metadata)
   include Hyrax::FormFields(:<%= file_name %>)
 

data/lib/generators/hyrax/work_resource/templates/metadata.yaml

@@ -2,6 +2,8 @@
 # index key names, and form properties.
 #
 # Attributes must have a type but all other configuration options are optional.
+# Please note: If using Valkyrie's Fedora Metadata Adapter, predicates for attributes
+# must be placed here.
 #
 # attributes:
 #   attribute_name: