hyrax 4.0.0.beta1 → 4.0.0.beta2

data/config/metadata/basic_metadata.yaml

@@ -113,6 +113,8 @@ attributes:
     multiple: true
     form:
       primary: true
+    index_keys:
+      - "rights_statement_tesim"
   source:
     type: string
     multiple: true

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/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/v4.0.0.beta1/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v4.0.0.beta2/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.beta2__. 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/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'
@@ -74,6 +74,7 @@ SUMMARY
   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 'reform', '~> 2.3'
@@ -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"

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
     #

data/lib/hyrax/configuration.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require 'hyrax/role_registry'
-require 'samvera/nesting_indexer'
 
 module Hyrax
   ##
@@ -65,12 +64,24 @@ module Hyrax
       @registered_concerns = []
       @role_registry = Hyrax::RoleRegistry.new
       @default_active_workflow_name = DEFAULT_ACTIVE_WORKFLOW_NAME
-      @nested_relationship_reindexer = default_nested_relationship_reindexer
     end
 
     DEFAULT_ACTIVE_WORKFLOW_NAME = 'default'
     private_constant :DEFAULT_ACTIVE_WORKFLOW_NAME
 
+    # Set the default logger for Hyrax.
+    attr_writer :logger
+
+    ##
+    # @return [Logger]
+    def logger
+      @logger ||= if defined?(Rails)
+                    Rails.logger
+                  else
+                    Valkyrie.logger
+                  end
+    end
+
     # @api public
     # When an admin set is created, we need to activate a workflow.
     # The :default_active_workflow_name is the name of the workflow we will activate.
@@ -643,7 +654,7 @@ module Hyrax
       # overriding the value in0 their config unless it's already
       # flipped to false
       if ENV.fetch('SERVER_SOFTWARE', '').match(/Apache.*Phusion_Passenger/).present?
-        Rails.logger.warn('Cannot enable realtime notifications atop Passenger + Apache. Coercing `Hyrax.config.realtime_notifications` to `false`. Set this value to `false` in config/initializers/hyrax.rb to stop seeing this warning.') unless @realtime_notifications == false
+        Hyrax.logger.warn('Cannot enable realtime notifications atop Passenger + Apache. Coercing `Hyrax.config.realtime_notifications` to `false`. Set this value to `false` in config/initializers/hyrax.rb to stop seeing this warning.') unless @realtime_notifications == false
         @realtime_notifications = false
       end
       return @realtime_notifications unless @realtime_notifications.nil?
@@ -827,18 +838,7 @@ module Hyrax
 
     attr_writer :uploader
     def uploader
-      @uploader ||= if Rails.env.development?
-                      # use sequential uploads in development to avoid database locking problems with sqlite3.
-                      default_uploader_config.merge(limitConcurrentUploads: 1, sequentialUploads: true)
-                    else
-                      default_uploader_config
-                    end
-    end
-
-    attr_accessor :nested_relationship_reindexer
-
-    def default_nested_relationship_reindexer
-      ->(id:, extent:) { Samvera::NestingIndexer.reindex_relationships(id: id, extent: extent) }
+      @uploader ||= default_uploader_config
     end
 
     attr_writer :solr_select_path
@@ -865,6 +865,16 @@ module Hyrax
       @range_for_number_of_results_to_display_per_page ||= [10, 20, 50, 100]
     end
 
+    attr_writer :derivative_services
+    # The registered candidate derivative services.  In the array, the first `valid?` candidate will
+    # handle the derivative generation.
+    #
+    # @return [Array] of objects that conform to Hyrax::DerivativeService interface.
+    # @see Hyrax::DerivativeService
+    def derivative_services
+      @derivative_services ||= [Hyrax::FileSetDerivativesService]
+    end
+
     private
 
     # @param [Symbol, #to_s] model_name - symbol representing the model

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

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

data/lib/hyrax/engine.rb

@@ -68,7 +68,7 @@ module Hyrax
 
       can_persist = can_connect && begin
         Hyrax.config.persist_registered_roles!
-        Rails.logger.info("Hyrax::Engine.after_initialize - persisting registered roles!")
+        Hyrax.logger.info("Hyrax::Engine.after_initialize - persisting registered roles!")
         true
                                    rescue ActiveRecord::StatementInvalid
                                      false
@@ -78,8 +78,12 @@ module Hyrax
         message = "Hyrax::Engine.after_initialize - unable to persist registered roles.\n"
         message += "It is expected during the application installation - during integration tests, rails install.\n"
         message += "It is UNEXPECTED if you are booting up a Hyrax powered application via `rails server'"
-        Rails.logger.info(message)
+        Hyrax.logger.info(message)
       end
+
+      # Force CatalogController to use our SearchState class, which has an important
+      # work-around for some highly suspect SPARQL-gem monkeypatching.
+      CatalogController.search_state_class = Hyrax::SearchState if CatalogController.try(:search_state_class) == Blacklight::SearchState
     end
 
     initializer 'requires' do

data/lib/hyrax/errors.rb

@@ -15,4 +15,6 @@ module Hyrax
   class SingleMembershipError < HyraxError; end
 
   class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError; end
+
+  class ModelMismatchError < HyraxError; end
 end

data/lib/hyrax/publisher.rb

@@ -119,6 +119,10 @@ module Hyrax
     #     unique id), AND a `:user` (the ::User responsible for the update).
     register_event('collection.membership.updated')
 
+    # @since 3.5.0
+    # @macro a_registered_event
+    register_event('file.characterized')
+
     # @since 3.3.0
     # @macro a_registered_event
     register_event('file.downloaded')

data/lib/hyrax/search_state.rb

