hyrax 4.0.0.beta1 → 4.0.0.rc1

data/config/metadata/file_set_metadata.yaml

@@ -0,0 +1,130 @@
+# This is the metadata used for `Hyrax::FileSet`s.` It is similar to
+# `basic_metadata.yaml`, but not exactly the same.
+#
+# Terms which are already present in `core_metadata.yaml` are not repeated here.
+attributes:
+  # Required attributes:
+  creator:
+    type: string
+    multiple: true
+    form:
+      required: true
+      primary: true
+    index_keys:
+      - "creator_tesim"
+  license:
+    type: string
+    multiple: true
+    form:
+      required: true
+      primary: true
+
+  # Other attributes:
+  abstract:
+    type: string
+    multiple: true
+  # form:
+  #   primary: false
+  # missing: access_right
+  # missing: alternative_title
+  based_near:
+    type: string
+    multiple: true
+    form:
+      primary: false
+    index_keys:
+      - "based_near_sim"
+      - "based_near_tesim"
+  # missing: bibliograpic_citation
+  contributor:
+    type: string
+    multiple: true
+    form:
+      primary: false
+  # required: creator
+  date_created:
+    type: date_time
+    multiple: true
+    form:
+      primary: false
+    index_keys:
+      - "date_created_tesim"
+  description:
+    type: string
+    multiple: true
+    form:
+      primary: false
+    index_keys:
+      - "description_tesim"
+  identifier:
+    type: string
+    multiple: true
+    form:
+      primary: false
+  # missing: import_url
+  keyword:
+    type: string
+    multiple: true
+    form:
+      primary: false
+    index_keys:
+      - "keyword_sim"
+      - "keyword_tesim"
+  # missing: publisher
+  label:
+    type: string
+  # form:
+  #   primary: false
+  language:
+    type: string
+    multiple: true
+    form:
+      primary: false
+  # required: license
+  publisher:
+    type: string
+    multiple: true
+    form:
+      primary: false
+  related_url:
+    type: string
+    multiple: true
+    form:
+      primary: false
+    index_keys:
+      - "related_url_tesim"
+  relative_path:
+    type: string
+  resource_type:
+    type: string
+    multiple: true
+  # form:
+  #   primary: false
+    index_keys:
+      - "resource_type_sim"
+      - "resource_type_tesim"
+  rights_notes:
+    type: string
+    multiple: true
+  # form:
+  #   primary: false
+  rights_statement:
+    type: string
+    multiple: true
+  # form:
+  #   primary: true
+    index_keys:
+      - "rights_statement_tesim"
+  source:
+    type: string
+    multiple: true
+  # form:
+  #   primary: false
+  subject:
+    type: string
+    multiple: true
+    form:
+      primary: false
+    index_keys:
+      - "subject_sim"
+      - "subject_tesim"

data/docker-compose-koppie.yml

