hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/presenters/hyrax/select_collection_type_list_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Presents the list of collection type options that a user may choose from when deciding to create a new work
   class SelectCollectionTypeListPresenter

data/app/presenters/hyrax/select_collection_type_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class SelectCollectionTypePresenter
     # @param [CollectionType] a Hyrax::CollectionType

data/app/presenters/hyrax/select_type_list_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Presents the list of work type options that a user may choose from when deciding to
   # create a new work
@@ -22,8 +23,9 @@ module Hyrax
 
     # Return or yield the first model in the list. This is used when the list
     # only has a single element.
-    # @yieldparam [Class] model a class that decends from ActiveFedora::Base
-    # @return [Class] a class that decends from ActiveFedora::Base
+    #
+    # @yieldparam [Class] model a model class
+    # @return [Class] a model class
     def first_model
       yield(authorized_models.first) if block_given?
       authorized_models.first

data/app/presenters/hyrax/select_type_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class SelectTypePresenter
     def initialize(concern)
@@ -38,23 +39,23 @@ module Hyrax
 
     private
 
-      def object_name
-        @object_name ||= concern.model_name.i18n_key
-      end
+    def object_name
+      @object_name ||= concern.model_name.i18n_key
+    end
 
-      def translate(key)
-        defaults = []
-        defaults << :"hyrax.select_type.#{object_name}.#{key}"
-        defaults << :"hyrax.select_type.#{key}"
-        defaults << ''
-        I18n.t(defaults.shift, default: defaults)
-      end
+    def translate(key)
+      defaults = []
+      defaults << :"hyrax.select_type.#{object_name}.#{key}"
+      defaults << :"hyrax.select_type.#{key}"
+      defaults << ''
+      I18n.t(defaults.shift, default: defaults)
+    end
 
-      def collection_id(params)
-        return nil unless params
-        collection_id = params[:add_works_to_collection]
-        collection_id ||= params[:id] if params[:id] && params[:controller] == 'hyrax/dashboard/collections'
-        collection_id
-      end
+    def collection_id(params)
+      return nil unless params
+      collection_id = params[:add_works_to_collection]
+      collection_id ||= params[:id] if params[:id] && params[:controller] == 'hyrax/dashboard/collections'
+      collection_id
+    end
   end
 end

data/app/presenters/hyrax/single_use_link_presenter.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module Hyrax
   class SingleUseLinkPresenter
     include ActionView::Helpers::TranslationHelper
 
     attr_reader :link
 
-    delegate :downloadKey, :expired?, :to_param, to: :link
+    delegate :download_key, :expired?, :to_param, to: :link
 
     # @param link [SingleUseLink]
     def initialize(link)
@@ -20,7 +21,7 @@ module Hyrax
     end
 
     def short_key
-      link.downloadKey.first(6)
+      link.download_key.first(6)
     end
 
     def link_type
@@ -41,12 +42,12 @@ module Hyrax
 
     private
 
-      def download?
-        link.path =~ /downloads/
-      end
+    def download?
+      link.path =~ /downloads/
+    end
 
-      def hours
-        (link.expires - Time.zone.now).to_i / 3600
-      end
+    def hours
+      (link.expires - Time.zone.now).to_i / 3600
+    end
   end
 end

data/app/presenters/hyrax/stats_usage_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Methods used by both WorkUsage and FileUsage
   class StatsUsagePresenter
@@ -9,35 +10,35 @@ module Hyrax
 
     private
 
-      def user_id
-        @user_id ||= begin
-                       user = Hydra::Ability.user_class.find_by_user_key(model.depositor)
-                       user ? user.id : nil
-                     end
-      end
+    def user_id
+      @user_id ||= begin
+                     user = Hydra::Ability.user_class.find_by_user_key(model.depositor)
+                     user ? user.id : nil
+                   end
+    end
 
-      # TODO: make this a lazy enumerator
-      def to_flots(stats)
-        stats.map(&:to_flot)
-      end
+    # TODO: make this a lazy enumerator
+    def to_flots(stats)
+      stats.map(&:to_flot)
+    end
 
