hyrax 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea0970bcb0ea485337ce206cd398d9ca95ce9f5dbd22bda820b6112e089ed624
-  data.tar.gz: c58183be603ec7ac6af52523412034f3b28332b2b8d5aa788239e7dabbf4c521
+  metadata.gz: d1dfd66c313400a16a149d5bdb7a2495164c18bce86b9bd8f079970b68e328cf
+  data.tar.gz: 66c678a483a9f2822712dea5f8448e55d9019dbdc47605b9a03177d0465ab775
 SHA512:
-  metadata.gz: af2b27f2c10d54ede9007a17f4a126bf408d92c163a924081658625212ff52edccb06bbc7edcf49fce1faa56c715bdf0454f687fbc284f93cfd8d30dbb26d46a
-  data.tar.gz: 85b38c0dc2628abbbb56dc8aed70461bb5fe6e9ce4444a2d61d6f972968efd1f9157881fc2a5f4443cb1bba85f0495b78e3bc2e7d0d7fe5ea9a8d4cb69d6946b
+  metadata.gz: 8309e7eb25d84767fd2395e04326df0c1f925bef0a2618818b0430327ac623f0f4078abbd45b5a966ccb6ccbc4c6bc233823e7d1b00d08b5e977771c97be4306
+  data.tar.gz: dd759280930d7cbc3448b3fafbfae5bbb631f9eb8fb93a9dca2e9ee73b3226f71d5b453ec29a40ac087dacf076059b752e8e72b2b9e35c5efab1b54743a1e958

data/.circleci/config.yml

@@ -189,21 +189,21 @@ workflows:
           hyrax_valkyrie: "true"
           requires:
             - build
-  ruby2-7-2:
+  ruby2-7-4:
     jobs:
       - bundle:
-          ruby_version: "2.7.2"
+          ruby_version: "2.7.4"
           rails_version: "5.2.6"
           bundler_version: "2.1.4"
       - build:
-          ruby_version: "2.7.2"
+          ruby_version: "2.7.4"
           rails_version: "5.2.6"
           bundler_version: "2.1.4"
           requires:
             - bundle
       - test:
-          name: "ruby2-7-2"
-          ruby_version: "2.7.2"
+          name: "ruby2-7-4"
+          ruby_version: "2.7.4"
           bundler_version: "2.1.4"
           requires:
             - build

data/.dassie/Gemfile

@@ -8,7 +8,7 @@ else
 end
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.7.2'
+ruby '2.7.4'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.2.4', '>= 5.2.4.4'

data/.dassie/app/controllers/catalog_controller.rb

@@ -5,6 +5,8 @@ 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"
@@ -28,6 +30,10 @@ class CatalogController < ApplicationController
     config.view.gallery.partials = [:index_header, :index]
     config.view.slideshow.partials = [:index]
 
+    # 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
+
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     config.default_solr_params = {
       qt: "search",

data/Dockerfile

@@ -1,6 +1,5 @@
-ARG RUBY_VERSION=2.7.2
-# lock at alpine3.12 because 3.13 has dns resolver problems
-FROM ruby:$RUBY_VERSION-alpine3.12 as hyrax-base
+ARG RUBY_VERSION=2.7.4
+FROM ruby:$RUBY_VERSION-alpine3.14 as hyrax-base
 
 ARG DATABASE_APK_PACKAGE="postgresql-dev"
 ARG EXTRA_APK_PACKAGES="git"

data/app/actors/hyrax/actors/base_actor.rb

@@ -37,7 +37,7 @@ module Hyrax
       # @return [Boolean] true if destroy was successful
       def destroy(env)
         env.curation_concern.in_collection_ids.each do |id|
-          destination_collection = ::Collection.find(id)
+          destination_collection = Hyrax.config.collection_class.find(id)
           destination_collection.members.delete(env.curation_concern)
           destination_collection.update_index
         end

data/app/actors/hyrax/actors/collections_membership_actor.rb

@@ -69,7 +69,7 @@ module Hyrax
       # Adds the item to the ordered members so that it displays in the items
       # along side the FileSets on the show page
       def add(env, id)
-        collection = ::Collection.find(id)
+        collection = Hyrax.config.collection_class.find(id)
         collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
 
         return unless env.current_ability.can?(:deposit, collection)
@@ -78,7 +78,7 @@ module Hyrax
 
       # Remove the object from the members set and the ordered members list
       def remove(curation_concern, id)
-        collection = ::Collection.find(id)
+        collection = Hyrax.config.collection_class.find(id)
         curation_concern.member_of_collections.delete(collection)
       end
 
@@ -107,7 +107,7 @@ module Hyrax
         collection_id = attributes_collection.first.second['id']
 
         # Do not apply permissions to work if collection type is configured not to
-        collection = ::Collection.find(collection_id)
+        collection = Hyrax.config.collection_class.find(collection_id)
         return unless collection.share_applies_to_new_works?
 
         # Save the collection id in env for use in apply_permission_template_actor

data/app/actors/hyrax/actors/file_set_actor.rb

@@ -165,6 +165,8 @@ module Hyrax
         elsif file_set.import_url.present?
           # This path is taken when file is a Tempfile (e.g. from ImportUrlJob)
           File.basename(Addressable::URI.unencode(file.file_url))
+        elsif file.respond_to?(:original_filename) # e.g. Rack::Test::UploadedFile
+          file.original_filename
         else
           File.basename(file)
         end

data/app/assets/stylesheets/hyrax/_styles.scss

@@ -72,3 +72,8 @@ label.disabled {
     }
   }
 }
