hyrax 3.0.0.pre.rc1 → 3.0.0.pre.rc2

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Finds a list of works that we can perform a workflow action on
@@ -27,39 +28,39 @@ module Hyrax
 
       private
 
-        delegate :logger, to: :context
+      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) }
-        end
+      # @return [Hash<String,SolrDocument>] a hash of id to solr document
+      def solr_documents
+        search_solr.map { |result| ::SolrDocument.new(result) }
+      end
 
-        def search_solr
-          actionable_roles = roles_for_user
-          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)
-        end
+      def search_solr
+        actionable_roles = roles_for_user
+        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)
+      end
 
-        def query(actionable_roles)
-          ["{!terms f=actionable_workflow_roles_ssim}#{actionable_roles.join(',')}",
-           @filter_condition]
-        end
+      def query(actionable_roles)
+        ["{!terms f=actionable_workflow_roles_ssim}#{actionable_roles.join(',')}",
+         @filter_condition]
+      end
 
-        # @return [Array<String>] the list of workflow-role combinations this user has
-        def roles_for_user
-          Sipity::Workflow.all.flat_map do |wf|
-            workflow_roles_for_user_and_workflow(wf).map do |wf_role|
-              "#{wf.permission_template.source_id}-#{wf.name}-#{wf_role.role.name}"
-            end
+      # @return [Array<String>] the list of workflow-role combinations this user has
+      def roles_for_user
+        Sipity::Workflow.all.flat_map do |wf|
+          workflow_roles_for_user_and_workflow(wf).map do |wf_role|
+            "#{wf.permission_template.source_id}-#{wf.name}-#{wf_role.role.name}"
           end
         end
+      end
 
-        # @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)
-        end
+      # @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)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for coordinating the behavior of an action taken within a workflow
@@ -24,34 +25,34 @@ module Hyrax
 
       private
 
-        def update_sipity_workflow_state
-          return true if action.resulting_workflow_state_id.blank?
-          subject.entity.update!(workflow_state_id: action.resulting_workflow_state_id)
-        end
-
-        def create_sipity_comment
-          return true if comment_text.blank?
-          Sipity::Comment.create!(entity: subject.entity, agent: subject.agent, comment: comment_text)
-        end
-
-        def handle_sipity_notifications(comment:)
-          Hyrax::Workflow::NotificationService.deliver_on_action_taken(
-            entity: subject.entity,
-            comment: comment,
-            action: action,
-            user: subject.user
-          )
-        end
-
-        # Run any configured custom methods
-        def handle_additional_sipity_workflow_action_processing(comment:)
-          Hyrax::Workflow::ActionTakenService.handle_action_taken(
-            target: subject.work,
-            comment: comment,
-            action: action,
-            user: subject.user
-          )
-        end
+      def update_sipity_workflow_state
+        return true if action.resulting_workflow_state_id.blank?
+        subject.entity.update!(workflow_state_id: action.resulting_workflow_state_id)
+      end
+
+      def create_sipity_comment
+        return true if comment_text.blank?
+        Sipity::Comment.create!(entity: subject.entity, agent: subject.agent, comment: comment_text)
+      end
+
+      def handle_sipity_notifications(comment:)
+        Hyrax::Workflow::NotificationService.deliver_on_action_taken(
+          entity: subject.entity,
+          comment: comment,
+          action: action,
+          user: subject.user
+        )
+      end
+
+      # Run any configured custom methods
+      def handle_additional_sipity_workflow_action_processing(comment:)
+        Hyrax::Workflow::ActionTakenService.handle_action_taken(
+          target: subject.work,
+          comment: comment,
+          action: action,
+          user: subject.user
+        )
+      end
     end
   end
 end

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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for:
     #
-    # * Creating a workflow entity
-    # * Assigning specific roles to the entity (but not the workflow)
+    # * Creating a Sipity::Entity (aka a database proxy for the given work)
+    # * Assigning specific roles to the Sipity::Entity (but not the workflow)
     # * Running the deposit_action
     #