-      # model.date_uploaded reflects the date the object was uploaded by the user
-      # and therefore (if available) the date that we want to use for the stats
-      # model.create_date reflects the date the file was added to Fedora. On data
-      # migrated from one repository to another the created_date can be later
-      # than the date the file was uploaded.
-      def date_for_analytics
-        earliest = Hyrax.config.analytic_start_date
-        date_uploaded = string_to_date(model.date_uploaded)
-        date_analytics = date_uploaded ? date_uploaded : model.create_date
-        return date_analytics if earliest.blank?
-        earliest > date_analytics ? earliest : date_analytics
-      end
+    # model.date_uploaded reflects the date the object was uploaded by the user
+    # and therefore (if available) the date that we want to use for the stats
+    # model.create_date reflects the date the file was added to Fedora. On data
+    # migrated from one repository to another the created_date can be later
+    # than the date the file was uploaded.
+    def date_for_analytics
+      earliest = Hyrax.config.analytic_start_date
+      date_uploaded = string_to_date(model.date_uploaded)
+      date_analytics = date_uploaded ? date_uploaded : model.create_date
+      return date_analytics if earliest.blank?
+      earliest > date_analytics ? earliest : date_analytics
+    end
 
-      def string_to_date(date_str)
-        Time.zone.parse(date_str)
-      rescue ArgumentError, TypeError
-        nil
-      end
+    def string_to_date(date_str)
+      Time.zone.parse(date_str)
+    rescue ArgumentError, TypeError
+      nil
+    end
   end
 end

data/app/presenters/hyrax/transfers_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class TransfersPresenter
     def initialize(current_user, view_context)
@@ -23,15 +24,15 @@ module Hyrax
 
     private
 
-      attr_reader :current_user, :view_context, :since
-      delegate :render, :t, to: :view_context
+    attr_reader :current_user, :view_context, :since
+    delegate :render, :t, to: :view_context
 
-      def incoming_proxy_deposits
-        @incoming ||= ProxyDepositRequest.incoming_for(user: current_user)
-      end
+    def incoming_proxy_deposits
+      @incoming ||= ProxyDepositRequest.incoming_for(user: current_user)
+    end
 
-      def outgoing_proxy_deposits
-        @outgoing ||= ProxyDepositRequest.outgoing_for(user: current_user)
-      end
+    def outgoing_proxy_deposits
+      @outgoing ||= ProxyDepositRequest.outgoing_for(user: current_user)
+    end
   end
 end

data/app/presenters/hyrax/trophy_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class TrophyPresenter
     include ModelProxy
@@ -13,7 +14,7 @@ module Hyrax
     # @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 = ActiveFedora::SolrQueryBuilder.construct_query_for_ids(work_ids)
+      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)) }
     rescue RSolr::Error::ConnectionRefused

data/app/presenters/hyrax/twitter_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Repeatable logic for presenting twitter handles.
   #

data/app/presenters/hyrax/user_profile_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class UserProfilePresenter
     def initialize(user, ability)

data/app/presenters/hyrax/version_list_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class VersionListPresenter
     def initialize(version_list)
@@ -8,11 +9,11 @@ module Hyrax
 
     private
 
-      def wrapped_list
-        @wrapped_list ||=
-          @raw_list.map { |v| Hyrax::VersionPresenter.new(v) } # wrap each item in a presenter
-                   .sort { |a, b| b.version.created <=> a.version.created } # sort list of versions based on creation date
-                   .tap { |l| l.first.try(:current!) } # set the first version to the current version
-      end
+    def wrapped_list
+      @wrapped_list ||=
+        @raw_list.map { |v| Hyrax::VersionPresenter.new(v) } # wrap each item in a presenter
+                 .sort { |a, b| b.version.created <=> a.version.created } # sort list of versions based on creation date
+                 .tap { |l| l.first.try(:current!) } # set the first version to the current version
+    end
   end
 end