+
+.read-only {
+  font-size: 1.2em;
+  margin: 0 0 10px;
+}

data/app/controllers/concerns/hyrax/collections_controller_behavior.rb

@@ -29,7 +29,7 @@ module Hyrax
     end
 
     def show
-      @curation_concern ||= Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: params[:id])
+      @curation_concern = @collection # we must populate curation_concern
       presenter
       query_collection_members
     end
@@ -101,14 +101,22 @@ module Hyrax
     #   uses the class attribute +parent_collection_query_service+ by default.
     def parent_collections(query_service: self.class.parent_collection_query_service)
       page = params[:parent_collection_page].to_i
-      collection.parent_collections = query_service.parent_collections(
-        child: collection_object, scope: self, page: page
-      )
+
+      collection.parent_collections =
+        query_service.parent_collections(child: collection_object,
+                                         scope: self,
+                                         page: page)
     end
     alias load_parent_collections parent_collections
 
+    ##
+    # @note this is here because, though we want to load and authorize the real
+    #   collection for show views, for apparently historical reasons,
+    #   {#collection} is overridden to access `@presenter`. this should probably
+    #   be deprecated and callers encouraged to use `@collection` but the scope
+    #   and impact of that change needs more evaluation.
     def collection_object
-      action_name == 'show' ? Collection.find(collection.id) : collection
+      action_name == 'show' ? @collection : collection
     end
 
     def member_subcollections

data/app/controllers/concerns/hyrax/controller.rb

@@ -16,6 +16,7 @@ module Hyrax::Controller
     include Hydra::Controller::ControllerBehavior
     helper_method :create_work_presenter
     before_action :set_locale
+    before_action :check_read_only, except: [:show, :index]
   end
 
   # Provide a place for Devise to send the user to after signing in
@@ -34,12 +35,14 @@ module Hyrax::Controller
   # @api public
   #
   # @return [#[]] a resolver for Hyrax's Transactions; this *should* be a
-  #   thread-safe Dry::Container, but callers to this method should strictly
-  #   use #[] for access
+  #   thread-safe {Dry::Container}, but callers to this method should strictly
+  #   use +#[]+ for access.
   #
   # @example
   #   transactions['change_set.create_work'].call(my_form)
   #
+  # @see Hyrax::Transactions::Container
+  # @see Hyrax::Transactions::Transaction
   # @see https://dry-rb.org/gems/dry-container
   def transactions
     Hyrax::Transactions::Container
@@ -88,4 +91,12 @@ module Hyrax::Controller
       wants.json { render_json_response(response_type: :unauthorized, message: json_message) }
     end
   end
+
+  # Redirect all deposit and edit requests with warning message when in read only mode
+  def check_read_only
+    return unless Flipflop.read_only?
+    # Allows feature to be turned off
+    return if self.class.to_s == Hyrax::Admin::StrategiesController.to_s
+    redirect_to root_path, flash: { error: t('hyrax.read_only') }
+  end
 end

data/app/controllers/hyrax/admin/admin_sets_controller.rb

@@ -4,9 +4,7 @@ module Hyrax
     include Hyrax::CollectionsControllerBehavior
 
     before_action :authenticate_user!
