hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/actors/hyrax/actors/cleanup_trophies_actor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Hyrax
   module Actors
@@ -12,9 +13,9 @@ module Hyrax
 
       private
 
-        def cleanup_trophies(env)
-          Trophy.where(work_id: env.curation_concern.id).destroy_all
-        end
+      def cleanup_trophies(env)
+        Trophy.where(work_id: env.curation_concern.id).destroy_all
+      end
     end
   end
 end

data/app/actors/hyrax/actors/collections_membership_actor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Actors
     # Adds membership to and removes membership from collections.
@@ -25,148 +26,102 @@ module Hyrax
 
       private
 
-        ##
-        # Attaches any unattached members.  Deletes those that are marked _delete
-        #
-        # @param env [Hyrax::Actors::Enviornment]
-        # @return [Boolean]
-        #
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        def assign_nested_attributes_for_collection(env)
-          attributes_collection = env.attributes.delete(:member_of_collections_attributes)
-
-          return assign_for_collection_ids(env) unless attributes_collection
-
-          emit_deprecation if env.attributes.delete(:member_of_collection_ids)
-
-          return false unless
-            valid_membership?(env, collection_ids: attributes_collection.map { |_, attributes| attributes['id'] })
-
-          attributes_collection = attributes_collection.sort_by { |i, _| i.to_i }.map { |_, attributes| attributes }
-          # checking for existing works to avoid rewriting/loading works that are already attached
-          existing_collections = env.curation_concern.member_of_collection_ids
-          boolean_type_caster = ActiveModel::Type::Boolean.new
-          attributes_collection.each do |attributes|
-            next if attributes['id'].blank?
-            if boolean_type_caster.cast(attributes['_destroy'])
-              # Likely someone in the UI sought to add the collection, then
-              # changed their mind and checked the "delete" checkbox and posted
-              # their update.
-              next unless existing_collections.include?(attributes['id'])
-              remove(env.curation_concern, attributes['id'])
-            else
-              next if existing_collections.include?(attributes['id'])
-              add(env, attributes['id'])
-            end
-          end
-
-          true
-        end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
-        ##
-        # @deprecated supports old :member_of_collection_ids arguments
-        def emit_deprecation
-          Deprecation.warn(self, ':member_of_collections_attributes and :member_of_collection_ids were both ' \
-                                 ' passed. :member_of_collection_ids is ignored when both are passed and is ' \
-                                 'deprecated for removal in Hyrax 3.0.')
-        end
-
-        ##
-        # @deprecated supports old :member_of_collection_ids arguments
-        def assign_for_collection_ids(env)
-          collection_ids = env.attributes.delete(:member_of_collection_ids)
-
-          return false unless valid_membership?(env, collection_ids: collection_ids)
-
-          if collection_ids
-            Deprecation.warn(self, ':member_of_collection_ids has been deprecated for removal in Hyrax 3.0. ' \
-                                   'use :member_of_collections_attributes instead.')
-
-            collection_ids = [] if collection_ids.empty?
-            other_collections = collections_without_edit_access(env)
-
-            collections = ::Collection.find(collection_ids)
-            raise "Tried to assign collections with ids: #{collection_ids}, but none were found" unless
-              collections
-
-            env.curation_concern.member_of_collections = collections
-            env.curation_concern.member_of_collections.concat(other_collections)
-          end
-
-          true
-        end
-
-        ##
-        # @deprecated supports old :member_of_collection_ids arguments
-        def collections_without_edit_access(env)
-          env.curation_concern.member_of_collections.select { |coll| env.current_ability.cannot?(:edit, coll) }
-        end
-
-        # Adds the item to the ordered members so that it displays in the items
-        # along side the FileSets on the show page
-        def add(env, id)
-          collection = Collection.find(id)
-          collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
-
-          return unless env.current_ability.can?(:deposit, collection)
-          env.curation_concern.member_of_collections << collection
-        end
-
-        # Remove the object from the members set and the ordered members list
-        def remove(curation_concern, id)
-          collection = Collection.find(id)
-          curation_concern.member_of_collections.delete(collection)
-        end
-
-        # Extact a singleton collection id from the collection attributes and save it in env.  Later in the actor stack,
-        # in apply_permission_template_actor.rb, `env.attributes[:collection_id]` will be used to apply the
-        # permissions of the collection to the created work.  With one and only one collection, the work is seen as
-        # being created directly in that collection.  The permissions will not be applied to the work if the collection
-        # type is configured not to allow that or if the work is being created in more than one collection.
-        #
-        # @param env [Hyrax::Actors::Enviornment]
-        #
-        # Given an array of collection_attributes when it is size:
-        # * 0 do not set `env.attributes[:collection_id]`
-        # * 1 set `env.attributes[:collection_id]` to the one and only one collection
-        # * 2+ do not set `env.attributes[:collection_id]`
-        #
-        # NOTE: Only called from create.  All collections are being added as parents of a work.  None are being removed.
-        def extract_collection_id(env)
-          attributes_collection =
-            env.attributes.fetch(:member_of_collections_attributes) { nil }
-
-          if attributes_collection
-            # Determine if the work is being created in one and only one collection.
-            return unless attributes_collection && attributes_collection.size == 1
-
-            # Extract the collection id from attributes_collection,
-            collection_id = attributes_collection.first.second['id']
+      ##
+      # Attaches any unattached members.  Deletes those that are marked _delete
+      #
+      # @param env [Hyrax::Actors::Enviornment]
+      # @return [Boolean]
+      #
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def assign_nested_attributes_for_collection(env)
+        attributes_collection = env.attributes.delete(:member_of_collections_attributes)
+        return true unless attributes_collection
+
+        return false unless
+          valid_membership?(env, collection_ids: attributes_collection.map { |_, attributes| attributes['id'] })
+
+        attributes_collection = attributes_collection.sort_by { |i, _| i.to_i }.map { |_, attributes| attributes }
+        # checking for existing works to avoid rewriting/loading works that are already attached
+        existing_collections = env.curation_concern.member_of_collection_ids
+        boolean_type_caster = ActiveModel::Type::Boolean.new
+        attributes_collection.each do |attributes|
+          next if attributes['id'].blank?
+          if boolean_type_caster.cast(attributes['_destroy'])
+            # Likely someone in the UI sought to add the collection, then
+            # changed their mind and checked the "delete" checkbox and posted
+            # their update.
+            next unless existing_collections.include?(attributes['id'])
+            remove(env.curation_concern, attributes['id'])
           else
