hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/app/actors/hyrax/actors/create_with_remote_files_actor.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   module Actors
-    # If there is a key `:remote_files' in the attributes, it attaches the files at the specified URIs
+    # 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 }
@@ -38,8 +38,7 @@ module Hyrax
             path.start_with?(dir) && path.length > dir.length
           end
         else
-          # TODO: It might be a good idea to validate other URLs as well.
-          #       The server can probably access URLs the user can't.
+          Rails.logger.debug "Assuming #{uri.scheme} uri is valid without a serious attempt to validate: #{uri}"
           true
         end
       end

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

@@ -1,41 +1,36 @@
 # frozen_string_literal: true
 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.
+    ##
+    # When adding member {FileSetBehavior}s to a {WorkBehavior}, {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.
+    # 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 work 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.
+    # 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,
+    # In +config/initializers/hyrax.rb+:
+    #   Hyrax::CurationConcern.actor_factory.swap(Hyrax::Actors::CreateWithRemoteFilesActor,
     #     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.:
+    # Alternatively, in +config/application.rb+:
+    #  config.to_prepare
+    #    Hyrax::CurationConcern.actor_factory.swap(Hyrax::Actors::CreateWithRemoteFilesActor,
+    #      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

data/app/actors/hyrax/actors/default_admin_set_actor.rb

@@ -6,8 +6,17 @@ module Hyrax
     # Hyrax::Actors::InitializeWorkflowActor, so that the correct
     # workflow can be kicked off.
     #
+    # @see Hyrax::EnsureWellFormedAdminSetService
+    #
     # @note Creates AdminSet, Hyrax::PermissionTemplate, Sipity::Workflow (with activation)
     class DefaultAdminSetActor < Hyrax::Actors::AbstractActor
+      # Hyrax provides a service that ensures well formed admin sets.
+      # It is possible that downstream implementers might seek to
+      # override this behavior.  The class attribute provicdes a means
+      # to override that behavior.
+      class_attribute :ensure_well_formed_admin_set_service
+      self.ensure_well_formed_admin_set_service = Hyrax::EnsureWellFormedAdminSetService
+
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
       def create(env)
@@ -24,28 +33,18 @@ module Hyrax
 
       private
 
+      # This method:
+      #
+      # - ensures that the env.attributes[:admin_set_id] is set
+      # - ensures that the permission template for the admin set is correct
       def ensure_admin_set_attribute!(env)
-        if env.attributes[:admin_set_id].present?
-          ensure_permission_template!(admin_set_id: env.attributes[:admin_set_id])
-        elsif env.curation_concern.admin_set_id.present?
-          env.attributes[:admin_set_id] = env.curation_concern.admin_set_id
-          ensure_permission_template!(admin_set_id: env.attributes[:admin_set_id])
-        else
-          env.attributes[:admin_set_id] = default_admin_set_id
-        end
-      end
-
-      def ensure_permission_template!(admin_set_id:)
-        Hyrax::PermissionTemplate.find_by(source_id: admin_set_id) || create_permission_template!(source_id: admin_set_id)
-      end
-
-      def default_admin_set_id
-        AdminSet.find_or_create_default_admin_set_id
-      end
-
-      # Creates a Hyrax::PermissionTemplate for the given AdminSet
-      def create_permission_template!(source_id:)
-        Hyrax::PermissionTemplate.create!(source_id: source_id)
+        # These logical hoops copy the prior behavior of the code;
+        # With a small logical caveat.  If the given curation_concern
+        # has an admin_set_id, we now verify that that admin set is
+        # well formed.
+        given_admin_set_id = env.attributes[:admin_set_id].presence || env.curation_concern.admin_set_id.presence
+        admin_set_id = ensure_well_formed_admin_set_service.call(admin_set_id: given_admin_set_id)
+        env.attributes[:admin_set_id] = given_admin_set_id || admin_set_id
       end
     end
   end

data/app/actors/hyrax/actors/file_actor.rb