-    before_action :ensure_manager!, except: [:show]
     load_and_authorize_resource
-    before_action :ensure_viewer!, only: [:show]
 
     # Catch permission errors
     rescue_from Hydra::AccessDenied, CanCan::AccessDenied, with: :deny_adminset_access
@@ -43,10 +41,8 @@ module Hyrax
     end
 
     def index
-      add_breadcrumb t(:'hyrax.controls.home'), root_path
-      add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
-      add_breadcrumb t(:'hyrax.admin.sidebar.admin_sets'), hyrax.admin_admin_sets_path
-      @admin_sets = Hyrax::AdminSetService.new(self).search_results(:edit)
+      # admin sets are listed with collections
+      redirect_to hyrax.my_collections_url
     end
 
     def new
@@ -106,19 +102,6 @@ module Hyrax
       hyrax.edit_admin_admin_set_path(@admin_set) + (params[:referer_anchor] || '')
     end
 
-    def ensure_manager!
-      # TODO: Review for possible removal.  Doesn't appear to apply anymore.
-      # Even though the user can view this admin set, they may not be able to view
-      # it on the admin page.
-      authorize! :manage_any, AdminSet
-    end
-
-    def ensure_viewer!
-      # Even though the user can view this admin set, they may not be able to view
-      # it on the admin page if access is granted as a public or registered user only.
-      authorize! :view_admin_show, @admin_set
-    end
-
     def create_admin_set
       admin_set_create_service.call(admin_set: @admin_set, creating_user: current_user)
     end

data/app/controllers/hyrax/admin/permission_template_accesses_controller.rb

@@ -35,7 +35,7 @@ module Hyrax
           redirect_to hyrax.edit_admin_admin_set_path(source_id,
                                                       anchor: 'participants'),
                       notice: translate('participants', scope: 'hyrax.admin.admin_sets.form.permission_update_notices')
-        elsif source.collection?
+        else
           redirect_to hyrax.edit_dashboard_collection_path(source_id,
                                                            anchor: 'sharing'),
                       notice: translate('sharing', scope: 'hyrax.dashboard.collections.form.permission_update_notices')
@@ -47,7 +47,7 @@ module Hyrax
           redirect_to hyrax.edit_admin_admin_set_path(source_id,
                                                       anchor: 'participants'),
                       alert: @permission_template_access.errors.full_messages.to_sentence
-        elsif source.collection?
+        else
           redirect_to hyrax.edit_dashboard_collection_path(source_id,
                                                            anchor: 'sharing'),
                       alert: @permission_template_access.errors.full_messages.to_sentence
@@ -56,6 +56,9 @@ module Hyrax
 
       delegate :source_id, to: :permission_template
 
+      ##
+      # @todo can we avoid querying solr to deciede where to redirect? we
+      #   otherwise don't need this data at all.
       def source
         @source ||= ::SolrDocument.find(source_id)
       end

data/app/controllers/hyrax/collections_controller.rb

@@ -4,7 +4,9 @@ module Hyrax
     include CollectionsControllerBehavior
     include BreadcrumbsForCollections
     with_themed_layout :decide_layout
-    load_and_authorize_resource except: [:index, :show, :create], instance_name: :collection
+    load_and_authorize_resource except: [:index, :create],
+                                instance_name: :collection,
+                                class: Hyrax.config.collection_model
 
     # Renders a JSON response with a list of files in this collection
     # This is used by the edit form to populate the thumbnail_id dropdown

data/app/controllers/hyrax/dashboard/collection_members_controller.rb

@@ -7,6 +7,10 @@ module Hyrax
 
       include Hyrax::Collections::AcceptsBatches
 
+      load_resource only: :update_members,
+                    instance_name: :collection,
+                    class: Hyrax.config.collection_model
+
       def after_update
         respond_to do |format|
           format.html { redirect_to success_return_path, notice: t('hyrax.dashboard.my.action.collection_update_success') }
@@ -26,9 +30,9 @@ module Hyrax
         after_update_error(err_msg) if err_msg.present?
         return if err_msg.present?
 
-        collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
+        @collection.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX)
         begin
-          Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: collection.id,
+          Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: collection_id,
                                                                          new_member_ids: batch_ids,
                                                                          user: current_user)
           after_update
@@ -46,9 +50,12 @@ module Hyrax
       private
 
       def validate
