hyrax 4.0.0 → 5.0.0.rc2

data/lib/hyrax/transactions/container.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'dry/container'
+
 module Hyrax
   module Transactions
     ##
@@ -23,7 +25,9 @@ module Hyrax
       require 'hyrax/transactions/collection_create'
       require 'hyrax/transactions/collection_destroy'
       require 'hyrax/transactions/collection_update'
+      require 'hyrax/transactions/file_metadata_destroy'
       require 'hyrax/transactions/file_set_destroy'
+      require 'hyrax/transactions/file_set_update'
       require 'hyrax/transactions/work_create'
       require 'hyrax/transactions/work_destroy'
       require 'hyrax/transactions/work_update'
@@ -31,13 +35,18 @@ module Hyrax
       require 'hyrax/transactions/steps/add_to_collections'
       require 'hyrax/transactions/steps/add_to_parent'
       require 'hyrax/transactions/steps/apply_collection_type_permissions'
+      require 'hyrax/transactions/steps/apply_permission_template'
       require 'hyrax/transactions/steps/change_depositor'
       require 'hyrax/transactions/steps/check_for_empty_admin_set'
       require 'hyrax/transactions/steps/delete_access_control'
+      require 'hyrax/transactions/steps/delete_all_file_metadata'
+      require 'hyrax/transactions/steps/delete_all_file_sets'
       require 'hyrax/transactions/steps/delete_resource'
       require 'hyrax/transactions/steps/ensure_admin_set'
+      require 'hyrax/transactions/steps/file_metadata_delete'
       require 'hyrax/transactions/steps/set_collection_type_gid'
       require 'hyrax/transactions/steps/remove_file_set_from_work'
+      require 'hyrax/transactions/steps/remove_from_membership'
       require 'hyrax/transactions/steps/save'
       require 'hyrax/transactions/steps/save_access_control'
       require 'hyrax/transactions/steps/save_collection_banner'
@@ -111,6 +120,10 @@ module Hyrax
           CollectionUpdate.new
         end
 
+        ops.register 'update_file_set' do
+          FileSetUpdate.new
+        end
+
         ops.register 'update_work' do
           WorkUpdate.new
         end
@@ -120,11 +133,25 @@ module Hyrax
         end
       end
 
+      namespace "file_metadata" do |ops| # Hyrax::FileMetadata
+        ops.register 'destroy' do
+          FileMetadataDestroy.new
+        end
+
+        ops.register 'delete' do
+          Steps::FileMetadataDelete.new
+        end
+      end
+
       namespace 'file_set' do |ops| # Hyrax::FileSet resource
         ops.register 'delete' do
           Steps::DeleteResource.new
         end
 
+        ops.register 'delete_all_file_metadata' do
+          Steps::DeleteAllFileMetadata.new
+        end
+
         ops.register 'destroy' do
           FileSetDestroy.new
         end
@@ -132,6 +159,14 @@ module Hyrax
         ops.register 'remove_from_work' do
           Steps::RemoveFileSetFromWork.new
         end
+
+        ops.register 'delete_acl' do
+          Steps::DeleteAccessControl.new
+        end
+
+        ops.register 'save_acl' do
+          Steps::SaveAccessControl.new
+        end
       end
 
       namespace 'admin_set_resource' do |ops| # Hyrax::AdministrativeSet resource
@@ -181,6 +216,10 @@ module Hyrax
           Steps::DeleteAccessControl.new
         end
 
+        ops.register 'remove_from_membership' do
+          Steps::RemoveFromMembership.new
+        end
+
         ops.register 'save_acl' do
           Steps::SaveAccessControl.new
         end
@@ -203,6 +242,10 @@ module Hyrax
           Steps::AddToParent.new
         end
 
+        ops.register 'apply_permission_template' do
+          Steps::ApplyPermissionTemplate.new
+        end
+
         ops.register 'change_depositor' do
           Steps::ChangeDepositor.new
         end
@@ -211,6 +254,10 @@ module Hyrax
           Steps::DeleteResource.new
         end
 
+        ops.register 'delete_all_file_sets' do
+          Steps::DeleteAllFileSets.new
+        end
+
         ops.register 'destroy' do
           WorkDestroy.new
         end