@@ -25,7 +25,7 @@ module Hyrax
       # @see IngestJob
       # @todo create a job to monitor the temp directory (or in a multi-worker system, directories!) to prune old files that have made it into the repo
       def ingest_file(io)
-        perform_ingest_file(io)
+        use_valkyrie ? perform_ingest_file_through_valkyrie(io) : perform_ingest_file_through_active_fedora(io)
       end
 
       # Reverts file and spawns async job to characterize and create derivatives.
@@ -35,7 +35,7 @@ module Hyrax
         repository_file = related_file
         repository_file.restore_version(revision_id)
         return false unless file_set.save
-        Hyrax::VersioningService.create(repository_file, user)
+        create_version(repository_file, user)
         CharacterizeJob.perform_later(file_set, repository_file.id)
       end
 
@@ -48,20 +48,21 @@ module Hyrax
 
       private
 
+      ##
+      # Wraps the verisoning service with erro handling. if the service's
+      # create handler isn't implemented, we want to accept that quietly here.
+      def create_version(content, user)
+        Hyrax::VersioningService.create(content, user)
+      rescue NotImplementedError
+        :no_op
+      end
+
+      ##
       # @return [Hydra::PCDM::File] the file referenced by relation
       def related_file
         file_set.public_send(normalize_relation(relation)) || raise("No #{relation} returned for FileSet #{file_set.id}")
       end
 
-      # Persists file as part of file_set and records a new version.
-      # Also spawns an async job to characterize and create derivatives.
-      # @param [JobIoWrapper] io the file to save in the repository, with mime_type and original_name
-      # @return [FileMetadata, FalseClass] the created file metadata on success, false on failure
-      # @todo create a job to monitor the temp directory (or in a multi-worker system, directories!) to prune old files that have made it into the repo
-      def perform_ingest_file(io)
-        use_valkyrie ? perform_ingest_file_through_valkyrie(io) : perform_ingest_file_through_active_fedora(io)
-      end
-
       def perform_ingest_file_through_active_fedora(io)
         # Skip versioning because versions will be minted by VersionCommitter as necessary during save_characterize_and_record_committer.
         Hydra::Works::AddFileToFileSet.call(file_set,
@@ -70,30 +71,25 @@ module Hyrax
                                             versioning: false)
         return false unless file_set.save
         repository_file = related_file
-        Hyrax::VersioningService.create(repository_file, user)
-        pathhint = io.uploaded_file.uploader.path if io.uploaded_file # in case next worker is on same filesystem
-        CharacterizeJob.perform_later(file_set, repository_file.id, pathhint || io.path)
+        create_version(repository_file, user)
+        CharacterizeJob.perform_later(file_set, repository_file.id, pathhint(io))
       end
 
       def perform_ingest_file_through_valkyrie(io)
-        # Skip versioning because versions will be minted by VersionCommitter as necessary during save_characterize_and_record_committer.
-        unsaved_file_metadata = io.to_file_metadata
-        unsaved_file_metadata.type = [relation]
-        begin
-          saved_file_metadata = file_metadata_builder.create(io_wrapper: io, file_metadata: unsaved_file_metadata, file_set: file_set)
-        rescue StandardError => e # Handle error persisting file metadata
-          Rails.logger.error("Failed to save file_metadata through valkyrie: #{e.message}")
-          return false
-        end
-        Hyrax::VersioningService.create(saved_file_metadata, user)
-        pathhint = io.uploaded_file.uploader.path if io.uploaded_file # in case next worker is on same filesystem
-        id = Hyrax.config.translate_uri_to_id.call saved_file_metadata.file_identifiers.first
-        CharacterizeJob.perform_later(file_set, id, pathhint || io.path)
-      end
-
-      def file_metadata_builder
-        Wings::FileMetadataBuilder.new(storage_adapter: Hyrax.storage_adapter,
-                                       persister: Hyrax.persister)
+        file =
+          begin
+            Hyrax.storage_adapter.upload(resource: file_set, file: io, original_filename: io.original_name, use: relation)
+          rescue StandardError => err
+            Rails.logger.error("Failed to save file_metadata through valkyrie: #{err.message}")
+            return false
+          end
+        file_metadata = Hyrax.custom_queries.find_file_metadata_by(id: file.id)
+        create_version(file_metadata, user)
+        id = file_metadata.file_identifier
+        file_set.file_ids << id
+        Hyrax.persister.save(resource: file_set)
+        CharacterizeJob.perform_later(file_set, id.to_s, pathhint(io))
+        file_metadata
       end
 
       def normalize_relation(relation)
