hyrax 3.0.0.pre.rc4 → 3.1.0

data/app/presenters/hyrax/user_profile_presenter.rb

@@ -1,16 +1,25 @@
 # frozen_string_literal: true
 module Hyrax
   class UserProfilePresenter
+    ##
+    # @param user [::User]
+    # @param ability [::Ability]
     def initialize(user, ability)
       @user = user
       @ability = ability
     end
 
+    ##
+    # @!attribute [r] ability
+    #   @return [::Ability]
+    # @!attribute [r] user
+    #   @return [::User]
     attr_reader :user, :ability
 
     delegate :name, to: :user
 
-    # @return true if the presenter is for the logged in user
+    ##
+    # @return [Boolean] true if the presenter is for the logged in user
     def current_user?
       user == ability.current_user
     end
@@ -23,6 +32,7 @@ module Hyrax
                   end
     end
 
+    ##
     # @return [Array<TrophyPresenter>] list of TrophyPresenters for this profile.
     def trophies
       @trophies ||= Hyrax::TrophyPresenter.find_by_user(user)

data/app/presenters/hyrax/version_list_presenter.rb

@@ -1,10 +1,29 @@
 # frozen_string_literal: true
 module Hyrax
+  ##
+  # @api public
   class VersionListPresenter
+    include Enumerable
+
+    ##
+    # @param version_list [Array<#created>]
     def initialize(version_list)
       @raw_list = version_list
     end
 
+    ##
+    # @param [Object] an object representing the File Set
+    #
+    # @return [Enumerable<Hyrax::VersionPresenter>] an enumerable of presenters
+    #   for the relevant file versions.
+    #
+    # @raise [ArgumentError] if we can't build an enu
+    def self.for(file_set:)
+      new(file_set.original_file&.versions&.all.to_a)
+    rescue NoMethodError
+      raise ArgumentError
+    end
+
     delegate :each, to: :wrapped_list
 
     private

data/app/presenters/hyrax/version_presenter.rb

@@ -20,8 +20,9 @@ module Hyrax
     end
 
     def committer
-      vc = Hyrax::VersionCommitter.where(version_id: @version.uri)
-      vc.empty? ? nil : vc.first.committer_login
+      Hyrax::VersionCommitter
+        .find_by(version_id: @version.uri)
+        &.committer_login
     end
   end
 end

data/app/presenters/hyrax/work_show_presenter.rb

@@ -94,7 +94,7 @@ module Hyrax
       return nil if representative_id.blank?
       @representative_presenter ||=
         begin
-          result = member_presenters_for([representative_id]).first
+          result = member_presenters([representative_id]).first
           return nil if result.try(:id) == id
           result.try(:representative_presenter) || result
         end
@@ -132,8 +132,13 @@ module Hyrax
       graph.dump(:ttl)
     end
 
+    ##
+    # @deprecated use `::Ability.can?(:edit, presenter)`. Hyrax views calling
+    #   presenter {#editor} methods will continue to call them until Hyrax
+    #   4.0.0. The deprecation time horizon for the presenter methods themselves
+    #   is 5.0.0.
     def editor?
-      current_ability.can?(:edit, solr_document)
+      current_ability.can?(:edit, self)
     end
 
     def tweeter
@@ -181,9 +186,13 @@ module Hyrax
       paginated_item_list(page_array: authorized_item_ids)
     end
 
+    ##
+    # @deprecated use `#member_presenters(ids)` instead
+    #
     # @param [Array<String>] ids a list of ids to build presenters for
     # @return [Array<presenter_class>] presenters for the array of ids (not filtered by class)
     def member_presenters_for(an_array_of_ids)
+      Deprecation.warn("Use `#member_presenters` instead.")
       member_presenters(an_array_of_ids)
     end
 
@@ -219,9 +228,25 @@ module Hyrax
       end
     end
 
