hyrax 3.0.0.pre.beta3 → 3.0.0

data/app/models/proxy_deposit_rights.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class ProxyDepositRights < ActiveRecord::Base
   belongs_to :grantor, class_name: "User"
   belongs_to :grantee, class_name: "User"

data/app/models/single_use_link.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class SingleUseLink < ActiveRecord::Base
   validate :expiration_date_cannot_be_in_the_past
   validate :cannot_be_destroyed
@@ -7,6 +8,10 @@ class SingleUseLink < ActiveRecord::Base
 
   after_initialize :set_defaults
 
+  def self.generate_download_key
+    (Digest::SHA2.new << rand(1_000_000_000).to_s).to_s
+  end
+
   def create_for_path(path)
     self.class.create(item_id: item_id, path: path)
   end
@@ -21,17 +26,17 @@ class SingleUseLink < ActiveRecord::Base
 
   private
 
-    def expiration_date_cannot_be_in_the_past
-      errors.add(:expires, "can't be in the past") if expired?
-    end
+  def expiration_date_cannot_be_in_the_past
+    errors.add(:expires, "can't be in the past") if expired?
+  end
 
-    def cannot_be_destroyed
-      errors[:base] << "Single Use Link has already been used" if destroyed?
-    end
+  def cannot_be_destroyed
+    errors[:base] << "Single Use Link has already been used" if destroyed?
+  end
 
-    def set_defaults
-      return unless new_record?
-      self.expires ||= DateTime.current.advance(hours: 24)
-      self.download_key ||= (Digest::SHA2.new << rand(1_000_000_000).to_s).to_s
-    end
+  def set_defaults
+    return unless new_record?
+    self.expires ||= DateTime.current.advance(hours: 24)
+    self.download_key ||= self.class.generate_download_key
+  end
 end

data/app/models/sipity.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Sipity
+  def Agent(input, &block) # rubocop:disable Naming/MethodName
+    result = case input
+             when Sipity::Agent
+               input
+             end
+
+    handle_conversion(input, result, :to_sipity_agent, &block)
+  end
+  module_function :Agent
+
+  ##
+  # Cast an object to an Entity
+  # rubocop:disable Naming/MethodName, Metrics/CyclomaticComplexity, Metrics/MethodLength
+  def Entity(input, &block)
+    result = case input
+             when Sipity::Entity
+               input
+             when URI::GID, GlobalID
+               Entity.find_by(proxy_for_global_id: input.to_s)
+             when SolrDocument
+               Entity(input.to_model)
+             when Draper::Decorator
+               Entity(input.model)
+             when Sipity::Comment
+               Entity(input.entity)
+             when Valkyrie::Resource
+               Entity(Hyrax::GlobalID(input))
+             else
+               Entity(input.to_global_id) if input.respond_to?(:to_global_id)
+             end
+
+    handle_conversion(input, result, :to_sipity_entity, &block)
+  rescue URI::GID::MissingModelIdError
+    Entity(nil)
+  end
+  module_function :Entity
+  # rubocop:enable Naming/MethodName, Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+  ##
+  # Cast an object to an Role
+  def Role(input, &block) # rubocop:disable Naming/MethodName
+    result = case input
+             when Sipity::Role
+               input
+             when String, Symbol
+               Sipity::Role.find_or_create_by(name: input)
+             end
+
+    handle_conversion(input, result, :to_sipity_role, &block)
+  end
+  module_function :Role
+
+  ##
+  # Cast an object to a WorkflowAction in a given workflow
+  def WorkflowAction(input, workflow, &block) # rubocop:disable Naming/MethodName
+    workflow_id = PowerConverter.convert_to_sipity_workflow_id(workflow)
+
+    result = case input
+             when WorkflowAction
+               input if input.workflow_id == workflow_id
+             when String, Symbol
+               WorkflowAction.find_by(workflow_id: workflow_id, name: input.to_s)
+             end
+
+    handle_conversion(input, result, :to_sipity_action, &block)
+  end
+  module_function :WorkflowAction
+
+  ##
+  # Cast an object to a WorkflowState in a given workflow
+  def WorkflowState(input, workflow, &block) # rubocop:disable Naming/MethodName
+    result = case input
+             when Sipity::WorkflowState
+               input
+             when Symbol, String
+               WorkflowState.find_by(workflow_id: workflow.id, name: input)
+             end
+
+    handle_conversion(input, result, :to_sipity_workflow_state, &block)
+  end
+  module_function :WorkflowState
+
+  ##
+  # A parent error class for all workflow errors caused by bad state
+  class StateError < RuntimeError; end
+
+  class ConversionError < PowerConverter::ConversionError
+    def initialize(value, **options)
+      options[:scope] ||= nil
+      options[:to]    ||= nil
+      super(value, options)
+    end
+  end
+
+  ##
+  # Provides compatibility with the old `PowerConverter` conventions
+  def handle_conversion(input, result, method_name)
+    result ||= input.try(method_name)
+    return result unless result.nil?
+    return yield if block_given?
+
+    raise ConversionError.new(input) # rubocop:disable Style/RaiseArgs
+  end
+  module_function :handle_conversion
+end

