hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/{lib/hyrax/callbacks/registry.rb → app/services/hyrax/callbacks.rb}

@@ -1,6 +1,29 @@
 # frozen_string_literal: true
+
 module Hyrax
+  ##
+  # @deprecated
   module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      # Define class instance variable as endpoint to the
+      # Callback::Registry api.
+      @callback = Registry.new
+    end
+
+    module ClassMethods
+      # Reader for class instance variable containing callback definitions.
+      def callback
+        @callback
+      end
+    end
+
+    # Accessor to Callback::Registry api for instances.
+    def callback
+      self.class.callback
+    end
+
     class Registry
       attr_reader :callbacks
 

data/app/services/hyrax/change_content_depositor_service.rb

@@ -31,11 +31,14 @@ module Hyrax
         work.permission_manager.acl.permissions = []
         work.permission_manager.acl.save
       end
+
       work.proxy_depositor = work.depositor
       apply_depositor_metadata(work, user)
-      work.file_sets.each do |f|
+
+      Hyrax.custom_queries.find_child_filesets(resource: work).each do |f|
         apply_depositor_metadata(f, user)
       end
+
       work
     end
     private_class_method :call_valkyrie

data/app/services/hyrax/collection_member_service.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
-# returns a list of solr documents for collections the item is a part of
+
 module Hyrax
+  ##
+  # Returns a list of solr documents for collections the item is a part of
   class CollectionMemberService
     include Blacklight::Configurable
     include Blacklight::SearchHelper
@@ -9,7 +11,9 @@ module Hyrax
 
     copy_blacklight_config_from(CatalogController)
 
+    ##
     # @param [SolrDocument] item represents a work
+    # @param [Hyrax::Ability] ability
     def self.run(item, ability)
       new(item, ability).list_collections
     end

data/app/services/hyrax/collection_types/permissions_service.rb

@@ -170,8 +170,6 @@ module Hyrax
       #
       # What types of collection can the user create or manage
       #
-      # @param user [User] user - The user requesting to create/manage a Collection
-      # @param roles [String] type of access, Hyrax::CollectionTypeParticipant::MANAGE_ACCESS and/or Hyrax::CollectionTypeParticipant::CREATE_ACCESS
       # @return [Array<Hyrax::CollectionType>]
       # @note Several checks get the user's groups from the user's ability.  The same values can be retrieved directly from a passed in ability.
       #   If calling from Abilities, pass the ability.  If you try to get the ability from the user, you end up in an infinit loop.

data/app/services/hyrax/collections/collection_member_service.rb

@@ -1,91 +1,71 @@
 # frozen_string_literal: true
 module Hyrax
   module Collections
-    # Responsible for retrieving collection members
-    class CollectionMemberService
-      attr_reader :scope, :params, :collection
-      delegate :repository, to: :scope
-
+    ##
+    # Retrieves collection members
+    class CollectionMemberService < Hyrax::SearchService
+      ##
       # @param scope [#repository] Typically a controller object which responds to :repository
-      # @param [::Collection]
-      # @param [ActionController::Parameters] query params
-      def initialize(scope:, collection:, params:)
-        @scope = scope
-        @collection = collection
-        @params = params
+      # @param [::Collection] collection
+      # @param [ActionController::Parameters] params the query params
+      # @param [ActionController::Parameters] user_params
+      # @param [::Ability] current_ability
+      # @param [Class] search_builder_class a {::SearchBuilder}
+      def initialize(scope:, collection:, params:, user_params: nil, current_ability: nil, search_builder_class: Hyrax::CollectionMemberSearchBuilder) # rubocop:disable Metrics/ParameterLists
+        super(
+          config: scope.blacklight_config,
+          user_params: user_params || params,
+          collection: collection,
+          scope: scope,
+          current_ability: current_ability || scope.current_ability,
+          search_builder_class: search_builder_class
+        )
       end
 
+      ##
       # @api public
       #
       # Collections which are members of the given collection
-      # @return [Blacklight::Solr::Response] {up to 50 solr documents}
+      #
+      # @return [Blacklight::Solr::Response] (up to 50 solr documents)
       def available_member_subcollections
-        query_solr(query_builder: subcollections_search_builder, query_params: params_for_subcollections)
+        response, _docs = search_results do |builder|
+          # To differentiate current page for works vs subcollections, we have to use a sub_collection_page
+          # param. Map this to the page param before querying for subcollections, if it's present
+          builder.page(user_params[:sub_collection_page])
+          builder.search_includes_models = :collections
+          builder
+        end
+        response
       end
 
+      ##
       # @api public
       #
       # Works which are members of the given collection