@@ -0,0 +1,163 @@
+# Requires Docker Compose v2
+name: koppie
+services:
+  app: &app
+    build:
+      context: .
+      target: hyrax-engine-dev
+      args:
+        - EXTRA_APK_PACKAGES=git less chromium
+        - APP_PATH=.koppie
+    image: ghcr.io/samvera/koppie
+    command: sh -l -c 'bundle && yarn && bundle exec puma -v -b tcp://0.0.0.0:3000'
+    stdin_open: true
+    tty: true
+    user: root
+    env_file:
+      - .koppie/.env
+    environment:
+      - RAILS_ROOT=/app/samvera/hyrax-webapp
+    depends_on:
+      - chrome
+      - db_migrate
+      - memcached
+      - postgres
+      - redis
+      - solr
+    ports:
+      - 3001:3000
+      - 9877:9876
+      - 1049:1048
+    volumes:
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - 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:
+      - koppie
+
+  sidekiq:
+    build:
+      context: .
+      target: hyrax-engine-dev-worker
+      args:
+        - APP_PATH=.koppie
+    image: ghcr.io/samvera/koppie-worker
+    command: sh -l -c 'bundle && bundle exec sidekiq'
+    user: root
+    env_file:
+      - .koppie/.env
+    depends_on:
+      - db_migrate
+      - memcached
+      - postgres
+      - redis
+      - solr
+    volumes:
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - hyrax-storage:/app/samvera/hyrax-webapp/storage
+      - 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
+    networks:
+      - koppie
+
+  db_migrate:
+    build:
+      context: .
+      target: hyrax-engine-dev
+      args:
+        - EXTRA_APK_PACKAGES=git less
+        - APP_PATH=.koppie
+    image: ghcr.io/samvera/koppie
+    user: root
+    env_file:
+      - .koppie/.env
+    command: sh -l -c 'bundle && db-migrate-seed.sh'
+    depends_on:
+      - postgres
+    volumes:
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - koppie
+
+  chrome:
+    image: selenium/standalone-chrome:3.141
+    logging:
+      driver: none
+    volumes:
+      - /dev/shm:/dev/shm
+    shm_size: 2G
+    ports:
+      - "4445:4444"
+      - "5960:5900"
+    networks:
+      - koppie
+
+  postgres:
+    image: postgres:latest
+    restart: always
+    env_file:
+      - .koppie/.env
+    ports:
+      - "5433:5432"
+    volumes:
+      - db:/var/lib/postgresql/data
+    networks:
+      - koppie
+
+  memcached:
+    image: bitnami/memcached
+    ports:
+      - '11212:11211'
+    networks:
+      - koppie
+
+  redis:
+    image: bitnami/redis:6.2
+    env_file:
+      - .koppie/.env
+    volumes:
+      - redis:/bitnami/redis/data
+    networks:
+      - koppie
+
+  solr:
+    image: solr:8.11
+    ports:
+      - 8984: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
+    networks:
+      - koppie
+
+volumes:
+  db:
+  hyrax-storage:
+  hyrax-derivatives:
+  hyrax-uploads:
+  rails-public:
+  rails-tmp:
+  redis:
+  sidekiq-public:
+  sidekiq-tmp:
+  solr_home:
+
+networks:
+  koppie:
+    driver: bridge
+    driver_opts:
+      com.docker.network.bridge.name: br-koppie

data/docker-compose.yml

@@ -13,7 +13,6 @@ services:
     tty: true
     user: root
     env_file:
-      - .env
       - .dassie/.env
     environment:
       - RAILS_ROOT=/app/samvera/hyrax-webapp
@@ -46,7 +45,6 @@ services:
     command: sh -l -c 'bundle && bundle exec sidekiq'
     user: root
     env_file:
-      - .env
       - .dassie/.env
     depends_on:
       - db_migrate
@@ -74,7 +72,6 @@ services:
     image: ghcr.io/samvera/dassie
     user: root
     env_file:
-      - .env
       - .dassie/.env
     command: sh -l -c 'bundle && db-migrate-seed.sh'
     depends_on:

data/documentation/MAINTENANCE.md