data/app/presenters/hyrax/version_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class VersionPresenter
     attr_reader :version, :current

data/app/presenters/hyrax/work_show_presenter.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
 module Hyrax
   class WorkShowPresenter
     include ModelProxy
     include PresentsAttributes
 
+    ##
+    # @!attribute [w] member_presenter_factory
+    #   @return [MemberPresenterFactory]
+    attr_writer :member_presenter_factory
     attr_accessor :solr_document, :current_ability, :request
 
     class_attribute :collection_presenter_class
@@ -15,14 +20,14 @@ module Hyrax
 
     # delegate fields from Hyrax::Works::Metadata to solr_document
     delegate :based_near_label, :related_url, :depositor, :identifier, :resource_type,
-             :keyword, :itemtype, :admin_set, to: :solr_document
+             :keyword, :itemtype, :admin_set, :rights_notes, :access_right, :abstract, to: :solr_document
 
     # @param [SolrDocument] solr_document
     # @param [Ability] current_ability
     # @param [ActionDispatch::Request] request the http request context. Used so
     #                                  the GraphExporter knows what URLs to draw.
     def initialize(solr_document, current_ability, request = nil)
-      @solr_document = solr_document
+      @solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(solr_document)
       @current_ability = current_ability
       @request = request
     end
@@ -39,7 +44,7 @@ module Hyrax
     delegate :title, :date_created, :description,
              :creator, :contributor, :subject, :publisher, :language, :embargo_release_date,
              :lease_expiration_date, :license, :source, :rights_statement, :thumbnail_id, :representative_id,
-             :rendering_ids, :member_of_collection_ids, to: :solr_document
+             :rendering_ids, :member_of_collection_ids, :alternative_title, to: :solr_document
 
     def workflow
       @workflow ||= WorkflowPresenter.new(solr_document, current_ability)
@@ -91,11 +96,7 @@ module Hyrax
         begin
           result = member_presenters_for([representative_id]).first
           return nil if result.try(:id) == id
-          if result.respond_to?(:representative_presenter)
-            result.representative_presenter
-          else
-            result
-          end
+          result.try(:representative_presenter) || result
         end
     end
 
@@ -116,7 +117,7 @@ module Hyrax
     end
 
     def link_name
-      current_ability.can?(:read, id) ? to_s : 'File'
+      current_ability.can?(:read, id) ? to_s : 'Private'
     end
 
     def export_as_nt
@@ -200,13 +201,9 @@ module Hyrax
     #
     # @return [Array] array of rendering hashes
     def sequence_rendering
-      renderings = []
-      if solr_document.rendering_ids.present?
-        solr_document.rendering_ids.each do |file_set_id|
-          renderings << manifest_helper.build_rendering(file_set_id)
-        end
-      end
-      renderings.flatten
+      solr_document.rendering_ids.each_with_object([]) do |file_set_id, renderings|
+        renderings << manifest_helper.build_rendering(file_set_id)
+      end.flatten
     end
 
     # IIIF metadata for inclusion in the manifest
@@ -214,84 +211,87 @@ module Hyrax
     #
     # @return [Array] array of metadata hashes
     def manifest_metadata
-      metadata = []
-      Hyrax.config.iiif_metadata_fields.each do |field|
+      Hyrax.config.iiif_metadata_fields.each_with_object([]) do |field, metadata|
         metadata << {
           'label' => I18n.t("simple_form.labels.defaults.#{field}"),
-          'value' => Array.wrap(send(field))
+          'value' => Array.wrap(send(field).map { |f| Loofah.fragment(f.to_s).scrub!(:whitewash).to_s })
         }
       end
-      metadata
     end
 
     # determine if the user can add this work to a collection
-    # @param collections <Collections> list of collections to which this user can deposit
+    # @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
     def show_deposit_for?(collections:)
-      collections.present? || current_ability.can?(:create_any, Collection)
+      collections.present? || current_ability.can?(:create_any, ::Collection)
+    end
+
+    ##
+    # @return [Array<Class>]
+    def valid_child_concerns
+      Hyrax::ChildTypes.for(parent: solr_document.hydra_model).to_a
     end
 
     private
 