+      #
       # @return [Blacklight::Solr::Response]
       def available_member_works
-        query_solr(query_builder: works_search_builder, query_params: params)
+        response, _docs = search_results do |builder|
+          builder.search_includes_models = :works
+          builder
+        end
+        response
       end
 
+      ##
       # @api public
       #
       # Work ids of the works which are members of the given collection
+      #
       # @return [Blacklight::Solr::Response]
       def available_member_work_ids
-        query_solr_with_field_selection(query_builder: work_ids_search_builder, fl: 'id')
-      end
-
-      private
-
-      # @api private
-      #
-      # set up a member search builder for works only
-      # @return [CollectionMemberSearchBuilder] new or existing
-      def works_search_builder
-        @works_search_builder ||= Hyrax::CollectionMemberSearchBuilder.new(scope: scope, collection: collection, search_includes_models: :works)
-      end
-
-      # @api private
-      #
-      # set up a member search builder for collections only
-      # @return [CollectionMemberSearchBuilder] new or existing
-      def subcollections_search_builder
-        @subcollections_search_builder ||= Hyrax::CollectionMemberSearchBuilder.new(scope: scope, collection: collection, search_includes_models: :collections)
-      end
-
-      # @api private
-      #
-      # set up a member search builder for returning work ids only
-      # @return [CollectionMemberSearchBuilder] new or existing
-      def work_ids_search_builder
-        @work_ids_search_builder ||= Hyrax::CollectionMemberSearchBuilder.new(scope: scope, collection: collection, search_includes_models: :works)
-      end
-
-      # @api private
-      #
-      def query_solr(query_builder:, query_params:)
-        repository.search(query_builder.with(query_params).query)
-      end
-
-      # @api private
-      #
-      def query_solr_with_field_selection(query_builder:, fl:)
-        repository.search(query_builder.merge(fl: fl).query)
-      end
-
-      # @api private
-      #
-      # Blacklight pagination still needs to be overridden and set up for the subcollections.
-      # @return <Hash> the additional inputs required for the subcollection member search builder
-      def params_for_subcollections
-        # To differentiate current page for works vs subcollections, we have to use a sub_collection_page
-        # param. Map this to the page param before querying for subcollections, if it's present
-        params[:page] = params.delete(:sub_collection_page)
-        params
+        response, _docs = search_results do |builder|
+          builder.search_includes_models = :works
+          builder.merge(fl: 'id')
+          builder
+        end
+        response
       end
     end
   end

data/app/services/hyrax/collections/managed_collections_service.rb

@@ -9,8 +9,21 @@ module Hyrax
       # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
       # @return [Array<SolrDocument>]
       def self.managed_collections_count(scope:)
-        query_builder = Hyrax::Dashboard::CollectionsSearchBuilder.new(scope).rows(0)
-        scope.repository.search(query_builder.query).response["numFound"]
+        response, _docs = search_service(scope).search_results do |builder|
+          builder.rows(0)
+        end
+
+        response.response['numFound']
+      end
+
+      def self.search_service(scope)
+        Hyrax::SearchService.new(
+          config: scope.blacklight_config,
+          user_params: {},
+          current_ability: scope.current_ability,
+          scope: scope,
+          search_builder_class: Hyrax::Dashboard::CollectionsSearchBuilder
+        )
       end
     end
   end

data/app/services/hyrax/collections/migration_service.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module Hyrax
   module Collections
+    ##
+    # @deprecated this migration tool should no longer be useful after Hyrax 2.1.0; Removal is planned for 4.0
     # Responsible for migrating legacy collections.  Legacy collections are those created before Hyrax 2.1.0 and
     # are identified by the lack of the collection having a collection type gid.
     class MigrationService
@@ -9,6 +11,8 @@ module Hyrax
       # Migrate all legacy collections to extended collections with collection type assigned.  Legacy collections are those
       # created before Hyrax 2.1.0 and are identified by the lack of the collection having a collection type gid.
       def self.migrate_all_collections
+        Deprecation.warn('This migration tool will be removed in Hyrax 4.0.0.')
+
         Rails.logger.info "*** Migrating #{::Collection.count} collections"
         ::Collection.all.each do |col|
           migrate_collection(col)
@@ -30,7 +34,7 @@ module Hyrax
       # @param collection [::Collection] collection object to be migrated
       def self.migrate_collection(collection)
         return if collection.collection_type_gid.present? # already migrated
-        collection.collection_type_gid = Hyrax::CollectionType.find_or_create_default_collection_type.gid
+        collection.collection_type_gid = Hyrax::CollectionType.find_or_create_default_collection_type.to_global_id
         create_permissions(collection)
         collection.save
       end
