hyrax 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8958d9121950df386c4f7d5cb5bcc9095711589c
-  data.tar.gz: 151738983808dfd64b6144babd565a4a315d1c6f
+  metadata.gz: d34c51d077dddcd6a5932d22a633104906b17e30
+  data.tar.gz: f61e880d0705b2863c0edf50e0066b8cf4df41c3
 SHA512:
-  metadata.gz: 7fac71e43de81973e966ab8ac058b7f127153cb1160f162b92a2a7125543e2f641b5738dc0d4c5b59d234058e21f707c61f3510b6b9d222d2b643fdd8d905ed3
-  data.tar.gz: 8798a1276dea980bbc2945f4e7629f663a9df0905c19c97f881c4650df2251c77998a2f8fe25ac61e23f755649706424059d5c74fd6f55d76d9834f61a937467
+  metadata.gz: bcda312829b2581af6d701b0a57cc11e99d26e12c4405fc5f8ecb814328cdc94a5ed74cb5deb0583b995b8ffd64127f806c4b7fb64a37372610ddf2d0e477d44
+  data.tar.gz: 70e85336f1286e3749f22f8cd4ee8d3607a4f06bc9dda48429cf37f53041b7d9012ddb1628bc97ae1de8d17622019e6f20d37f66bd920adb272fe1996a96954c

data/.circleci/config.yml

@@ -12,7 +12,7 @@ jobs:
     - image: ualbertalib/docker-fcrepo4:4.7
       environment:
         CATALINA_OPTS: "-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server -Xms512m -Xmx1024m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC"
-    - image: solr:7
+    - image: solr:7-alpine
       command: bin/solr -cloud -noprompt -f -p 8985
 
     # Specify service dependencies here if necessary

data/.github/stale.yml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 30
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 14
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  activity for 30 days. It will be closed if no further activity occurs within 14 days. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false
+# Limit to only `issues` or `pulls`
+only: pulls

data/README.md

@@ -64,7 +64,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v2.3.3__. If you are looking for instructions on installing a different
+v2.4.0__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -163,7 +163,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.1.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.3.3/template.rb
+rails _5.1.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.4.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/app/actors/hyrax/actors/apply_permission_template_actor.rb

@@ -31,10 +31,8 @@ module Hyrax
         end
 
         def set_curation_concern_access(env, template)
-          env.curation_concern.edit_users += template.agent_ids_for(agent_type: 'user', access: 'manage')
-          env.curation_concern.edit_groups += template.agent_ids_for(agent_type: 'group', access: 'manage')
-          env.curation_concern.read_users += template.agent_ids_for(agent_type: 'user', access: 'view')
-          env.curation_concern.read_groups += template.agent_ids_for(agent_type: 'group', access: 'view')
+          PermissionTemplateApplicator
+            .apply(template).to(model: env.curation_concern)
         end
     end
   end

data/app/actors/hyrax/actors/create_with_files_ordered_members_actor.rb

@@ -0,0 +1,45 @@
+module Hyrax
+  module Actors
+    # When adding member FileSets to a Work, Hyrax saves
+    #   and reloads the work for each new member FileSet.
+    #   This can significantly slow down ingest for Works
+    #   with many member FileSets. The saving and reloading
+    #   happens in FileSetActor#attach_to_work.
+    #
+    # This is a 'swappable' alternative approach. It will
+    #   be of most value to Hyrax applications dealing with
+    #   works with many filesets. Anecdotally, a work with
+    #   600 filesets can be processed in ~15 mins versus
+    #   > 3 hours with the standard approach.
+    #
+    # The tradeoff is that the ordered members are now added in a
+    #   single step after the creation of all the FileSets, thus
+    #   introducing a slight risk of orphan filesets if the upload
+    #   fails before the addition of the ordered members. This
+    #   has not been observed in practice.
+    #
+    # Swapping out the actors can be achieved thus:
+    #
+    # In `config/initializers/hyrax.rb`:
+    # ```
+    # Hyrax::CurationConcern.actor_factory.swap(Hyrax::Actors::CreateWithFilesActor,
+    #   Hyrax::Actors::CreateWithFilesOrderedMembersActor)
+    # ```
+    # Alternatively, in `config/application.rb`:
+    # ```
+    # config.to_prepare
+    #   Hyrax::CurationConcern.actor_factory.swap(Hyrax::Actors::CreateWithFilesActor,
+    #     Hyrax::Actors::CreateWithFilesOrderedMembersActor)
+    # end
+    # ```
+    # Creates a work and attaches files to the work
+    class CreateWithFilesOrderedMembersActor < CreateWithFilesActor
+      # @return [TrueClass]
+      def attach_files(files, env)
+        return true if files.blank?
+        AttachFilesToWorkWithOrderedMembersJob.perform_later(env.curation_concern, files, env.attributes.to_h.symbolize_keys)
+        true
+      end
+    end
+  end
+end