-    # determine if the user can add this work to a collection
-    # @param collections [Array<::Collection>] list of collections to which this user can deposit
-    # @return true if the user can deposit to at least one collection OR if the user can create a collection; otherwise, false
+    ##
+    # @return [Integer]
+    def member_count
+      @member_count ||= member_presenters.count
+    end
+
+    ##
+    # Given a set of collections, which the caller asserts the current ability
+    # can deposit to, decide whether to display actions to add this work to a
+    # collection.
+    #
+    # By default, this returns `true` if any collections are passed in OR the
+    # current ability can create a collection.
+    #
+    # @param collections [Enumerable<::Collection>, nil] list of collections to
+    #   which the current ability can deposit
+    #
+    # @return [Boolean] a flag indicating whether to display collection deposit
+    #   options.
     def show_deposit_for?(collections:)
       collections.present? || current_ability.can?(:create_any, ::Collection)
     end

data/app/presenters/hyrax/work_usage.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-# class WorkUsage follows the model established by FileUsage
-# Called by the stats controller, it finds cached work pageview data,
-# and prepares it for visualization in /app/views/stats/work.html.erb
+
 module Hyrax
+  # Follows the model established by {FileUsage}.
+  #
+  # Called by the stats controller, it finds cached work pageview data,
+  # and prepares it for visualization in /app/views/stats/work.html.erb
   class WorkUsage < StatsUsagePresenter
     def initialize(id)
       self.model = Hyrax::WorkRelation.new.find(id)

data/app/renderers/hyrax/renderers/attribute_renderer.rb

@@ -11,12 +11,14 @@ module Hyrax
 
       attr_reader :field, :values, :options
 
+      ##
       # @param [Symbol] field
       # @param [Array] values
       # @param [Hash] options
       # @option options [String] :label The field label to render
       # @option options [String] :include_empty Do we render if if the values are empty?
       # @option options [String] :work_type Used for some I18n logic
+      # @option options [Boolean] :sort sort the values with +Array#sort+ if truthy
       def initialize(field, values, options = {})
         @field = field
         @values = values
@@ -31,7 +33,10 @@ module Hyrax
 
         attributes = microdata_object_attributes(field).merge(class: "attribute attribute-#{field}")
 
-        markup += Array(values).map do |value|
+        values_array = Array(values)
+        values_array = values_array.sort if options[:sort]
+
+        markup += values_array.map do |value|
           "<li#{html_attributes(attributes)}>#{attribute_value_to_html(value.to_s)}</li>"
         end.join
 
@@ -48,7 +53,10 @@ module Hyrax
 
         attributes = microdata_object_attributes(field).merge(class: "attribute attribute-#{field}")
 
-        markup += Array(values).map do |value|
+        values_array = Array(values)
+        values_array.sort! if options[:sort]
+
+        markup += values_array.map do |value|
           "<li#{html_attributes(attributes)}>#{attribute_value_to_html(value.to_s)}</li>"
         end.join
         markup += %(</ul></dd>)

data/app/search_builders/hyrax/admin_set_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     # This overrides the models in FilterByType
     def models
-      [::AdminSet]
+      [::AdminSet, Hyrax::AdministrativeSet]
     end
 
     # Overrides Hydra::AccessControlsEnforcement

data/app/search_builders/hyrax/collection_member_search_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   # This search builder requires that a accessor named "collection" exists in the scope
-  class CollectionMemberSearchBuilder < ::SearchBuilder
+  class CollectionMemberSearchBuilder < ::Hyrax::CollectionSearchBuilder
     include Hyrax::FilterByType
     attr_writer :collection, :search_includes_models
 
@@ -41,6 +41,11 @@ module Hyrax
       solr_parameters[:fq] << "#{collection_membership_field}:#{collection.id}"
     end
 
+    # This overrides the models in FilterByType
+    def models
+      work_classes + collection_classes
+    end
+
     private
 
     def only_works?

data/app/search_builders/hyrax/my/collections_search_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Added to allow for the My controller to show only things I have edit access to
-class Hyrax::My::CollectionsSearchBuilder < ::SearchBuilder
+class Hyrax::My::CollectionsSearchBuilder < ::Hyrax::CollectionSearchBuilder
   include Hyrax::My::SearchBuilderBehavior
   include Hyrax::FilterByType
 
@@ -21,6 +21,6 @@ class Hyrax::My::CollectionsSearchBuilder < ::SearchBuilder
   # This overrides the models in FilterByType
   # @return [Array<Class>] a list of classes to include
   def models