-            collection_ids = env.attributes.fetch(:member_of_collection_ids) { [] }
-            return unless collection_ids.size == 1
-            collection_id = collection_ids.first
+            # Let's not try to add an item already
+            next if existing_collections.include?(attributes['id'])
+            add(env, attributes['id'])
           end
+        end
+        true
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      # Adds the item to the ordered members so that it displays in the items
+      # along side the FileSets on the show page
+      def add(env, id)
+        collection = ::Collection.find(id)
+        collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
+
+        return unless env.current_ability.can?(:deposit, collection)
+        env.curation_concern.member_of_collections << collection
+      end
 
-          # Do not apply permissions to work if collection type is configured not to
-          collection = ::Collection.find(collection_id)
-          return unless collection.share_applies_to_new_works?
+      # Remove the object from the members set and the ordered members list
+      def remove(curation_concern, id)
+        collection = ::Collection.find(id)
+        curation_concern.member_of_collections.delete(collection)
+      end
 
-          # Save the collection id in env for use in apply_permission_template_actor
-          env.attributes[:collection_id] = collection_id
-        end
+      # Extact a singleton collection id from the collection attributes and save it in env.  Later in the actor stack,
+      # in apply_permission_template_actor.rb, `env.attributes[:collection_id]` will be used to apply the
+      # permissions of the collection to the created work.  With one and only one collection, the work is seen as
+      # being created directly in that collection.  The permissions will not be applied to the work if the collection
+      # type is configured not to allow that or if the work is being created in more than one collection.
+      #
+      # @param env [Hyrax::Actors::Enviornment]
+      #
+      # Given an array of collection_attributes when it is size:
+      # * 0 do not set `env.attributes[:collection_id]`
+      # * 1 set `env.attributes[:collection_id]` to the one and only one collection
+      # * 2+ do not set `env.attributes[:collection_id]`
+      #
+      # NOTE: Only called from create.  All collections are being added as parents of a work.  None are being removed.
+      def extract_collection_id(env)
+        attributes_collection =
+          env.attributes.fetch(:member_of_collections_attributes) { nil }
+
+        # Determine if the work is being created in one and only one collection.
+        return unless attributes_collection && attributes_collection.size == 1
+
+        # Extract the collection id from attributes_collection,
+        collection_id = attributes_collection.first.second['id']
+
+        # Do not apply permissions to work if collection type is configured not to
+        collection = ::Collection.find(collection_id)
+        return unless collection.share_applies_to_new_works?
+
+        # Save the collection id in env for use in apply_permission_template_actor
+        env.attributes[:collection_id] = collection_id
+      end
 
