hyrax 3.0.0 → 3.2.0

data/app/services/hyrax/thumbnail_path_service.rb

@@ -30,7 +30,7 @@ module Hyrax
       def fetch_thumbnail(object)
         return object if object.thumbnail_id == object.id
         Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: object.thumbnail_id)
-      rescue Hyrax::ObjectNotFoundError
+      rescue Valkyrie::Persistence::ObjectNotFoundError, Hyrax::ObjectNotFoundError
         Rails.logger.error("Couldn't find thumbnail #{object.thumbnail_id} for #{object.id}")
         nil
       end

data/app/services/hyrax/visibility_intention.rb

@@ -54,7 +54,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def valid_embargo?
-      wants_embargo? && release_date.present?
+      wants_embargo? && release_date.present? && a_valid_date?(release_date)
     end
 
     ##
@@ -66,7 +66,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def valid_lease?
-      wants_lease? && release_date.present?
+      wants_lease? && release_date.present? && a_valid_date?(release_date)
     end
 
     ##
@@ -74,5 +74,23 @@ module Hyrax
     def wants_lease?
       visibility == LEASE_REQUEST
     end
+
+    private
+
+    ##
+    # @param date [Object]
+    # @return [Boolean]
+    # @note If we don't have a valid date, we really can't have a
+    # valid release_date
+    def a_valid_date?(date)
+      return true if date.is_a?(Date)
+      return true if date.is_a?(Time)
+      Date.parse(date)
+      # In Ruby 2.7.x, Date::Error descends from ArgumentError; Once
+      # we stop supporting pre-2.7, we can switch this to the more
+      # narrow Date::Error
+    rescue ArgumentError
+      false
+    end
   end
 end

data/app/services/hyrax/visibility_propagator.rb

@@ -2,7 +2,7 @@
 module Hyrax
   ##
   # @abstract Propagates visibility from a provided object (e.g. a Work) to some
-  # group of its members (e.g. file_sets).
+  #   group of its members (e.g. file_sets).
   class VisibilityPropagator
     ##
     # @param source [#visibility] the object to propagate visibility from
@@ -14,6 +14,35 @@ module Hyrax
         FileSetVisibilityPropagator.new(source: source)
       when Hyrax::Resource # Valkyrie
         ResourceVisibilityPropagator.new(source: source)
+      else
+        NullVisibilityPropogator.new(source: source)
+      end
+    end
+
+    ##
+    # Provides a null/logging implementation of the visibility propogator.
+    class NullVisibilityPropogator
+      ##
+      # @!attribute [rw] source
+      #   @return [#visibility]
+      attr_accessor :source
+
+      ##
+      # @param source [#visibility] the object to propagate visibility from
+      def initialize(source:)
+        self.source = source
+      end
+
+      ##
+      # @return [void]
+      # @raise [RuntimeError] if we're in development mode
+      def propogate
+        message =  "Tried to propogate visibility to members of #{source} " \
+                   "but didn't know what kind of object it is. Model " \
+                   "name #{source.try(:model_name)}. Called from #{caller[0]}."
+
+        Hyrax.logger.warn(message)
+        Rails.env.development? ? raise(message) : :noop
       end
     end
   end

data/app/services/hyrax/work_uploads_handler.rb

@@ -48,7 +48,9 @@ module Hyrax
     #   @return [Enumberable<Hyrax::UploadedFile>]
     # @!attribute [r] work
     #   @return [Hyrax::Work]
-    attr_reader :files, :work
+    # @!attribute [r] file_set_params
+    #   @return [Enumerable<Hash>]
+    attr_reader :files, :work, :file_set_params
 
     ##
     # @param [Hyrax::Work] work
@@ -71,9 +73,10 @@ module Hyrax
     # @return [WorkFileSetManager] self
     # @raise [ArgumentError] if any of the uploaded files are not an
     #   `UploadedFile`
-    def add(files:)
+    def add(files:, file_set_params: [])
       validate_files(files) &&
         @files = Array.wrap(files).reject { |f| f.file_set_uri.present? }