-    [::AdminSet, ::Collection]
+    [::AdminSet, ::Collection, Hyrax::AdministrativeSet]
   end
 end

data/app/search_builders/hyrax/nested_collections_parent_search_builder.rb

@@ -2,7 +2,7 @@
 module Hyrax
   ##
   # Searches for all collections that are parents of a given collection.
-  class NestedCollectionsParentSearchBuilder < ::SearchBuilder
+  class NestedCollectionsParentSearchBuilder < ::Hyrax::CollectionSearchBuilder
     include Hyrax::FilterByType
     attr_reader :child, :page, :limit
 

data/app/search_builders/hyrax/single_collection_search_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
-  class SingleCollectionSearchBuilder < ::SearchBuilder
+  class SingleCollectionSearchBuilder < ::Hyrax::CollectionSearchBuilder
     include SingleResult
   end
 end

data/app/services/hyrax/access_control_list.rb

@@ -14,7 +14,7 @@ module Hyrax
     when AccessControlList
       obj
     else
-      AccessControlList.new(resource: obj)
+      obj.try(:permission_manager)&.acl || AccessControlList.new(resource: obj)
     end
   end
 

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

@@ -56,7 +56,7 @@ module Hyrax
       # @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)
+          id = Hyrax.config.translate_uri_to_id.call(uri)
           object = ActiveFedora::Base.find(id)
           parent_ids = object.try(:member_of_collection_ids) || []
 

data/app/services/hyrax/admin_set_create_service.rb

@@ -81,9 +81,11 @@ module Hyrax
       ::Ability.admin_group_name
     end
 
+    ##
+    # @return [PermissionTemplate]
     def create_permission_template
       permission_template = PermissionTemplate.create!(source_id: admin_set.id, access_grants_attributes: access_grants_attributes)
-      admin_set.reset_access_controls!
+      permission_template.reset_access_controls_for(collection: admin_set)
       permission_template
     end
 

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module Hyrax
+  module Collections
+    ##
+    # Retrieves collection members
+    class CollectionMemberSearchService < Hyrax::SearchService
+      ##
+      # @param scope [#repository] Typically a controller object which responds to :repository
+      # @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)
+      def available_member_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
+        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
+        response, _docs = search_results do |builder|
+          builder.search_includes_models = :works
+          builder.merge(fl: 'id')
+          builder
+        end
+        response
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Hyrax
   module Collections
     ##
     # Retrieves collection members
-    class CollectionMemberService < Hyrax::SearchService
+    class CollectionMemberService
       ##
       # @param scope [#repository] Typically a controller object which responds to :repository
       # @param [::Collection] collection
@@ -12,14 +12,14 @@ module Hyrax
       # @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
-        )
+        Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use the same method in 'Hyrax::Collections::CollectionMemberSearchService'.")
+        @member_search_service = Hyrax::Collections::CollectionMemberSearchService(scope: scope,
+                                                                                   collection: collection,
+                                                                                   params: params,
+                                                                                   user_params: user_params,
+                                                                                   current_ability: current_ability,
+                                                                                   search_builder_class: search_builder_class)
       end
 
       ##
@@ -29,14 +29,9 @@ module Hyrax
       #
       # @return [Blacklight::Solr::Response] (up to 50 solr documents)
       def available_member_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
+        Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use the same method in 'Hyrax::Collections::CollectionMemberSearchService'.")
+        @member_search_service.available_member_subcollections
       end
 
       ##
@@ -46,11 +41,9 @@ module Hyrax
       #
       # @return [Blacklight::Solr::Response]
       def available_member_works
-        response, _docs = search_results do |builder|
-          builder.search_includes_models = :works
-          builder
-        end
-        response
+        Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use the same method in 'Hyrax::Collections::CollectionMemberSearchService'.")
+        @member_search_service.available_member_works
       end
 
       ##
@@ -60,12 +53,104 @@ module Hyrax
       #
       # @return [Blacklight::Solr::Response]
       def available_member_work_ids