data/app/models/sipity/agent.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # A proxy for something that can take an action.
   #
@@ -6,14 +7,13 @@ module Sipity
   class Agent < ActiveRecord::Base
     self.table_name = 'sipity_agents'
 
-    ENTITY_LEVEL_AGENT_RELATIONSHIP = 'entity_level'.freeze
-    WORKFLOW_LEVEL_AGENT_RELATIONSHIP = 'workflow_level'.freeze
+    ENTITY_LEVEL_AGENT_RELATIONSHIP = 'entity_level'
+    WORKFLOW_LEVEL_AGENT_RELATIONSHIP = 'workflow_level'
 
     has_many :workflow_responsibilities, dependent: :destroy, class_name: 'Sipity::WorkflowResponsibility'
     has_many :entity_specific_responsibilities, dependent: :destroy, class_name: 'Sipity::EntitySpecificResponsibility'
 
     has_many :comments,
-             foreign_key: :agent_id,
              dependent: :destroy,
              class_name: 'Sipity::Comment'
 

data/app/models/sipity/comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # Represents a "comment" placed by the given :agent in regards to the give :entity
   class Comment < ActiveRecord::Base

data/app/models/sipity/entity.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 module Sipity
-  # A proxy for the entity that is being processed.
+  # A proxy for the entity that is being processed via workflows.
+  #
   # By using a proxy, we need not worry about polluting the proxy's concerns
-  # with things related to processing.
+  # with things related to workflow processing.
   #
   # The goal is to keep this behavior separate, so that we can possibly
   # extract the information.
   # @example To get the Sipity::Entity for a work
   #   work = GenericWork.first
-  #   work_global_id = work.to_global_id.to_s
+  #   work_global_id = Hyrax::GlobalID(work).to_s
   #   => "gid://whatever/GenericWork/3x816m604"
   #   Sipity::Entity.where(proxy_for_global_id: work_global_id).first
   #   => #<Sipity::Entity id: 1, proxy_for_global_id: "gid://whatever/GenericWork/3x816m604",
@@ -23,7 +25,6 @@ module Sipity
     has_many :entity_specific_responsibilities, dependent: :destroy, class_name: 'Sipity::EntitySpecificResponsibility'
 
     has_many :comments,
-             foreign_key: :entity_id,
              dependent: :destroy,
              class_name: 'Sipity::Comment'
 

data/app/models/sipity/entity_specific_responsibility.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # In what capacity can an agent act upon the given entity?
   #

data/app/models/sipity/method.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # When a Sipity::Action is taken, each Sipity::Method is loaded and
   # it's service_name is instantiated and called (all of this done via

data/app/models/sipity/notifiable_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # A bridge for defining the "contexts" in which emails are sent.
   #
@@ -21,6 +22,6 @@ module Sipity
     belongs_to :scope_for_notification, polymorphic: true
     belongs_to :notification, class_name: 'Sipity::Notification'
 
-    REASON_ACTION_IS_TAKEN = 'action_is_taken'.freeze
+    REASON_ACTION_IS_TAKEN = 'action_is_taken'
   end
 end

data/app/models/sipity/notification.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # Responsible for defining a notification that is associated with a given
   # context; I believe the context is something that will be triggered via
@@ -8,15 +9,13 @@ module Sipity
 
     has_many :notifiable_contexts,
              dependent: :destroy,