+    # @see Sipity:Entity
     # @see Hyrax::Workflow::WorkflowActionService
     # @see Hyrax::Workflow::PermissionGenerator
     # @see Hyrax::RoleRegistry
@@ -22,7 +24,7 @@ module Hyrax
         new(work, attributes, user).create
       end
 
-      # @param work [#to_global_id, #active_workflow]
+      # @param work [#to_global_id, #admin_set_id]
       # @param user [User]
       # @param attributes [Hash]
       def initialize(work, attributes, user)
@@ -46,33 +48,37 @@ module Hyrax
 
       private
 
-        def create_workflow_entity!
-          Sipity::Entity.create!(proxy_for_global_id: work.to_global_id.to_s,
-                                 workflow: work.active_workflow,
-                                 workflow_state: nil)
-        end
+      def create_workflow_entity!
+        Sipity::Entity.create!(proxy_for_global_id: work.to_global_id.to_s,
+                               workflow: workflow_for(work),
+                               workflow_state: nil)
+      end
+
+      def assign_specific_roles_to(entity:)
+        Hyrax::Workflow::PermissionGenerator.call(agents: user,
+                                                  entity: entity,
+                                                  roles: depositing_role,
+                                                  workflow: workflow_for(work))
+      end
 
-        def assign_specific_roles_to(entity:)
-          Hyrax::Workflow::PermissionGenerator.call(agents: user,
-                                                    entity: entity,
-                                                    roles: depositing_role,
-                                                    workflow: work.active_workflow)
-        end
+      def run_workflow_action!
+        subject = WorkflowActionInfo.new(work, user)
+        Workflow::WorkflowActionService.run(subject: subject,
+                                            action: find_deposit_action)
+      end
 
-        def run_workflow_action!
-          subject = WorkflowActionInfo.new(work, user)
-          Workflow::WorkflowActionService.run(subject: subject,
-                                              action: find_deposit_action)
-        end
+      # Find an action that has no starting state. This is the deposit action.
+      # # @return [Sipity::WorkflowAction]
+      def find_deposit_action
+        actions_that_lead_to_states = Sipity::WorkflowStateAction.all.pluck(:workflow_action_id)
+        relation = Sipity::WorkflowAction.where(workflow: workflow_for(work))
+        relation = relation.where('id NOT IN (?)', actions_that_lead_to_states) if actions_that_lead_to_states.any?
+        relation.first!
+      end
 
-        # Find an action that has no starting state. This is the deposit action.
-        # # @return [Sipity::WorkflowAction]
-        def find_deposit_action
-          actions_that_lead_to_states = Sipity::WorkflowStateAction.all.pluck(:workflow_action_id)
-          relation = Sipity::WorkflowAction.where(workflow: work.active_workflow)
-          relation = relation.where('id NOT IN (?)', actions_that_lead_to_states) if actions_that_lead_to_states.any?
-          relation.first!
-        end
+      def workflow_for(work)
+        Sipity::Workflow.find_active_workflow_for(admin_set_id: work.admin_set_id)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for loading workflows from a data source.
@@ -19,7 +20,7 @@ module Hyrax
 
         private
 
-          attr_writer :load_errors
+        attr_writer :load_errors
       end
 
       # @api public
@@ -100,25 +101,25 @@ module Hyrax
 
       private
 
-        attr_reader :data, :logger
+      attr_reader :data, :logger
 
-        def data=(input)
-          @data = input.deep_symbolize_keys
-        end
+      def data=(input)
+        @data = input.deep_symbolize_keys
+      end
 
-        attr_accessor :validator, :permission_template, :schema
+      attr_accessor :validator, :permission_template, :schema
 
-        def default_validator
-          SchemaValidator.method(:call)
-        end
+      def default_validator
+        SchemaValidator.method(:call)
+      end
 
-        def default_schema
-          Hyrax::Workflow::WorkflowSchema
-        end
+      def default_schema
+        Hyrax::Workflow::WorkflowSchema.new
+      end
 
