hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/inputs/multi_value_select_input.rb

@@ -1,45 +1,46 @@
+# frozen_string_literal: true
 class MultiValueSelectInput < MultiValueInput
   # Overriding so that the class is correct and the javascript for will work on this.
   # See https://github.com/samvera/hydra-editor/blob/4da9c0ea542f7fde512a306ec3cc90380691138b/app/assets/javascripts/hydra-editor/field_manager.es6#L61
   def input_type
-    'multi_value'.freeze
+    'multi_value'
   end
 
   private
 
-    def select_options
-      @select_options ||= begin
-        collection = options.delete(:collection) || self.class.boolean_collection
-        collection.respond_to?(:call) ? collection.call : collection.to_a
-      end
+  def select_options
+    @select_options ||= begin
+      collection = options.delete(:collection) || self.class.boolean_collection
+      collection.respond_to?(:call) ? collection.call : collection.to_a
     end
+  end
 
-    def build_field_options(value)
-      field_options = input_html_options.dup
+  def build_field_options(value) # rubocop:disable Metrics/MethodLength (builder method)
+    field_options = input_html_options.dup
 
-      field_options[:value] = value
-      if @rendered_first_element
-        field_options[:id] = nil
-        field_options[:required] = nil
-      else
-        field_options[:id] ||= input_dom_id
-      end
-      field_options[:class] ||= []
-      field_options[:class] += ["#{input_dom_id} form-control multi-text-field"]
-      field_options[:'aria-labelledby'] = label_id
-      field_options.delete(:multiple)
-      field_options.delete(:item_helper)
-      field_options.merge!(options.slice(:include_blank))
+    field_options[:value] = value
+    if @rendered_first_element
+      field_options[:id] = nil
+      field_options[:required] = nil
+    else
+      field_options[:id] ||= input_dom_id
+    end
+    field_options[:class] ||= []
+    field_options[:class] += ["#{input_dom_id} form-control multi-text-field"]
+    field_options[:'aria-labelledby'] = label_id
+    field_options.delete(:multiple)
+    field_options.delete(:item_helper)
+    field_options.merge!(options.slice(:include_blank))
 
-      @rendered_first_element = true
+    @rendered_first_element = true
 
-      field_options
-    end
+    field_options
+  end
 
-    def build_field(value, index)
-      render_options = select_options
-      html_options = build_field_options(value)
-      (render_options, html_options) = options[:item_helper].call(value, index, render_options, html_options) if options[:item_helper]
-      template.select_tag(attribute_name, template.options_for_select(render_options, value), html_options)
-    end
+  def build_field(value, index)
+    render_options = select_options
+    html_options = build_field_options(value)
+    (render_options, html_options) = options[:item_helper].call(value, index, render_options, html_options) if options[:item_helper]
+    template.select_tag(attribute_name, template.options_for_select(render_options, value), html_options)
+  end
 end

data/app/inputs/multifile_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class MultifileInput < SimpleForm::Inputs::CollectionInput
   def input(wrapper_options = nil)
     merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)

data/app/jobs/attach_files_to_work_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Converts UploadedFiles into FileSets and attaches them to works.
 class AttachFilesToWorkJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
@@ -5,16 +6,28 @@ class AttachFilesToWorkJob < Hyrax::ApplicationJob
   # @param [ActiveFedora::Base] work - the work object
   # @param [Array<Hyrax::UploadedFile>] uploaded_files - an array of files to attach
   def perform(work, uploaded_files, **work_attributes)
+    case work
+    when ActiveFedora::Base
+      perform_af(work, uploaded_files, work_attributes)
+    when Valkyrie::Resource
+      perform_valkyrie(work, uploaded_files, work_attributes)
+    end
+  end
+
+  private
+
+  def perform_af(work, uploaded_files, work_attributes)
     validate_files!(uploaded_files)
     depositor = proxy_or_depositor(work)
     user = User.find_by_user_key(depositor)
-    work_permissions = work.permissions.map(&:to_hash)
+
+    work, work_permissions = create_permissions work, depositor
     metadata = visibility_attributes(work_attributes)
     uploaded_files.each do |uploaded_file|
       next if uploaded_file.file_set_uri.present?
 
       actor = Hyrax::Actors::FileSetActor.new(FileSet.create, user)