-        return t('hyrax.dashboard.my.action.members_no_access') if batch_ids.blank?
-        return t('hyrax.dashboard.my.action.collection_deny_add_members') unless current_ability.can?(:deposit, collection)
-        return t('hyrax.dashboard.my.action.add_to_collection_only') unless member_action == "add" # should never happen
+        return t('hyrax.dashboard.my.action.members_no_access') if
+          batch_ids.blank?
+        return t('hyrax.dashboard.my.action.collection_deny_add_members') unless
+          current_ability.can?(:deposit, @collection)
+        return t('hyrax.dashboard.my.action.add_to_collection_only') unless
+          member_action == "add" # should never happen
       end
 
       def success_return_path
@@ -63,10 +70,6 @@ module Hyrax
         params[:id]
       end
 
-      def collection
-        @collection ||= ::Collection.find(collection_id)
-      end
-
       def batch_ids
         params[:batch_document_ids]
       end

data/app/controllers/hyrax/dashboard/collections_controller.rb

@@ -43,7 +43,12 @@ module Hyrax
       # The search builder to find the collections' members
       self.membership_service_class = Collections::CollectionMemberSearchService
 
-      load_and_authorize_resource except: [:index, :create], instance_name: :collection
+      load_and_authorize_resource except: [:index],
+                                  instance_name: :collection,
+                                  class: Hyrax.config.collection_model
+
+      skip_load_resource only: :create if
+        Hyrax.config.collection_class < ActiveFedora::Base
 
       def deny_collection_access(exception)
         if exception.action == :edit
@@ -63,14 +68,14 @@ module Hyrax
         @collection.collection_type_gid = CollectionType.find(collection_type_id).to_global_id
         add_breadcrumb t(:'hyrax.controls.home'), root_path
         add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
-        add_breadcrumb t('.header', type_title: @collection.collection_type.title), request.path
-        @collection.apply_depositor_metadata(current_user.user_key)
+        add_breadcrumb t('.header', type_title: collection_type.title), request.path
+        @collection.try(:apply_depositor_metadata, current_user.user_key)
         form
       end
 
       def show
         # @todo: remove this unused assignment in 4.0.0
-        @banner_file = presenter.banner_file if @collection.collection_type.brandable?
+        @banner_file = presenter.banner_file if collection_type.brandable?
 
         presenter
         query_collection_members
@@ -102,10 +107,11 @@ module Hyrax
       end
 
       def create
+        return valkyrie_create if @collection.is_a?(Valkyrie::Resource)
         # Manual load and authorize necessary because Cancan will pass in all
         # form attributes. When `permissions_attributes` are present the
         # collection is saved without a value for `has_model.`
-        @collection = ::Collection.new
+        @collection = Hyrax.config.collection_class.new
         authorize! :create, @collection
         # Coming from the UI, a collection type gid should always be present.  Coming from the API, if a collection type gid is not specified,
         # use the default collection type (provides backward compatibility with versions < Hyrax 2.1.0)
@@ -143,6 +149,9 @@ module Hyrax
         end
 
         process_member_changes
+
+        return valkyrie_update if @collection.is_a?(Valkyrie::Resource)
+
         @collection.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE unless @collection.discoverable?
         # we don't have to reindex the full graph when updating collection
         @collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
@@ -175,11 +184,20 @@ module Hyrax
       end
 
       def destroy
-        if @collection.destroy
+        case @collection
+        when Valkyrie::Resource
+          Hyrax.persister.delete(resource: @collection)
           after_destroy(params[:id])
         else
-          after_destroy_error(params[:id])
+          if @collection.destroy
+            after_destroy(params[:id])
+          else
+            after_destroy_error(params[:id])
+          end
         end
+      rescue StandardError => err
+        Rails.logger.error(err)
+        after_destroy_error(params[:id])
       end
 
       def collection
@@ -197,10 +215,36 @@ module Hyrax
 
       private
 
+      def valkyrie_create
+        form.validate(collection_params) &&
+          @collection = transactions['change_set.create_collection']
+                        .with_step_args(
+                          'change_set.set_user_as_depositor' => { user: current_user },
+                          'collection_resource.apply_collection_type_permissions' => { user: current_user }
+                        )
+                        .call(form)
+                        .value_or { return after_create_error }
+
+        add_members_to_collection unless batch.empty?
+        @collection
+      end
+
+      def valkyrie_update
+        form.validate(collection_params) &&
+          @collection = transactions['change_set.update_collection']
+                        .call(form)
+                        .value_or { return after_update_error }
+        after_update
+      end
+
       def default_collection_type
         Hyrax::CollectionType.find_or_create_default_collection_type
       end
 