-        response, _docs = search_results do |builder|
-          builder.search_includes_models = :works
-          builder.merge(fl: 'id')
-          builder
+        Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use the same method in 'Hyrax::Collections::CollectionMemberSearchService'.")
+        @member_search_service.available_member_work_ids
+      end
+
+      class << self
+        # Check if a work or collection is already a member of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param member [Hyrax::Resource] the child collection and/or child work to check
+        # @return [Boolean] true if already in the member set; otherwise, false
+        def member?(collection_id:, member:)
+          member.member_of_collection_ids.include? collection_id
+        end
+
+        # Add works and/or collections as members of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param new_member_ids [Enumerable<Valkyrie::ID>] the ids of the new child collections and/or child works
+        # @return [Enumerable<Hyrax::Resource>] updated member resources
+        def add_members_by_ids(collection_id:, new_member_ids:, user:)
+          new_members = Hyrax.query_service.find_many_by_ids(ids: new_member_ids)
+          add_members(collection_id: collection_id, new_members: new_members, user: user)
+        end
+
+        # Add works and/or collections as members of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param new_members [Enumerable<Hyrax::Resource>] the new child collections and/or child works
+        # @return [Enumerable<Hyrax::Resource>] updated member resources
+        def add_members(collection_id:, new_members:, user:)
+          messages = []
+          new_members.map do |new_member|
+            begin
+              add_member(collection_id: collection_id, new_member: new_member, user: user)
+            rescue Hyrax::SingleMembershipError => err
+              messages += [err.message]
+            end
+          end
+          raise Hyrax::SingleMembershipError, messages if messages.present?
+        end
+
+        # Add a work or collection as a member of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param new_member_id [Valkyrie::ID] the id of the new child collection or child work
+        # @return [Hyrax::Resource] updated member resource
+        def add_member_by_id(collection_id:, new_member_id:, user:)
+          new_member = Hyrax.query_service.find_by(id: new_member_id)
+          add_member(collection_id: collection_id, new_member: new_member, user: user)
+        end
+
+        # Add a work or collection as a member of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param new_member [Hyrax::Resource] the new child collection or child work
+        # @return [Hyrax::Resource] updated member resource
+        def add_member(collection_id:, new_member:, user:)
+          message = Hyrax::MultipleMembershipChecker.new(item: new_member).check(collection_ids: [collection_id], include_current_members: true)
+          raise Hyrax::SingleMembershipError, message if message.present?
+          new_member.member_of_collection_ids << collection_id # only populate this direction
+          new_member = Hyrax.persister.save(resource: new_member)
+          Hyrax.publisher.publish('object.metadata.updated', object: new_member, user: user)
+          new_member
+        end
+
+        # Remove collections and/or works from the members set of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param member_ids [Enumerable<Valkyrie::ID>] the ids of the child collections and/or child works to be removed
+        # @return [Enumerable<Hyrax::Resource>] updated member resources
+        def remove_members_by_ids(collection_id:, member_ids:, user:)
+          members = Hyrax.query_service.find_many_by_ids(ids: member_ids)
+          remove_members(collection_id: collection_id, members: members, user: user)
+        end
+
+        # Remove collections and/or works from the members set of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param members [Enumerable<Valkyrie::Resource>] the child collections and/or child works to be removed
+        # @return [Enumerable<Hyrax::Resource>] updated member resources
+        def remove_members(collection_id:, members:, user:)
+          members.map { |member| remove_member(collection_id: collection_id, member: member, user: user) }
+        end
+
+        # Remove collections and/or works from the members set of a collection
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param member_id [Valkyrie::ID] the id of the child collection or child work to be removed
+        # @return [Hyrax::Resource] updated member resource
+        def remove_member_by_id(collection_id:, member_id:, user:)
+          member = Hyrax.query_service.find_by(id: member_id)
+          remove_member(collection_id: collection_id, member: member, user: user)
+        end
+
+        # Remove a collection or work from the members set of a collection, also removing the inverse relationship
+        # @param collection_id [Valkyrie::ID] the id of the parent collection
+        # @param member [Hyrax::Resource] the child collection or child work to be removed
+        # @return [Hyrax::Resource] updated member resource
+        def remove_member(collection_id:, member:, user:)
+          return member unless member?(collection_id: collection_id, member: member)
+          member.member_of_collection_ids.delete(collection_id)
+          member = Hyrax.persister.save(resource: member)
+          Hyrax.publisher.publish('object.metadata.updated', object: member, user: user)
+          member
         end
-        response
       end
     end
   end