hyrax 3.0.0.pre.rc4 → 3.1.0

data/app/jobs/embargo_expiry_job.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 class EmbargoExpiryJob < Hyrax::ApplicationJob
   def perform
-    records_with_expired_embargos.each do |id|
-      work = ActiveFedora::Base.find(id)
-      Hyrax::Actors::EmbargoActor.new(work).destroy
+    records_with_expired_embargos.each do |resource|
+      Hyrax::EmbargoManager.release_embargo_for(resource: resource) &&
+        Hyrax::AccessControlList(resource).save
     end
   end
 
   ##
-  # @return [Enumerator<String>] ids for all the objects that have expired active embargoes
+  # @return [Enumerator<Valkyrie::Resource>] ids for all the objects that have expired active embargoes
   def records_with_expired_embargos
-    Hyrax::EmbargoService.assets_with_expired_embargoes.map(&:id)
+    ids = Hyrax::EmbargoService.assets_with_expired_embargoes.map(&:id)
+
+    Hyrax.query_service.find_many_by_ids(ids: ids)
   end
 end

data/app/jobs/file_set_attached_event_job.rb

@@ -30,6 +30,11 @@ class FileSetAttachedEventJob < ContentEventJob
   end
 
   def curation_concern
-    repo_object.in_works.first
+    case repo_object
+    when ActiveFedora::Base
+      repo_object.in_works.first
+    else
+      Hyrax.query_service.find_parents(resource: repo_object).first
+    end
   end
 end

data/app/jobs/ingest_local_file_job.rb

@@ -2,13 +2,29 @@
 class IngestLocalFileJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
-  # @param [FileSet] file_set
+  # @param [FileSet, Hyrax::FileSet] file_set
   # @param [String] path
   # @param [User] user
   def perform(file_set, path, user)
+    case file_set
+    when ActiveFedora::Base
+      __perform(file_set, path, user, use_valkyrie: false)
+    else
+      __perform(file_set, path, user, use_valkyrie: true)
+    end
+  end
+
+  private
+
+  # @note Based on the present implementation (see SHA a8597884e) of
+  # the Hyrax::Actors::FileSetActor, we wouldn't need to pass the
+  # `use_valkyrie` parameter.  However, I want to include this logic
+  # to demonstrate that "Yes, the IngestLocalFileJob has been tested
+  # for Valkyrie usage"
+  def __perform(file_set, path, user, use_valkyrie:)
     file_set.label ||= File.basename(path)
 
-    actor = Hyrax::Actors::FileSetActor.new(file_set, user)
+    actor = Hyrax::Actors::FileSetActor.new(file_set, user, use_valkyrie: use_valkyrie)
 
     if actor.create_content(File.open(path))
       Hyrax.config.callback.run(:after_import_local_file_success, file_set, user, path, warn: false)

data/app/jobs/inherit_permissions_job.rb

@@ -5,12 +5,16 @@ class InheritPermissionsJob < Hyrax::ApplicationJob
   # Perform the copy from the work to the contained filesets
   #
   # @param work containing access level and filesets
-  # @param use_valkyrie [Boolean] whether to use valkyrie support
-  def perform(work, use_valkyrie: Hyrax.config.use_valkyrie?)
-    if use_valkyrie
-      valkyrie_perform(work)
-    else
+  # @param use_valkyrie [Boolean] whether to use valkyrie support (deprecated)
+  def perform(work, use_valkyrie: :DEFAULT)
+    Deprecation.warn("use_valkyrie argument is deprecated, behavior depends on deserialized resource") unless
+      use_valkyrie == :DEFAULT
+
+    case work
+    when ActiveFedora::Base
       af_perform(work)
+    else
+      valkyrie_perform(work)
     end
   end
 

data/app/jobs/lease_expiry_job.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 class LeaseExpiryJob < Hyrax::ApplicationJob
   def perform
