hyrax 3.3.0 → 3.4.2

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_collection_banner.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Adds banner info via `ChangeSet`.
+      #
+      # During the update collection process this step is called to update the file
+      # to be used as a the banner for the collection.
+      #
+      class SaveCollectionBanner
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::ChangeSet] change_set
+        # @param [Array<Integer>] update_banner_file_ids
+        # @param [Boolean] banner_unchanged_indicator
+        #
+        # @return [Dry::Monads::Result] `Failure` if the banner info fails to save;
+        #   `Success(input)`, otherwise.
+        def call(collection_resource, update_banner_file_ids: nil, banner_unchanged_indicator: true)
+          return Success(collection_resource) if ActiveModel::Type::Boolean.new.cast(banner_unchanged_indicator)
+          collection_id = collection_resource.id.to_s
+          process_banner_input(collection_id: collection_id, update_banner_file_ids: update_banner_file_ids)
+          Success(collection_resource)
+        end
+
+        private
+
+        def process_banner_input(collection_id:, update_banner_file_ids:)
+          remove_banner(collection_id: collection_id)
+          add_new_banner(collection_id: collection_id, uploaded_file_ids: update_banner_file_ids) if update_banner_file_ids
+        end
+
+        def remove_banner(collection_id:)
+          banner_info = CollectionBrandingInfo.where(collection_id: collection_id).where(role: "banner")
+          banner_info&.delete_all
+        end
+
+        def add_new_banner(collection_id:, uploaded_file_ids:)
+          f = uploaded_files(uploaded_file_ids).first
+          banner_info = CollectionBrandingInfo.new(
+            collection_id: collection_id,
+            filename: File.split(f.file_url).last,
+            role: "banner",
+            alt_txt: "",
+            target_url: ""
+          )
+          banner_info.save f.file_url
+        end
+
+        def uploaded_files(uploaded_file_ids)
+          return [] if uploaded_file_ids.empty?
+          UploadedFile.find(uploaded_file_ids)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Adds logo info via `ChangeSet`.
+      #
+      # During the update collection process this step is called to update the file(s)
+      # to be used as logo(s) for the collection.
+      #
+      class SaveCollectionLogo
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::ChangeSet] change_set
+        # @param [Array<#Integer>] update_logo_file_ids
+        # @param [Array<String>] alttext_values
+        # @param [Array<String>] linkurl_values
+        #
+        # @return [Dry::Monads::Result] `Failure` if the work fails to save;
+        #   `Success(input)`, otherwise.
+        def call(collection_resource, update_logo_file_ids: nil, alttext_values: nil, linkurl_values: nil)
+          collection_id = collection_resource.id.to_s
+          process_logo_input(collection_id: collection_id, update_logo_file_ids: update_logo_file_ids, alttext_values: alttext_values, linkurl_values: linkurl_values)
+          Success(collection_resource)
+        end
+
+        private
+
+        def process_logo_input(collection_id:, update_logo_file_ids:, alttext_values:, linkurl_values:)
+          uploaded_file_ids = update_logo_file_ids
+          public_files = []
+
+          if uploaded_file_ids.nil?
+            # all logo files were removed, so delete all files previously uploaded
+            remove_redundant_files(collection_id: collection_id, public_files: public_files)
+            return
+          end
+
+          public_files = process_logo_records(collection_id: collection_id, uploaded_file_ids: uploaded_file_ids, alttext_values: alttext_values, linkurl_values: linkurl_values)
+          remove_redundant_files(collection_id: collection_id, public_files: public_files)
+        end
+
+        def process_logo_records(collection_id:, uploaded_file_ids:, alttext_values:, linkurl_values:)
+          public_files = []
+          uploaded_file_ids.each_with_index do |ufi, i|
+            # If the user has chosen a new logo, the ufi will be an integer
+            # If the logo was previously chosen, the ufi will be a path
+            # If it is a path, update the rec, else create a new rec
+            if !ufi.match(/\D/).nil?
+              update_logo_info(collection_id: collection_id, uploaded_file_id: ufi, alttext: alttext_values[i], linkurl: verify_linkurl(linkurl_values[i]))
+              public_files << ufi
+            else # brand new one, insert in the database
+              logo_info = create_logo_info(collection_id: collection_id, uploaded_file_id: ufi, alttext: alttext_values[i], linkurl: verify_linkurl(linkurl_values[i]))
+              public_files << logo_info.local_path
+            end
+          end
+          public_files
+        end
+
+        def update_logo_info(collection_id:, uploaded_file_id:, alttext:, linkurl:)
+          logo_info = CollectionBrandingInfo.where(collection_id: collection_id).where(role: "logo").where(local_path: uploaded_file_id.to_s).first
+          logo_info.alt_text = alttext
+          logo_info.target_url = linkurl
+          logo_info.local_path = uploaded_file_id
+          logo_info.save(uploaded_file_id, false)
+        end
+
+        def create_logo_info(collection_id:, uploaded_file_id:, alttext:, linkurl:)
+          file = uploaded_files(uploaded_file_id)
+          logo_info = CollectionBrandingInfo.new(
+            collection_id: collection_id,
+            filename: File.split(file.file_url).last,
+            role: "logo",
+            alt_txt: alttext,
+            target_url: linkurl
+          )
+          logo_info.save file.file_url
+          logo_info
+        end
+
+        def uploaded_files(uploaded_file_ids)
+          return [] if uploaded_file_ids.empty?
+          UploadedFile.find(uploaded_file_ids)
+        end
+
+        def remove_redundant_files(collection_id:, public_files:)
+          # remove any public ones that were not included in the selection.
+          logos_info = CollectionBrandingInfo.where(collection_id: collection_id).where(role: "logo")
+          logos_info.each do |logo_info|
+            logo_info.delete(logo_info.local_path) unless public_files.include? logo_info.local_path
+            logo_info.destroy unless public_files.include? logo_info.local_path
+          end
+        end
+
+        # Only accept HTTP|HTTPS urls;
+        # @return <String> the url
+        def verify_linkurl(linkurl)
+          url = Loofah.scrub_fragment(linkurl, :prune).to_s
+          url if valid_url?(url)
+        end
+
+        def valid_url?(url)
+          (url =~ URI.regexp(['http', 'https']))
+        end
+      end
+    end
+  end
+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.2'
 end