+      @file_set_params = file_set_params
       self
     end
 
@@ -105,6 +108,10 @@ module Hyrax
 
       # copy ACLs; should we also be propogating embargo/lease?
       Hyrax::AccessControlList.copy_permissions(source: target_permissions, target: file_set)
+
+      # set visibility from params and save
+      file_set.visibility = file_set_extra_params(file)[:visibility] if file_set_extra_params(file)[:visibility].present?
+      file_set.permission_manager.acl.save if file_set.permission_manager.acl.pending_changes?
       append_to_work(file_set)
 
       IngestJob.perform_later(wrap_file(file, file_set))
@@ -135,6 +142,14 @@ module Hyrax
         title: file.uploader.filename }
     end
 
+    ##
+    # @api private
+    #
+    # return [Hash(Symbol => Object)]
+    def file_set_extra_params(file)
+      file_set_params&.find { |fs| fs[:uploaded_file_id] == file.id.to_s } || {}
+    end
+
     ##
     # @api private
     #

data/app/services/hyrax/workflow/abstract_notification.rb

@@ -39,9 +39,9 @@ module Hyrax
       # @option recipients [Array<Hyrax::User>] :to a list of users to which to send the notification
       # @option recipients [Array<Hyrax::User>] :cc a list of users to which to copy on the notification
       def initialize(entity, comment, user, recipients)