-    records_with_expired_leases.each do |id|
-      work = ActiveFedora::Base.find(id)
-      Hyrax::Actors::LeaseActor.new(work).destroy
+    records_with_expired_leases.each do |resource|
+      Hyrax::LeaseManager.release_lease_for(resource: resource) &&
+        Hyrax::AccessControlList(resource).save
     end
   end
 
   ##
   # @return [Enumerator<String>] ids for all the objects that have expired active leases
   def records_with_expired_leases
-    Hyrax::LeaseService.assets_with_expired_leases.map(&:id)
+    ids = Hyrax::LeaseService.assets_with_expired_leases.map(&:id)
+
+    Hyrax.query_service.find_many_by_ids(ids: ids)
   end
 end

data/app/models/admin_set.rb

@@ -75,37 +75,18 @@ class AdminSet < ActiveFedora::Base
     Sipity::Workflow.find_active_workflow_for(admin_set_id: id)
   end
 
+  ##
+  # @deprecated use PermissionTemplate#reset_access_controls instead
+  #
   # Calculate and update who should have edit access based on who
   # has "manage" access in the PermissionTemplateAccess
   def reset_access_controls!
-    # NOTE: This is different from Collections in that it doesn't update read access based on visibility.
-    #       See also app/models/concerns/hyrax/collection_behavior.rb#reset_access_controls!
-    update!(edit_users: permission_template_edit_users,
-            edit_groups: permission_template_edit_groups,
-            read_users: permission_template_read_users,
-            read_groups: permission_template_read_groups)
-  end
-
-  private
-
-  def permission_template_edit_users
-    permission_template.agent_ids_for(access: 'manage', agent_type: 'user')
-  end
-
-  def permission_template_edit_groups
-    permission_template.agent_ids_for(access: 'manage', agent_type: 'group')
-  end
+    Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
 
