hyrax 3.0.0.pre.rc1 → 3.0.0.pre.rc2

data/app/services/hyrax/collection_member_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # returns a list of solr documents for collections the item is a part of
 module Hyrax
   class CollectionMemberService

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module CollectionTypes
     # @api public

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module CollectionTypes
     class PermissionsService
@@ -13,7 +14,7 @@ module Hyrax
       #   If calling from Abilities, pass the ability.  If you try to get the ability from the user, you end up in an infinit loop.
       def self.collection_type_ids_for_user(roles:, user: nil, ability: nil)
         return false unless user.present? || ability.present?
-        return Hyrax::CollectionType.all.pluck(Arel.sql('DISTINCT id')) if user_admin?(user, ability)
+        return Hyrax::CollectionType.all.select(:id).distinct.pluck(:id) if user_admin?(user, ability)
         Hyrax::CollectionTypeParticipant.where(agent_type: Hyrax::CollectionTypeParticipant::USER_TYPE,
                                                agent_id: user_id(user, ability),
                                                access: roles)
@@ -21,7 +22,10 @@ module Hyrax
                                           Hyrax::CollectionTypeParticipant.where(agent_type: Hyrax::CollectionTypeParticipant::GROUP_TYPE,
                                                                                  agent_id: user_groups(user, ability),
                                                                                  access: roles)
-                                        ).pluck(Arel.sql('DISTINCT hyrax_collection_type_id'))
+                                        )
+                                        .select(:hyrax_collection_type_id)
+                                        .distinct
+                                        .pluck(:hyrax_collection_type_id)
       end
 
       # @api public

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     # Responsible for retrieving collection members
@@ -6,7 +7,7 @@ module Hyrax
       delegate :repository, to: :scope
 
       # @param scope [#repository] Typically a controller object which responds to :repository
-      # @param [Collection]
+      # @param [::Collection]
       # @param [ActionController::Parameters] query params
       def initialize(scope:, collection:, params:)
         @scope = scope
@@ -40,52 +41,52 @@ module Hyrax
 
       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 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 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
+      #
+      # 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(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
+      #
+      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
-        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
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     module ManagedCollectionsService

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     # Responsible for migrating legacy collections.  Legacy collections are those created before Hyrax 2.1.0 and
@@ -8,8 +9,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
-        Rails.logger.info "*** Migrating #{Collection.count} collections"
-        Collection.all.each do |col|
+        Rails.logger.info "*** Migrating #{::Collection.count} collections"
+        ::Collection.all.each do |col|
           migrate_collection(col)
           Rails.logger.info "  migrating collection - id: #{col.id}, title: #{col.title}"
         end
@@ -26,7 +27,7 @@ module Hyrax
       # Migrate a single legacy collection 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.
       #
-      # @param collection [Collection] collection object to be migrated
+      # @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
@@ -56,7 +57,7 @@ module Hyrax
       # the default collection type are ignored.
       def self.repair_migrated_collections
         Rails.logger.info "*** Repairing migrated collections"
-        Collection.all.each do |col|
+        ::Collection.all.each do |col|
           repair_migrated_collection(col)
           Rails.logger.info "  repairing collection - id: #{col.id}, title: #{col.title}"
         end
@@ -71,7 +72,7 @@ module Hyrax
       #
       # Validate and repair a migrated collection if needed.
       #
-      # @param collection [Collection] collection object to be migrated/repaired
+      # @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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     module NestedCollectionPersistenceService
@@ -6,8 +7,8 @@ module Hyrax
       # Responsible for persisting the relationship between the parent and the child.
       # @see Hyrax::Collections::NestedCollectionQueryService
       #
-      # @param parent [Collection]
-      # @param child [Collection]
+      # @param parent [::Collection]
+      # @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.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     module NestedCollectionQueryService
@@ -28,7 +29,7 @@ module Hyrax
       #
       # What possible collections can be nested within the given parent collection?
       #
-      # @param parent [Collection]
+      # @param parent [::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.
       # @return [Array<SolrDocument>]
@@ -42,7 +43,7 @@ module Hyrax
       #
       # What possible collections can the given child be nested within?
       #
-      # @param child [Collection]
+      # @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.
       # @return [Array<SolrDocument>]
