hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/presenters/hyrax/embargo_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Presents embargoed objects
   class EmbargoPresenter

data/app/presenters/hyrax/file_set_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class FileSetPresenter
     include ModelProxy
@@ -33,12 +34,8 @@ module Hyrax
              :original_file_id,
              to: :solr_document
 
-    def alpha_channels
-      []
-    end
-
     def single_use_links
-      @single_use_links ||= SingleUseLink.where(itemId: id).map { |link| link_presenter_class.new(link) }
+      @single_use_links ||= SingleUseLink.where(item_id: id).map { |link| link_presenter_class.new(link) }
     end
 
     # The title of the webpage that shows this FileSet.
@@ -96,17 +93,16 @@ module Hyrax
 
     private
 
-      def link_presenter_class
-        SingleUseLinkPresenter
-      end
-
-      def fetch_parent_presenter
-        ids = ActiveFedora::SolrService.query("{!field f=member_ids_ssim}#{id}",
-                                              fl: ActiveFedora.id_field)
-                                       .map { |x| x.fetch(ActiveFedora.id_field) }
-        Hyrax::PresenterFactory.build_for(ids: ids,
-                                          presenter_class: WorkShowPresenter,
-                                          presenter_args: current_ability).first
-      end
+    def link_presenter_class
+      SingleUseLinkPresenter
+    end
+
+    def fetch_parent_presenter
+      ids = Hyrax::SolrService.query("{!field f=member_ids_ssim}#{id}", fl: Hyrax.config.id_field)
+                              .map { |x| x.fetch(Hyrax.config.id_field) }
+      Hyrax::PresenterFactory.build_for(ids: ids,
+                                        presenter_class: WorkShowPresenter,
+                                        presenter_args: current_ability).first
+    end
   end
 end

data/app/presenters/hyrax/file_usage.rb

@@ -1,3 +1,4 @@
+# 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
@@ -26,12 +27,12 @@ module Hyrax
 
     private
 
-      def downloads
-        to_flots(FileDownloadStat.statistics(model, created, user_id))
-      end
+    def downloads
+      to_flots(FileDownloadStat.statistics(model, created, user_id))
+    end
 
-      def pageviews
-        to_flots(FileViewStat.statistics(model, created, user_id))
-      end
+    def pageviews
+      to_flots(FileViewStat.statistics(model, created, user_id))
+    end
   end
 end

data/app/presenters/hyrax/fixity_status_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Creates fixity status messages to display to user, for a fileset.
   # Determines status by looking up existing recorded ChecksumAuditLog objects,
@@ -24,66 +25,66 @@ module Hyrax
         if relevant_log_records.empty?
           "Fixity checks have not yet been run on this object"
         elsif failing_checks.empty?
-          content_tag("span", "passed", class: "label label-success") + ' ' + render_existing_check_summary
+          tag.span("passed", class: "label label-success") + ' ' + render_existing_check_summary
         else
-          content_tag("span", "FAIL", class: "label label-danger") + ' ' + render_existing_check_summary + render_failed_compact
+          tag.span("FAIL", class: "label label-danger") + ' ' + render_existing_check_summary + render_failed_compact
         end
     end
 
     protected
 