-  def permission_template_read_users
-    (permission_template.agent_ids_for(access: 'view', agent_type: 'user') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')).uniq
+    permission_template.reset_access_controls_for(collection: self)
   end
 
-  def permission_template_read_groups
-    (permission_template.agent_ids_for(access: 'view', agent_type: 'group') +
-      permission_template.agent_ids_for(access: 'deposit', agent_type: 'group')).uniq -
-      [::Ability.registered_group_name, ::Ability.public_group_name]
-  end
+  private
 
   def destroy_permission_template
     permission_template.destroy

data/app/models/collection_branding_info.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 class CollectionBrandingInfo < ApplicationRecord
-  # i = ColectionImageInfo.new()
-
   def initialize(collection_id:,
                  filename:,
                  role:,
@@ -13,20 +11,32 @@ class CollectionBrandingInfo < ApplicationRecord
     self.role = role
     self.alt_text = alt_txt
     self.target_url = target_url
-
-    self.local_path = find_local_filename(collection_id, role, filename)
+    self.local_path = File.join(role, filename)
   end
 
   def save(file_location, copy_file = true)
-    local_dir = find_local_dir_name(collection_id, role)
-    FileUtils.mkdir_p local_dir
-    FileUtils.cp file_location, local_path unless file_location == local_path || !copy_file
+    filename = File.split(local_path).last
+    role_and_filename = File.join(role, filename)
+
+    storage.upload(resource: Hyrax::PcdmCollection.new(id: collection_id),
+                   file: File.open(file_location),
+                   original_filename: role_and_filename)
+    self.local_path = find_local_filename(collection_id, role, filename)
+
     FileUtils.remove_file(file_location) if File.exist?(file_location) && copy_file
     super()
   end
 
-  def delete(location_path)
-    FileUtils.remove_file(location_path) if File.exist?(location_path)
+  def delete(location_path = nil)
+    id = if location_path
+           Deprecation.warn('Passing an explict location path is ' \
+                            'deprecated. Call without arguments instead.')
+           location_path
+         else
+           local_path
+         end
+
+    storage.delete(id: id)
   end
 
   def find_local_filename(collection_id, role, filename)
@@ -37,4 +47,10 @@ class CollectionBrandingInfo < ApplicationRecord
   def find_local_dir_name(collection_id, role)
     File.join(Hyrax.config.branding_path, collection_id.to_s, role.to_s)
   end
+
+  private
+
+  def storage
+    Hyrax.config.branding_storage_adapter
+  end
 end

data/app/models/concerns/hyrax/ability.rb

@@ -37,6 +37,7 @@ module Hyrax
       self.registered_group_name = Hyrax.config.registered_user_group_name
       self.public_group_name = Hyrax.config.public_user_group_name
       self.ability_logic += [:admin_permissions,
+                             :edit_resources,
                              :curation_concerns_permissions,
                              :operation_abilities,
                              :add_to_collection,
@@ -108,6 +109,16 @@ module Hyrax
       end
     end
 
+    ##
+    # @api public
+    #
+    # Allows
+    def edit_resources
+      can [:edit, :update, :destroy], Hyrax::Resource do |resource|
+        test_edit(resource.id)
+      end
+    end
+
     ##
     # @api public
     #
@@ -406,8 +417,10 @@ module Hyrax
 
     def extract_subjects(subject)
       case subject
+      when Hyrax::WorkShowPresenter, FileSetPresenter, Hyrax::CollectionPresenter
+        extract_subjects(subject.solr_document)
       when Draper::Decorator
-        super(subject.model)
+        extract_subjects(subject.model)
       else
         super
       end

data/app/models/concerns/hyrax/collection_behavior.rb

@@ -51,27 +51,22 @@ module Hyrax
     end
 
     # Add members using the members association.
-    # TODO: Confirm if this is ever used.  I believe all relationships are done through
-    #       add_member_objects using the member_of_collections relationship.  Deprecate?
     def add_members(new_member_ids)
-      return if new_member_ids.blank?
-      members << Hyrax.custom_queries.find_many_by_alternate_ids(alternate_ids: new_member_ids, use_valkyrie: false)
+      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
+      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
+                                                                     new_member_ids: new_member_ids,
+                                                                     user: nil)
     end
 
     # Add member objects by adding this collection to the objects' member_of_collection association.
     # @param [Enumerable<String>] the ids of the new child collections and works collection ids
     def add_member_objects(new_member_ids)
-      Array(new_member_ids).collect do |member_id|
-        member = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: member_id, use_valkyrie: false)
-        message = Hyrax::MultipleMembershipChecker.new(item: member).check(collection_ids: id, include_current_members: true)
-        if message
-          member.errors.add(:collections, message)
-        else
-          member.member_of_collections << self
-          member.save!
-        end
-        member
-      end
+      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
+      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
+                                                                     new_member_ids: new_member_ids,
+                                                                     user: nil)
     end
 
     # @return [Enumerable<ActiveFedora::Base>] an enumerable over the children of this collection
@@ -125,41 +120,19 @@ module Hyrax
       Hyrax::PermissionTemplate.find_by!(source_id: id)
     end
 
+    ##
+    # @deprecated use PermissionTemplate#reset_access_controls instead
+    #
     # Calculate and update who should have read/edit access to the collections based on who
     # has access in PermissionTemplateAccess
     def reset_access_controls!
-      update!(edit_users: permission_template_edit_users,
-              edit_groups: permission_template_edit_groups,
-              read_users: permission_template_read_users,
-              read_groups: (permission_template_read_groups + visibility_group).uniq)
-    end
-
-    private
-
-    def permission_template_edit_users
-      permission_template.agent_ids_for(access: 'manage', agent_type: 'user')
-    end
+      Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
 
-    def permission_template_edit_groups
-      permission_template.agent_ids_for(access: 'manage', agent_type: 'group')
+      permission_template
+        .reset_access_controls_for(collection: self, interpret_visibility: true)
     end
 
-    def permission_template_read_users
-      (permission_template.agent_ids_for(access: 'view', agent_type: 'user') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')).uniq
-    end
-
-    def permission_template_read_groups
-      (permission_template.agent_ids_for(access: 'view', agent_type: 'group') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'group')).uniq -
-        [::Ability.registered_group_name, ::Ability.public_group_name]
-    end
-
-    def visibility_group
-      return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
-      return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
-      []
-    end
+    private
 
     # Solr field name works use to index member ids
     def member_ids_field

