hyrax 3.3.0 → 3.4.0

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

@@ -7,6 +7,8 @@ module Hyrax
       # collections on a given work.
       #
       # @since 3.0.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class ApplyCollectionPermissionTemplate
         include Dry::Transaction::Operation
 

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

@@ -7,6 +7,8 @@ module Hyrax
       # work's AdminSet.
       #
       # @since 2.4.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class ApplyPermissionTemplate
         include Dry::Transaction::Operation
 

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

@@ -7,6 +7,8 @@ module Hyrax
       # passed arguments.
       #
       # @since 3.0.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class ApplyVisibility
         include Dry::Transaction::Operation
 

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Add a given `::User` as the `#depositor`
+      # Move the previous value of that property to `#proxy_depositor`
+      #
+      #
+      # If no user is given, simply passes as a `Success`.
+      #
+      # @since 3.4.0
+      class ChangeDepositor
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Hyrax::Work] obj
+        # @param user [User] the user that will "become" the depositor of
+        #             the given work
+        #
+        # @return [Dry::Monads::Result]
+        def call(obj, user: NullUser.new, reset: false)
+          return Success(obj) unless user&.user_key
+
+          obj = Hyrax::ChangeDepositorService.call(obj, user, reset)
+
+          Success(obj)
+        rescue StandardError => err
+          Failure([err.message, obj])
+        end
+
+        ##
+        # @api private
+        class NullUser
+          ##
+          # @return [nil]
+          def user_key
+            nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Validates emptiness of the {Hyrax::AdministrativeSet}; gives `Success`
+      # when empty and `Failure` otherwise.
+      #
+      # Use this step to guard against destroying AdminSets with member objects.
+      class CheckForEmptyAdminSet
+        include Dry::Monads[:result]
+
+        ##
+        # @param [#find_inverse_references_by] query_service
+        def initialize(query_service: Hyrax.query_service)
+          @query_service = query_service
+        end
+
+        ##
+        # @param [Hyrax::AdministrativeSet] admin_set
+        #
+        # @return [Dry::Monads::Result]
+        def call(admin_set)
+          members = @query_service
+                    .find_inverse_references_by(property: :admin_set_id,
+                                                resource: admin_set)
+          return Failure[:admin_set_has_members, members] if members.any?
+
+          Success(admin_set)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Deletes the Hyrax::AccessControlList for any resource with a `#permission_manager`.
+      # If `#permission_manager` is undefined, succeeds.
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class DeleteAccessControl
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Valkyrie::Resource] obj
+        #
+        # @return [Dry::Monads::Result]
+        def call(obj)
+          return Success(obj) unless obj.respond_to?(:permission_manager)
+
+          acl = obj.permission_manager&.acl
+          return Success(obj) if acl.nil?
+
+          acl.destroy || (return Failure[:failed_to_delete_acl, acl])
+
+          Success(obj)
+        end
+      end
+    end
+  end
+end

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

@@ -14,8 +14,9 @@ module Hyrax
 
         ##
         # @params [#save] persister
-        def initialize(persister: Hyrax.persister)
+        def initialize(persister: Hyrax.persister, publisher: Hyrax.publisher)
           @persister = persister
+          @publisher = publisher
         end
 
         ##
@@ -27,11 +28,26 @@ module Hyrax
           return Failure(:resource_not_persisted) unless resource.persisted?
 
           @persister.delete(resource: resource)
-          Hyrax.publisher
-               .publish('object.deleted', object: resource, id: resource.id.id, user: user)
+          publish_changes(resource: resource, user: user)
 
           Success(resource)
         end
+
+        private
+
+        def publish_changes(resource:, user:)
+          if resource.collection?
+            @publisher.publish('collection.deleted',
+                               collection: resource,
+                               id: resource.id.id,
+                               user: user)
+          else
+            @publisher.publish('object.deleted',
+                               object: resource,
+                               id: resource.id.id,
+                               user: user)
+          end
+        end
       end
     end
   end

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

@@ -6,7 +6,9 @@ module Hyrax
       # A `dry-transcation` step that destroys a Work.
       #
       # @since 3.0.0
-      # @deprecated
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
+      # @see Hyrax::Transactions::Steps::DeleteResource
       class DestroyWork
         include Dry::Transaction::Operation
 

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

@@ -7,6 +7,8 @@ module Hyrax
       # template.
       #
       # @since 2.4.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
       class EnsurePermissionTemplate
         include Dry::Transaction::Operation
 

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

@@ -17,8 +17,9 @@ module Hyrax
 
         ##
         # @params [#save] persister
-        def initialize(persister: Hyrax.persister)
+        def initialize(persister: Hyrax.persister, publisher: Hyrax.publisher)
           @persister = persister
+          @publisher = publisher
         end
 
         ##
