hyrax 3.0.2 → 3.1.0

data/app/presenters/hyrax/collection_presenter.rb

@@ -28,6 +28,7 @@ module Hyrax
              :to_s, to: :solr_document
 
     delegate(*Hyrax::CollectionType.settings_attributes, to: :collection_type, prefix: :collection_type_is)
+    alias nestable? collection_type_is_nestable?
 
     def collection_type
       @collection_type ||= Hyrax::CollectionType.find_by_gid!(collection_type_gid)
@@ -77,19 +78,36 @@ module Hyrax
     end
 
     def total_items
-      Hyrax::SolrService.new.count("member_of_collection_ids_ssim:#{id}")
+      field_pairs = { "member_of_collection_ids_ssim" => id.to_s }
+      SolrQueryService.new
+                      .with_field_pairs(field_pairs: field_pairs)
+                      .count
     end
 
     def total_viewable_items
-      ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id}").accessible_by(current_ability).count
+      field_pairs = { "member_of_collection_ids_ssim" => id.to_s }
+      SolrQueryService.new
+                      .with_field_pairs(field_pairs: field_pairs)
+                      .accessible_by(ability: current_ability)
+                      .count
     end
 
     def total_viewable_works
-      ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id} AND generic_type_sim:Work").accessible_by(current_ability).count
+      field_pairs = { "member_of_collection_ids_ssim" => id.to_s }
+      SolrQueryService.new
+                      .with_field_pairs(field_pairs: field_pairs)
+                      .with_generic_type(generic_type: "Work")
+                      .accessible_by(ability: current_ability)
+                      .count
     end
 
     def total_viewable_collections
-      ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id} AND generic_type_sim:Collection").accessible_by(current_ability).count
+      field_pairs = { "member_of_collection_ids_ssim" => id.to_s }
+      SolrQueryService.new
+                      .with_field_pairs(field_pairs: field_pairs)
+                      .with_generic_type(generic_type: "Collection")
+                      .accessible_by(ability: current_ability)
+                      .count
     end
 
     def collection_type_badge
@@ -154,14 +172,21 @@ module Hyrax
       create_work_presenter.first_model
     end
 
+    ##
+    # @deprecated this implementation requires an extra db round trip, had a
+    #   buggy cacheing mechanism, and was largely duplicative of other code.
+    #   all versions of this code are replaced by
+    #   {CollectionsHelper#available_parent_collections_data}.
     def available_parent_collections(scope:)
+      Deprecation.warn("#{self.class}#available_parent_collections is " \
+                       "deprecated. Use available_parent_collections_data " \
+                       "helper instead.")
       return @available_parents if @available_parents.present?
       collection = ::Collection.find(id)
       colls = Hyrax::Collections::NestedCollectionQueryService.available_parent_collections(child: collection, scope: scope, limit_to_id: nil)
       @available_parents = colls.map do |col|
         { "id" => col.id, "title_first" => col.title.first }
-      end
-      @available_parents.to_json
+      end.to_json
     end
 
     def subcollection_count=(total)

data/app/presenters/hyrax/file_set_presenter.rb

@@ -57,8 +57,13 @@ module Hyrax
       current_ability.can?(:read, id) ? first_title : 'File'
     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

data/app/presenters/hyrax/file_usage.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-# Called by the stats controller, it finds cached file pageview data,
-# and prepares it for visualization in /app/views/stats/file.html.erb
 module Hyrax
+  ##
+  # Called by the stats controller, it finds cached file pageview data,
+  # and prepares it for visualization in /app/views/stats/file.html.erb
   class FileUsage < StatsUsagePresenter
     def initialize(id)
       self.model = ::FileSet.find(id)

data/app/presenters/hyrax/stats_usage_presenter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
-  # Methods used by both WorkUsage and FileUsage
+  ##
+  # @abstract methods used by both {WorkUsage} and {FileUsage}
   class StatsUsagePresenter
     attr_accessor :id, :model
 

data/app/presenters/hyrax/trophy_presenter.rb

@@ -1,27 +1,56 @@
 # frozen_string_literal: true
+
 module Hyrax
+  ##
+  # @api public
+  #
+  # Presents works in context as "trophied" for a given user.
+  #
+  # @example
+  #   my_user = User.find(user_id)
+  #
+  #   trophies = Hyrax::TrophyPresenter.find_by_user(my_user)
+  #   trophies.each do |trophy|
+  #     puts "Object name/title: #{trophy}"
+  #     puts "Thumbnail path: #{trophy.thumbnail_path}"
+  #   end
   class TrophyPresenter
     include ModelProxy
+
+    ##
+    # @param solr_document [::SolrDocument]
     def initialize(solr_document)
       @solr_document = solr_document
     end
 
+    ##
+    # @!attribute [r] SolrDocument
+    #   @return [::SolrDocument]
     attr_reader :solr_document
 
     delegate :to_s, :thumbnail_path, to: :solr_document
 
+    ##
     # @param user [User] the user to find the TrophyPresentes for.
+    #
     # @return [Array<TrophyPresenter>] a list of all the trophy presenters for the user
     def self.find_by_user(user)
-      work_ids = user.trophies.pluck(:work_id)
-      query = Hyrax::SolrQueryBuilderService.construct_query_for_ids(work_ids)
-      results = Hyrax::WorkRelation.new.search_with_conditions(query)
-      results.map { |result| TrophyPresenter.new(document_model.new(result)) }
+      ids = user.trophies.pluck(:work_id)
+      return ids if ids.empty?
+
+      documents = Hyrax::SolrQueryService.new.with_ids(ids: ids).solr_documents
+
+      documents.map { |doc| new(doc) }
     rescue RSolr::Error::ConnectionRefused
       []
     end
 
+    ##
+    # @api private
+    # @deprecated use CatalogController.blacklight_config.document_model instead
     def self.document_model
+      Deprecation
+        .warn("Use CatalogController.blacklight_config.document_model instead.")
       CatalogController.blacklight_config.document_model
     end
     private_class_method :document_model

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

@@ -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
@@ -223,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/my/collections_search_builder.rb

@@ -21,6 +21,6 @@ class Hyrax::My::CollectionsSearchBuilder < ::Hyrax::CollectionSearchBuilder
   # 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/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