data/lib/wings/active_fedora_converter/file_metadata_node.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Wings
+  class ActiveFedoraConverter
+    def self.FileMetadataNode(resource_class) # rubocop:disable Naming/MethodName
+      class_cache[resource_class] ||= Class.new(FileMetadataNode) do
+        self.valkyrie_class = resource_class
+
+        # skip reserved attributes, we assume we don't need to translate valkyrie internals
+        schema = resource_class.schema.reject do |key|
+          resource_class.reserved_attributes.include?(key.name) ||
+            key.name == :size
+        end
+
+        Wings::ActiveFedoraConverter.apply_properties(self, schema)
+      end
+    end
+  end
+
+  class FileMetadataNode < ActiveFedora::Base
+    property :file_set_id, predicate: ::RDF::URI.intern("http://hyrax.samvera.org/ns/wings#file_set_id")
+    property :file_identifier, predicate: ::RDF::URI.intern("http://hyrax.samvera.org/ns/wings#file_identifier")
+
+    class_attribute :valkyrie_class
+
+    class << self
+      def model_name(*)
+        Hyrax::Name.new(valkyrie_class)
+      end
+
+      def to_rdf_representation
+        "Wings(#{valkyrie_class})"
+      end
+      alias inspect to_rdf_representation
+      alias to_s inspect
+    end
+
+    def indexing_service
+      Hyrax::ValkyrieIndexer.for(resource: valkyrie_resource)
+    end
+
+    def to_solr
+      super.tap do |doc|
+        doc[:file_identifier_ssim] = file_identifier
+      end
+    end
+  end
+end