-      uploaded_file.update(file_set_uri: actor.file_set.uri)
+      uploaded_file.add_file_set!(actor.file_set)
       actor.file_set.permissions_attributes = work_permissions
       actor.create_metadata(metadata)
       actor.create_content(uploaded_file)
@@ -22,27 +35,71 @@ class AttachFilesToWorkJob < Hyrax::ApplicationJob
     end
   end
 
-  private
-
-    # The attributes used for visibility - sent as initial params to created FileSets.
-    def visibility_attributes(attributes)
-      attributes.slice(:visibility, :visibility_during_lease,
-                       :visibility_after_lease, :lease_expiration_date,
-                       :embargo_release_date, :visibility_during_embargo,
-                       :visibility_after_embargo)
+  def perform_valkyrie(work, uploaded_files, work_attributes)
+    validate_files!(uploaded_files)
+    depositor = proxy_or_depositor(work)
+    user = User.find_by_user_key(depositor)
+    work_permissions = permissions_map(work.permission_manager.acl.permissions)
+    uploaded_files.each do |uploaded_file|
+      next if uploaded_file.file_set_uri.present?
+      attach_uploaded_file!(uploaded_file, user, work, work_permissions, work_attributes)
     end
+  end
 
-    def validate_files!(uploaded_files)
-      uploaded_files.each do |uploaded_file|
-        next if uploaded_file.is_a? Hyrax::UploadedFile
-        raise ArgumentError, "Hyrax::UploadedFile required, but #{uploaded_file.class} received: #{uploaded_file.inspect}"
-      end
-    end
+  def attach_uploaded_file!(uploaded_file, user, work, work_permissions, work_attributes)
+    file_set = Hyrax.persister.save(resource: Hyrax::FileSet.new(user: user))
+    actor = Hyrax::Actors::FileSetActor.new(file_set, user)
+    uploaded_file.add_file_set!(actor.file_set)
+    file_acl = Hyrax::AccessControlList.new(resource: actor.file_set)
+    work_permissions.each { |perm| file_acl.grant(perm[:mode]).to(perm[:agent]).save }
+    file_acl.save
+    metadata = visibility_attributes(work_attributes)
+    actor.create_metadata(metadata)
+    actor.create_content(uploaded_file)
+    actor.attach_to_work(work)
+  end
+
+  # Return array of hashes representing permissions without their :access_to objects
+  # @param permissions [Permission]
+  # @return [Array<Hash>]
+  def permissions_map(permissions)
+    permissions.collect { |p| { agent: agent_object(p.agent), mode: p.mode } }
+  end
 
-    ##
-    # A work with files attached by a proxy user will set the depositor as the intended user
-    # that the proxy was depositing on behalf of. See tickets #2764, #2902.
-    def proxy_or_depositor(work)
-      work.on_behalf_of.blank? ? work.depositor : work.on_behalf_of
+  # Converts string representation of Permission.agent to either User or Hyrax::Group
+  # @param agent [String]
+  # @return [User] or [Hyrax::Group]
+  def agent_object(agent)
+    return Hyrax::Group.new(agent.sub(Hyrax::Group.name_prefix, '')) if agent.starts_with?(Hyrax::Group.name_prefix)
+    User.find_by_user_key(agent)
+  end
+
+  def create_permissions(work, depositor)
+    work.edit_users += [depositor]
+    work.edit_users = work.edit_users.dup
+    work_permissions = work.permissions.map(&:to_hash)
+    [work, work_permissions]
+  end
+
+  # The attributes used for visibility - sent as initial params to created FileSets.
+  def visibility_attributes(attributes)
+    attributes.slice(:visibility, :visibility_during_lease,
+                     :visibility_after_lease, :lease_expiration_date,
+                     :embargo_release_date, :visibility_during_embargo,
+                     :visibility_after_embargo)
+  end
+
+  def validate_files!(uploaded_files)
+    uploaded_files.each do |uploaded_file|
+      next if uploaded_file.is_a? Hyrax::UploadedFile
+      raise ArgumentError, "Hyrax::UploadedFile required, but #{uploaded_file.class} received: #{uploaded_file.inspect}"
     end
