hyrax 3.0.1 → 3.3.0

data/app/presenters/hyrax/file_set_presenter.rb

@@ -34,6 +34,8 @@ module Hyrax
              :original_file_id,
              to: :solr_document
 
+    delegate :member_of_collection_ids, to: :parent
+
     def workflow
       nil
     end
@@ -57,8 +59,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/menu_presenter.rb

@@ -43,6 +43,10 @@ module Hyrax
       end
     end
 
+    def analytics_reporting_section?
+      %w[work_reports collection_reports].include?(controller_name)
+    end
+
     # Draw a collaspable menu section. The passed block should contain <li> items.
     def collapsable_section(text, id:, icon_class:, open:, &block)
       CollapsableSectionPresenter.new(view_context: view_context,

data/app/presenters/hyrax/pcdm_member_presenter_factory.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # constructs presenters for the pcdm:members of an Object, omitting those
+  # not readable by a provided +Ability+.
+  #
+  # this implementation builds the presenters without recourse to the request
+  # context and ActiveFedora-specific index structures (i.e. no `list_source`
+  # or `proxy_in_ssi`).
+  #
+  # @see MemberPresenterFactory
+  class PcdmMemberPresenterFactory
+    class_attribute :file_presenter_class, :work_presenter_class
+    self.file_presenter_class = FileSetPresenter
+    self.work_presenter_class = WorkShowPresenter
+
+    attr_reader :ability, :object
+
+    ##
+    # @param [#member_ids] object
+    # @param [::Ability] ability
+    def initialize(object, ability, _request = nil)
+      @object = object
+      @ability = ability
+    end
+
+    ##
+    # @return [Array<FileSetPresenter, WorkShowPresenter>]
+    # @return [Enumerator<FileSetPresenter>]
+    def file_set_presenters
+      return enum_for(:file_set_presenters) unless block_given?
+
+      results = query_docs(generic_type: "FileSet")
+
+      object.member_ids.each do |id|
+        id = id.to_s
+        indx = results.index { |doc| id == doc['id'] }
+        next if indx.nil?
+        hash = results.delete_at(indx)
+        yield presenter_for(document: ::SolrDocument.new(hash), ability: ability)
+      end
+    end
+
+    ##
+    # @note defaults to using `object.member_ids`. passing a specific set of
+    #   ids is supported for compatibility with {MemberPresenterFactory}, but
+    #   we recommend making sparing use of this feature.
+    #
+    # @overload member_presenters
+    #   @return [Enumerator<FileSetPresenter, WorkShowPresenter>]
+    #   @raise [ArgumentError] if an unindexed id is passed
+    # @overload member_presenters
+    #   @param [Array<#to_s>] ids
+    #   @return [Enumerator<FileSetPresenter, WorkShowPresenter>]
+    #   @raise [ArgumentError] if an unindexed id is passed
+    def member_presenters(ids = object.member_ids)
+      return enum_for(:member_presenters, ids) unless block_given?
+
+      results = query_docs(ids: ids)
+
+      ids.each do |id|
+        id = id.to_s
+        indx = results.index { |doc| id == doc['id'] }
+        raise(ArgumentError, "Could not find an indexed document for id: #{id}") if
+          indx.nil?
+        hash = results.delete_at(indx)
+        yield presenter_for(document: ::SolrDocument.new(hash), ability: ability)
+      end
+    end
+
+    ##
+    # @return [Array<#to_s>]
+    def ordered_ids
+      object.member_ids
+    end
+
+    ##
+    # @return [Array<WorkShowPresenter>]
+    def work_presenters
+      return enum_for(:work_presenters) unless block_given?
+
+      results = query_docs(generic_type: "Work")
+
+      object.member_ids.each do |id|
+        id = id.to_s
+        indx = results.index { |doc| id == doc['id'] }
+        next if indx.nil?
+        hash = results.delete_at(indx)
+        yield presenter_for(document: ::SolrDocument.new(hash), ability: ability)
+      end
+    end
+
+    ##
+    # @param [::SolrDocument] document
+    # @param [::Ability] ability
+    #
+    # @return
+    def presenter_for(document:, ability:)
+      case document['has_model_ssim'].first
+      when Hyrax::FileSet.name
+        Hyrax::FileSetPresenter.new(document, ability)
+      else
+        Hyrax::WorkShowPresenter.new(document, ability)
+      end
+    end
+
+    private
+
+    def query_docs(generic_type: nil, ids: object.member_ids)
+      query = "{!terms f=id}#{ids.join(',')}"
+      query += "{!term f=generic_type_si}#{generic_type}" if generic_type
+
+      Hyrax::SolrService
+        .post(query, rows: 10_000)
+        .fetch('response')
+        .fetch('docs')
+    end
+  end
+end

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

@@ -10,10 +10,11 @@ module Hyrax
     attr_writer :member_presenter_factory
     attr_accessor :solr_document, :current_ability, :request
 
-    class_attribute :collection_presenter_class
+    class_attribute :collection_presenter_class, :presenter_factory_class
 
     # modify this attribute to use an alternate presenter class for the collections
     self.collection_presenter_class = CollectionPresenter
+    self.presenter_factory_class = MemberPresenterFactory
 
     # Methods used by blacklight helpers
     delegate :has?, :first, :fetch, :export_formats, :export_as, to: :solr_document
@@ -94,7 +95,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 +133,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 +187,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,11 +229,28 @@ 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)
+      collections.present? ||
+        current_ability.can?(:create_any, Hyrax.config.collection_class)
     end
 
     ##