data/lib/wings/active_fedora_converter/instance_builder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Wings
+  class ActiveFedoraConverter
+    ##
+    # Constructs an instance for the given converter. +converter+ must provide
+    # an +id+, +resource+, and +active_fedora_class+.
+    #
+    # This interface allows handling for special cases based on the target
+    # class, instance data for +resource+, or the id format. This originated as
+    # an extraction of some such special handling from the converter code.
+    class InstanceBuilder
+      ##
+      # @!attribute [r] converter
+      #   @return [#active_fedora_class, #id, #resource]
+      # @!attribute [r] resource
+      #   @return [Valkyrie::Resource]
+      attr_reader :converter, :resource
+
+      ##
+      # @param [#active_fedora_class, #id, #resource]
+      def initialize(converter)
+        @converter = converter
+        @resource = converter.resource
+      end
+
+      ##
+      # @return [ActiveFedora::Common]
+      def build
+        if builds_file_metadata? && !builds_metadata_for_active_fedora_file?
+          # convert to a generic/generated FileMetadataNode class with
+          # properties matching the source class
+          Wings::ActiveFedoraConverter::FileMetadataNode(resource.class)
+                                      .new(file_identifier: Array(resource.file_identifier)
+            .map(&:to_s))
+        elsif converter.id.present?
+          converter.active_fedora_class.find(converter.id)
+        else
+          converter.active_fedora_class.new
+        end
+      rescue ActiveFedora::ObjectNotFoundError
+        converter.active_fedora_class.new
+      end
+
+      ##
+      # @return [Boolean]
+      def builds_file_metadata?
+        resource.try(:file_identifier).present?
+      end
+
+      ##
+      # @return [Boolean]
+      def builds_metadata_for_active_fedora_file?
+        return false unless builds_file_metadata?
+
+        adapter_for_file = begin
+                             ::Valkyrie::StorageAdapter.adapter_for(id: resource.file_identifier)
+                           rescue ::Valkyrie::StorageAdapter::AdapterNotFoundError => err
+                             Hyrax.logger.warn "Processing a FileMetadata (id: #{converter.id}) referencing " \
+                                               "a file #{resource.file_identifier}; could not find a " \
+                                               "storage adapter to handle that file.\n\t#{err.message}"
+                           end
+
+        adapter_for_file.is_a?(::Valkyrie::Storage::Fedora)
+      end
+    end
+  end
+end

data/lib/wings/active_fedora_converter.rb

@@ -2,6 +2,8 @@
 
 require 'wings/converter_value_mapper'
 require 'wings/active_fedora_converter/default_work'
+require 'wings/active_fedora_converter/file_metadata_node'
+require 'wings/active_fedora_converter/instance_builder'
 require 'wings/active_fedora_converter/nested_resource'
 
 module Wings
@@ -100,9 +102,7 @@ module Wings
     private
 
     def instance
-      id.present? ? active_fedora_class.find(id) : active_fedora_class.new
-    rescue ActiveFedora::ObjectNotFoundError
-      active_fedora_class.new
+      InstanceBuilder.new(self).build
     end
 
     def attributes_class

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/services/custom_queries/find_file_metadata.rb

@@ -33,7 +33,20 @@ module Wings
       #
       # @raise [Hyrax::ObjectNotFoundError]
       def find_file_metadata_by(id:, use_valkyrie: true)
-        find_file_metadata_by_alternate_identifier(alternate_identifier: id, use_valkyrie: use_valkyrie)
+        fcrepo_flag =
+          begin
+            ::Valkyrie::StorageAdapter.adapter_for(id: id).is_a?(::Valkyrie::Storage::Fedora)
+          rescue ::Valkyrie::StorageAdapter::AdapterNotFoundError
+            true # assume fcrepo if we can't find an adapter
+          end
+
+        if fcrepo_flag
+          find_file_metadata_by_alternate_identifier(alternate_identifier: id, use_valkyrie: use_valkyrie)
+        else
+          result = ActiveFedora::Base.where(file_identifier_ssim: id.to_s).first ||
+                   raise(Hyrax::ObjectNotFoundError)
+          result.valkyrie_resource
+        end
       end
 
       # Find a Hyrax::FileMetadata using an alternate ID, and map it to a
@@ -48,8 +61,8 @@ module Wings
       #
       # @raise [Hyrax::ObjectNotFoundError]
       def find_file_metadata_by_alternate_identifier(alternate_identifier:, use_valkyrie: true)
-        alternate_identifier = ::Valkyrie::ID.new(alternate_identifier)
-        object = Hydra::PCDM::File.find(alternate_identifier.to_s)
+        alternate_identifier = ::Valkyrie::ID.new(alternate_identifier).to_s
+        object = Hydra::PCDM::File.find(alternate_identifier)
         raise Hyrax::ObjectNotFoundError if object.new_record?
 
         if use_valkyrie == false
@@ -73,11 +86,9 @@ module Wings
       #   if there are no ids or none of the ids map to Hyrax::FileMetadata
       def find_many_file_metadata_by_ids(ids:, use_valkyrie: true)
         ids.each_with_object([]) do |alt_id, results|
-          begin
-            results << find_file_metadata_by_alternate_identifier(alternate_identifier: alt_id, use_valkyrie: use_valkyrie)
-          rescue Hyrax::ObjectNotFoundError
-            next
-          end
+          results << find_file_metadata_by_alternate_identifier(alternate_identifier: alt_id, use_valkyrie: use_valkyrie)
+        rescue Hyrax::ObjectNotFoundError
+          next
         end
       end