@@ -30,6 +31,7 @@ module Hyrax
         #   `Failure([#to_s, change_set.resource])`, otherwise.
         def call(change_set, user: nil)
           begin
+            new_collections = changed_collection_membership(change_set)
             unsaved = change_set.sync
             saved = @persister.save(resource: unsaved)
           rescue StandardError => err
@@ -43,18 +45,34 @@ module Hyrax
 
           user ||= ::User.find_by_user_key(saved.depositor)
 
-          publish_changes(resource: saved, user: user, new: unsaved.new_record)
+          publish_changes(resource: saved, user: user, new: unsaved.new_record, new_collections: new_collections)
           Success(saved)
         end
 
         private
 
-        def publish_changes(resource:, user:, new: false)
+        ##
+        # @param [Hyrax::ChangeSet] change_set
+        #
+        # @return [Array<Valkyrie::ID>]
+        def changed_collection_membership(change_set)
+          return [] unless change_set.changed?(:member_of_collection_ids)
+
+          change_set.member_of_collection_ids - change_set.model.member_of_collection_ids
+        end
+
+        def publish_changes(resource:, user:, new: false, new_collections: [])
           if resource.collection?
-            Hyrax.publisher.publish('collection.metadata.updated', collection: resource, user: user)
+            @publisher.publish('collection.metadata.updated', collection: resource, user: user)
           else
-            Hyrax.publisher.publish('object.deposited', object: resource, user: user) if new
-            Hyrax.publisher.publish('object.metadata.updated', object: resource, user: user)
+            @publisher.publish('object.deposited', object: resource, user: user) if new
+            @publisher.publish('object.metadata.updated', object: resource, user: user)
+          end
+
+          new_collections.each do |collection_id|
+            @publisher.publish('collection.membership.updated',
+                               collection_id: collection_id,
+                               user: user)
           end
         end
       end

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

@@ -18,8 +18,8 @@ module Hyrax
         # @return [Dry::Monads::Result]
         def call(obj)
           return Success(obj) unless obj.respond_to?(:permission_manager)
-          obj.permission_manager&.acl&.save ||
-            (return Failure[:failed_to_save_acl, acl])
+          acl = obj.permission_manager&.acl
+          acl&.save || (return Failure[:failed_to_save_acl, acl])
 
           Success(obj)
         end

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

@@ -18,6 +18,9 @@ module Hyrax
       #   step.call(work).or { |err| puts err.messages }
       #
       # @since 2.4.0
+      # @deprecated This is part of the legacy AF set of transaction steps for works.
+      #   Transactions are not being used with AF works.  This will be removed in 4.0.
+      # @see Hyrax::Transactions::Steps::Save
       class SaveWork
         include Dry::Transaction::Operation
 

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Add a given `::User` as the `#creator` via a ChangeSet.
+      #
+      # If no user is given, simply passes as a `Success`.
+      #
+      # @since 3.0.0
+      class SetUserAsCreator
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Hyrax::ChangeSet] change_set
+        # @param [#user_key] user
+        #
+        # @return [Dry::Monads::Result]
+        def call(change_set, user: NullUser.new)
+          change_set.creator = [user.user_key] if user.user_key
+
+          Success(change_set)
+        rescue NoMethodError => err
+          Failure([err.message, change_set])
+        end
+
+        ##
+        # @api private
+        class NullUser
+          ##
+          # @return [nil]
+          def user_key
+            nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Adds and removes work members
+      class UpdateWorkMembers
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Hyrax::Work] obj
+        # @param [Hash] work_members_attributes
+        #
+        # @return [Dry::Monads::Result]
+        def call(obj, work_members_attributes: nil, user: nil)
+          return Success(obj) if work_members_attributes.blank?
+
+          attributes = extract_attributes(work_members_attributes)
+          current_member_ids = obj.member_ids.map(&:id)
+          destroys = attributes.select do |v|
+            ActiveModel::Type::Boolean.new.cast(v['_destroy'])
+          end
+
+          inserts  = (attributes - destroys).map { |h| h['id'] }.compact - current_member_ids
+          destroys = destroys.map { |h| h['id'] }.compact & current_member_ids
+          obj.member_ids += inserts.map  { |id| Valkyrie::ID.new(id) }
+          obj.member_ids -= destroys.map { |id| Valkyrie::ID.new(id) }
+
+          save_resource(obj, user)
+          Success(obj)
+        end
+
+        private
+
+        def extract_attributes(attribute_hash)
+          attribute_hash
+            .sort_by { |i, _| i.to_i }
+            .map { |_, attributes| attributes }
+        end
+
+        def save_resource(obj, user)
+          saved = Hyrax.persister.save(resource: obj)
+          user ||= ::User.find_by_user_key(obj.depositor)
+          Hyrax.publisher.publish('object.metadata.updated', object: saved, user: user)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/update_work.rb