@@ -278,7 +305,9 @@ module Hyrax
 
     def member_presenter_factory
       @member_presenter_factory ||=
-        MemberPresenterFactory.new(solr_document, current_ability, request)
+        self.class
+            .presenter_factory_class
+            .new(solr_document, current_ability, request)
     end
 
     def graph

data/app/presenters/hyrax/work_usage.rb

@@ -1,8 +1,11 @@
 # 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
+  # TODO: - Analytics do we still need this?
+  # 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/README.md

@@ -66,4 +66,4 @@ module Hyrax
 end
 ```
 
-There is no point having the other `filter_models` methods apply `:fq`s that we then try to undo or overwrite.  In general, directly overwriting the whole `default_processor_chain` or solr parameters like `:fq` is less flexible than appending constraints sufficient for your use case.  In particular, you might find that you have overwritten components that implement access controls, thereby making your SearchBuilder less useful and less secure.  When in doubt, examine the actual solr queries produced.
+There is no point having the other `filter_models` methods apply `:fq`s that we then try to undo or overwrite.  In general, directly overwriting the whole `default_processor_chain` or solr parameters like `:fq` is less flexible than appending constraints sufficient for your use case.  In particular, you might find that you have overwritten components that implement access controls, thereby making your SearchBuilder less useful and less secure.  When in doubt, examine the actual solr queries produced.

data/app/search_builders/hyrax/abstract_type_relation.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 module Hyrax
   class AbstractTypeRelation < ActiveFedora::Relation
-    def initialize(opts = {})
+    def initialize(allowable_types: nil, **opts)
+      @allowable_types = allowable_types
       super(DummyModel, opts)
     end
 
     def allowable_types
-      raise NotImplementedException, "Implement allowable_types in a subclass"
+      @allowable_types ||
+        raise(NotImplementedException, "Implement allowable_types in a subclass")
     end
 
     def equivalent_class?(klass)

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/dashboard/collections_search_builder.rb

@@ -9,7 +9,7 @@ module Hyrax
 
       # This overrides the models in FilterByType
       def models
-        [::AdminSet, ::Collection]
+        [::AdminSet, ::Collection, Hyrax.config.collection_class].uniq.compact
       end
 
       # adds a filter to exclude collections and admin sets created by the

data/app/search_builders/hyrax/exposed_models_relation.rb

@@ -3,7 +3,7 @@ module Hyrax
   # A relation that scopes to all user visible models (e.g. works + collections + file sets)
   class ExposedModelsRelation < AbstractTypeRelation
     def allowable_types
-      Hyrax.config.curation_concerns + [::Collection, ::FileSet]
+      (Hyrax.config.curation_concerns + [Hyrax.config.collection_class, ::Collection, ::FileSet]).uniq
     end
   end
 end

data/app/search_builders/hyrax/filter_by_type.rb

@@ -53,8 +53,7 @@ module Hyrax
 
     def collection_classes
       return [] if only_works?
-      # to_class_uri is deprecated in AF 11
-      [::Collection]
+      [::Collection, Hyrax.config.collection_class].uniq
     end
   end
 end

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, Hyrax::AdministrativeSet, ::Collection, Hyrax.config.collection_class].uniq.compact
   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