data/app/actors/hyrax/actors/create_with_remote_files_ordered_members_actor.rb

@@ -0,0 +1,96 @@
+module Hyrax
+  module Actors
+    # When adding member FileSets to a Work, Hyrax saves
+    #   and reloads the work for each new member FileSet.
+    #   This can significantly slow down ingest for Works
+    #   with many member FileSets. The saving and reloading
+    #   happens in FileSetActor#attach_to_work.
+    #
+    # This is a 'swappable' alternative approach. It will
+    #   be of most value to Hyrax applications dealing with
+    #   works with many filesets. Anecdotally, a 600 fileset
+    #   can be processed in ~15 mins versus >3 hours
+    #   with the standard approach.
+    #
+    # The tradeoff is that the ordered members are now added in a
+    #   single step after the creation of all the FileSets, thus
+    #   introducing a slight risk of orphan filesets if the upload
+    #   fails before the addition of the ordered members. This
+    #   has not been observed in practice.
+    #
+    # Swapping out the actors can be achieved thus:
+    #
+    # In `config/initializers/hyrax.rb`:
+    # ```
+    # Hyrax::CurationConcern.actor_factory.swap(Hyrax::Actors::CreateWithFilesActor,
+    #   Hyrax::Actors::CreateWithRemoteFilesOrderedMembersActor)
+    # ```
+    # Alternatively, in `config/application.rb`:
+    # ```
+    # config.to_prepare
+    #   Hyrax::CurationConcern.actor_factory.swap(Hyrax::Actors::CreateWithFilesActor,
+    #     Hyrax::Actors::CreateWithRemoteFilesOrderedMembersActor)
+    # end
+    # ```
+    #
+    # If there is a key `:remote_files' in the attributes, it attaches the files at the specified URIs
+    # to the work. e.g.:
+    #     attributes[:remote_files] = filenames.map do |name|
+    #       { url: "https://example.com/file/#{name}", file_name: name }
+    #     end
+    #
+    # Browse everything may also return a local file. And although it's in the
+    # url property, it may have spaces, and not be a valid URI.
+    class CreateWithRemoteFilesOrderedMembersActor < CreateWithRemoteFilesActor
+      attr_reader :ordered_members
+
+      # @param [HashWithIndifferentAccess] remote_files
+      # @return [TrueClass]
+      def attach_files(env, remote_files)
+        return true unless remote_files
+        @ordered_members = env.curation_concern.ordered_members.to_a
+        remote_files.each do |file_info|
+          next if file_info.blank? || file_info[:url].blank?
+          # Escape any space characters, so that this is a legal URI
+          uri = URI.parse(Addressable::URI.escape(file_info[:url]))
+          unless validate_remote_url(uri)
+            Rails.logger.error "User #{env.user.user_key} attempted to ingest file from url #{file_info[:url]}, which doesn't pass validation"
+            return false
+          end
+          auth_header = file_info.fetch(:auth_header, {})
+          create_file_from_url(env, uri, file_info[:file_name], auth_header)
+        end
+        add_ordered_members(env.user, env.curation_concern)
+        true
+      end
+
+      # Generic utility for creating FileSet from a URL
+      # Used in to import files using URLs from a file picker like browse_everything
+      def create_file_from_url(env, uri, file_name, auth_header = {})
+        ::FileSet.new(import_url: uri.to_s, label: file_name) do |fs|
+          actor = file_set_actor_class.new(fs, env.user)
+          actor.create_metadata(visibility: env.curation_concern.visibility)
+          actor.attach_to_work(env.curation_concern)
+          fs.save!
+          ordered_members << fs
+          if uri.scheme == 'file'
+            # Turn any %20 into spaces.
+            file_path = CGI.unescape(uri.path)
+            IngestLocalFileJob.perform_later(fs, file_path, env.user)
+          else
+            ImportUrlJob.perform_later(fs, operation_for(user: actor.user), auth_header)
+          end
+        end
+      end
+
+      # Add all file_sets as ordered_members in a single action
+      def add_ordered_members(user, work)
+        actor = Hyrax::Actors::OrderedMembersActor.new(ordered_members, user)
+        actor.attach_ordered_members_to_work(work)
+      end
+
+      class_attribute :file_set_actor_class
+      self.file_set_actor_class = Hyrax::Actors::FileSetOrderedMembersActor
+    end
+  end
+end