data/lib/hyrax/transactions/file_metadata_destroy.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # destroys a FileSet resource.
+    #
+    # @since 3.1.0
+    class FileMetadataDestroy < Transaction
+      DEFAULT_STEPS = ['file_metadata.delete'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/file_set_destroy.rb

@@ -8,7 +8,9 @@ module Hyrax
     #
     # @since 3.1.0
     class FileSetDestroy < Transaction
-      DEFAULT_STEPS = ['file_set.remove_from_work',
+      DEFAULT_STEPS = ['file_set.delete_all_file_metadata',
+                       'file_set.remove_from_work',
+                       'file_set.delete_acl',
                        'file_set.delete'].freeze
 
       ##

data/lib/hyrax/transactions/file_set_update.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Updates a {Hyrax::FileSet} from a ChangeSet
+    #
+    # @since 3.4.0
+    class FileSetUpdate < Transaction
+      DEFAULT_STEPS = ['change_set.apply',
+                       'file_set.save_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/add_file_sets.rb

@@ -25,6 +25,12 @@ module Hyrax
         # @return [Dry::Monads::Result]
         def call(obj, uploaded_files: [], file_set_params: [])
           if @handler.new(work: obj).add(files: uploaded_files, file_set_params: file_set_params).attach
+            file_sets = obj.member_ids.map do |member|
+              Hyrax.query_service.find_by(id: member) if Hyrax.query_service.find_by(id: member).is_a? Hyrax::FileSet
+            end
+
+            Hyrax::LeaseManager.create_or_update_lease_on_members(file_sets, obj) if obj.lease
+            Hyrax::EmbargoManager.create_or_update_embargo_on_members(file_sets, obj) if obj.embargo
             Success(obj)
           else
             Failure[:failed_to_attach_file_sets, uploaded_files]

data/lib/hyrax/transactions/steps/add_to_parent.rb

@@ -20,7 +20,7 @@ module Hyrax
           return Success(obj) if parent_id.blank?
 
           parent = Hyrax.query_service.find_by(id: parent_id)
-          parent.member_ids << obj.id
+          parent.member_ids += [obj.id]
           Hyrax.persister.save(resource: parent)
 
           user ||= ::User.find_by_user_key(obj.depositor)

data/lib/hyrax/transactions/steps/apply_permission_template.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transcation` step that applies a permission template
+      # to a saved object.
+      #
+      # @note by design, this step should succeed even if for some reason a
+      #   permission template could not be applied. it's better to complete the
+      #   rest of the creation process with missing ACL grants than to crash and
+      #   miss other crucial steps.
+      #
+      # @since 4.1.0
+      class ApplyPermissionTemplate
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Hyrax::Work] object
+        #
+        # @return [Dry::Monads::Result]
+        def call(object)
+          template = Hyrax::PermissionTemplate.find_by(source_id: object&.admin_set_id)
+
+          if template.blank?
+            Hyrax.logger.info("At create time, #{object} doesn't have a " \
+                              "PermissionTemplate, which it should have via " \
+                              "AdministrativeSet #{object&.admin_set_id}). " \
+                              "Continuing to create this object anyway.")
+
+            return Success(object)
+          end
+
+          Hyrax::PermissionTemplateApplicator.apply(template).to(model: object) &&
+            Success(object)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/delete_all_file_metadata.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Deletes a resource from the persister, returning a `Dry::Monads::Result`
+      # (`Success`|`Failure`).
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class DeleteAllFileMetadata
+        include Dry::Monads[:result]
+
+        ##
+        # @params [#save] persister
+        def initialize(property: :file_ids, query_service: Hyrax.query_service, persister: Hyrax.persister, publisher: Hyrax.publisher)
+          @property = property
+          @persister = persister
+          @query_service = query_service
+          @publisher = publisher
+        end
+
+        ##
+        # @param [Valkyrie::Resource] resource
+        # @param [::User] the user resposible for the delete action
+        #
+        # @return [Dry::Monads::Result]
+        def call(resource)
+          return Failure(:resource_not_persisted) unless resource.persisted?
+
+          resource[@property].each do |file_id|
+            return Failure[:failed_to_delete_file_metadata, file_id] unless
+              Hyrax::Transactions::Container['file_metadata.destroy']
+              .call(@query_service.custom_queries.find_file_metadata_by(id: file_id))
+              .success?
+          rescue ::Ldp::Gone
+            nil
+          end
+
+          Success(resource)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/delete_all_file_sets.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Deletes a resource's member FileSets from the persister, returning a `Dry::Monads::Result`
+      # (`Success`|`Failure`).
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class DeleteAllFileSets
+        include Dry::Monads[:result]
+
+        ##
+        # @params [#save] persister
+        def initialize(query_service: Hyrax.query_service, persister: Hyrax.persister, publisher: Hyrax.publisher)
+          @persister = persister
+          @query_service = query_service
+          @publisher = publisher
+        end
+
+        ##
+        # @param [Valkyrie::Resource] resource
+        # @param [::User] the user resposible for the delete action
+        #
+        # @return [Dry::Monads::Result]
+        def call(resource, user: nil)
+          return Failure(:resource_not_persisted) unless resource.persisted?
+
+          @query_service.custom_queries.find_child_file_sets(resource: resource).each do |file_set|
+            return Failure[:failed_to_delete_file_set, file_set] unless
+              Hyrax::Transactions::Container['file_set.destroy']
+              .with_step_args('file_set.remove_from_work' => { user: user },
+                              'file_set.delete' => { user: user })
+              .call(file_set).success?
+          rescue ::Ldp::Gone
+            nil
+          end
+
+          Success(resource)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/file_metadata_delete.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Deletes a resource from the persister, returning a `Dry::Monads::Result`
+      # (`Success`|`Failure`).
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class FileMetadataDelete
+        include Dry::Monads[:result]
+
+        ##
+        # @params [#save] persister
+        def initialize(persister: Hyrax.persister, storage_adapter: Hyrax.storage_adapter, publisher: Hyrax.publisher)
+          @persister = persister
+          @publisher = publisher
+          @storage_adapter = storage_adapter
+        end
+
+        ##
+        # @param [Hyrax::FileMetadata] FileMetadata resource
+        # @param [::User] the user resposible for the delete action
+        #
+        # @return [Dry::Monads::Result]
+        def call(resource)
+          return Failure(:resource_not_persisted) unless resource.persisted?
+
+          @persister.delete(resource: resource)
+          @publisher.publish('file.metadata.deleted', metadata: resource)
+          Valkyrie::StorageAdapter.delete(id: resource.file_identifier) if resource.file_identifier.present?
+
+          Success(resource)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/remove_from_membership.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Removes a collection from its members, returning a `Dry::Monads::Result`
+      # (`Success`|`Failure`).
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class RemoveFromMembership
+        include Dry::Monads[:result]
+
+        ##
+        # @params [#save] persister
+        def initialize(query_service: Hyrax.custom_queries, persister: Hyrax.persister, publisher: Hyrax.publisher)
+          @persister = persister
+          @query_service = query_service
+          @publisher = publisher
+        end
+
+        ##
+        # @param [Valkyrie::Resource] resource
+        # @param [::User] the user resposible for the delete action
+        #
+        # @return [Dry::Monads::Result]
+        def call(collection, user: nil)
+          return Failure(:resource_not_persisted) unless collection.persisted?
+          return Failure(:user_not_present) if user.blank?
+
+          @query_service.find_members_of(collection: collection).each do |member|
+            member.member_of_collection_ids -= [collection.id]
+            @persister.save(resource: member)
+            @publisher.publish('collection.membership.updated', collection: collection, user: user)
+          rescue StandardError
+            nil
+          end
+
+          Success(collection)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/save.rb

@@ -29,10 +29,15 @@ module Hyrax
         # @return [Dry::Monads::Result] `Success(work)` if the change_set is
         #   applied and the resource is saved;
         #   `Failure([#to_s, change_set.resource])`, otherwise.
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def call(change_set, user: nil)
           begin
+            valid_future_date?(change_set.lease, 'lease_expiration_date') if change_set.respond_to?(:lease) && change_set.lease
+            valid_future_date?(change_set.embargo, 'embargo_release_date') if change_set.respond_to?(:embargo) && change_set.embargo
             new_collections = changed_collection_membership(change_set)
+
             unsaved = change_set.sync
+            save_lease_or_embargo(unsaved)
             saved = @persister.save(resource: unsaved)
           rescue StandardError => err
             return Failure(["Failed save on #{change_set}\n\t#{err.message}", change_set.resource])
@@ -48,9 +53,25 @@ module Hyrax
           publish_changes(resource: saved, user: user, new: unsaved.new_record, new_collections: new_collections)
           Success(saved)
         end
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
         private
 
+        def valid_future_date?(item, attribute)
+          raise StandardError, "#{item.model} must use a future date" if item.fields[attribute] < Time.zone.now
+        end
+
+        def save_lease_or_embargo(unsaved)
+          if unsaved.embargo.present?
+            unsaved.embargo.embargo_release_date = unsaved.embargo.embargo_release_date&.to_datetime
+            unsaved.embargo = @persister.save(resource: unsaved.embargo)
+          end
+          return if unsaved.lease.blank?
+
+          unsaved.lease.lease_expiration_date = unsaved.lease.lease_expiration_date&.to_datetime
+          unsaved.lease = @persister.save(resource: unsaved.lease)
+        end
+
         ##
         # @param [Hyrax::ChangeSet] change_set
         #

data/lib/hyrax/transactions/work_create.rb

@@ -12,6 +12,7 @@ module Hyrax
                        'change_set.ensure_admin_set',
                        'change_set.set_user_as_depositor',
                        'change_set.apply',
+                       'work_resource.apply_permission_template',
                        'work_resource.save_acl',
                        'work_resource.add_file_sets',
                        'work_resource.change_depositor',

data/lib/hyrax/transactions/work_destroy.rb

@@ -8,8 +8,9 @@ module Hyrax
     #
     # @since 3.0.0
     class WorkDestroy < Transaction
-      DEFAULT_STEPS = ['work_resource.delete',
-                       'work_resource.delete_acl'].freeze
+      DEFAULT_STEPS = ['work_resource.delete_all_file_sets',
+                       'work_resource.delete_acl',
+                       'work_resource.delete'].freeze
 
       ##
       # @see Hyrax::Transactions::Transaction

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '4.0.0'
+  VERSION = '5.0.0.rc2'
 end

data/lib/hyrax.rb

@@ -20,6 +20,7 @@ require 'hyrax/version'
 require 'hyrax/inflections'
 require 'hyrax/name'
 require 'hyrax/valkyrie_can_can_adapter'
+require 'retriable'
 require 'valkyrie/indexing_adapter'
 require 'valkyrie/indexing/solr/indexing_adapter'
 require 'valkyrie/indexing/null_indexing_adapter'

data/lib/tasks/collection_type_global_id.rake

@@ -7,13 +7,18 @@ namespace :hyrax do
 
       count = 0
 
-      Collection.all.each do |collection|
-        next if collection.collection_type_gid == collection.collection_type.to_global_id.to_s
+      Hyrax.query_service.find_all_of_model(model: Hyrax::PcdmCollection).each do |collection|
+        type = Hyrax::CollectionType.find_by_gid(collection.collection_type_gid)
+        next if collection.collection_type_gid == type.to_global_id.to_s
 
-        collection.public_send(:collection_type_gid=, collection.collection_type.to_global_id, force: true)
+        # Awful hack to allow converted AF collections to force update collection_type_gid
+        Thread.current[:force_collection_type_gid] = true
+        collection.collection_type_gid = type.to_global_id
 
-        collection.save &&
+        Hyrax.persister.save(resource: collection) &&
           count += 1
+      ensure
+        Thread.current[:force_collection_type_gid] = false
       end
 
       puts "Updated #{count} collections."

data/lib/tasks/embargo_lease.rake

@@ -8,6 +8,7 @@ namespace :hyrax do
 
       Hyrax.query_service.find_many_by_ids(ids: ids).each do |resource|
         Hyrax::EmbargoManager.release_embargo_for(resource: resource) &&
+          Hyrax.persister.save(resource: resource.embargo) &&
           Hyrax::AccessControlList(resource).save
       end
     end

data/lib/valkyrie/indexing/solr/indexing_adapter.rb

@@ -81,6 +81,8 @@ module Valkyrie
           # if any configuration is missing, derive it from Blacklight
           config = blacklight_based_config.with_indifferent_access.merge(config)
 
+          return config['url'] if config['url'].present?
+
           "http://#{config['host']}:#{config['port']}/solr/#{config['core']}"
         end
 

data/lib/wings/active_fedora_converter/default_work.rb

@@ -27,7 +27,7 @@ module Wings
       #
       # @return [void] apply the property
       def apply(klass)
-        return if klass.properties.keys.include?(name) ||
+        return if klass.properties.keys.include?(name.to_s) ||
                   klass.protected_property_name?(name)
         klass.send(definition_method, name, options)
       end
@@ -98,6 +98,7 @@ module Wings
       include Hyrax::Noid
       include Hyrax::Permissions
       include Hydra::AccessControls::Embargoable
+      include Hyrax::CoreMetadata
       property :nested_resource, predicate: ::RDF::URI("http://example.com/nested_resource"), class_name: "Wings::ActiveFedoraConverter::NestedResource"
 
       validates :lease_expiration_date, 'hydra/future_date': true, on: :create
@@ -118,7 +119,7 @@ module Wings
         end
 
         def to_rdf_representation
-          "Wings(#{valkyrie_class})"
+          "Wings(#{valkyrie_class})" unless valkyrie_class&.to_s&.include?('Wings(')
         end
         alias inspect to_rdf_representation
         alias to_s inspect
@@ -136,6 +137,10 @@ module Wings
         false
       end
 
+      def file_sets
+        members.select(&:file_set?)
+      end
+
       def indexing_service
         Hyrax::ValkyrieIndexer.for(resource: valkyrie_resource)
       end

data/lib/wings/active_fedora_converter/file_metadata_node.rb

@@ -29,7 +29,7 @@ module Wings
       end
 
       def to_rdf_representation
-        "Wings(#{valkyrie_class})"
+        "Wings(#{valkyrie_class})" unless valkyrie_class&.to_s&.include?('Wings(')
       end
       alias inspect to_rdf_representation
       alias to_s inspect