hyrax 2.8.0 → 2.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140c7caa34751f7a525eda269abcee6331a9e7d200863e2cbee29d315966de65
-  data.tar.gz: 7085c394edd0aa1e90baef7d13f90245d8fb0fb65659e54549cedda0487445e9
+  metadata.gz: f943e7915f659dabbc79d757e34334d8eb602fd0a25d663ccaffd6e4d5427cab
+  data.tar.gz: dc220a862725eaf06e8bf6b3d2c7196aa1c7aca72d63f950d4ace93aab4cc544
 SHA512:
-  metadata.gz: 691b84f363281552cbd84f85b767bb5b460ba749e0449aed0498594143767a6cd4dae187a5dd9c88bf3b7bd06a568375da70367b3b8faa674a59f39deaf4df06
-  data.tar.gz: e19605afaa51b569ea79e7e99d65fd0576b172cd6dfeb38f815c4dd3a7ac18678bb6b3ff4ac4a5af2b6358bf55c459baba0c4a98b393d20f7d64388f576c894f
+  metadata.gz: 8511afa746c378d0b697ea488aae0811e0cd93c6e055d23b063a75f5611cbc6d99004d134bafb19f285a20b160b5c37cc3ce5625a484964d7d91d4ca4d72e7d9
+  data.tar.gz: 43efe3c7bfc349a2aa113c18d2f507da53a8d6fd9e1ceb677f028577e832469740cff247ef3fd3e7a4f8b9b136aed595ef1bfda2a3a1fc3146bab365b97a0a46

data/.gitignore

@@ -78,3 +78,4 @@ _yardoc
 lib/bundler/man
 spec/reports
 /spec/examples.txt
+node_modules

data/.regen

@@ -1 +1 @@
-3
+3.http_method

data/README.md

@@ -158,7 +158,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.4.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.8.0/template.rb
+rails _5.2.4.4_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.9.4/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/app/assets/javascripts/hyrax.js

@@ -104,6 +104,7 @@
 //= require hyrax/tabbed_form
 //= require hyrax/turbolinks_events
 //= require hyrax/i18n_helper
+//= require hyrax/skip_to_content
 
 // this needs to be after batch_select so that the form ids get setup correctly
 //= require hyrax/batch_edit

data/app/assets/javascripts/hyrax/autocomplete.es6