+      def collection_type
+        @collection_type ||= CollectionType.find_by_gid!(collection.collection_type_gid)
+      end
+
       def link_parent_collection(parent_id)
         child = collection.respond_to?(:valkyrie_resource) ? collection.valkyrie_resource : collection
         Hyrax::Collections::CollectionMemberService.add_member(collection_id: parent_id,
@@ -341,8 +385,14 @@ module Hyrax
       deprecation_deprecate :single_item_search_builder
 
       def collection_params
-        @participants = extract_old_style_permission_attributes(params[:collection])
-        form_class.model_attributes(params[:collection])
+        if Hyrax.config.collection_class < ActiveFedora::Base
+          @participants = extract_old_style_permission_attributes(params[:collection])
+          form_class.model_attributes(params[:collection])
+        else
+          params.permit(collection: {})[:collection]
+                .merge(params.permit(:collection_type_gid))
+                .merge(member_of_collection_ids: Array(params[:parent_id]))
+        end
       end
 
       def extract_old_style_permission_attributes(attributes)
@@ -379,28 +429,36 @@ module Hyrax
         end
       end
 
-      def add_members_to_collection(collection = nil)
-        collection ||= @collection
-        Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: collection.id,
-                                                                       new_member_ids: batch,
-                                                                       user: current_user)
+      def add_members_to_collection(collection = nil, collection_id: nil)
+        collection_id ||= (collection.try(:id) || @collection.id)
+
+        Hyrax::Collections::CollectionMemberService
+          .add_members_by_ids(collection_id: collection_id,
+                              new_member_ids: batch,
+                              user: current_user)
       end
 
       def remove_members_from_collection
-        Hyrax::Collections::CollectionMemberService.remove_members_by_ids(collection_id: @collection.id,
-                                                                          member_ids: batch,
-                                                                          user: current_user)
+        Hyrax::Collections::CollectionMemberService
+          .remove_members_by_ids(collection_id: @collection.id,
+                                 member_ids: batch,
+                                 user: current_user)
       end
 
       def move_members_between_collections
-        destination_collection = ::Collection.find(params[:destination_collection_id])
         remove_members_from_collection
-        add_members_to_collection(destination_collection)
-        if destination_collection.save
-          flash[:notice] = "Successfully moved #{batch.count} files to #{destination_collection.title} Collection."
-        else
-          flash[:error] = "An error occured. Files were not moved to #{destination_collection.title} Collection."
-        end
+        add_members_to_collection(collection_id: params[:destination_collection_id])
+
+        destination_title =
+          Hyrax.query_service.find_by(id: params[:destination_collection_id]).title.first ||
+          params[:destination_collection_id]
+        flash[:notice] = "Successfully moved #{batch.count} files to #{destination_title} Collection."
+      rescue StandardError => err
+        Rails.logger.error(err)
+        destination_title =
+          Hyrax.query_service.find_by(id: params[:destination_collection_id]).title.first ||
+          destination_id
+        flash[:error] = "An error occured. Files were not moved to #{destination_title} Collection."
       end
 
       # Include 'catalog' and 'hyrax/base' in the search path for views, while prefering
@@ -420,7 +478,13 @@ module Hyrax
       end
 
       def form
-        @form ||= form_class.new(@collection, current_ability, repository)
+        @form ||=
+          case @collection
+          when Valkyrie::Resource
+            Hyrax::Forms::ResourceForm.for(@collection)
+          else
+            form_class.new(@collection, current_ability, repository)
+          end
       end
 
       def set_default_permissions
@@ -430,8 +494,8 @@ module Hyrax
 
       def query_collection_members
         member_works
-        member_subcollections if collection.collection_type.nestable?
-        parent_collections if collection.collection_type.nestable? && action_name == 'show'
+        member_subcollections if collection_type.nestable?
+        parent_collections if collection_type.nestable? && action_name == 'show'
       end
 
       # Instantiate the membership query service
@@ -459,7 +523,7 @@ module Hyrax
       end
 
       def collection_object
-        action_name == 'show' ? ::Collection.find(collection.id) : collection
+        @collection
       end
 
       # You can override this method if you need to provide additional