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

data/app/search_builders/hyrax/README.md

@@ -1,6 +1,6 @@
 # Search Builders
 
-Building searches is core to any Blacklight app, and Hyrax is no exception.  
+Building searches is core to any Blacklight app, and Hyrax is no exception.
 This directory contains our Search Builders, so named because the design followed a builder pattern, meaning
 that when invoked to set values, methods return the object itself, so that invocations can be chained, like:
 
@@ -11,13 +11,13 @@ builder = Blacklight::SearchBuilder.new(processor_chain, scope)
             .with(q: 'Abraham Lincoln')
 ```
 
-However, at this level, many if not most of the additional methods do not follow this pattern.  
+However, at this level, many if not most of the additional methods do not follow this pattern.
 Refer to the `Blacklight::SearchBuilder` class if you want to be certain.  That leads to the next topic...
 
 ## Ancestry
 
 Most of the SearchBuilders have `::SearchBuilder` as a parent or ancestor.  `::SearchBuilder` does not exist in any repo: it is generated
-by Blacklight and modified by Hyrax.  Others descend from `Blacklight::SearchBuilder`, or various other relatives.  
+by Blacklight and modified by Hyrax.  Others descend from `Blacklight::SearchBuilder`, or various other relatives.
 
 ### ::SearchBuilder
 

data/app/search_builders/hyrax/admin_admin_set_member_search_builder.rb

@@ -8,14 +8,20 @@ module Hyrax
 
     attr_reader :collection
 
-    # @param [scope] Typically the controller object
-    # @param [::Collection]
+    ##
+    # @param [Object] scope Typically the controller object
+    # @param [::Collection] collection
     def initialize(scope:, collection:)
       @collection = collection
       super(scope)
     end
 
+    ##
     # include filters into the query to only include the admin_set members (regardless of status)
+    #
+    # @param [Hash] solr_parameters
+    #
+    # @return [void]
     def in_admin_set(solr_parameters)
       solr_parameters[:fq] ||= []
       solr_parameters[:fq] << "{!term f=#{Hyrax.config.admin_set_predicate.qname.last}_ssim}#{collection.id}"

data/app/search_builders/hyrax/collection_member_search_builder.rb

@@ -3,7 +3,7 @@ module Hyrax
   # This search builder requires that a accessor named "collection" exists in the scope
   class CollectionMemberSearchBuilder < ::SearchBuilder
     include Hyrax::FilterByType
-    attr_reader :collection, :search_includes_models
+    attr_writer :collection, :search_includes_models
 
     class_attribute :collection_membership_field
     self.collection_membership_field = 'member_of_collection_ids_ssim'
@@ -11,14 +11,28 @@ module Hyrax
     # Defines which search_params_logic should be used when searching for Collection members
     self.default_processor_chain += [:member_of_collection]
 
-    # @param [scope] Typically the controller object
-    # @param [Symbol] :works, :collections, (anything else retrieves both)
-    def initialize(scope:,
-                   collection:,
-                   search_includes_models: :works)
+    # @param [Object] scope Typically the controller object
+    # @param [Symbol] search_includes_models +:works+ or +:collections+; (anything else retrieves both)
+    def initialize(*args,
+                   scope: nil,
+                   collection: nil,
+                   search_includes_models: nil)
       @collection = collection
       @search_includes_models = search_includes_models
-      super(scope)
+
+      if args.any?
+        super(*args)
+      else
+        super(scope)
+      end
+    end
+
+    def collection
+      @collection || (scope.context[:collection] if scope&.respond_to?(:context))
+    end
+
+    def search_includes_models
+      @search_includes_models || :works
     end
 
     # include filters into the query to only include the collection memebers

data/app/search_builders/hyrax/dashboard/managed_search_filters.rb

@@ -15,7 +15,7 @@ module Hyrax
         return [] if groups.empty?
         permission_types.map do |type|
           field = solr_field_for(type, 'group')
-          user_groups = type == 'read' ? groups - ['public', 'registered'] : groups
+          user_groups = type == 'read' ? groups - [::Ability.public_group_name, ::Ability.registered_group_name] : groups
           next if user_groups.empty?
           "({!terms f=#{field}}#{user_groups.join(',')})" # parens required to properly OR the clauses together.
         end

data/app/search_builders/hyrax/dashboard/nested_collections_search_builder.rb

@@ -28,7 +28,7 @@ module Hyrax
         solr_parameters[:fq] ||= []
         solr_parameters[:fq] += [
           "-" + Hyrax::SolrQueryBuilderService.construct_query_for_ids([limit_ids]),
-          Hyrax::SolrQueryBuilderService.construct_query(::Collection.collection_type_gid_document_field_name => @collection.collection_type_gid)
+          Hyrax::SolrQueryBuilderService.construct_query(Hyrax.config.collection_type_index_field => @collection.collection_type_gid)
         ]
         solr_parameters[:fq] += limit_clause if limit_clause # add limits to prevent illegal nesting arrangements
       end

data/app/search_builders/hyrax/embargo_search_builder.rb

@@ -4,7 +4,6 @@ module Hyrax
   class EmbargoSearchBuilder < Blacklight::SearchBuilder
     self.default_processor_chain = [:with_pagination, :with_sorting, :only_active_embargoes]
 
-    # TODO: add more complex pagination
     def with_pagination(solr_params)
       solr_params[:rows] = 1000
     end

data/app/search_builders/hyrax/filter_by_type.rb

@@ -30,7 +30,9 @@ module Hyrax
     end
 
     def models_to_solr_clause
-      models.map { |model| model.try(:to_rdf_representation) || model.name }.join(',')
+      models.map do |model|
+        model.respond_to?(:to_rdf_representation) ? model.to_rdf_representation : model.name
+      end.join(',')
     end
 
     def generic_type_field

data/app/search_builders/hyrax/lease_search_builder.rb

@@ -4,7 +4,6 @@ module Hyrax
   class LeaseSearchBuilder < Blacklight::SearchBuilder
     self.default_processor_chain = [:with_pagination, :with_sorting, :only_active_leases]
 
-    # TODO: add more complex pagination
     def with_pagination(solr_params)
       solr_params[:rows] = 1000
     end

data/app/search_builders/hyrax/nested_collections_parent_search_builder.rb

@@ -1,25 +1,35 @@
 # frozen_string_literal: true
 module Hyrax
+  ##
   # Searches for all collections that are parents of a given collection.
   class NestedCollectionsParentSearchBuilder < ::SearchBuilder
     include Hyrax::FilterByType
     attr_reader :child, :page, :limit
 
-    # @param [scope] Typically the controller object
-    # @param [child] The child collection
+    # @param [Object] scope Typically the controller object
+    # @param [ActiveFedora::Base] child The child collection
     def initialize(scope:, child:, page:)
       @child = child
       @page = page
       super(scope)
     end
 
+    ##
     # Filters the query to only include the parent collections
+    #
+    # @param [Hash] solr_parameters
+    #
+    # @return [void]
     def parent_collections_only(solr_parameters)
       solr_parameters[:fq] ||= []
       solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids(child.member_of_collection_ids)]
     end
     self.default_processor_chain += [:parent_collections_only]
 
+    ##
+    # @param [Hash] solr_parameters
+    #
+    # @return [void]
     def with_pagination(solr_parameters)
       solr_parameters[:page] = page
     end

data/app/search_builders/hyrax/search_builder.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 module Hyrax
-  class SearchBuilder < Blacklight::SearchBuilder
-    include Blacklight::Solr::SearchBuilderBehavior
-    include Hydra::AccessControlsEnforcement
-    include Hyrax::SearchFilters
+  class SearchBuilder < ::SearchBuilder
   end
 end

data/app/search_builders/hyrax/search_filters.rb

@@ -22,12 +22,10 @@ module Hyrax
 
     private
 
-    # TODO: could this be moved to Blacklight::AccessControls::Enforcement?
     def current_user_key
       current_user.user_key
     end
 
-    # TODO: could this be moved to Blacklight::AccessControls::Enforcement?
     def current_user
       scope.current_user
     end

data/app/services/hyrax/access_control_list.rb

@@ -1,6 +1,23 @@
 # frozen_string_literal: true
 
 module Hyrax
+  ##
+  # @api public
+  #
+  # Cast an object to its AccessControlList
+  #
+  # @param [Object] an object to try to cast
+  #
+  # @return [Hyrax::AccessControlList]
+  def self.AccessControlList(obj)
+    case obj
+    when AccessControlList
+      obj
+    else
+      AccessControlList.new(resource: obj)
+    end
+  end
+
   ##
   # @api public
   #
@@ -53,6 +70,19 @@ module Hyrax
       @query_service = query_service
     end
 
+    ##
+    # Copy and save permissions from source to target
+    #
+    # @param [Valkyrie::Resource, Hyrax::AccessControlList] source
+    # @param [Valkyrie::Resource, Hyrax::AccessControlList] target
+    #
+    # @return [Hyrax::AccessControlList] an acl for `target` with the updated permissions
+    def self.copy_permissions(source:, target:)
+      target = Hyrax::AccessControlList(target)
+      target.permissions = Hyrax::AccessControlList(source).permissions
+      target.save && target
+    end
+
     ##
     # @api public
     #
@@ -112,7 +142,8 @@ module Hyrax
     #
     # @return [Array<Hyrax::Permission>]
     def permissions=(new_permissions)
-      change_set.permissions = new_permissions.to_a
+      change_set.permissions = []
+      new_permissions.each { |p| self << p }
     end
 
     ##
@@ -156,7 +187,7 @@ module Hyrax
 
       private
 
-      def id_for(agent: user_or_group)
+      def id_for(agent:)
         case agent
         when Hyrax::Group
           "#{Hyrax::Group.name_prefix}#{agent.name}"

data/app/services/hyrax/adapters/nesting_index_adapter.rb

@@ -6,7 +6,10 @@ module Hyrax
       LIMITED_REINDEX = "limited"
 
       # @!group Providing interface for a Samvera::NestingIndexer::Adapter
+
+      ##
       # @api public
+      #
       # @param id [String]
       # @return Samvera::NestingIndexer::Document::PreservationDocument
       def self.find_preservation_document_by(id:)
@@ -16,7 +19,9 @@ module Hyrax
         Samvera::NestingIndexer::Documents::PreservationDocument.new(id: id, parent_ids: parent_ids)
       end
 
+      ##
       # @api public
+      #
       # @param id [String]
       # @return Samvera::NestingIndexer::Document::PreservationDocument
       def self.find_preservation_parent_ids_for(id:)
@@ -33,7 +38,9 @@ module Hyrax
         end
       end
 
+      ##
       # @api public
+      #
       # @param id [String]
       # @return Samvera::NestingIndexer::Documents::IndexDocument
       def self.find_index_document_by(id:)
@@ -41,12 +48,13 @@ module Hyrax
         coerce_solr_document_to_index_document(original_solr_document: solr_document, id: id)
       end
 
+      ##
       # @api public
       # @yieldparam id [String]
       # @yieldparam parent_id [Array<String>]
-      # Samvera::NestingIndexer.reindex_all!(extent: FULL_REINDEX)
-      # rubocop:disable Lint/UnusedMethodArgument
-      def self.each_perservation_document_id_and_parent_ids(&block)
+      #
+      # @see Samvera::NestingIndexer.reindex_all!(extent: FULL_REINDEX)
+      def self.each_perservation_document_id_and_parent_ids(&block) # rubocop:disable Lint/UnusedMethodArgument
         ActiveFedora::Base.descendant_uris(ActiveFedora.fedora.base_uri, exclude_uri: true).each do |uri|
           id = Hyrax::Base.uri_to_id(uri)
           object = ActiveFedora::Base.find(id)
@@ -62,8 +70,8 @@ module Hyrax
           end
         end
       end
-      # rubocop:enable Lint/UnusedMethodArgument
 
+      ##
       # @api public
       #
       # From the nesting_document, we will need to add the nesting attributes to the underlying SOLR document for the object
@@ -85,6 +93,7 @@ module Hyrax
         )
       end
 
+      ##
       # @api public
       #
       # @param solr_doc [SolrDocument]
@@ -92,7 +101,7 @@ module Hyrax
       # @param parent_ids [Array]
       # @param pathnames [Array]
       # @param depth [Array] the object's deepest nesting depth
-      # @return solr_doc [SolrDocument]
+      # @return [SolrDocument]
       def self.add_nesting_attributes(solr_doc:, ancestors:, parent_ids:, pathnames:, depth:)
         solr_doc[solr_field_name_for_storing_ancestors] = ancestors
         solr_doc[solr_field_name_for_storing_parent_ids] = parent_ids
@@ -102,11 +111,14 @@ module Hyrax
         solr_doc
       end
 
+      ##
       # @api public
+      #
       # @param document [Samvera::NestingIndexer::Documents::IndexDocument]
       # @param extent [String] if not "full" or nil, doesn't yield children for reindexing
-      # @param solr_field_name_for_ancestors [String] The SOLR field name we use to find children
       # @yield Samvera::NestingIndexer::Documents::IndexDocument
+      #
+      # @return [void]
       def self.each_child_document_of(document:, extent:, &block)
         raw_child_solr_documents_of(parent_document: document).each do |solr_document|
           child_document = coerce_solr_document_to_index_document(original_solr_document: solr_document, id: solr_document.fetch('id'))
@@ -114,11 +126,13 @@ module Hyrax
           block.call(child_document) if full_reindex?(extent: extent) || child_document.pathnames.empty?
         end
       end
-      # @!endgroup
 
+      # @!endgroup
       # @!group Supporting methods for interface implementation
 
+      ##
       # @api private
+      #
       # @todo Need to implement retrieving parent_ids, pathnames, and ancestors from the given document
       def self.coerce_solr_document_to_index_document(original_solr_document:, id:)
         Samvera::NestingIndexer::Documents::IndexDocument.new(
@@ -130,6 +144,7 @@ module Hyrax
       end
       private_class_method :coerce_solr_document_to_index_document
 
+      ##
       # @api private
       def self.find_solr_document_by(id:)
         query = Hyrax::SolrQueryBuilderService.construct_query_for_ids([id])
@@ -140,6 +155,7 @@ module Hyrax
       end
       private_class_method :find_solr_document_by
 
+      ##
       # @api private
       def self.nesting_configuration
         @nesting_configuration ||= Samvera::NestingIndexer.configuration
@@ -152,9 +168,11 @@ module Hyrax
                  :solr_field_name_for_deepest_nested_depth, to: :nesting_configuration
       end
 
+      ##
       # @api private
       # @param parent_document [Curate::Indexer::Documents::IndexDocument]
       # @return [Hash] A raw response document from SOLR
+      #
       # @todo What is the appropriate suffix to apply to the solr_field_name?
       def self.raw_child_solr_documents_of(parent_document:)
         # query Solr for all of the documents included as a member_of_collection parent. Or up to 10000 of them.
@@ -168,6 +186,7 @@ module Hyrax
         false
       end
       private_class_method :full_reindex?
+
       # @!endgroup
     end
   end

data/app/services/hyrax/admin_set_member_service.rb

@@ -1,19 +1,33 @@
 # frozen_string_literal: true
 module Hyrax
+  ##
   # Responsible for retrieving admin set's members
   class AdminSetMemberService
+    ##
+    # @!attribute [r] collection
+    #   @return [::Collection]
+    # @!attribute [r] params
+    #   @return [ActionController::Parameters]
+    # @!attribute [r] scope
+    #   @return [#repository]
     attr_reader :scope, :params, :collection
+
+    ##
+    # @!method repository
+    #   @note delegated to +:scope+
     delegate :repository, to: :scope
 
-    # @param scope [#repository] Typically acontroller object which responds to :repository
-    # @param [::Collection] an collection of type admin set
-    # @param [ActionController::Parameters] query params
+    ##
+    # @param [#repository] scope Typically acontroller object which responds to :repository
+    # @param [::Collection] collection an collection of type admin set
+    # @param [ActionController::Parameters] params query params
     def initialize(scope:, collection:, params:)
       @scope = scope
       @collection = collection
       @params = params
     end
 
+    ##
     # @api public
     #
     # All members of the given admin_set
@@ -32,8 +46,8 @@ module Hyrax
       @members_search_builder ||= Hyrax::AdminAdminSetMemberSearchBuilder.new(scope: scope, collection: collection)
     end
 
+    ##
     # @api private
-    #
     def query_solr(query_builder:, query_params:)
       repository.search(query_builder.with(query_params).query)
     end