data/app/actors/hyrax/actors/file_set_ordered_members_actor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Actors
+    class FileSetOrderedMembersActor < FileSetActor
+      # Adds representative and thumbnail to work; sets file_set visibility
+      # @param [ActiveFedora::Base] work the parent work
+      # @param [Hash] file_set_params
+      def attach_to_work(work, file_set_params = {})
+        file_set.visibility = work.visibility unless assign_visibility?(file_set_params)
+        work.representative = file_set if work.representative_id.blank?
+        work.thumbnail = file_set if work.thumbnail_id.blank?
+      end
+    end
+  end
+end

data/app/actors/hyrax/actors/ordered_members_actor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Actors
+    class OrderedMembersActor < FileSetActor
+      include Lockable
+      attr_reader :ordered_members, :user
+
+      def initialize(ordered_members, user)
+        @ordered_members = ordered_members
+        @user = user
+      end
+
+      # Adds FileSets to the work using ore:Aggregations.
+      # Locks to ensure that only one process is operating on the list at a time.
+      # @param [ActiveFedora::Base] work the parent work
+      def attach_ordered_members_to_work(work)
+        acquire_lock_for(work.id) do
+          work.ordered_members = ordered_members
+          work.save
+          ordered_members.each do |file_set|
+            Hyrax.config.callback.run(:after_create_fileset, file_set, user)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -289,6 +289,7 @@ Blacklight.onLoad(function () {
       parentId = $modal.find('[name="parent_id"]').val(),
       data = {
         parent_id: parentId,
+        // source parameter is used by NestCollectionsController#redirect_path
         source: $self.data('source')
       };
     if (url.length === 0) {
@@ -308,6 +309,7 @@ Blacklight.onLoad(function () {
       childId = $(this).closest('.modal').find('[name="child_id"]').val(),
       data = {
       child_id: childId,
+      // source parameter is used by NestCollectionsController#redirect_path
       source: $(this).data('source')
     };
     if (url.length === 0) {

data/app/assets/stylesheets/hyrax/_file-listing.scss

@@ -97,7 +97,8 @@ h4 .small {
   text-decoration: none;
 }
 
-input.batch_document_selector {
+input.batch_document_selector,
+input.disabled {
   margin: 10px 10px 2px 10px;
   padding: 0px;
 }

data/app/assets/stylesheets/hyrax/_work-show.scss

@@ -18,6 +18,10 @@ header > h1 .label {
   padding: $panel-body-padding;
 }
 
+.ensure-wrapped {
+  word-break: break-all;
+}
+
 .relationships,
 .attributes {
   tbody th {

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

@@ -36,7 +36,7 @@ module Hyrax
           curation_concern.copy_visibility_to_files
         end
       end
-      redirect_to embargoes_path
+      redirect_to embargoes_path, notice: t('.embargo_deactivated')
     end
 
     # This allows us to use the unauthorized template in curation_concerns/base

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

@@ -127,13 +127,16 @@ module Hyrax
 
     def manifest
       headers['Access-Control-Allow-Origin'] = '*'
-      render json: manifest_builder.to_h
+      respond_to do |wants|
+        wants.json { render json: manifest_builder.to_h }
+        wants.html { render json: manifest_builder.to_h }
+      end
     end
 
     private
 
       def user_collections
-        collections_service.search_results(:deposit) if presenter.editor?
+        collections_service.search_results(:deposit)
       end
 
       def collections_service

data/app/controllers/hyrax/dashboard/nest_collections_controller.rb

@@ -91,15 +91,8 @@ module Hyrax
 
         # determine appropriate redirect location depending on specified source
         def redirect_path(item:)
-          from = params[:source] || 'none'
-          case from
-          when "my"
-            my_collections_path
-          when "show"
-            dashboard_collection_path(item)
-          else
-            dashboard_collection_path(item)
-          end
+          return my_collections_path if params[:source] == 'my'
+          dashboard_collection_path(item)
         end
     end
   end

data/app/helpers/hyrax/batch_edits_helper.rb

@@ -9,7 +9,6 @@ module Hyrax
     # Displays a "check all" button with a dropdown that has "Select None"
     # and "Select current page" actions
     def render_check_all
-      return if params[:controller] == "hyrax/my/collections"
       render 'hyrax/batch_edits/check_all'
     end
   end

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -11,6 +11,7 @@ module Hyrax
     include Hyrax::CollectionsHelper
     include Hyrax::ChartsHelper
     include Hyrax::DashboardHelperBehavior
+    include Hyrax::IiifHelper
 
     # 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/iiif_helper.rb

@@ -0,0 +1,12 @@
+module Hyrax
+  module IiifHelper
+    def iiif_viewer_display(work_presenter, locals = {})
+      render iiif_viewer_display_partial(work_presenter),
+             locals.merge(presenter: work_presenter)
+    end
+
+    def iiif_viewer_display_partial(work_presenter)
+      'hyrax/base/iiif_viewers/' + work_presenter.iiif_viewer.to_s
+    end
+  end
+end

data/app/jobs/attach_files_to_work_with_ordered_members_job.rb

@@ -0,0 +1,41 @@
+# Converts UploadedFiles into FileSets and attaches them to works.
+class AttachFilesToWorkWithOrderedMembersJob < AttachFilesToWorkJob
+  attr_reader :ordered_members, :uploaded_files
+
+  # @param [ActiveFedora::Base] work - the work object
+  # @param [Array<Hyrax::UploadedFile>] uploaded_files - an array of files to attach
+  def perform(work, uploaded_files, **work_attributes)
+    @uploaded_files = uploaded_files
+    validate_files!(uploaded_files)
+    @ordered_members = work.ordered_members.to_a # Build array of ordered members
+    depositor = proxy_or_depositor(work)
+    user = User.find_by_user_key(depositor)
+    metadata = visibility_attributes(work_attributes)
+    add_uploaded_files(user, metadata, work)
+    add_ordered_members(user, work)
+  end
+
+  private
+
+    def add_uploaded_files(user, metadata, work)
+      work_permissions = work.permissions.map(&:to_hash)
+      uploaded_files.each do |uploaded_file|
+        actor = file_set_actor_class.new(FileSet.create, user)
+        actor.create_metadata(metadata)
+        actor.create_content(uploaded_file)
+        actor.attach_to_work(work)
+        actor.file_set.permissions_attributes = work_permissions
+        ordered_members << actor.file_set
+        uploaded_file.update(file_set_uri: actor.file_set.uri)
+      end
+    end
+
+    # Add all file_sets as ordered_members in a single action
+    def add_ordered_members(user, work)
+      actor = Hyrax::Actors::OrderedMembersActor.new(ordered_members, user)
+      actor.attach_ordered_members_to_work(work)
+    end
+
+    class_attribute :file_set_actor_class
+    self.file_set_actor_class = Hyrax::Actors::FileSetOrderedMembersActor
+end

data/app/presenters/hyrax/work_show_presenter.rb

@@ -55,8 +55,8 @@ module Hyrax
       Hyrax::Engine.routes.url_helpers.download_url(representative_presenter, host: request.host)
     end
 
-    # @return [Boolean] render the UniversalViewer
-    def universal_viewer?
+    # @return [Boolean] render a IIIF viewer
+    def iiif_viewer?
       representative_id.present? &&
         representative_presenter.present? &&
         representative_presenter.image? &&
@@ -64,6 +64,26 @@ module Hyrax
         members_include_viewable_image?
     end
 
+    alias universal_viewer? iiif_viewer?
+    deprecation_deprecate universal_viewer?: "use iiif_viewer? instead"
+
+    # @return [Symbol] the name of the IIIF viewer partial to render
+    # @example A work presenter with a custom iiif viewer
+    #   module Hyrax
+    #     class GenericWorkPresenter < Hyrax::WorkShowPresenter
+    #       def iiif_viewer
+    #         :my_iiif_viewer
+    #       end
+    #     end
+    #   end
+    #
+    #   Custom iiif viewer partial at app/views/hyrax/base/iiif_viewers/_my_iiif_viewer.html.erb
+    #   <h3>My IIIF Viewer!</h3>
+    #   <a href=<%= main_app.polymorphic_url([main_app, :manifest, presenter], { locale: nil }) %>>Manifest</a>
+    def iiif_viewer
+      :universal_viewer
+    end
+
     # @return FileSetPresenter presenter for the representative FileSets
     def representative_presenter
       return nil if representative_id.blank?
@@ -204,6 +224,13 @@ module Hyrax
       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
+    # @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)
+    end
+
     private
 
       # list of item ids to display is based on ordered_ids