@@ -3,10 +3,11 @@ module Hyrax
   module Transactions
     ##
     # @since 3.0.0
+    # @deprecated Use Hyrax::Transactions::WorkUpdate instead.
     class UpdateWork < Transaction
-      DEFAULT_STEPS = ['change_set.apply',
-                       'work_resource.save_acl',
-                       'work_resource.add_file_sets'].freeze
+      DEFAULT_STEPS = Hyrax::Transactions::WorkUpdate::DEFAULT_STEPS
+
+      # DO NOT USE - This class is deprecated.  Use Hyrax::Transactions::WorkUpdate instead.
 
       ##
       # @see Hyrax::Transactions::Transaction

data/lib/hyrax/transactions/work_create.rb

@@ -11,10 +11,10 @@ module Hyrax
       DEFAULT_STEPS = ['change_set.set_default_admin_set',
                        'change_set.ensure_admin_set',
                        'change_set.set_user_as_depositor',
-                       'change_set.add_to_collections',
                        'change_set.apply',
                        'work_resource.save_acl',
                        'work_resource.add_file_sets',
+                       'work_resource.change_depositor',
                        'work_resource.add_to_parent'].freeze
 
       ##

data/lib/hyrax/transactions/work_destroy.rb

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

data/lib/hyrax/transactions/work_update.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    ##
+    # @since 3.4.0
+    class WorkUpdate < Transaction
+      DEFAULT_STEPS = ['change_set.apply',
+                       'work_resource.save_acl',
+                       'work_resource.add_file_sets',
+                       'work_resource.update_work_members'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/lib/wings/attribute_transformer.rb

@@ -58,7 +58,11 @@ module Wings
       end
 
       attributes[:original_filename] = obj.original_name
-      attributes[:file_identifier] = obj.id if obj.id.present?
+
+      if obj.id.present?
+        uri = Hyrax.config.translate_id_to_uri.call(obj.id)
+        attributes[:file_identifier] = Wings::Valkyrie::Storage.cast_to_valkyrie_id(uri)
+      end
       attributes[:type] = obj.metadata_node.type.to_a
       attributes[:size] = obj.size
       attributes

data/lib/wings/setup.rb

@@ -93,8 +93,10 @@ Valkyrie.config.storage_adapter = :active_fedora
 custom_queries = [Hyrax::CustomQueries::Navigators::CollectionMembers,
                   Hyrax::CustomQueries::Navigators::ChildCollectionsNavigator,
                   Hyrax::CustomQueries::Navigators::ParentCollectionsNavigator,
-                  Hyrax::CustomQueries::Navigators::ChildFilesetsNavigator,
+                  Hyrax::CustomQueries::Navigators::ChildFileSetsNavigator,
+                  Hyrax::CustomQueries::Navigators::ChildFilesetsNavigator, # deprecated; use ChildFileSetsNavigator
                   Hyrax::CustomQueries::Navigators::ChildWorksNavigator,
+                  Hyrax::CustomQueries::Navigators::ParentWorkNavigator,
                   Hyrax::CustomQueries::Navigators::FindFiles,
                   Wings::CustomQueries::FindAccessControl, # override Hyrax::CustomQueries::FindAccessControl
                   Wings::CustomQueries::FindCollectionsByType,

data/lib/wings/valkyrie/query_service.rb

@@ -168,9 +168,10 @@ module Wings
         id ||= resource.id
         raise ArgumentError, "Resource has no id; is it persisted?" unless id
 
+        property = Hyrax.config.admin_set_predicate.qname.last if property.to_sym == :admin_set_id
         active_fedora_model = model ? model_class_for(model) : ActiveFedora::Base
-
         uri = active_fedora_model.id_to_uri(id.to_s)
+
         active_fedora_model.where("+(#{property}_ssim: \"#{uri}\" OR #{property}_ssim: \"#{id}\")").map do |obj|
           resource_factory.to_resource(object: obj)
         end

data/lib/wings/valkyrie/storage.rb

@@ -28,6 +28,12 @@ module Wings
         super
       end
 
+      ##
+      # @api private
+      def self.cast_to_valkyrie_id(id)
+        ::Valkyrie::ID.new(id.to_s.sub(/^.+\/\//, PROTOCOL))
+      end
+
       ##
       # @param key [Symbol] the key for plugin behavior to check support for
       #
@@ -140,7 +146,7 @@ module Wings
       end
 
       def cast_to_valkyrie_id(id)
-        ::Valkyrie::ID.new(id.to_s.sub(/^.+\/\//, PROTOCOL))
+        self.class.cast_to_valkyrie_id(id)
       end
     end
   end

data/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Hack for https://github.com/rails/rails/issues/35153
 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '3.3.0'
+gem 'hyrax', '3.4.0'
 run 'bundle install'
 generate 'hyrax:install', '-f'