@@ -56,7 +57,7 @@ module Hyrax
       #
       # What collections is the given child nested within?
       #
-      # @param child [Collection]
+      # @param child [::Collection]
       # @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
@@ -100,7 +101,7 @@ module Hyrax
       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
         query = builder.query.to_hash
-        query['q'].gsub!('{!lucene}', '') if query.key? 'q'
+        query['q'] = query['q'].gsub('{!lucene}', '') if query.key?('q')
         query
       end
 
@@ -110,8 +111,8 @@ module Hyrax
       #
       # Is it valid to nest the given child within the given parent?
       #
-      # @param parent [Collection]
-      # @param child [Collection]
+      # @param parent [::Collection]
+      # @param child [::Collection]
       # @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"
@@ -127,8 +128,8 @@ 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 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`
       # @return [Boolean] true if the parent can nest the child; false otherwise
       def self.valid_combined_nesting_depth?(parent:, child: nil, scope:)
@@ -143,7 +144,7 @@ module Hyrax
       #
       # Get the child collection's nesting depth
       #
-      # @param child [Collection]
+      # @param child [::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?
@@ -175,7 +176,7 @@ module Hyrax
       #
       # Get the parent collection's nesting depth
       #
-      # @param parent [Collection]
+      # @param parent [::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?

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     class PermissionsCreateService
@@ -5,7 +6,7 @@ module Hyrax
       #
       # Set the default permissions for a (newly created) collection
       #
-      # @param collection [Collection] the collection the new permissions will act on
+      # @param collection [::Collection] the collection the new permissions will act on
       # @param creating_user [User] the user that created the collection
       # @param grants [Array<Hash>] additional grants to apply to the new collection
       # @return [Hyrax::PermissionTemplate]
@@ -29,7 +30,7 @@ module Hyrax
       #       access: Hyrax::PermissionTemplateAccess::DEPOSIT } ]
       # @see Hyrax::PermissionTemplateAccess for valid values for agent_type and access
       def self.add_access(collection_id:, grants:)
-        collection = Collection.find(collection_id)
+        collection = ::Collection.find(collection_id)
         template = Hyrax::PermissionTemplate.find_by!(source_id: collection_id)
         grants.each do |grant|
           Hyrax::PermissionTemplateAccess.find_or_create_by(permission_template_id: template.id,

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     class PermissionsService
@@ -13,7 +14,7 @@ module Hyrax
       def self.source_ids_for_user(access:, ability:, source_type: nil, exclude_groups: [])
         scope = PermissionTemplateAccess.for_user(ability: ability, access: access, exclude_groups: exclude_groups)
                                         .joins(:permission_template)
-        ids = scope.pluck(Arel.sql('DISTINCT source_id'))
+        ids = scope.select(:source_id).distinct.pluck(:source_id)
         return ids unless source_type
         filter_source(source_type: source_type, ids: ids)
       end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     class SearchService

data/app/services/hyrax/collections_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class CollectionsService
     attr_reader :context
@@ -19,10 +20,10 @@ module Hyrax
 
     private
 
-      def list_search_builder(access)
-        list_search_builder_class.new(context)
-                                 .rows(100)
-                                 .with_access(access)
-      end
+    def list_search_builder(access)
+      list_search_builder_class.new(context)
+                               .rows(100)
+                               .with_access(access)
+    end
   end
 end

data/app/services/hyrax/contextual_path.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class ContextualPath
     include Rails.application.routes.url_helpers

data/app/services/hyrax/curation_concern.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class CurationConcern
     # The actor middleware stack can be customized like so:

data/app/services/hyrax/custom_queries/find_access_control.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Hyrax
+  module CustomQueries
+    # @example
+    #   Hyrax.custom_queries.find_access_control_for(resource: resource)
+    class FindAccessControl
+      def self.queries
+        [:find_access_control_for]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+
+      def find_access_control_for(resource:)
+        query_service
+          .find_inverse_references_by(resource: resource, property: :access_to)
+          .find { |r| r.is_a?(Hyrax::AccessControl) } ||
+          raise(Valkyrie::Persistence::ObjectNotFoundError)
+      rescue ArgumentError # some adapters raise ArgumentError for missing resources
+        raise(Valkyrie::Persistence::ObjectNotFoundError)
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/find_collections_by_type.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Hyrax
+  module CustomQueries
+    # @example
+    #   collection_type = Hyrax::CollectionType.find(1)
+    #
+    #   Hyrax.custom_queries.find_collections_by_type(global_id: collection_type.to_global_id)
+    #
+    # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+    class FindCollectionsByType
+      def self.queries
+        [:find_collections_by_type]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+
+      ##
+      # @note this is an unoptimized default implementation of this custom
+      #   query. it's Hyrax's policy to provide such implementations of custom
+      #   queries in use for cross-compatibility of Valkyrie query services.
+      #   it's advisable to provide an optimized query for the specific adapter.
+      #
+      # @param global_id [GlobalID] global id for a Hyrax::CollectionType
+      #
+      # @return [Enumerable<PcdmCollection>]
+      def find_collections_by_type(global_id:)
+        query_service
+          .find_all_of_model(model: PcdmCollection)
+          .select { |collection| collection.collection_type_gid == global_id }
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/find_file_metadata.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# Provide custom queries for finding Hyrax::FileMetadata
+# @example
+#   Hyrax.custom_queries.find_file_metadata_by(id: valkyrie_id)
+#   Hyrax.custom_queries.find_file_metadata_by_alternate_identifier(alternate_identifier: alt_id)
+#   Hyrax.custom_queries.find_many_file_metadata_by_ids(ids: [valkyrie_id, valkyrie_id])
+module Hyrax
+  module CustomQueries
+    class FindFileMetadata
+      def self.queries
+        [:find_file_metadata_by,
+         :find_file_metadata_by_alternate_identifier,
+         :find_many_file_metadata_by_ids,
+         :find_many_file_metadata_by_use]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+
+      # Find a file metadata using a Valkyrie ID, and map it to a Hyrax::FileMetadata
+      # @param id [Valkyrie::ID, String]
+      # @return [Hyrax::FileMetadata]
+      # @raise [Hyrax::ObjectNotFoundError]
+      def find_file_metadata_by(id:)
+        result = query_service.find_by(id: id)
+        unless result.is_a? Hyrax::FileMetadata
+          raise ::Valkyrie::Persistence::ObjectNotFoundError,
+                "Result type #{result.internal_resource} for id #{id} is not a `Hyrax::FileMetadata`"
+        end
+        result
+      end
+
+      # Find a file metadata using an alternate ID, and map it to a Hyrax::FileMetadata
+      # @param alternate_identifier [Valkyrie::ID, String]
+      # @return [Hyrax::FileMetadata]
+      # @raise [Hyrax::ObjectNotFoundError]
+      def find_file_metadata_by_alternate_identifier(alternate_identifier:)
+        result = query_service.find_by_alternate_identifier(alternate_identifier: alternate_identifier)
+        unless result.is_a? Hyrax::FileMetadata
+          raise ::Valkyrie::Persistence::ObjectNotFoundError,
+                "Result type #{result.internal_resource} for alternate_identifier #{alternate_identifier} is not a `Hyrax::FileMetadata`"
+        end
+        result
+      end
+
+      # Find an array of file metadata using Valkyrie IDs, and map them to Hyrax::FileMetadata maintaining order based on given ids
+      # @param ids [Array<Valkyrie::ID, String>]
+      # @return [Array<Hyrax::FileMetadata>] or empty array if there are no ids or none of the ids map to Hyrax::FileMetadata
+      # NOTE: Ignores non-existent ids and ids for non-file metadata resources.
+      def find_many_file_metadata_by_ids(ids:)
+        results = query_service.find_many_by_ids(ids: ids)
+        results.select { |resource| resource.is_a? Hyrax::FileMetadata }
+      end
+
+      # Find file metadata for files within a resource that have the requested use.
+      # @param use [RDF::URI] uri for the desired use Type
+      # @return [Array<Hyrax::FileMetadata] or empty array if there are no files with the requested use
+      # @example
+      #   Hyrax.query_service.find_file_metadata_by_use(use: ::RDF::URI("http://pcdm.org/ExtractedText"))
+      def find_many_file_metadata_by_use(resource:, use:)
+        return [] unless resource.try(:file_ids)
+
+        results = find_many_file_metadata_by_ids(ids: resource.file_ids)
+        results.select { |fm| fm.type.include?(use) }
+      end
+    end
+  end
+end