-             foreign_key: :notification_id,
              class_name: 'Sipity::NotifiableContext'
 
     has_many :recipients,
              dependent: :destroy,
-             foreign_key: :notification_id,
              class_name: 'Sipity::NotificationRecipient'
 
-    NOTIFICATION_TYPE_EMAIL = 'email'.freeze
+    NOTIFICATION_TYPE_EMAIL = 'email'
 
     # TODO: There are other types, but for now, we are assuming just emails to send.
     enum(notification_type: { NOTIFICATION_TYPE_EMAIL => NOTIFICATION_TYPE_EMAIL })

data/app/models/sipity/notification_recipient.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # Responsible for defining who receives what email and in what capacity
   # (eg to:, cc:, bcc:)

data/app/models/sipity/role.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # A role is a responsibility to do things. That is to take actions. It is
   # easy to conflate a person's role with the groups to which they belong.
@@ -30,7 +31,6 @@ module Sipity
 
     has_many :email_recipients,
              dependent: :destroy,
-             foreign_key: :role_id,
              class_name: 'Sipity::NotificationRecipient'
 
     before_destroy :prevent_registered_roles_from_being_destroyed
@@ -45,8 +45,8 @@ module Sipity
 
     private
 
-      def prevent_registered_roles_from_being_destroyed
-        throw :abort if Hyrax.config.registered_role?(name: name)
-      end
+    def prevent_registered_roles_from_being_destroyed
+      throw :abort if Hyrax.config.registered_role?(name: name)
+    end
   end
 end

data/app/models/sipity/workflow.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # A named workflow for processing an entity. Originally I had thought of
   # calling this a Type, but once I extracted the Processing submodule,
@@ -13,9 +14,9 @@ module Sipity
 
     # Each PermissionTemplate has multiple potential workflows. But only one "active" workflow
     # @see Sipity::Workflow.activate!
-    belongs_to :permission_template, class_name: 'Hyrax::PermissionTemplate', required: true
+    belongs_to :permission_template, class_name: 'Hyrax::PermissionTemplate', optional: false
 
-    DEFAULT_INITIAL_WORKFLOW_STATE = 'new'.freeze
+    DEFAULT_INITIAL_WORKFLOW_STATE = 'new'
     def initial_workflow_state
       workflow_states.find_or_create_by!(name: DEFAULT_INITIAL_WORKFLOW_STATE)
     end
@@ -29,9 +30,11 @@ module Sipity
       workflows = Sipity::Workflow.arel_table
       Sipity::Workflow.where(active: true).where(
         workflows[:permission_template_id].in(
-          templates.project(templates[:id]).where(templates[:source_id].eq(admin_set_id))
+          templates.project(templates[:id]).where(templates[:source_id].eq(admin_set_id.to_s))
         )
       ).first!
+    rescue ActiveRecord::RecordNotFound => err
+      raise NoActiveWorkflowError, err.message
     end
 
     # @api public
@@ -44,9 +47,10 @@ module Sipity
     # @param workflow_name [String] The name of the workflow within the given permission template that should be activated
     # @return [Sipity::Workflow] active workflow
     # @raise [ActiveRecord::RecordNotFound] When we have a mismatch on permission template and workflow id or workflow name
-    # @raise [RuntimeError] When you don't specify a workflow_id or workflow_name
+    # @raise [ArgumentError] When you don't specify a workflow_id or workflow_name
     def self.activate!(permission_template:, workflow_id: nil, workflow_name: nil)
-      raise "You must specify a workflow_id or workflow_name to activate!" if workflow_id.blank? && workflow_name.blank?
+      raise(ArgumentError, "You must specify a workflow_id or workflow_name to activate!") if
+        workflow_id.blank? && workflow_name.blank?
       workflow_to_activate = Sipity::Workflow.find_by!({ permission_template: permission_template, id: workflow_id, name: workflow_name }.compact)
       active_workflow = Sipity::Workflow.where(permission_template: permission_template, active: true)
       return workflow_to_activate if workflow_to_activate == active_workflow.first
@@ -56,6 +60,21 @@ module Sipity
       end
     end
 