+  end
+
+  ##
+  # A work with files attached by a proxy user will set the depositor as the intended user
+  # that the proxy was depositing on behalf of. See tickets #2764, #2902.
+  def proxy_or_depositor(work)
+    work.on_behalf_of.presence || work.depositor
+  end
 end

data/app/jobs/attach_files_to_work_with_ordered_members_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Converts UploadedFiles into FileSets and attaches them to works.
 class AttachFilesToWorkWithOrderedMembersJob < AttachFilesToWorkJob
   attr_reader :ordered_members, :uploaded_files
@@ -17,25 +18,25 @@ class AttachFilesToWorkWithOrderedMembersJob < AttachFilesToWorkJob
 
   private
 
-    def add_uploaded_files(user, metadata, work)
-      work_permissions = work.permissions.map(&:to_hash)
-      uploaded_files.each do |uploaded_file|
-        actor = file_set_actor_class.new(FileSet.create, user)
-        actor.create_metadata(metadata)
-        actor.create_content(uploaded_file)
-        actor.attach_to_work(work)
-        actor.file_set.permissions_attributes = work_permissions
-        ordered_members << actor.file_set
-        uploaded_file.update(file_set_uri: actor.file_set.uri)
-      end
+  def add_uploaded_files(user, metadata, work)
+    work_permissions = work.permissions.map(&:to_hash)
+    uploaded_files.each do |uploaded_file|
+      actor = file_set_actor_class.new(FileSet.create, user)
+      actor.create_metadata(metadata)
+      actor.create_content(uploaded_file)
+      actor.attach_to_work(work)
+      actor.file_set.permissions_attributes = work_permissions
+      ordered_members << actor.file_set
+      uploaded_file.update(file_set_uri: actor.file_set.uri)
     end
+  end
 
-    # Add all file_sets as ordered_members in a single action
-    def add_ordered_members(user, work)
-      actor = Hyrax::Actors::OrderedMembersActor.new(ordered_members, user)
-      actor.attach_ordered_members_to_work(work)
-    end
+  # Add all file_sets as ordered_members in a single action
+  def add_ordered_members(user, work)
+    actor = Hyrax::Actors::OrderedMembersActor.new(ordered_members, user)
+    actor.attach_ordered_members_to_work(work)
+  end
 
-    class_attribute :file_set_actor_class
-    self.file_set_actor_class = Hyrax::Actors::FileSetOrderedMembersActor
+  class_attribute :file_set_actor_class
+  self.file_set_actor_class = Hyrax::Actors::FileSetOrderedMembersActor
 end

data/app/jobs/batch_create_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class BatchCreateJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
@@ -23,19 +24,19 @@ class BatchCreateJob < Hyrax::ApplicationJob
 
   private
 
-    def create(user, titles, resource_types, uploaded_files, attributes, operation)
-      model = attributes.delete(:model) || attributes.delete('model')
-      raise ArgumentError, 'attributes must include "model" => ClassName.to_s' unless model
-      uploaded_files.each do |upload_id|
-        title = [titles[upload_id]] if titles[upload_id]
-        resource_type = Array.wrap(resource_types[upload_id]) if resource_types[upload_id]
-        attributes = attributes.merge(uploaded_files: [upload_id],
-                                      title: title,
-                                      resource_type: resource_type)
-        child_operation = Hyrax::Operation.create!(user: user,
-                                                   operation_type: "Create Work",
-                                                   parent: operation)
-        CreateWorkJob.perform_later(user, model, attributes, child_operation)
-      end
+  def create(user, titles, resource_types, uploaded_files, attributes, operation)
+    model = attributes.delete(:model) || attributes.delete('model')
+    raise ArgumentError, 'attributes must include "model" => ClassName.to_s' unless model
+    uploaded_files.each do |upload_id|
+      title = [titles[upload_id]] if titles[upload_id]
+      resource_type = Array.wrap(resource_types[upload_id]) if resource_types[upload_id]
+      attributes = attributes.merge(uploaded_files: [upload_id],
+                                    title: title,
+                                    resource_type: resource_type)
+      child_operation = Hyrax::Operation.create!(user: user,
+                                                 operation_type: "Create Work",
+                                                 parent: operation)
+      CreateWorkJob.perform_later(user, model, attributes, child_operation)
     end
+  end
 end