-        def valid_membership?(env, collection_ids:)
-          multiple_memberships = Hyrax::MultipleMembershipChecker.new(item: env.curation_concern).check(collection_ids: collection_ids)
-          if multiple_memberships
-            env.curation_concern.errors.add(:collections, multiple_memberships)
-            return false
-          end
-          true
+      def valid_membership?(env, collection_ids:)
+        multiple_memberships = Hyrax::MultipleMembershipChecker.new(item: env.curation_concern).check(collection_ids: collection_ids)
+        if multiple_memberships
+          env.curation_concern.errors.add(:collections, multiple_memberships)
+          return false
         end
+        true
+      end
     end
   end
 end

data/app/actors/hyrax/actors/create_with_files_actor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Actors
     # Creates a work and attaches files to the work
@@ -6,48 +7,58 @@ module Hyrax
       # @return [Boolean] true if create was successful
       def create(env)
         uploaded_file_ids = filter_file_ids(env.attributes.delete(:uploaded_files))
-        files = uploaded_files(uploaded_file_ids)
-        validate_files(files, env) && next_actor.create(env) && attach_files(files, env)
+        files             = uploaded_files(uploaded_file_ids)
+        # get a current copy of attributes, to protect against future mutations
+        attributes        = env.attributes.clone
+
+        validate_files(files, env) &&
+          next_actor.create(env) &&
+          attach_files(files, env.curation_concern, attributes)
       end
 
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if update was successful
       def update(env)
         uploaded_file_ids = filter_file_ids(env.attributes.delete(:uploaded_files))
-        files = uploaded_files(uploaded_file_ids)
-        validate_files(files, env) && next_actor.update(env) && attach_files(files, env)
+        files             = uploaded_files(uploaded_file_ids)
+        # get a current copy of attributes, to protect against future mutations
+        attributes        = env.attributes.clone
+
+        validate_files(files, env) &&
+          next_actor.update(env) &&
+          attach_files(files, env.curation_concern, attributes)
       end
 
       private
 
-        def filter_file_ids(input)
-          Array.wrap(input).select(&:present?)
-        end
+      def filter_file_ids(input)
+        Array.wrap(input).select(&:present?)
+      end
 
-        # ensure that the files we are given are owned by the depositor of the work
-        def validate_files(files, env)
-          expected_user_id = env.user.id
-          files.each do |file|
-            if file.user_id != expected_user_id
-              Rails.logger.error "User #{env.user.user_key} attempted to ingest uploaded_file #{file.id}, but it belongs to a different user"
-              return false
-            end
+      # ensure that the files we are given are owned by the depositor of the work
+      def validate_files(files, env)
+        expected_user_id = env.user.id
+        files.each do |file|
+          if file.user_id != expected_user_id
+            Rails.logger.error "User #{env.user.user_key} attempted to ingest uploaded_file #{file.id}, but it belongs to a different user"
+            return false
           end
-          true
         end
+        true
+      end
 