-        @work_id = entity.proxy_for_global_id.sub(/.*\//, '')
+        @work_id = entity.proxy_for.id
         @title = entity.proxy_for.title.first
-        @comment = comment.respond_to?(:comment) ? comment.comment.to_s : ''
+        @comment = comment&.comment.to_s
         # Convert to hash with indifferent access to allow both string and symbol keys
         @recipients = recipients.with_indifferent_access
         @user = user

data/app/services/hyrax/workflow/action_taken_service.rb

@@ -14,7 +14,14 @@ module Hyrax
       end
 
       def initialize(target:, action:, comment:, user:)
-        @target = target
+        @target =
+          case target
+          when Valkyrie::Resource
+            Hyrax::ChangeSet.for(target)
+          else
+            target
+          end
+
         @action = action
         @comment = comment
         @user = user
@@ -70,10 +77,15 @@ module Hyrax
       # @api private
       def save_target
         case target
-        when ActiveFedora::Base
-          target.save
+        when Valkyrie::ChangeSet
+          return target.model unless target.changed?
+
+          Hyrax::Transactions::Container['change_set.apply']
+            .with_step_args('change_set.save' => { user: user })
+            .call(target)
+            .value!
         else
-          Hyrax.persister.save(resource: target)
+          target.save
         end
       end
     end

data/app/services/hyrax/workflow/actionable_objects.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+module Hyrax
+  module Workflow
+    ##
+    # Produces a list of workflow-ready objects for a given user. Results are
+    # given as a presenter objects with SolrDocument-like behavior, with added
+    # support for workflow states.
+    #
+    # @example
+    #   Hyrax::Workflow::ActionableObjects.new(user: current_user).each do |object|
+    #     puts object.title
+    #     puts object.workflow_state
+    #   end
+    #
+    # @see Hyrax::Workflow::ObjectInWorkflowDecorator
+    class ActionableObjects
+      include Enumerable
+
+      ##
+      # @!attribute [rw] user
+      #   @return [::User]
+      attr_accessor :user
+
+      ##
+      # @param [::User] user the user whose
+      def initialize(user:)
+        @user = user
+      end
+
+      ##
+      # @return [Hyrax::Workflow::ObjectInWorkflowDecorator]
+      def each
+        return enum_for(:each) unless block_given?
+        ids_and_states = id_state_pairs
+        return if ids_and_states.none?
+
+        docs = Hyrax::SolrQueryService.new.with_ids(ids: ids_and_states.map(&:first)).solr_documents
+
+        docs.each do |solr_doc|
+          object = ObjectInWorkflowDecorator.new(solr_doc)
+          _, state = ids_and_states.find { |id, _| id == object.id }
+
+          object.workflow_state = state
+
+          yield object
+        end
+      end
+
+      private
+
+      ##
+      # @api private
+      # @return [Array[String, Sipity::WorkflowState]]
+      def id_state_pairs
+        gids_and_states = PermissionQuery
+                          .scope_entities_for_the_user(user: user)
+                          .pluck(:proxy_for_global_id, :workflow_state_id)
+
+        return [] if gids_and_states.none?
+
+        all_states = Sipity::WorkflowState.find(gids_and_states.map(&:last).uniq)
+
+        gids_and_states.map do |str, state_id|
+          [GlobalID.new(str).model_id,
+           all_states.find { |state| state.id == state_id }]
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/workflow/activate_object.rb

@@ -3,14 +3,15 @@ module Hyrax
   module Workflow
     module ActivateObject
       ##
-      # This is a built in function for workflow, setting the `#state`
-      # of the target to the Fedora 'active' status URI
+      # This is a built in function for workflow, setting the +#state+
+      # of the target to the Fedora +active+ status URI
       #
-      # @param target [#state] an instance of a model that includes `Hyrax::Suppressible`
+      # @param target [#state] an instance of a model with a +#state+ property;
+      #   e.g. a {Hyrax::Work}
       #
       # @return [RDF::Vocabulary::Term] the Fedora Resource Status 'active' term
       def self.call(target:, **)
-        target.state = Vocab::FedoraResourceStatus.active
+        target.state = Hyrax::ResourceStatus::ACTIVE
       end
     end
   end

data/app/services/hyrax/workflow/changes_required_notification.rb

@@ -9,14 +9,15 @@ module Hyrax
       end
 
       def message
-        I18n.t('hyrax.notifications.workflow.changes_required.message', title: title,
-                                                                        link: (link_to work_id, document_path),
-                                                                        comment: comment)
+        I18n.t('hyrax.notifications.workflow.changes_required.message',
+               title: title,
+               link: (link_to work_id, document_path),
+               comment: comment)
       end
 
       def users_to_notify
         user_key = document.depositor
-        super << ::User.find_by(email: user_key)
+        super << ::User.find_by_user_key(user_key)
       end
     end
   end

data/app/services/hyrax/workflow/deactivate_object.rb

@@ -2,15 +2,17 @@
 module Hyrax
   module Workflow
     ##
-    # This is a built in function for workflow, setting the `#state`
-    # of the target to the Fedora 'inactive' status URI
+    # This is a built in function for workflow, setting the +#state+
+    # of the target to the Fedora +inactive+ status URI
     #
-    # @param target [#state] an instance of a model that includes `Hyrax::Suppressible`
+    # @param target [#state] an instance of a model with a +#state+ property;
+    #   e.g. a {Hyrax::Work}
     #
-    # @return [RDF::Vocabulary::Term] the Fedora Resource Status 'inactive' term
+    # @return [RDF::URI] the Fedora Resource Status 'inactive' term
+    # @see Hyrax::ResourceStatus
     module DeactivateObject
       def self.call(target:, **)
-        target.state = Vocab::FedoraResourceStatus.inactive
+        target.state = Hyrax::ResourceStatus::INACTIVE
       end
     end
   end

data/app/services/hyrax/workflow/deposited_notification.rb

@@ -9,13 +9,17 @@ module Hyrax
       end
 
       def message
-        I18n.t('hyrax.notifications.workflow.deposited.message', title: title, link: (link_to work_id, document_path),
-                                                                 user: user.user_key, comment: comment)
+        I18n.t('hyrax.notifications.workflow.deposited.message',
+               title: title,
+               link: (link_to work_id, document_path),
+               user: user.user_key,
+               comment: comment)
       end
 
       def users_to_notify
-        user_key = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: work_id).depositor
-        super << ::User.find_by(email: user_key)
+        user_key = @entity.proxy_for.depositor
+
+        super << ::User.find_by_user_key(user_key)
       end
     end
   end