data/app/models/concerns/hyrax/embargoable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Hyrax
+  module Embargoable
+    extend ActiveSupport::Concern
+    include Hydra::AccessControls::Embargoable
+
+    included do
+      validates :lease_expiration_date, 'hydra/future_date': true, on: :create
+      validates :embargo_release_date, 'hydra/future_date': true, on: :create
+    end
+
+    ##
+    # Override aggressive Hydra::AccessControls validation
+    def enforce_future_date_for_embargo?
+      false
+    end
+
+    ##
+    # Override aggressive Hydra::AccessControls validation
+    def enforce_future_date_for_lease?
+      false
+    end
+  end
+end

data/app/models/concerns/hyrax/file_set/characterization.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
-# This module points the FileSet to the location of the technical metadata.
-# By default, the file holding the metadata is :original_file and the terms
-# are listed under ::characterization_terms.
-# Implementations may define their own terms or use a different source file, but
-# any terms must be set on the ::characterization_proxy by the Hydra::Works::CharacterizationService
-#
-# class MyFileSet
-#   include Hyrax::FileSetBehavior
-# end
-#
-# MyFileSet.characterization_proxy = :master_file
-# MyFileSet.characterization_terms = [:term1, :term2, :term3]
+
 module Hyrax
   class FileSet
+    ##
+    # This module points the FileSet to the location of the technical metadata.
+    # By default, the file holding the metadata is +:original_file+ and the terms
+    # are listed under +.characterization_terms+.
+    #
+    # Implementations may define their own terms or use a different source file, but
+    # any terms must be set on the +.characterization_proxy+ by the
+    # +Hydra::Works::CharacterizationService+.
+    #
+    # @example
+    #   class MyFileSet
+    #     include Hyrax::FileSetBehavior
+    #   end
+    #
+    #   MyFileSet.characterization_proxy = :master_file
+    #   MyFileSet.characterization_terms = [:term1, :term2, :term3]
+    #
     module Characterization
       extend ActiveSupport::Concern
 

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -13,6 +13,8 @@ module Hyrax
   #
   # @see https://github.com/projectblacklight/blacklight/wiki/Understanding-Rails-and-Blacklight#models
   module SolrDocumentBehavior
+    ModelWrapper = ActiveFedoraDummyModel # alias for backward compatibility
+
     extend ActiveSupport::Concern
     include Hydra::Works::MimeTypes
     include Hyrax::Permissions::Readable
@@ -39,58 +41,13 @@ module Hyrax
       title_or_label.to_s
     end
 
-    ##
-    # Given a model class and an +id+, provides +ActiveModel+ style model methods.
-    #
-    # @note access this via {SolrDocumentBehavior#to_model}.
-    class ModelWrapper
-      ##
-      # @api private
-      #
-      # @param [Class] model
-      # @param [String, nil] id
-      def initialize(model, id)
-        @model = model
-        @id = id
-      end
-
-      ##
-      # @api public
-      def persisted?
-        true
-      end
-
-      ##
-      # @api public
-      def to_param
-        @id
-      end
-
-      ##
-      # @api public
-      def model_name
-        @model.model_name
-      end
-
-      ##
-      # @api public
-      def to_partial_path
-        @model._to_partial_path
-      end
-
-      ##
-      # @api public
-      def to_global_id
-        URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
-      end
-    end
     ##
     # Offer the source model to Rails for some of the Rails methods (e.g. link_to).
     #
     # @example
     #   link_to '...', SolrDocument(:id => 'bXXXXXX5').new => <a href="/dams_object/bXXXXXX5">...</a>
     def to_model
-      @model ||= ModelWrapper.new(hydra_model, id)
+      @model ||= ActiveFedoraDummyModel.new(hydra_model, id)
     end
 
     ##
@@ -111,6 +68,12 @@ module Hyrax
       hydra_model == ::AdminSet
     end
 
+    ##
+    # @return [Boolean]
+    def work?
+      Hyrax.config.curation_concerns.include? hydra_model
+    end
+
     # Method to return the model
     def hydra_model(classifier: ActiveFedora.model_mapper)
       "::#{first('has_model_ssim')}".safe_constantize ||