-        def validate!
-          validator.call(data: data, schema: schema, logger: logger)
-        end
+      def validate!
+        validator.call(data: data, schema: schema, logger: logger)
+      end
 
       public
 
@@ -142,39 +143,52 @@ module Hyrax
 
       private
 
-        def find_or_create_from(configuration:)
-          workflow = Sipity::Workflow.find_or_initialize_by(name: configuration.fetch(:name), permission_template: permission_template)
-          generate_state_diagram!(workflow: workflow, actions_configuration: configuration.fetch(:actions))
-
-          find_or_create_workflow_permissions!(
-            workflow: workflow, workflow_permissions_configuration: configuration.fetch(:workflow_permissions, [])
-          )
-          workflow.label = configuration.fetch(:label, nil)
-          workflow.description = configuration.fetch(:description, nil)
-          workflow.allows_access_grant = configuration.fetch(:allows_access_grant, nil)
-          workflow.save!
-          logger.info(%(Loaded Sipity::Workflow "#{workflow.name}" for #{permission_template.class} ID=#{permission_template.id}))
-          workflow
+      def find_or_create_from(configuration:)
+        workflow = Sipity::Workflow.find_or_initialize_by(name: configuration.fetch(:name), permission_template: permission_template)
+        generate_state_diagram!(workflow: workflow, actions_configuration: configuration.fetch(:actions))
+
+        find_or_create_workflow_permissions!(
+          workflow: workflow, workflow_permissions_configuration: configuration.fetch(:workflow_permissions, [])
+        )
+        workflow.label = configuration.fetch(:label, nil)
+        workflow.description = configuration.fetch(:description, nil)
+        workflow.allows_access_grant = configuration.fetch(:allows_access_grant, nil)
+        workflow.save!
+        logger.info(%(Loaded Sipity::Workflow "#{workflow.name}" for #{permission_template.class} ID=#{permission_template.id}))
+        workflow
+      end
+
+      extend Forwardable
+      def_delegator WorkflowPermissionsGenerator, :call, :find_or_create_workflow_permissions!
+      def_delegator SipityActionsGenerator, :call, :generate_state_diagram!
+
+      module SchemaValidator
+        # @param data [Hash]
+        # @param schema [#call]
+        #
+        # @return [Boolean] true if the data validates from the schema
+        # @raise [RuntimeError] if the data does not validate against the schema
+        def self.call(data:, schema:, logger:)
+          result = schema.call(data)
+          return true if result.success?
+          message = format_message(result)
+          logger.error(message)
+          raise message
         end
 
-        extend Forwardable
-        def_delegator WorkflowPermissionsGenerator, :call, :find_or_create_workflow_permissions!
-        def_delegator SipityActionsGenerator, :call, :generate_state_diagram!
-
-        module SchemaValidator
-          # @param data [Hash]
-          # @param schema [#call]
-          #
-          # @return true if the data validates from the schema
-          # @raise Exceptions::InvalidSchemaError if the data does not validate against the schema
-          def self.call(data:, schema:, logger:)
-            result = schema.call(data)
-            return true if result.success?
-            message = result.messages(full: true).inspect
-            logger.error(message)
-            raise message
+        ##
+        # @param result [Dry::Validation::Result]
+        #
+        # @return [String]
+        def self.format_message(result)
+          messages = result.errors(full: true).map do |msg|
+            "Error on workflow entry #{msg.path}\n\t#{msg.text}\n\tGot: #{msg.input || '[no entry]'}"
           end
+
+          messages << "Input was:\n\t#{result.to_h}"
+          messages.join("\n")
         end
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for creating database entries for the given workflow's permissions
@@ -20,12 +21,12 @@ module Hyrax
 
       private
 
-        attr_accessor :workflow
-        attr_reader :workflow_permissions_configuration
+      attr_accessor :workflow
+      attr_reader :workflow_permissions_configuration
 
-        def workflow_permissions_configuration=(input)
-          @workflow_permissions_configuration = Array.wrap(input)
-        end
+      def workflow_permissions_configuration=(input)
+        @workflow_permissions_configuration = Array.wrap(input)
+      end
 
       public
 
@@ -36,14 +37,14 @@ module Hyrax
 
       private
 
-        def find_or_create_workflow_permissions!
-          # In Sipity application, Agents were assigned in the configuration file.
-          # However this is something assigned via a UI component for a given role.
-          default_agents = []
-          workflow_permissions_configuration.each do |configuration|
-            PermissionGenerator.call(agents: default_agents, roles: configuration.fetch(:role), workflow: workflow)
-          end
+      def find_or_create_workflow_permissions!
+        # In Sipity application, Agents were assigned in the configuration file.
+        # However this is something assigned via a UI component for a given role.
+        default_agents = []
+        workflow_permissions_configuration.each do |configuration|
+          PermissionGenerator.call(agents: default_agents, roles: configuration.fetch(:role), workflow: workflow)
         end
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for describing the JSON schema for a Workflow.
@@ -14,48 +15,41 @@ module Hyrax
     # @see Sipity::Notification
     # @see Sipity::Method
     # @see ./lib/generators/hyrax/templates/workflow.json.erb
-    WorkflowSchema = Dry::Validation.Schema do
-      configure do
-        def self.messages
-          Dry::Validation::Messages.default.merge(
-            en: { errors: { constant_name?: 'must be an initialized Ruby constant' } }
-          )
-        end
+    class WorkflowSchema < Dry::Validation::Contract
+      class Types
+        include Dry::Types()
 
-        def constant_name?(value)
-          value.constantize
-          true
-        rescue NameError
-          false
+        Constant = Types::Class.constructor do |v|
+          begin
+            v.constantize
+          rescue NameError => _err
+            v
+          end
         end
       end
 
-      required(:workflows).each do
-        required(:name).filled(:str?) # Sipity::Workflow#name
-        optional(:label).filled(:str?) # Sipity::Workflow#label
-        optional(:description).filled(:str?) # Sipity::Workflow#description
-        optional(:allows_access_grant).filled(:bool?) # Sipity::Workflow#allows_access_grant?
-        required(:actions).each do
-          schema do
-            required(:name).filled(:str?) # Sipity::WorkflowAction#name
-            required(:from_states).each do
-              schema do
-                required(:names) { array? { each(:str?) } } # Sipity::WorkflowState#name
-                required(:roles) { array? { each(:str?) } } # Sipity::Role#name
-              end
+      params do
+        required(:workflows).array(:hash) do
+          required(:name).filled(:string) # Sipity::Workflow#name
+          optional(:label).filled(:string) # Sipity::Workflow#label
+          optional(:description).filled(:string) # Sipity::Workflow#description
+          optional(:allows_access_grant).filled(:bool) # Sipity::Workflow#allows_access_grant?
+          required(:actions).array(:hash) do
+            required(:name).filled(:string) # Sipity::WorkflowAction#name
+            required(:from_states).array(:hash) do
+              required(:names) { array? { each(:string) } } # Sipity::WorkflowState#name
+              required(:roles) { array? { each(:string) } } # Sipity::Role#name
             end
-            optional(:transition_to).filled(:str?) # Sipity::WorkflowState#name
-            optional(:notifications).each do
-              schema do
-                required(:name).value(:constant_name?) # Sipity::Notification#name
-                required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
-                required(:to) { array? { each(:str?) } }
-                optional(:cc) { array? { each(:str?) } }
-                optional(:bcc) { array? { each(:str?) } }
-              end
+            optional(:transition_to).filled(:string) # Sipity::WorkflowState#name
+            optional(:notifications).array(:hash) do
+              required(:name).value(Types::Constant) # Sipity::Notification#name
+              required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
+              required(:to) { array? { each(:string) } }
+              optional(:cc) { array? { each(:string) } }
+              optional(:bcc) { array? { each(:string) } }
             end
-            optional(:methods) { array? { each(:str?) } } # See it_behaves_like "a Hyrax workflow method"
           end
+          optional(:methods) { array? { each(:string) } } # See it_behaves_like "a Hyrax workflow method"
         end
       end
     end