@@ -0,0 +1,77 @@
+# Maintenance Policy for Hyrax
+January 25, 2023
+
+[Hyrax Maintenance Working Group](https://samvera.atlassian.net/wiki/spaces/samvera/pages/496632295/Hyrax+Maintenance+Working+Group)
+
+## Why do we need a policy? 
+A written policy prevents word-of-mouth policies which create confusion in the community. 
+A written policy also provides a transparent way to communicate our values to people who may 
+not work on the maintenance team consistently. It gives a basis to justify spending time on 
+something that isn’t in the product backlog.
+
+Updated versions of JavaScript libraries, Ruby, and Ruby gems are released all the time. 
+If we don’t keep our applications up-to-date with the latest released versions of their 
+dependencies, we may end up with applications that rely on dependencies with known 
+vulnerabilities, bugs, or deprecated features.
+
+Hyrax releases are managed in two groupings: 
+- Breaking changes which include new features with incompatible changes such as requiring 
+  data migration, bug fixes or security fixes with incompatible changes. 
+- Non-breaking changes which have new features that can be introduced with feature flipper, 
+  backwards compatibility, or that do not require data migration, bug fixes or security fixes
+  that do not require data migration. 
+
+## Semantic Versioning
+
+Hyrax follows [semver](https://semver.org/) for release versioning. All releases are handled in X.Y.Z format.
+
+Current releases are at https://github.com/samvera/hyrax/releases 
+
+### Major X
+New features with incompatible changes such as requiring data migration, bug fixes or security 
+fixes with incompatible changes. Breaking changes are paired with deprecation notices in the 
+previous minor or major release.
+
+### Minor Y
+New features that can be introduced with feature flipper, backwards compatibility, or that do not 
+require data migration. May also contain bug fixes or security fixes that do not require data migration.
+
+### Patch Z
+Bug fixes or security fixes that do not require data migration. No new features.
+
+## Supported Versions
+Supported versions are the highest currently released X version and then backwards to X-1. So when 
+Hyrax 4.0 is released, the latest Hyrax 3.y is supported but Hyrax 2.y is not. Extended support for 
+an otherwise unsupported version may be offered at the Product Owner or Technical Lead’s discretion. 
+See End-of-Life Versions below.
+
+## New features
+New features that are added to the current release may be backported to supported past versions on 
+a case-by-case basis. New features that are not relevant to the current release can be added to a 
+supported past version.
+
+## Bug fixes
+Bug fixes that are added to the current release may be backported to supported past versions on a 
+case-by-case basis. 
+
+## Security fixes
+The current major release will receive patches and new versions in case of a security fix. The last
+release in the previous major version will also receive security updates. So when Hyrax 4.y has a 
+security fix applied, this security fix would also be applied to the latest Hyrax 3.y, but not to 
+Hyrax 2.y.
+
+## Dependency Management
+Deprecated or end-of-life versions of dependencies used as part of building a Hyrax-based application 
+will be removed from the test suite to manage maintenance. If an outdated version of a dependency is 
+still supported that does not pose security issues, it may remain supported in the test suite.
+
+## End-of-Life  Versions
+End-of-life versions are X-1 versions behind the highest currently released X version. So when Hyrax 4.0 
+is released, Hyrax 2.y is end-of-life and no longer supported, but Hyrax 3.y is still supported and is 
+not end-of-life. Extended support for an otherwise unsupported version may be offered at the Product 
+Owner or Technical Lead’s discretion (e.g. many major releases in a short period of time). 
+See Supported Versions above.
+
+End-of-Life versions of Hyrax will not be supported. Applying fixes (security or otherwise) will be 
+up to the implementing entity. We encourage updating to supported versions of Hyrax to receive updates 
+and security fixes.

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
-v3.0.1__. If you are looking for instructions on installing a different
+v4.0.0.rc1__. 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 _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v4.0.0.beta1/template.rb
+rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc1/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

@@ -45,12 +45,12 @@ Hyrax is a front-end based on the robust [Samvera](http://samvera.org) framework
 
 # Help
 
-The Samvera community is here to help. Please see our [support guide](./.github/SUPPORT.md).
+The Samvera community is here to help. Please see our [support guide](../.github/SUPPORT.md).
 
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v4.0.0.beta1__. If you are looking for instructions on installing a different
+v4.0.0.rc1__. 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.
 
@@ -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 _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.2/template.rb
+rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc1/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

@@ -35,7 +35,7 @@ SUMMARY
   spec.add_dependency 'active-fedora', '~> 13.1', '>= 13.1.2'
   spec.add_dependency 'almond-rails', '~> 0.1'
   spec.add_dependency 'awesome_nested_set', '~> 3.1'
-  spec.add_dependency 'blacklight', '< 7.25'
+  spec.add_dependency 'blacklight', '~> 7.29'
   spec.add_dependency 'blacklight-gallery', '~> 4.0'
   spec.add_dependency 'breadcrumbs_on_rails', '~> 3.0'
   spec.add_dependency 'browse-everything', '>= 0.16', '< 2.0'
@@ -44,8 +44,8 @@ SUMMARY
   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-transaction', '~> 0.11'
   spec.add_dependency 'dry-validation', '~> 1.3'
   spec.add_dependency 'flipflop', '~> 2.3'
   # Pin more tightly because 0.x gems are potentially unstable
@@ -69,20 +69,21 @@ SUMMARY
   spec.add_dependency 'oauth2', '~> 1.2'
   spec.add_dependency 'openseadragon'
   spec.add_dependency 'posix-spawn'
-  spec.add_dependency 'power_converter', '~> 0.1', '>= 0.1.2'
   spec.add_dependency 'qa', '~> 5.5', '>= 5.5.1' # questioning_authority
   spec.add_dependency 'rails_autolink', '~> 1.1'
   spec.add_dependency 'rdf-rdfxml' # controlled vocabulary importer
   spec.add_dependency 'rdf-vocab', '~> 3.0'
+  spec.add_dependency 'redis', '~> 4.0'
   spec.add_dependency 'redis-namespace', '~> 1.5'
-  spec.add_dependency 'redlock', '>= 0.1.2'
+  spec.add_dependency 'redlock', '>= 0.1.2', '< 2.0'
   spec.add_dependency 'reform', '~> 2.3'
   spec.add_dependency 'reform-rails', '~> 0.2.0'
   spec.add_dependency 'retriable', '>= 2.9', '< 4.0'
   spec.add_dependency 'samvera-nesting_indexer', '~> 2.0'
   spec.add_dependency 'signet'
   spec.add_dependency 'tinymce-rails', '~> 5.10'
-  spec.add_dependency 'valkyrie', '~> 2', '>= 2.1.1'
+  spec.add_dependency 'valkyrie', '~> 3.0.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'
   spec.add_dependency 'select2-rails', '~> 3.5'
@@ -90,7 +91,7 @@ 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.2'
+  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'
@@ -99,9 +100,9 @@ SUMMARY
   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', '~> 4.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0'
   spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "selenium-webdriver", '~> 4.4'
   spec.add_development_dependency 'i18n-debug'
   spec.add_development_dependency 'i18n_yaml_sorter'
   spec.add_development_dependency 'rails-controller-testing', '~> 1'

data/lib/generators/hyrax/install_generator.rb

@@ -71,10 +71,6 @@ module Hyrax
       end
     end
 
-    def catalog_controller
-      copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
-    end
-
     # Add behaviors to the SolrDocument model
     def inject_solr_document_behavior
       file_path = 'app/models/solr_document.rb'
@@ -126,6 +122,10 @@ module Hyrax
       end
     end
 
+    def catalog_controller
+      copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
+    end
+
     def copy_helper
       copy_file 'hyrax_helper.rb', 'app/helpers/hyrax_helper.rb'
     end

data/lib/generators/hyrax/templates/catalog_controller.rb

@@ -5,8 +5,6 @@ class CatalogController < ApplicationController
 
   # This filter applies the hydra access controls
   before_action :enforce_show_permissions, only: :show
-  # Allow all search options when in read-only mode
-  skip_before_action :check_read_only
 
   def self.uploaded_field
     "system_create_dtsi"
@@ -21,7 +19,7 @@ class CatalogController < ApplicationController
 
     # Because too many times on Samvera tech people raise a problem regarding a failed query to SOLR.
     # Often, it's because they inadvertently exceeded the character limit of a GET request.
-    config.http_method = :post
+    config.http_method = Hyrax.config.solr_default_method
 
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     config.default_solr_params = {

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

@@ -22,6 +22,9 @@ Hyrax.config do |config|
   # avoid clashes if you plan to use the default (dct:hasFormat) for other relations.
   # config.rendering_predicate = ::RDF::DC.hasFormat
 
+  # Configure the Logger for the Hyrax application; by default it is the Rails.logger.
+  # config.logger = Rails.logger
+
   # Email recipient of messages sent via the contact form
   # config.contact_email = "repo-admin@example.org"
 
@@ -165,6 +168,10 @@ Hyrax.config do |config|
   #  config.upload_path = ->() { Rails.root + 'tmp' + 'uploads' }
   #  config.cache_path = ->() { Rails.root + 'tmp' + 'uploads' + 'cache' }
 
+  # The registered candidate derivative services.  In the array, the first `valid?` candidate will
+  # handle the derivative generation.
+  # config.derivative_services = [Hyrax::FileSetDerivativesService]
+
   # Location on local file system where derivatives will be stored
   # If you use a multi-server architecture, this MUST be a shared volume
   # config.derivatives_path = Rails.root.join('tmp', 'derivatives')
@@ -256,7 +263,7 @@ Hyrax.config do |config|
     if defined? BrowseEverything
       config.browse_everything = BrowseEverything.config
     else
-      Rails.logger.warn "BrowseEverything is not installed"
+      Hyrax.logger.warn "BrowseEverything is not installed"
     end
   rescue Errno::ENOENT
     config.browse_everything = nil

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

@@ -16,7 +16,7 @@ ActiveSupport::Reloader.to_prepare do
 
   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}"
+      Hyrax.logger.info "Riiif resolved #{id} to #{url}"
     end
   end
 

data/lib/hyrax/active_fedora_dummy_model.rb

@@ -35,12 +35,25 @@ module Hyrax
       @id
     end
 
+    ##
+    # @api public
+    def to_key
+      [@id]
+    end
+
     ##
     # @api public
     def model_name
       @model.model_name
     end
 
+    ##
+    # @api public
+    # @return [String]
+    def human_readable_type
+      @model.human_readable_type
+    end
+
     ##
     # @api public
     #