data/app/services/hyrax/workflow/grant_edit_to_depositor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
+    ##
     # This is a built in function for workflow, so that a workflow action can be created that
     # grants the creator the ability to alter it.
     module GrantEditToDepositor
@@ -8,11 +9,14 @@ module Hyrax
       # @return void
       def self.call(target:, **)
         return true unless target.try(:depositor)
-        target.edit_users = target.edit_users.to_a + Array.wrap(target.depositor) # += works in Ruby 2.6+
-        target.try(:permission_manager)&.acl&.save
+
+        model = target.try(:model) || target # get the model if target is a ChangeSet
+        model.edit_users = model.edit_users.to_a + Array.wrap(target.depositor) # += works in Ruby 2.6+
+        model.try(:permission_manager)&.acl&.save
+
         # If there are a lot of members, granting access to each could take a
         # long time. Do this work in the background.
-        GrantEditToMembersJob.perform_later(target, target.depositor)
+        GrantEditToMembersJob.perform_later(model, target.depositor)
       end
     end
   end

data/app/services/hyrax/workflow/grant_read_to_depositor.rb

@@ -1,16 +1,23 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
+    ##
     # This is a built in function for workflow, so that a workflow action can be created that
     # grants the creator the ability to view their work.
     module GrantReadToDepositor
-      # @param [#read_users=, #read_users] target (likely an ActiveRecord::Base) to which we are adding read_users for the depositor
+      # @param [#read_users=, #read_users] target to which we are adding read_users
+      #   for the depositor
       # @return void
       def self.call(target:, **)
-        target.read_users += [target.depositor]
+        return true unless target.try(:depositor)
+
+        model = target.try(:model) || target # get the model if target is a ChangeSet
+        model.read_users = model.read_users.to_a + Array.wrap(target.depositor) # += works in Ruby 2.6+
+        model.try(:permission_manager)&.acl&.save
+
         # If there are a lot of members, granting access to each could take a
         # long time. Do this work in the background.
-        GrantReadToMembersJob.perform_later(target, target.depositor)
+        GrantReadToMembersJob.perform_later(model, target.depositor)
       end
     end
   end

data/app/services/hyrax/workflow/object_in_workflow_decorator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Workflow
+    ##
+    # Decorates objects with attributes with their workflow state.
+    class ObjectInWorkflowDecorator < Hyrax::ModelDecorator
+      delegate_all
+
+      ##
+      # @!attribute [w] workflow
+      #   @return [Sipity::Workflow]
+      # @!attribute [w] workflow_state
+      #   @return [Sipity::WorkflowState]
+      attr_writer :workflow, :workflow_state
+
+      ##
+      # @return [Boolean]
+      def published?
+        Hyrax::Admin::WorkflowsController.deposited_workflow_state_name ==
+          workflow_state
+      end
+
+      ##
+      # @return [String]
+      def workflow_state
+        @workflow_state&.name || 'unknown'
+      end
+    end
+  end
+end

data/app/services/hyrax/workflow/revoke_edit_from_depositor.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
+    ##
     # This is a built in function for workflow, so that a workflow action can be created that
     # removes the creators the ability to alter it.
     module RevokeEditFromDepositor
       def self.call(target:, **)
-        target.edit_users -= [target.depositor]
+        return true unless target.try(:depositor)
+
+        model = target.try(:model) || target # get the model if target is a ChangeSet
+        model.edit_users = model.edit_users.to_a - Array.wrap(target.depositor)
+        model.try(:permission_manager)&.acl&.save
+
         # If there are a lot of members, revoking access from each could take a
         # long time. Do this work in the background.
-        RevokeEditFromMembersJob.perform_later(target, target.depositor)
+        RevokeEditFromMembersJob.perform_later(model, target.depositor)
       end
     end
   end