-      # list of item ids to display is based on ordered_ids
-      def authorized_item_ids
-        @member_item_list_ids ||= begin
-          items = ordered_ids
-          items.delete_if { |m| !current_ability.can?(:read, m) } if Flipflop.hide_private_items?
-          items
-        end
-      end
+    # list of item ids to display is based on ordered_ids
+    def authorized_item_ids(filter_unreadable: Flipflop.hide_private_items?)
+      @member_item_list_ids ||=
+        filter_unreadable ? ordered_ids.reject { |id| !current_ability.can?(:read, id) } : ordered_ids
+    end
 
-      # Uses kaminari to paginate an array to avoid need for solr documents for items here
-      def paginated_item_list(page_array:)
-        Kaminari.paginate_array(page_array, total_count: page_array.size).page(current_page).per(rows_from_params)
-      end
+    # Uses kaminari to paginate an array to avoid need for solr documents for items here
+    def paginated_item_list(page_array:)
+      Kaminari.paginate_array(page_array, total_count: page_array.size).page(current_page).per(rows_from_params)
+    end
 
-      def total_items
-        authorized_item_ids.size
-      end
+    def total_items
+      authorized_item_ids.size
+    end
 
-      def rows_from_params
-        request.params[:rows].nil? ? Hyrax.config.show_work_item_rows : request.params[:rows].to_i
-      end
+    def rows_from_params
+      request.params[:rows].nil? ? Hyrax.config.show_work_item_rows : request.params[:rows].to_i
+    end
 
-      def current_page
-        page = request.params[:page].nil? ? 1 : request.params[:page].to_i
-        page > total_pages ? total_pages : page
-      end
+    def current_page
+      page = request.params[:page].nil? ? 1 : request.params[:page].to_i
+      page > total_pages ? total_pages : page
+    end
 
-      def manifest_helper
-        @manifest_helper ||= ManifestHelper.new(request.base_url)
-      end
+    def manifest_helper
+      @manifest_helper ||= ManifestHelper.new(request.base_url)
+    end
 
-      def featured?
-        @featured = FeaturedWork.where(work_id: solr_document.id).exists? if @featured.nil?
-        @featured
-      end
+    def featured?
+      # only look this up if it's not boolean; ||= won't work here
+      @featured = FeaturedWork.where(work_id: solr_document.id).exists? if @featured.nil?
+      @featured
+    end
 
-      def user_can_feature_works?
-        current_ability.can?(:create, FeaturedWork)
-      end
+    def user_can_feature_works?
+      current_ability.can?(:create, FeaturedWork)
+    end
 
-      def presenter_factory_arguments
-        [current_ability, request]
-      end
+    def presenter_factory_arguments
+      [current_ability, request]
+    end
 
-      def member_presenter_factory
+    def member_presenter_factory
+      @member_presenter_factory ||=
         MemberPresenterFactory.new(solr_document, current_ability, request)
-      end
+    end
 
-      def graph
-        GraphExporter.new(solr_document, request).fetch
-      end
+    def graph
+      GraphExporter.new(solr_document, request).fetch
+    end
 
-      def member_of_authorized_parent_collections
-        # member_of_collection_ids with current_ability access
-        @member_of ||= Hyrax::CollectionMemberService.run(solr_document, current_ability).map(&:id)
-      end
+    # @return [Array<String>] member_of_collection_ids with current_ability access
+    def member_of_authorized_parent_collections
+      @member_of ||= Hyrax::CollectionMemberService.run(solr_document, current_ability).map(&:id)
+    end
 
-      def members_include_viewable_image?
-        file_set_presenters.any? { |presenter| presenter.image? && current_ability.can?(:read, presenter.id) }
-      end
+    def members_include_viewable_image?
+      file_set_presenters.any? { |presenter| presenter.image? && current_ability.can?(:read, presenter.id) }
+    end
   end
 end