data/app/jobs/characterize_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CharacterizeJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
@@ -9,11 +10,25 @@ class CharacterizeJob < Hyrax::ApplicationJob
   def perform(file_set, file_id, filepath = nil)
     raise "#{file_set.class.characterization_proxy} was not found for FileSet #{file_set.id}" unless file_set.characterization_proxy?
     filepath = Hyrax::WorkingDirectory.find_or_retrieve(file_id, file_set.id) unless filepath && File.exist?(filepath)
+    characterize(file_set, file_id, filepath)
+    CreateDerivativesJob.perform_later(file_set, file_id, filepath)
+  end
+
+  private
+
+  def characterize(file_set, _file_id, filepath)
     Hydra::Works::CharacterizationService.run(file_set.characterization_proxy, filepath)
     Rails.logger.debug "Ran characterization on #{file_set.characterization_proxy.id} (#{file_set.characterization_proxy.mime_type})"
+    file_set.characterization_proxy.alpha_channels = channels(filepath) if file_set.image? && Hyrax.config.iiif_image_server?
     file_set.characterization_proxy.save!
     file_set.update_index
-    file_set.parent&.in_collections&.each(&:update_index)
-    CreateDerivativesJob.perform_later(file_set, file_id, filepath)
+  end
+
+  def channels(filepath)
+    ch = MiniMagick::Tool::Identify.new do |cmd|
+      cmd.format '%[channels]'
+      cmd << filepath
+    end
+    [ch]
   end
 end

data/app/jobs/concerns/hyrax/members_permission_job_behavior.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Hyrax
+  # Grants read access for the supplied user for the members attached to a work
+  module MembersPermissionJobBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      queue_as Hyrax.config.ingest_queue_name
+    end
+
+    private
+
+    # Filter the member ids and return only the FileSet ids (filter out child works)
+    # @return [Array<String>] the file set ids
+    def file_set_ids(work)
+      case work
+      when ActiveFedora::Base
+        ::FileSet.search_with_conditions(id: work.member_ids).map(&:id)
+      when Valkyrie::Resource
+        Hyrax.custom_queries.find_child_fileset_ids(resource: work)
+      end
+    end
+
+    def use_valkyrie?(work)
+      work.is_a? Valkyrie::Resource
+    end
+  end
+end

data/app/jobs/concerns/hyrax/permission_job_behavior.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Hyrax
+  # Grants the user's edit access on the provided FileSet
+  module PermissionJobBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      queue_as Hyrax.config.ingest_queue_name
+    end
+
+    private
+
+    def acl(id)
+      valk_id = Valkyrie::ID.new(id)
+      file_set = Hyrax.query_service.find_by(id: valk_id)
+      AccessControlList.new(resource: file_set)
+    end
+
+    def user(user_key)
+      ::User.find_by_user_key(user_key)
+    end
+  end
+end

data/app/jobs/content_delete_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Log object deletion to activity streams
 #
 # @attr_reader deleted_work_id The id of the work that has been deleted by the user

data/app/jobs/content_deposit_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Log a concern deposit to activity streams
 class ContentDepositEventJob < ContentEventJob
   def action

data/app/jobs/content_depositor_change_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Log work depositor change to activity streams
 #
 # @attr [Boolean] reset (false) should the access controls be reset. This means revoking edit access from the depositor

data/app/jobs/content_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A generic job for sending events about repository objects to a user and their followers.
 #
 # @attr [String] repo_object the object event is specified for

data/app/jobs/content_new_version_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Log new version of a file to activity streams
 class ContentNewVersionEventJob < ContentEventJob
   def action

data/app/jobs/content_restored_version_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Log file restored version to activity streams
 class ContentRestoredVersionEventJob < ContentEventJob
   attr_accessor :revision_id

data/app/jobs/content_update_event_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Log content update to activity streams
 class ContentUpdateEventJob < ContentEventJob
   def action

data/app/jobs/create_derivatives_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateDerivativesJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 

data/app/jobs/create_work_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This is a job spawned by the BatchCreateJob
 class CreateWorkJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
@@ -25,7 +26,7 @@ class CreateWorkJob < Hyrax::ApplicationJob
 
   private
 
-    def work_actor
-      Hyrax::CurationConcern.actor
-    end
+  def work_actor
+    Hyrax::CurationConcern.actor
+  end
 end