@@ -56,6 +60,8 @@ module Hyrax
       # access created and associated with the collection.  Any collection without collection type gid as nil or assigned
       # the default collection type are ignored.
       def self.repair_migrated_collections
+        Deprecation.warn('This migration tool will be removed in Hyrax 4.0.0.')
+
         Rails.logger.info "*** Repairing migrated collections"
         ::Collection.all.each do |col|
           repair_migrated_collection(col)
@@ -74,8 +80,8 @@ module Hyrax
       #
       # @param collection [::Collection] collection object to be migrated/repaired
       def self.repair_migrated_collection(collection)
-        return if collection.collection_type_gid.present? && collection.collection_type_gid != Hyrax::CollectionType.find_or_create_default_collection_type.gid
-        collection.collection_type_gid = Hyrax::CollectionType.find_or_create_default_collection_type.gid
+        return if collection.collection_type_gid.present? && collection.collection_type_gid != Hyrax::CollectionType.find_or_create_default_collection_type.to_global_id
+        collection.collection_type_gid = Hyrax::CollectionType.find_or_create_default_collection_type.to_global_id
         permission_template = Hyrax::PermissionTemplate.find_by(source_id: collection.id)
         if permission_template.present?
           collection.reset_access_controls!

data/app/services/hyrax/collections/nested_collection_persistence_service.rb

@@ -11,7 +11,7 @@ module Hyrax
       # @param child [::Collection]
       # @note There is odd permission arrangement based on the NestedCollectionQueryService:
       #       You can nest the child within a parent if you can edit the parent and read the child.
-      #       See https://wiki.duraspace.org/display/samvera/Samvera+Tech+Call+2017-08-23 for tech discussion.
+      #       See https://wiki.lyrasis.org/display/samvera/Samvera+Tech+Call+2017-08-23 for tech discussion.
       # @note Adding the member_of_collections method doesn't trigger reindexing of the child so we have to do it manually.
       #       However it save and reindexes the parent unnecessarily!!
       def self.persist_nested_collection_for(parent:, child:)

data/app/services/hyrax/collections/nested_collection_query_service.rb

@@ -2,13 +2,10 @@
 module Hyrax
   module Collections
     module NestedCollectionQueryService
+      ##
       # @api private
       #
       # an encapsulation of a collection's nesting index attributes
-      #
-      # @param id [String] a collection id
-      # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
-      # @return object [NestingAttributes]
       class NestingAttributes
         attr_accessor :parents, :pathnames, :ancestors, :depth, :id
 
@@ -25,6 +22,7 @@ module Hyrax
         end
       end
 
+      ##
       # @api public
       #
       # What possible collections can be nested within the given parent collection?
@@ -39,13 +37,17 @@ module Hyrax
         query_solr(collection: parent, access: :read, scope: scope, limit_to_id: limit_to_id, nest_direction: :as_child).documents
       end
 
+      ##
       # @api public
       #
       # What possible collections can the given child be nested within?
       #
       # @param child [::Collection]
-      # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
-      # @param limit_to_id [nil, String] Limit the query to just check if the given id is in the response. Useful for validation.
+      # @param scope [Object] Typically a controller object that responds
+      #   to +repository+, +can?+, +blacklight_config+, +current_ability+
+      # @param limit_to_id [nil, String] Limit the query to just check if
+      #   the given id is in the response. Useful for validation.
+      #
       # @return [Array<SolrDocument>]
       def self.available_parent_collections(child:, scope:, limit_to_id: nil)
         return [] unless child.try(:nestable?)
@@ -53,14 +55,16 @@ module Hyrax
         query_solr(collection: child, access: :deposit, scope: scope, limit_to_id: limit_to_id, nest_direction: :as_parent).documents
       end
 
+      ##
       # @api public
       #
       # What collections is the given child nested within?
       #
       # @param child [::Collection]
-      # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
+      # @param scope [Object] Typically a controller object that responds
+      #   to +repository+, +can?+, +blacklight_config+, +current_ability+
       # @param page [Integer] Starting page for pagination
-      # @param limit [Integer] Limit to number of collections for pagination
+      #
       # @return [Blacklight::Solr::Response]
       def self.parent_collections(child:, scope:, page: 1)
         return [] unless child.try(:nestable?)
@@ -69,12 +73,15 @@ module Hyrax
         scope.repository.search(query)
       end
 
+      ##
       # @api private
       #
       # @param collection [Collection]
       # @param access [Symbol] I need this kind of permission on the queried objects.