@@ -9,5 +9,14 @@ module Hyrax
       return [hyrax, doc] if doc.collection?
       [main_app, doc]
     end
+
+    # The SPARQL gem stomps on the Rails definition of deep_dup and gives us a Hash instead of
+    # a HashWithIndifferentAccess. This is an ugly workaround to get the right contract with
+    # the upstream class.
+    # https://github.com/ruby-rdf/sparql/blob/develop/lib/sparql/algebra/extensions.rb#L238-L244
+    def to_hash
+      super.with_indifferent_access
+    end
+    alias to_h to_hash
   end
 end

data/lib/hyrax/specs/capybara.rb

@@ -23,12 +23,12 @@ if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
   args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
   args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
 
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome("goog:chromeOptions" => { args: args })
+  options = Selenium::WebDriver::Options.chrome("goog:chromeOptions" => { args: args })
 
   Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
     driver = Capybara::Selenium::Driver.new(app,
                                        browser: :remote,
-                                       desired_capabilities: capabilities,
+                                       capabilities: options,
                                        url: ENV['HUB_URL'])
 
     # Fix for capybara vs remote files. Selenium handles this for us

data/lib/hyrax/specs/shared_specs/factories/strategies/json_strategy.rb

@@ -10,4 +10,8 @@ class JsonStrategy
   def result(evaluation)
     @strategy.result(evaluation).to_json
   end
+
+  def to_sym
+    :json
+  end
 end

data/lib/hyrax/specs/shared_specs/factories/strategies/valkyrie_resource.rb

@@ -3,6 +3,12 @@
 # @example
 #   let(:resource) { FactoryBot.valkyrie_create(:hyrax_work) }
 class ValkyrieCreateStrategy
+  def initialize
+    @strategy = FactoryBot.strategy_by_name(:create).new
+  end
+
+  delegate :association, to: :@strategy
+
   def result(evaluation)
     evaluation.notify(:after_build, evaluation.object)
     evaluation.notify(:before_create, evaluation.object)
@@ -13,6 +19,10 @@ class ValkyrieCreateStrategy
     result
   end
 
+  def to_sym
+    :valkyrie_create
+  end
+
   private
 
   def persister

data/lib/hyrax/specs/shared_specs/indexers.rb

@@ -266,6 +266,11 @@ RSpec.shared_examples 'a Collection indexer' do
         .to include(generic_type_sim: a_collection_containing_exactly('Collection'))
     end
 
+    it 'indexes member_of_collection_ids' do
+      expect(indexer.to_solr)
+        .to include(member_of_collection_ids_ssim: resource.member_of_collection_ids)
+    end
+
     it 'indexes depositor' do
       expect(indexer.to_solr)
         .to include(depositor_ssim: [resource.depositor],

data/lib/hyrax/transactions/steps/remove_file_set_from_work.rb

@@ -32,15 +32,41 @@ module Hyrax
         # @return [Dry::Monads::Result]
         def call(file_set, user: nil)
           return Failure('No user provided.') if user.nil?
-
-          @query_service.find_parents(resource: file_set).each do |parent|
+          find_parents(resource: file_set).each do |parent|
             parent.member_ids -= [file_set.id]
+            unlink_file_set(parent: parent, file_set: file_set)
             saved = @persister.save(resource: parent)
             Hyrax.publisher.publish('object.metadata.updated', object: saved, user: user)
           end
-
           Success(file_set)
         end
+
+        private
+
+        def find_parents(resource:)
+          @query_service.find_parents(resource: resource)
+        end
+
+        def unlink_file_set(parent:, file_set:)
+          fid = file_set.id
+          unlink_thumbnail_id(fid: fid, parent: parent)
+          unlink_representative_id(fid: fid, parent: parent)
+          unlink_rendering_ids(fid: fid, parent: parent)
+        end
+
+        def unlink_rendering_ids(fid:, parent:)
+          parent.rendering_ids -= [fid] if parent.respond_to?(:rendering_ids) && parent.rendering_ids.present?
+        end
+
+        def unlink_representative_id(fid:, parent:)
+          parent.representative_id = nil if parent.representative_id == fid
+        end
+
+        def unlink_thumbnail_id(fid:, parent:)
+          return unless parent.thumbnail_id == fid
+          parent.thumbnail = nil if parent.respond_to? :thumbnail
+          parent.thumbnail_id = nil
+        end
       end
     end
   end

data/lib/hyrax/transactions/steps/save_access_control.rb

@@ -16,13 +16,29 @@ module Hyrax
         # @param [Valkyrie::Resource] obj
         #
         # @return [Dry::Monads::Result]
-        def call(obj)
+        def call(obj, permissions_params: [])
           return Success(obj) unless obj.respond_to?(:permission_manager)
+
           acl = obj.permission_manager&.acl
+          # Translate step args into Hyrax::Permission objects before saving
+          Array(permissions_params).each do |param|
+            permission = param_to_permission(obj, param)
+            acl << permission if permission
+          end
+
           acl&.save || (return Failure[:failed_to_save_acl, acl])
 
           Success(obj)
         end
+
+        private
+
+        def param_to_permission(obj, param)
+          return nil unless param["access"] && param["type"] && param["name"]
+          mode = param["access"].to_sym
+          agent = param["type"] == "group" ? "group/#{param['name']}" : param["name"]
+          Hyrax::Permission.new(access_to: obj.id, mode: mode, agent: agent)
+        end
       end
     end
   end

data/lib/hyrax/version.rb

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

data/lib/hyrax.rb

@@ -80,7 +80,7 @@ module Hyrax
   ##
   # @return [Logger]
   def self.logger
-    @logger ||= Valkyrie.logger
+    config.logger
   end
 
   def self.primary_work_type