+    ##
+    # @api public
+    # Find an action in this workflow that has no starting state. This is the deposit action.
+    #
+    # @return [Sipity::WorkflowAction]
+    # @raise [Sipity::StateError]
+    def find_deposit_action
+      actions_that_lead_to_states = Sipity::WorkflowStateAction.all.pluck(:workflow_action_id)
+      relation = Sipity::WorkflowAction.where(workflow: self)
+      relation = relation.where('id NOT IN (?)', actions_that_lead_to_states) if actions_that_lead_to_states.any?
+      relation.first!
+    rescue ActiveRecord::RecordNotFound => err
+      raise NoActiveWorkflowError, err.message
+    end
+
     # Grant a workflow responsibility to a set of agents and remove it from any
     # agents who currently have the workflow responsibility, but are not in the
     # provided list
@@ -68,22 +87,24 @@ module Sipity
 
     private
 
-      # Give workflow responsibilites to the provided agents for the given role
-      # @param [Sipity::Role] role
-      # @param [Array<Sipity::Agent>] agents
-      def add_workflow_responsibilities(role, agents)
-        Hyrax::Workflow::PermissionGenerator.call(roles: role,
-                                                  workflow: self,
-                                                  agents: agents)
-      end
+    # Give workflow responsibilites to the provided agents for the given role
+    # @param [Sipity::Role] role
+    # @param [Array<Sipity::Agent>] agents
+    def add_workflow_responsibilities(role, agents)
+      Hyrax::Workflow::PermissionGenerator.call(roles: role,
+                                                workflow: self,
+                                                agents: agents)
+    end
 
-      # Find any workflow_responsibilities held by agents not in the allowed_agents
-      # and remove them
-      # @param [Sipity::Role] role
-      # @param [Array<Sipity::Agent>] allowed_agents
-      def remove_workflow_responsibilities(role, allowed_agents)
-        wf_role = Sipity::WorkflowRole.find_by(workflow: self, role_id: role)
-        wf_role.workflow_responsibilities.where.not(agent: allowed_agents).destroy_all
-      end
+    # Find any workflow_responsibilities held by agents not in the allowed_agents
+    # and remove them
+    # @param [Sipity::Role] role
+    # @param [Array<Sipity::Agent>] allowed_agents
+    def remove_workflow_responsibilities(role, allowed_agents)
+      wf_role = Sipity::WorkflowRole.find_by(workflow: self, role_id: role)
+      wf_role.workflow_responsibilities.where.not(agent: allowed_agents).destroy_all
+    end
+
+    class NoActiveWorkflowError < StateError; end
   end
 end

data/app/models/sipity/workflow_action.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # A named thing that happens within the bounds of a :workflow.
   #
@@ -12,16 +13,39 @@ module Sipity
     self.table_name = 'sipity_workflow_actions'
 
     belongs_to :workflow, class_name: 'Sipity::Workflow'
+
+    # Not all workflow actions will change state. For example, leaving a comment
+    # is an action, but likely not one to advance the state. Whereas, remove from
+    # public view is something that would likely advance the state.
     belongs_to :resulting_workflow_state,
                optional: true,
                class_name: 'Sipity::WorkflowState'
 
+    # In what states can this (eg. self) action be taken
     has_many :workflow_state_actions, dependent: :destroy, class_name: 'Sipity::WorkflowStateAction'
+
+    # These are arbitrary "lambdas" that you can call when the action is taken
+    #   * Need to send an email?
+    #   * Need to publish a WEBHOOK callback?
+    #   * Need to update the ACLs for the record?
     has_many :triggered_methods, dependent: :destroy, class_name: 'Sipity::Method'
 
     has_many :notifiable_contexts,
              dependent: :destroy,
              as: :scope_for_notification,
              class_name: 'Sipity::NotifiableContext'
+
+    ##
+    # @param [Object] input
+    # @return [String]
+    def self.name_for(input, &block)
+      result = case input
+               when String, Symbol
+                 input.to_s.sub(/[\?\!]\Z/, '')
+               when Sipity::WorkflowAction
+                 input.name
+               end
+      Sipity.handle_conversion(input, result, :to_sipity_action_name, &block)
+    end
   end
 end

data/app/models/sipity/workflow_responsibility.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sipity
   # In what capacity can an agent act upon all entities for the given
   # Workflow