-      # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
-      # @param limit_to_id [nil, String] Limit the query to just check if the given id is in the response. Useful for validation.
+      # @param scope [Object] Typically a controller object that responds
+      #   to +repository+, +can?+, +blacklight_config+, +current_ability+
+      # @param limit_to_id [nil, String] Limit the query to just check if the given
+      #   id is in the response. Useful for validation.
       # @param nest_direction [Symbol] :as_child or :as_parent
       def self.query_solr(collection:, access:, scope:, limit_to_id:, nest_direction:)
         nesting_attributes = NestingAttributes.new(id: collection.id, scope: scope)
@@ -92,30 +99,38 @@ module Hyrax
       end
       private_class_method :query_solr
 
+      ##
       # @api private
       #
-      # clean query for {!lucene} error
+      # clean query for +{!lucene}+ error
       #
       # @param builder [SearchBuilder]
       # @return [Blacklight::Solr::Request] cleaned and functional query
       def self.clean_lucene_error(builder:)
-        # TODO: Need to investigate further to understand why these particular queries using the where cause fail when others in the app apparently work
+        # TODO: Need to investigate further to understand why these particular queries
+        # using the where cause fail when others in the app apparently work
         query = builder.query.to_hash
         query['q'] = query['q'].gsub('{!lucene}', '') if query.key?('q')
         query
       end
 
+      ##
       # @api public
       #
-      # @note There is a short-circuit of logic; To be robust, we should ensure that the child and parent are in the corresponding available collections
+      # @note There is a short-circuit of logic; To be robust, we should ensure that the child
+      #   and parent are in the corresponding available collections
       #
       # Is it valid to nest the given child within the given parent?
       #
       # @param parent [::Collection]
       # @param child [::Collection]
-      # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
+      # @param scope [Object] Typically a controller object that responds
+      #   to +repository+, +can?+, +blacklight_config+, +current_ability+
+      #
       # @return [Boolean] true if the parent can nest the child; false otherwise
-      # @todo Consider expanding from same collection type to a lookup table that says "This collection type can have within it, these collection types"
+      #
+      # @todo Consider expanding from same collection type to a lookup table that
+      #   says "This collection type can have within it, these collection types"
       def self.parent_and_child_can_nest?(parent:, child:, scope:)
         return false if parent == child # Short-circuit
         return false unless parent.collection_type_gid == child.collection_type_gid
@@ -129,8 +144,11 @@ module Hyrax
       # Does the nesting depth fall within defined limit?
       #
       # @param parent [::Collection]
-      # @param child [nil, ::Collection] will be nil if we are nesting a new collection under the parent
-      # @param scope [Object] Typically a controller object that responds to `repository`, `can?`, `blacklight_config`, `current_ability`
+      # @param child [nil, ::Collection] will be nil if we are nesting a new
+      #   collection under the parent
+      # @param scope [Object] Typically a controller object that responds
+      #   to +repository+, +can?+, +blacklight_config+, +current_ability+
+      #
       # @return [Boolean] true if the parent can nest the child; false otherwise
       def self.valid_combined_nesting_depth?(parent:, child: nil, scope:)
         # We limit the total depth of collections to the size specified in the samvera-nesting_indexer configuration.
@@ -145,7 +163,8 @@ module Hyrax
       # Get the child collection's nesting depth
       #
       # @param child [::Collection]
-      # @return [Fixnum] the largest number of collections in a path nested under this collection (including this collection)
+      # @return [Fixnum] the largest number of collections in a path nested
+      #   under this collection (including this collection)
       def self.child_nesting_depth(child:, scope:)
         return 1 if child.nil?
         # The nesting depth of a child collection is found by finding the largest nesting depth
@@ -177,7 +196,8 @@ module Hyrax
       # Get the parent collection's nesting depth
       #
       # @param parent [::Collection]
-      # @return [Fixnum] the largest number of collections above this collection (includes this collection)
+      # @return [Fixnum] the largest number of collections above
+      #   this collection (includes this collection)
       def self.parent_nesting_depth(parent:, scope:)
         return 1 if parent.nil?
         NestingAttributes.new(id: parent.id, scope: scope).depth

data/app/services/hyrax/collections/permissions_service.rb

@@ -42,7 +42,6 @@ module Hyrax
       # @param ability [Ability] the ability coming from cancan ability check
       # @return [Array<String>] IDs of admin sets for which the user has specified roles
       # @note Several checks get the user's groups from the user's ability.  The same values can be retrieved directly from a passed in ability.
-      # TODO: MOVE TO ABILITY
       def self.admin_set_ids_for_user(access:, ability:)
         source_ids_for_user(access: access, ability: ability, source_type: 'admin_set')
       end