data/app/services/hyrax/workflow/status_list_service.rb

@@ -1,35 +1,65 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
-    # Finds a list of works that we can perform a workflow action on
+    ##
+    # @deprecated use the Hyrax::Workflow::ActionableObjects enumerator instead.
+    #   that service is designed as a more efficient and ergonomic replacement
+    #   for this one, and has fewer dependencies on specific indexing behavior.
+    #
+    # Finds a list of works that a given user can perform a workflow action on.
     class StatusListService
-      # @param context [#current_user, #logger]
+      ##
+      # @param context_or_user [::User, #current_user]
       # @param filter_condition [String] a solr filter
-      def initialize(context, filter_condition)
-        @context = context
+      #
+      # @raise [ArgumentError] if th caller fails to provide a user
+      def initialize(context_or_user, filter_condition)
+        Deprecation
+          .warn("Use the Hyrax::Workflow::ActionableObjects enumerator instead.")
+
+        case context_or_user
+        when ::User
+          @user = context_or_user
+        when nil
+          raise ArgumentError, "A current user MUST be provided."
+        else
+          Deprecation.warn('Initializing StatusListService with a controller ' \
+                           '"context" is deprecated. Pass in a user instead.')
+          @context = context_or_user
+          @user = @context.current_user
+        end
         @filter_condition = filter_condition
       end
 
+      ##
+      # @!attribute [r] context
+      #   @deprecated
+      #   @return [#current_user]
       attr_reader :context
+      deprecation_deprecate :context
 
-      # TODO: We will want to paginate this
-      # @return [Array<StatusRow>] a list of results that the given user can take action on.
+      ##
+      # @todo We will want to paginate this
+      # @return [Enumerable<StatusRow>] a list of results that the given user can take action on.
       def each
         return enum_for(:each) unless block_given?
+
         solr_documents.each do |doc|
           yield doc
         end
       end
 
-      # TODO: Make this private for version 1.0
+      ##
+      # @deprecated
       def user
-        context.current_user
+        Deprecation.warn('This method was always intended to be private. ' \
+                         'It will be removed in Hyrax 4.0')
+        @user
       end
 
       private
 
-      delegate :logger, to: :context
-
+      ##
       # @return [Hash<String,SolrDocument>] a hash of id to solr document
       def solr_documents
         search_solr.map { |result| ::SolrDocument.new(result) }
@@ -37,9 +67,9 @@ module Hyrax
 
       def search_solr
         actionable_roles = roles_for_user
-        logger.debug("Actionable roles for #{user.user_key} are #{actionable_roles}")
+        Hyrax.logger.debug("Actionable roles for #{@user.user_key} are #{actionable_roles}")
         return [] if actionable_roles.empty?
-        WorkRelation.new.search_with_conditions(query(actionable_roles), rows: 1000, method: :post)
+        WorkRelation.new.search_with_conditions(query(actionable_roles), method: :post)
       end
 
       def query(actionable_roles)
@@ -59,7 +89,7 @@ module Hyrax
       # @param workflow [Sipity::Workflow]
       # @return [ActiveRecord::Relation<Sipity::WorkflowRole>]
       def workflow_roles_for_user_and_workflow(workflow)
-        Hyrax::Workflow::PermissionQuery.scope_processing_workflow_roles_for_user_and_workflow(user: user, workflow: workflow)
+        Hyrax::Workflow::PermissionQuery.scope_processing_workflow_roles_for_user_and_workflow(user: @user, workflow: workflow)
       end
     end
   end

data/app/services/hyrax/workflow/workflow_action_service.rb

@@ -31,7 +31,8 @@ module Hyrax
       end
 
       def create_sipity_comment
-        return true if comment_text.blank?
+        return Sipity::NullComment.new(entity: subject.entity, agent: subject.agent) if
+          comment_text.blank?
         Sipity::Comment.create!(entity: subject.entity, agent: subject.agent, comment: comment_text)
       end
 