-      # A weird display, cause we need it to fit in that 180px column on
-      # FileSet show, and have no real UI to link to for files/versions :(
-      # rubocop:disable Metrics/MethodLength
-      def render_failed_compact
-        safe_join(
-          ["<p><strong>Failed checks:</strong></p>".html_safe] +
-          failing_checks.collect do |log|
-            safe_join(
-              [
-                "<p>".html_safe,
-                "ChecksumAuditLog id: #{log.id}; ",
-                content_tag("a", "file", href: "#{Hydra::PCDM::File.translate_id_to_uri.call(log.file_id)}/fcr:metadata") + "; ",
-                content_tag("a", "checked_uri", href: "#{log.checked_uri}/fcr:metadata") + "; ",
-                "date: #{log.created_at}; ",
-                "expected_result: #{log.expected_result}",
-                "</p>".html_safe
-              ]
-            )
-          end
-        )
-      end
-      # rubocop:enable Metrics/MethodLength
+    # A weird display, cause we need it to fit in that 180px column on
+    # FileSet show, and have no real UI to link to for files/versions :(
+    # rubocop:disable Metrics/MethodLength
+    def render_failed_compact
+      safe_join(
+        ["<p><strong>Failed checks:</strong></p>".html_safe] +
+        failing_checks.collect do |log|
+          safe_join(
+            [
+              "<p>".html_safe,
+              "ChecksumAuditLog id: #{log.id}; ",
+              tag.a("file", href: "#{Hydra::PCDM::File.translate_id_to_uri.call(log.file_id)}/fcr:metadata") + "; ",
+              tag.a("checked_uri", href: "#{log.checked_uri}/fcr:metadata") + "; ",
+              "date: #{log.created_at}; ",
+              "expected_result: #{log.expected_result}",
+              "</p>".html_safe
+            ]
+          )
+        end
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
 
-      def render_existing_check_summary
-        @render_existing_check_summary ||=
-          "#{pluralize num_checked_files, 'File'} with #{pluralize relevant_log_records.count, 'total version'} checked #{render_date_range}"
-      end
+    def render_existing_check_summary
+      @render_existing_check_summary ||=
+        "#{pluralize num_checked_files, 'File'} with #{pluralize relevant_log_records.count, 'total version'} checked #{render_date_range}"
+    end
 
-      def render_date_range
-        @render_date_range ||= begin
-          from = relevant_log_records.min_by(&:created_at).created_at.to_s
-          to   = relevant_log_records.max_by(&:created_at).created_at.to_s
-          if from == to
-            from
-          else
-            "between #{from} and #{to}"
-          end
+    def render_date_range
+      @render_date_range ||= begin
+        from = relevant_log_records.min_by(&:created_at).created_at.to_s
+        to   = relevant_log_records.max_by(&:created_at).created_at.to_s
+        if from == to
+          from
+        else
+          "between #{from} and #{to}"
         end
       end
+    end
 
-      # Should be all _latest_ ChecksumAuditLog about different files/versions
-      # currently existing in specified FileSet.
-      def relevant_log_records
-        @relevant_log_records ||= ChecksumAuditLog.latest_for_file_set_id(file_set_id)
-      end
+    # Should be all _latest_ ChecksumAuditLog about different files/versions
+    # currently existing in specified FileSet.
+    def relevant_log_records
+      @relevant_log_records ||= ChecksumAuditLog.latest_for_file_set_id(file_set_id)
+    end
 
-      def num_checked_files
-        @num_relevant_files ||= relevant_log_records.group_by(&:file_id).keys.count
-      end
+    def num_checked_files
+      @num_relevant_files ||= relevant_log_records.group_by(&:file_id).keys.count
+    end
 
-      def failing_checks
-        @failing_checks ||= relevant_log_records.find_all(&:failed?)
-      end
+    def failing_checks
+      @failing_checks ||= relevant_log_records.find_all(&:failed?)
+    end
   end
 end

data/app/presenters/hyrax/homepage_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class HomepagePresenter
     class_attribute :create_work_presenter_class
@@ -37,9 +38,9 @@ module Hyrax
 
     private
 
-      def user_unregistered?
-        current_ability.current_user.new_record? ||
-          current_ability.current_user.guest?
-      end
+    def user_unregistered?
+      current_ability.current_user.new_record? ||
+        current_ability.current_user.guest?
+    end
   end
 end

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # This presenter wraps objects in the interface required by `IIIFManifiest`.
+  # It will accept either a Work-like resource or a SolrDocument.
+  #
+  # @example with a work
+  #
+  #   monograph = Monograph.new
+  #   presenter = IiifManifestPresenter.new(monograph)
+  #   presenter.title # => []
+  #
+  #   monograph.title = ['Comet in Moominland']
+  #   presenter.title # => ['Comet in Moominland']
+  #
+  # @see https://www.rubydoc.info/gems/iiif_manifest
+  class IiifManifestPresenter < Draper::Decorator
+    delegate_all
+
+    ##
+    # @!attribute [w] ability
+    #   @return [Ability]
+    # @!attribute [w] hostname
+    #   @return [String]
+    attr_writer :ability, :hostname
+
+    class << self
+      ##
+      # @param [Hyrax::Resource, SolrDocument]
+      def for(model)
+        klass = model.file_set? ? DisplayImagePresenter : IiifManifestPresenter
+
+        klass.new(model)
+      end
+    end
+
+    ##
+    # @return [#can?]
+    def ability
+      @ability ||= NullAbility.new
+    end
+
+    ##
+    # @return [String]
+    def description
+      Array(super).first || ''
+    end
+
+    ##
+    # @return [Boolean]
+    def file_set?
+      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet')
+    end
+
+    ##
+    # @return [Array<DisplayImagePresenter>]
+    def file_set_presenters
+      member_presenters.select(&:file_set?)
+    end
+
+    ##
+    # IIIF metadata for inclusion in the manifest
+    #  Called by the `iiif_manifest` gem to add metadata
+    #
+    # @todo should this use the simple_form i18n keys?! maybe the manifest
+    #   needs its own?
+    #
+    # @return [Array<Hash{String => String}>] array of metadata hashes
+    def manifest_metadata
+      metadata_fields.map do |field_name|
+        {
+          'label' => I18n.t("simple_form.labels.defaults.#{field_name}"),
+          'value' => Array(self[field_name]).map { |value| scrub(value.to_s) }
+        }
+      end
+    end
+
+    ##
+    # @return [String] the URL where the manifest can be found
+    def manifest_url
+      return '' if id.blank?
+
+      Rails.application.routes.url_helpers.polymorphic_url([:manifest, model], host: hostname)
+    end
+
+    ##
+    # @return [Array<#to_s>]
+    def member_ids
+      case model
+      when Valkyrie::Resource
+        Array(model.try(:member_ids))
+      else
+        Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
+      end
+    end
+
+    ##
+    # @note cache member presenters to avoid querying repeatedly; we expect this
+    #   presenter to live only as long as the request.
+    #
+    # @note skips presenters for objects the current `@ability` cannot read.
+    #   the default ability has all permissions.
+    #
+    # @return [Array<IiifManifestPresenter>]
+    def member_presenters
+      @member_presenters_cache ||= Factory.build_for(ids: member_ids, presenter_class: self.class).map do |presenter|
+        next unless ability.can?(:read, presenter.model)
+
+        presenter.hostname = hostname
+        presenter.ability  = ability
+        presenter
+      end.compact
+    end
+
+    ##
+    # @return [Array<Hash{String => String}>]
+    def sequence_rendering
+      Array(try(:rendering_ids)).map do |file_set_id|
+        rendering = file_set_presenters.find { |p| p.id == file_set_id }
+        next unless rendering
+
+        { '@id' => Hyrax::Engine.routes.url_helpers.download_url(rendering.id, host: hostname),
+          'format' => rendering.mime_type.presence || I18n.t("hyrax.manifest.unknown_mime_text"),
+          'label' => I18n.t("hyrax.manifest.download_text") + (rendering.label || '') }
+      end.flatten
+    end
+
+    ##
+    # @return [Boolean]
+    def work?
+      object.try(:work?) || !file_set?
+    end
+
+    ##
+    # @return [Array<IiifManifestPresenter>]
+    def work_presenters
+      member_presenters.select(&:work?)
+    end
+
+    ##
+    # @note ideally, this value will be cheap to retrieve, and will reliably
+    #   change any time the manifest JSON will change. the current implementation
+    #   is more blunt than this, changing only when the work itself changes.
+    #
+    # @return [String] a string tag suitable for cache keys for this manifiest
+    def version
+      object.try(:modified_date)&.to_s || ''
+    end
+
+    ##
+    # An Ability-like object that gives `true` for all `can?` requests
+    class NullAbility
+      ##
+      # @return [Boolean] true
+      def can?(*)
+        true
+      end
+    end
+
+    class Factory < PresenterFactory
+      ##
+      # @return [Array]
+      def build
+        ids.map do |id|
+          solr_doc = load_docs.find { |doc| doc.id == id }
+          presenter_class.for(solr_doc) if solr_doc
+        end.compact
+      end
+
+      private
+
+      ##
+      # cache the docs in this method, rather than #build;
+      # this can probably be pushed up to the parent class
+      def load_docs
+        @cached_docs ||= super
+      end
+    end
+
+    ##
+    # a Presenter for producing `IIIFManifest::DisplayImage` objects
+    #
+    class DisplayImagePresenter < Draper::Decorator
+      delegate_all
+
+      include Hyrax::DisplaysImage
+
+      ##
+      # @!attribute [w] ability
+      #   @return [Ability]
+      # @!attribute [w] hostname
+      #   @return [String]
+      attr_writer :ability, :hostname
+
+      ##
+      # Creates a display image only where #model is an image.
+      #
+      # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
+      def display_image
+        return nil unless model.image?
+        return nil unless latest_file_id
+
+        IIIFManifest::DisplayImage
+          .new(display_image_url(hostname),
+               format: image_format(alpha_channels),
+               width: width,
+               height: height,
+               iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
+      end
+
+      def hostname
+        @hostname || 'localhost'
+      end
+
+      ##
+      # @return [Boolean] false
+      def work?
+        false
+      end
+    end
+
+    private
+
+    def hostname
+      @hostname || 'localhost'
+    end
+
+    def metadata_fields
+      Hyrax.config.iiif_metadata_fields
+    end
+
+    def scrub(value)
+      Loofah.fragment(value).scrub!(:whitewash).to_s
+    end
+  end
+end