-        # @return [TrueClass]
-        def attach_files(files, env)
-          return true if files.blank?
-          AttachFilesToWorkJob.perform_later(env.curation_concern, files, env.attributes.to_h.symbolize_keys)
-          true
-        end
+      # @return [TrueClass]
+      def attach_files(files, curation_concern, attributes)
+        return true if files.blank?
+        AttachFilesToWorkJob.perform_later(curation_concern, files, attributes.to_h.symbolize_keys)
+        true
+      end
 
-        # Fetch uploaded_files from the database
-        def uploaded_files(uploaded_file_ids)
-          return [] if uploaded_file_ids.empty?
-          UploadedFile.find(uploaded_file_ids)
-        end
+      # Fetch uploaded_files from the database
+      def uploaded_files(uploaded_file_ids)
+        return [] if uploaded_file_ids.empty?
+        UploadedFile.find(uploaded_file_ids)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Actors
     # When adding member FileSets to a Work, Hyrax saves
@@ -35,9 +36,9 @@ module Hyrax
     # Creates a work and attaches files to the work
     class CreateWithFilesOrderedMembersActor < CreateWithFilesActor
       # @return [TrueClass]
-      def attach_files(files, env)
+      def attach_files(files, curation_concern, attributes)
         return true if files.blank?
-        AttachFilesToWorkWithOrderedMembersJob.perform_later(env.curation_concern, files, env.attributes.to_h.symbolize_keys)
+        AttachFilesToWorkWithOrderedMembersJob.perform_later(curation_concern, files, attributes.to_h.symbolize_keys)
         true
       end
     end

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

@@ -1,3 +1,4 @@
+# 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
@@ -25,65 +26,65 @@ module Hyrax
 
       private
 
-        def whitelisted_ingest_dirs
-          Hyrax.config.whitelisted_ingest_dirs
-        end
+      def registered_ingest_dirs
+        Hyrax.config.registered_ingest_dirs
+      end
 
-        # @param uri [URI] the uri fo the resource to import
-        def validate_remote_url(uri)
-          if uri.scheme == 'file'
-            path = File.absolute_path(CGI.unescape(uri.path))
-            whitelisted_ingest_dirs.any? do |dir|
-              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.
-            true
+      # @param uri [URI] the uri fo the resource to import
+      def validate_remote_url(uri)
+        if uri.scheme == 'file'
+          path = File.absolute_path(CGI.unescape(uri.path))
+          registered_ingest_dirs.any? do |dir|
+            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.
+          true
         end
+      end
 
-        # @param [HashWithIndifferentAccess] remote_files
-        # @return [TrueClass]
-        def attach_files(env, remote_files)
-          return true unless remote_files
-          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)
+      # @param [HashWithIndifferentAccess] remote_files
+      # @return [TrueClass]
+      def attach_files(env, remote_files)
+        return true unless remote_files
+        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
-          true
+          auth_header = file_info.fetch(:auth_header, {})
+          create_file_from_url(env, uri, file_info[:file_name], auth_header)
         end
+        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 = {})
-          import_url = URI.decode_www_form_component(uri.to_s)
-          ::FileSet.new(import_url: import_url, label: file_name) do |fs|
-            actor = Hyrax::Actors::FileSetActor.new(fs, env.user)
-            actor.create_metadata(visibility: env.curation_concern.visibility)
-            actor.attach_to_work(env.curation_concern)
-            fs.save!
-            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
+      # 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 = {})
+        import_url = URI.decode_www_form_component(uri.to_s)
+        ::FileSet.new(import_url: import_url, label: file_name) do |fs|
+          actor = Hyrax::Actors::FileSetActor.new(fs, env.user)
+          actor.create_metadata(visibility: env.curation_concern.visibility)
+          actor.attach_to_work(env.curation_concern)
+          fs.save!
+          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
 
-        def operation_for(user:)
-          Hyrax::Operation.create!(user: user,
-                                   operation_type: "Attach Remote File")
-        end
+      def operation_for(user:)
+        Hyrax::Operation.create!(user: user,
+                                 operation_type: "Attach Remote File")
+      end
     end
   end
 end