@@ -124,6 +120,10 @@ module Hyrax
       rescue ArgumentError
         Hyrax::FileMetadata::Use::ORIGINAL_FILE
       end
+
+      def pathhint(io)
+        io.uploaded_file&.uploader&.path || io.path
+      end
     end
   end
 end

data/app/actors/hyrax/actors/file_set_actor.rb

@@ -23,7 +23,7 @@ module Hyrax
         # If the file set doesn't have a title or label assigned, set a default.
         file_set.label ||= label_for(file)
         file_set.title = [file_set.label] if file_set.title.blank?
-        @file_set = perform_save(file_set) # Need to save to get an id # TODO: change this to `save(file_set)` when fully valkyrized
+        @file_set = perform_save(file_set)
         return false unless file_set
         if from_url
           # If ingesting from URL, don't spawn an IngestJob; instead
@@ -47,7 +47,6 @@ module Hyrax
       def update_content(file, relation = :original_file)
         IngestJob.perform_later(wrapper!(file: file, relation: relation), notification: true)
       end
-
       # @!endgroup
 
       # Adds the appropriate metadata, visibility and relationships to file_set
@@ -138,7 +137,8 @@ module Hyrax
       end
 
       def build_file_actor(relation)
-        file_actor_class.new(file_set, relation, user, use_valkyrie: use_valkyrie)
+        fs = use_valkyrie ? file_set.valkyrie_resource : file_set
+        file_actor_class.new(fs, relation, user, use_valkyrie: use_valkyrie)
       end
 
       # uses create! because object must be persisted to serialize for jobs
@@ -185,20 +185,11 @@ module Hyrax
         work.save!
       end
 
-      # save a valkyrie resource returning false if FailedSaveError is raised
-      # TODO: Change calls to `#perform_save` to call `#save` instead when env passes resources instead of active fedora objects
-      def save(resource)
-        Hyrax.persister.save(resource: resource)
-      rescue FailedSaveError
-        false
-      end
-
       # switches between using valkyrie to save or active fedora to save
-      # TODO: Remove this method when env passes resources instead of active fedora objects
       def perform_save(object)
         obj_to_save = object_to_act_on(object)
         if valkyrie_object?(obj_to_save)
-          saved_resource = save(obj_to_save)
+          saved_resource = Hyrax.persister.save(resource: obj_to_save)
           # return the same type of object that was passed in
           saved_object_to_return = valkyrie_object?(object) ? saved_resource : Wings::ActiveFedoraConverter.new(resource: saved_resource).convert
         else
@@ -209,14 +200,12 @@ module Hyrax
       end
 
       # if passed a resource or if use_valkyrie==true, object to act on is the valkyrie resource
-      # TODO: Remove this method when env passes resources instead of active fedora objects
       def object_to_act_on(object)
         return object if valkyrie_object?(object)
         use_valkyrie ? object.valkyrie_resource : object
       end
 
       # determine if the object is a valkyrie resource
-      # TODO: Remove this method when env passes resources instead of active fedora objects
       def valkyrie_object?(object)
         object.is_a? Valkyrie::Resource
       end

data/app/actors/hyrax/actors/initialize_workflow_actor.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 module Hyrax
   module Actors
+    ##
+    # @deprecated
+    #
     # Responsible for generating the workflow for the given curation_concern.
     # Done through direct collaboration with the configured Hyrax::Actors::InitializeWorkflowActor.workflow_factory
     #
@@ -13,6 +16,7 @@ module Hyrax
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
       def create(env)