@@ -10,6 +10,34 @@ export default class Autocomplete {
    * @param {string} url - The url for the autocompete search endpoint
    */
   setup (element, fieldName, url) {
+    if(element.data('autocomplete-type') && element.data('autocomplete-type').length > 0) {
+      this.byDataAttribute(element, url)
+    } else {
+      this.byFieldName(element, fieldName, url)
+    }
+  }
+
+  byDataAttribute(element, url) {
+    let type = element.data('autocomplete-type')
+    let exlude = element.data('exclude-work')
+    if(type === 'resource' && exclude.length > 0) {
+      new Resource(
+        element,
+        url,
+        { excluding: exclude }
+      )
+    } else if(type === 'resource' ) {
+      new Resource(
+        element,
+        url)
+    } else if(type === 'linked') {
+      new LinkedData(element, url)
+    } else {
+      new Default(element, url)
+    }
+  }
+
+  byFieldName(element, fieldName, url) {
     switch (fieldName) {
       case 'work':
         new Resource(
@@ -30,4 +58,5 @@ export default class Autocomplete {
         break
     }
   }
+
 }

data/app/assets/javascripts/hyrax/editor.es6

@@ -53,17 +53,16 @@ export default class {
       $('[data-autocomplete]').each((function() {
         var elem = $(this)
         autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
+        elem.parents('.multi_value.form-group').manage_fields({
+          add: function(e, element) {
+            var elem = $(element)
+            // Don't mark an added element as readonly even if previous element was
+            // Enable before initializing, as otherwise LinkedData fields remain disabled
+            elem.attr('readonly', false)
+            autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
+          }
+        })
       }))
-
-      $('.multi_value.form-group').manage_fields({
-        add: function(e, element) {
-          var elem = $(element)
-          // Don't mark an added element as readonly even if previous element was
-          // Enable before initializing, as otherwise LinkedData fields remain disabled
-          elem.attr('readonly', false)
-          autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
-        }
-      })
   }
 
   // initialize any controlled vocabulary widgets

data/app/assets/javascripts/hyrax/skip_to_content.js

@@ -0,0 +1,15 @@
+// This code is to implement skip_to_content
+
+Blacklight.onLoad(function () {
+  $(".skip-to-content").click(function(event) {
+    event.preventDefault();
+    // element to focus on
+    var skipTo = '#' + $(this)[0].firstElementChild.hash.split('#')[1];
+
+    // Setting 'tabindex' to -1 takes an element out of normal
+    // tab flow but allows it to be focused via javascript
+    $(skipTo).attr('tabindex', -1).on('blur focusout', function () {
+      $(this).removeAttr('tabindex');
+    }).focus();
+  });
+});

data/app/controllers/concerns/hyrax/works_controller_behavior.rb

@@ -10,10 +10,11 @@ module Hyrax
       with_themed_layout :decide_layout
       copy_blacklight_config_from(::CatalogController)
 
-      class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class
+      class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class, :iiif_manifest_builder
       self.show_presenter = Hyrax::WorkShowPresenter
       self.work_form_service = Hyrax::WorkFormService
       self.search_builder_class = WorkSearchBuilder
+      self.iiif_manifest_builder = (Flipflop.cache_work_iiif_manifest? ? Hyrax::CachingIiifManifestBuilder.new : Hyrax::ManifestBuilderService.new)
       attr_accessor :curation_concern
       helper_method :curation_concern, :contextual_path
 
@@ -127,14 +128,28 @@ module Hyrax
 
     def manifest
       headers['Access-Control-Allow-Origin'] = '*'
+
+      json = iiif_manifest_builder.manifest_for(presenter: iiif_manifest_presenter)
+
       respond_to do |wants|
-        wants.json { render json: manifest_builder.to_h }
-        wants.html { render json: manifest_builder.to_h }
+        wants.json { render json: json }
+        wants.html { render json: json }
       end
     end
 
     private
 
+      def iiif_manifest_builder
+        self.class.iiif_manifest_builder
+      end
+
+      def iiif_manifest_presenter
+        IiifManifestPresenter.new(curation_concern_from_search_results).tap do |p|
+          p.hostname = request.base_url
+          p.ability = current_ability
+        end
+      end
+
       def user_collections
         collections_service.search_results(:deposit)
       end
@@ -157,10 +172,6 @@ module Hyrax
         @form = work_form_service.build(curation_concern, current_ability, self)
       end
 
-      def manifest_builder
-        ::IIIFManifest::ManifestFactory.new(presenter)
-      end
-
       def actor
         @actor ||= Hyrax::CurationConcern.actor
       end

data/app/controllers/hyrax/file_sets_controller.rb

@@ -85,13 +85,18 @@ module Hyrax
           actor.revert_content(params[:revision])
         elsif params.key?(:file_set)
           if params[:file_set].key?(:files)
-            actor.update_content(params[:file_set][:files].first)
+            actor.update_content(uploaded_file_from_path)
           else
             update_metadata
           end
         end
       end
 
+      def uploaded_file_from_path
+        uploaded_file = CarrierWave::SanitizedFile.new(params[:file_set][:files].first)
+        Hyrax::UploadedFile.create(user_id: current_user.id, file: uploaded_file)
+      end
+
       def after_update_response
         respond_to do |wants|
           wants.html do

data/app/controllers/hyrax/users_controller.rb

@@ -41,7 +41,7 @@ module Hyrax
 
       def find_user
         @user = ::User.from_url_component(params[:id])
-        redirect_to root_path, alert: "User '#{params[:id]}' does not exist" if @user.nil?
+        redirect_to root_path, alert: "User does not exist" unless @user
       end
 
       def sort_value

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -12,6 +12,7 @@ module Hyrax
     include Hyrax::ChartsHelper
     include Hyrax::DashboardHelperBehavior
     include Hyrax::IiifHelper
+    include Hyrax::WorkFormHelper
 
     # Which translations are available for the user to select
     # @return [Hash<String,String>] locale abbreviations as keys and flags as values

data/app/helpers/hyrax/work_form_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Hyrax
+  module WorkFormHelper
+    ##
+    # This helper allows downstream applications and engines to add/remove/reorder the tabs to be
+    # rendered on the work form.
+    #
+    # @example with additional tabs
+    #  Override this helper and ensure that it loads after Hyrax's helpers.
+    #  module WorksHelper
+    #    def form_tabs_for(form:)
+    #      super + ["my_new_tab"]
+    #    end
+    #  end
+    #  Add the new section partial at app/views/hyrax/base/_form_my_new_tab.html.erb
+    #
+    # @todo The share tab isn't included because it wasn't in guts4form.  guts4form should be
+    #   cleaned up so share is treated the same as other tabs and can be included below.
+    # @param form [Hyrax::Forms::WorkForm]
+    # @return [Array<String>] the list of names of tabs to be rendered in the form
+    def form_tabs_for(form:)
+      if form.instance_of? Hyrax::Forms::BatchUploadForm
+        %w[files metadata relationships]
+      else
+        %w[metadata files relationships]
+      end
+    end
+
+    ##
+    # This helper allows downstream applications and engines to add additional sections to be
+    # rendered after the visibility section in the Save Work panel on the work form.
+    #
+    # @example with additional sections
+    #  Override this helper and ensure that it loads after Hyrax's helpers.
+    #  module WorksHelper
+    #    def form_progress_sections_for(*)
+    #      super + ["my_new_section"]
+    #    end
+    #  end
+    #  Add the new section partial at app/views/hyrax/base/_form_progress_my_new_section.html.erb
+    #
+    # @param form [Hyrax::Forms::WorkForm]
+    # @return [Array<String>] the list of names of sections to be rendered in the form_progress panel
+    def form_progress_sections_for(*)
+      []
+    end
+  end
+end

data/app/jobs/embargo_expiry_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+class EmbargoExpiryJob < Hyrax::ApplicationJob
+  def perform
+    records_with_expired_embargos.each do |id|
+      work = ActiveFedora::Base.find(id)
+      Hyrax::Actors::EmbargoActor.new(work).destroy
+    end
+  end
+
+  ##
+  # @return [Enumerator<String>] ids for all the objects that have expired active embargoes
+  def records_with_expired_embargos
+    Hyrax::EmbargoService.assets_with_expired_embargoes.map(&:id)
+  end
+end

data/app/jobs/iiif_manifest_cache_prewarm_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class IiifManifestCachePrewarmJob < Hyrax::ApplicationJob
+  ##
+  # @param work [ActiveFedora::Base]
+  def perform(work)
+    presenter = Hyrax::IiifManifestPresenter.new(work)
+    manifest_builder.manifest_for(presenter: presenter)
+  end
+
+  private
+
+    def manifest_builder
+      Hyrax::CachingIiifManifestBuilder.new
+    end
+end

data/app/jobs/lease_expiry_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+class LeaseExpiryJob < Hyrax::ApplicationJob
+  def perform
+    records_with_expired_leases.each do |id|
+      work = ActiveFedora::Base.find(id)
+      Hyrax::Actors::LeaseActor.new(work).destroy
+    end
+  end
+
+  ##
+  # @return [Enumerator<String>] ids for all the objects that have expired active leases
+  def records_with_expired_leases
+    Hyrax::LeaseService.assets_with_expired_leases.map(&:id)
+  end
+end

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -54,6 +54,7 @@ module Hyrax
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
         attribute :admin_set, Solr::Array, solr_name('admin_set')
+        attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, solr_name('member_of_collection_ids', :symbol)
         attribute :description, Solr::Array, solr_name('description')
         attribute :title, Solr::Array, solr_name('title')

data/app/models/concerns/hyrax/solr_document/ordered_members.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Hyrax
+  module SolrDocument
+    ##
+    # Decorates an object responding to `#id` with an `#ordered_member_ids` method.
+    #
+    # @note this decorator is intended for use with data representations other
+    #   than the core model objects, as an alternative to a direct query of the
+    #   canonical database. for example, it can be used with `SolrDocument` to
+    #   quickly retrieve member order in a way that is compatible with the
+    #   fast access required in Blacklight's search contexts.
+    #
+    # @example
+    #   base_document = SolrDocument.new(my_work.to_solr)
+    #   solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(base_document)
+    #
+    #   solr_document.ordered_member_ids # => ['abc', '123']
+    #
+    class OrderedMembers < Draper::Decorator
+      delegate_all
+
+      ##
+      # @note the purpose of this method is to provide fast access to member
+      #   order. currently this is achieved by accessing indexed list proxies
+      #   from Solr. however, this strategy may change in the future.
+      #
+      # @return [Enumerable<String>] ids in the order of their membership,
+      #   only includes ids of ordered members.
+      def ordered_member_ids
+        return [] if id.blank?
+        @ordered_member_ids ||= query_for_ordered_ids
+      end
+
+      private
+
+        def query_for_ordered_ids(limit: 10_000,
+                                  proxy_field: 'proxy_in_ssi',
+                                  target_field: 'ordered_targets_ssim')
+          ActiveFedora::SolrService
+            .query("#{proxy_field}:#{id}", rows: limit, fl: target_field)
+            .flat_map { |x| x.fetch(target_field, nil) }
+            .compact
+        end
+    end
+  end
+end

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -61,10 +61,20 @@ module Hyrax
       @model ||= ModelWrapper.new(hydra_model, id)
     end
 
+    ##
+    # @return [Boolean]
     def collection?
       hydra_model == ::Collection
     end
 
+    ##
+    # @return [Boolean]
+    def file_set?
+      hydra_model == ::FileSet
+    end
+
+    ##
+    # @return [Boolean]
     def admin_set?
       hydra_model == ::AdminSet
     end

data/app/presenters/hyrax/displays_image.rb

@@ -11,20 +11,11 @@ module Hyrax
     # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
     def display_image
       return nil unless solr_document.image? && current_ability.can?(:read, solr_document)
-
-      latest_file_id = lookup_original_file_id
-
       return nil unless latest_file_id
 
-      url = Hyrax.config.iiif_image_url_builder.call(
-        latest_file_id,
-        request.base_url,
-        Hyrax.config.iiif_image_size_default
-      )
-
       # @see https://github.com/samvera-labs/iiif_manifest
-      IIIFManifest::DisplayImage.new(url,
-                                     format: image_format([]),
+      IIIFManifest::DisplayImage.new(display_image_url(request.base_url),
+                                     format: image_format(alpha_channels),
                                      width: width,
                                      height: height,
                                      iiif_endpoint: iiif_endpoint(latest_file_id))
@@ -32,16 +23,24 @@ module Hyrax
 
     private
 
-      def iiif_endpoint(file_id)
+      def display_image_url(base_url)
+        Hyrax.config.iiif_image_url_builder.call(
+          latest_file_id,
+          base_url,
+          Hyrax.config.iiif_image_size_default
+        )
+      end
+
+      def iiif_endpoint(file_id, base_url: request.base_url)
         return unless Hyrax.config.iiif_image_server?
         IIIFManifest::IIIFEndpoint.new(
-          Hyrax.config.iiif_info_url_builder.call(file_id, request.base_url),
+          Hyrax.config.iiif_info_url_builder.call(file_id, base_url),
           profile: Hyrax.config.iiif_image_compliance_level_uri
         )
       end
 
       def image_format(channels)
-        channels.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
+        channels&.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
       end
 
       def unindexed_current_file_version
@@ -49,13 +48,18 @@ module Hyrax
         ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
       end
 
-      def lookup_original_file_id
-        result = original_file_id
-        if result.blank?
-          Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
-          result = ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
-        end
-        result
+      def latest_file_id
+        @latest_file_id ||=
+          begin
+            result = original_file_id
+
+            if result.blank?
+              Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
+              result = Hyrax::VersioningService.versioned_file_id ::FileSet.find(id).original_file
+            end
+
+            result
+          end
       end
   end
 end