@@ -44,7 +45,9 @@ module Hyrax
         )
       end
 
+      ##
       # Run any configured custom methods
+      #
       def handle_additional_sipity_workflow_action_processing(comment:)
         Hyrax::Workflow::ActionTakenService.handle_action_taken(
           target: subject.work,

data/app/views/hyrax/admin/admin_sets/_form.html.erb

@@ -26,7 +26,7 @@
                 <% if f.object.persisted? && f.object.member_ids.present? %>
                   <%# we're loading these values dynamically to speed page load %>
                   <%= f.input :thumbnail_id,
-                              input_html: { data: { text: f.object.thumbnail_title } } %>
+                              input_html: { data: { text: thumbnail_label_for(object: f.object) } } %>
                 <% end %>
 
               </div>

data/app/views/hyrax/base/_form_child_work_relationships.html.erb

@@ -24,7 +24,7 @@ HTML Properties:
   </div>
   <div class="message has-warning hidden"></div>
   <div style="margin-top: 10px">
-    <%= link_to t('.attach_new_work'), polymorphic_path([main_app, :new, :hyrax, :parent, curation_concern.model_name.singular], parent_id: curation_concern.id), target: "_blank", class: 'btn btn-primary' %>
+    <%= link_to t('.attach_new_work'), polymorphic_path([main_app, :new, :hyrax, :parent, curation_concern.model_name.singular.to_sym], parent_id: curation_concern.id), target: "_blank", class: 'btn btn-primary' %>
   </div>
   <table class="table table-striped">
     <caption><%= t('.caption') %></caption>

data/app/views/hyrax/base/_form_relationships.html.erb

@@ -1,8 +1,7 @@
 <% if Flipflop.assign_admin_set? %>
-  <%# TODO: avoid direct dependency on AdminSetService and AdminSetOptionsPresenter in the view!! make the controller provide the options! %>
   <%= f.input :admin_set_id, as: :select,
       include_blank: false,
-      collection: Hyrax::AdminSetOptionsPresenter.new(Hyrax::AdminSetService.new(controller)).select_options,
+      collection: admin_set_options,
       input_html: { class: 'form-control' } %>
 <% end %>
 

data/app/views/hyrax/base/_form_rendering.html.erb

@@ -7,7 +7,7 @@
       <div class="form-group">
         <span class="help-block"><%= t("hyrax.base.form_rendering.help_html") %></span>
         <%= f.select :rendering_ids,
-                    f.object.select_files,
+                    form_file_set_select_for(parent: f.object),
                     { include_blank: true },
                     { class: 'form-control', multiple: true } %>
       </div>

data/app/views/hyrax/base/_form_representative.html.erb

@@ -6,7 +6,7 @@
         </legend>
         <div class="form-group">
           <span class="help-block"><%= t("hyrax.base.form_representative.help_html") %></span>
-          <%= f.select :representative_id, @form.select_files, {}, { class: 'form-control' } %>
+          <%= f.select :representative_id, form_file_set_select_for(parent: @form), {}, { class: 'form-control' } %>
         </div>
       </fieldset>
     </div>

data/app/views/hyrax/base/_form_thumbnail.html.erb

@@ -6,7 +6,7 @@
         </legend>
         <div class="form-group">
           <span class="help-block"><%= t("hyrax.base.form_thumbnail.help_html") %></span>
-          <%= f.select :thumbnail_id, @form.select_files, {}, { class: 'form-control' } %>
+          <%= f.select :thumbnail_id, form_file_set_select_for(parent: @form), {}, { class: 'form-control' } %>
         </div>
       </fieldset>
     </div>

data/app/views/hyrax/base/_form_visibility_error.html.erb

@@ -1,3 +1,5 @@
 <%= f.full_error(:visibility) %>
 <%= f.full_error(:embargo_release_date) %>
 <%= f.full_error(:visibility_after_embargo) %>
+<%= f.full_error(:lease_expiration_date) %>
+<%= f.full_error(:visibility_after_lease) %>