+        Deprecation.warn('Use Hyrax::Listeners::WorkflowListener instead.')
         next_actor.create(env) && create_workflow(env)
       end
 
@@ -20,6 +24,10 @@ module Hyrax
 
       # @return [TrueClass]
       def create_workflow(env)
+        # if the entity exists, this is already initialized
+        Sipity::Entity(env.curation_concern)
+        true
+      rescue Sipity::ConversionError
         workflow_factory.create(env.curation_concern, env.attributes, env.user)
       end
     end

data/app/actors/hyrax/actors/transfer_request_actor.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 module Hyrax
   module Actors
+    ##
+    # @deprecated transfer requests are now carried out in response to published
+    # 'object.deposited' events.
+    #
     # Notify the provided owner that their proxy wants to make a
     # deposit on their behalf
     class TransferRequestActor < AbstractActor
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
       def create(env)
+        Deprecation.warn('Use Hyrax::Listeners::ProxyDepositListener instead.')
         next_actor.create(env) && create_proxy_deposit_request(env)
       end
 

data/app/assets/javascripts/hyrax.js

@@ -105,6 +105,7 @@
 //= require hyrax/turbolinks_events
 //= require hyrax/i18n_helper
 //= require hyrax/collapse
+//= 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/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/assets/stylesheets/hyrax/_usage-stats.scss

@@ -4,7 +4,7 @@
 
 .stats-container {
   box-sizing: border-box;
-  width: 850px;
+  max-width: 850px;
   height: 450px;
   padding: 20px 15px 15px 15px;
   margin: 15px auto 30px auto;

data/app/authorities/qa/authorities/collections.rb

@@ -7,9 +7,7 @@ module Qa::Authorities
     def search(_q, controller)
       # The Hyrax::CollectionSearchBuilder expects a current_user
       return [] unless controller.current_user
-      repo = CatalogController.new.repository
-      builder = search_builder(controller)
-      response = repo.search(builder)
+      response, _docs = search_response(controller)
       docs = response.documents
       docs.map do |doc|
         id = doc.id
@@ -20,12 +18,24 @@ module Qa::Authorities
 
     private
 
-    def search_builder(controller)
+    def search_service(controller)
+      @search_service ||= Hyrax::SearchService.new(
+        config: controller.blacklight_config,
+        user_params: controller.params,
+        search_builder_class: search_builder_class,
+        scope: controller,
+        current_ability: controller.current_ability
+      )
+    end
+
+    def search_response(controller)
       access = controller.params[:access] || 'read'
-      search_builder_class.new(controller)
-                          .where(controller.params[:q])
-                          .with_access(access)
-                          .rows(100)
+
+      search_service(controller).search_results do |builder|
+        builder.where(controller.params[:q])
+               .with_access(access)
+               .rows(100)
+      end
     end
   end
 end

data/app/authorities/qa/authorities/find_works.rb

@@ -7,9 +7,8 @@ module Qa::Authorities
     def search(_q, controller)
       # The My::FindWorksSearchBuilder expects a current_user
       return [] unless controller.current_user
-      repo = CatalogController.new.repository
-      builder = search_builder(controller)
-      response = repo.search(builder)
+
+      response, _docs = search_response(controller)
       docs = response.documents
       docs.map do |doc|
         id = doc.id
@@ -20,8 +19,24 @@ module Qa::Authorities
 
     private
 
-    def search_builder(controller)
-      search_builder_class.new(controller)
+    def search_service(controller)
+      @search_service ||= Hyrax::SearchService.new(
+        config: controller.blacklight_config,
+        user_params: controller.params,
+        search_builder_class: search_builder_class,
+        scope: controller,
+        current_ability: controller.current_ability
+      )
+    end
+
+    def search_response(controller)
+      access = controller.params[:access] || 'read'
+
+      search_service(controller).search_results do |builder|
+        builder.where(controller.params[:q])
+               .with_access(access)
+               .rows(100)
+      end
     end
   end
 end