hyrax 3.0.0.pre.rc4 → 3.1.0

data/app/presenters/hyrax/admin_set_presenter.rb

@@ -12,7 +12,11 @@ module Hyrax
     end
 
     def total_viewable_items
-      ActiveFedora::Base.where("isPartOf_ssim:#{id}").accessible_by(current_ability).count
+      field_pairs = { "isPartOf_ssim" => id.to_s }
+      SolrQueryService.new
+                      .with_field_pairs(field_pairs: field_pairs)
+                      .accessible_by(ability: current_ability)
+                      .count
     end
 
     # AdminSet cannot be deleted if default set or non-empty

data/app/presenters/hyrax/admin_set_selection_presenter.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # @api public
+  # @since 3.1.0
+  #
+  # Presents select options for admin sets.
+  #
+  # Each entry in the {#select_options} return value provides a label for
+  # display, an id to serve as the value, and a data hash which is used as HTML5
+  # data entries. The data entries can be used as hooks for Javascript
+  # to control input validation taking into account the Admin Set and
+  # `PermissionTemplate` rules (`visibility_component.es6` does this, for
+  # example).
+  #
+  # @note this supersedes the older +Hyrax::AdminSetOptionsPresenter+, which
+  #   actied more like a "service" sending database queries to Solr and
+  #   ActiveRecord.  this version seeks only to present the input data and
+  #   relies on its caller to pass in the right data.
+  class AdminSetSelectionPresenter
+    ##
+    # @param [Array<#id>]
+    def initialize(admin_sets:)
+      @admin_sets = admin_sets
+    end
+
+    ##
+    # @return [Array<Array<String, String, Hash>>] an array suitable for  a form
+    #   input `collection:` parameter. it should contain a label, an id, and a
+    #   hash of HTML5  data attributes.
+    def select_options
+      @admin_sets.map do |admin_set|
+        case admin_set
+        when OptionsEntry
+          admin_set.result
+        else
+          OptionsEntry.new(admin_set: admin_set).result
+        end
+      end
+    end
+
+    ##
+    # @api public
+    class OptionsEntry
+      ##
+      # @!attribute [rw] admin_set
+      #   @return [AdministrativeSet, SolrDocument]
+      # @!attribute [rw] permission_template
+      #   @return [PermissionTemplate]
+      # @!attribute [rw] permit_sharing
+      #   @return [Boolean]
+      attr_accessor :admin_set, :permission_template, :permit_sharing
+
+      ##
+      # @param [AdministrativeSet, SolrDocument] admin_set
+      # @param [PermissionTemplate] permission_template
+      # @param [Boolean] permit_sharing
+      def initialize(admin_set:, permission_template: nil, permit_sharing: false)
+        @admin_set = admin_set
+        @permission_template = permission_template
+        @permit_sharing = permit_sharing
+      end
+
+      ##
+      # @return [Array<String, String, Hash>]
+      def result
+        [label, id, data]
+      end
+
+      ##
+      # @return [String]
+      def label
+        Array(admin_set.title).first || admin_set.to_s
+      end
+
+      ##
+      # @return [String]
+      def id
+        admin_set.id.to_s
+      end
+
+      ##
+      # @return [Hash{String => Object}]
+      def data
+        {}.tap do |data|
+          data['data-sharing'] = permit_sharing
+
+          if permission_template
+            data.merge!(data_for(permission_template))
+          else
+            data['data-release-no-delay'] = true
+          end
+        end
+      end
+
+      private
+
+      ##
+      # @api private
+      def data_for(template)
+        {}.tap do |data|
+          if template.release_no_delay?
+            data['data-release-no-delay'] = true
+          elsif template.release_date.present?
+            data['data-release-date'] = template.release_date
+          end
+
+          data['data-release-before-date'] = true if
+            template.release_before_date?
+          data['data-visibility'] = template.visibility if
+            template.visibility.present?
+        end
+      end
+    end
+  end
+end

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
@@ -119,25 +137,21 @@ module Hyrax
       Hyrax::Engine.routes.url_helpers.dashboard_collection_path(id, locale: I18n.locale)
     end
 
+    ##
+    # @return [#to_s, nil] a download path for the banner file
     def banner_file
-      # Find Banner filename
-      ci = CollectionBrandingInfo.where(collection_id: id, role: "banner")
-      "/" + ci[0].local_path.split("/")[-4..-1].join("/") unless ci.empty?
+      banner = CollectionBrandingInfo.find_by(collection_id: id, role: "banner")
+      "/" + banner.local_path.split("/")[-4..-1].join("/") if banner
     end
 
     def logo_record
-      logo_info = []
-      # Find Logo filename, alttext, linktext
-      cis = CollectionBrandingInfo.where(collection_id: id, role: "logo")
-      return if cis.empty?
-      cis.each do |coll_info|
-        logo_file = File.split(coll_info.local_path).last
-        file_location = "/" + coll_info.local_path.split("/")[-4..-1].join("/") unless logo_file.empty?
-        alttext = coll_info.alt_text
-        linkurl = coll_info.target_url
-        logo_info << { file: logo_file, file_location: file_location, alttext: alttext, linkurl: linkurl }
+      CollectionBrandingInfo.where(collection_id: id, role: "logo")
+                            .select(:local_path, :alt_text, :target_url).map do |logo|
+        { alttext: logo.alt_text,
+          file: File.split(logo.local_path).last,
+          file_location: "/#{logo.local_path.split('/')[-4..-1].join('/')}",
+          linkurl: logo.target_url }
       end
-      logo_info
     end
 
     # A presenter for selecting a work type to create
@@ -158,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/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)
+      @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