rails_workflow 0.3.9 → 0.4.0

data/lib/generators/rails_workflow/install/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators/migration'
 
 module RailsWorkflow

data/lib/generators/rails_workflow/install/templates/create_workflow_processes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateWorkflowProcesses < ActiveRecord::Migration
   def change
     create_tables
@@ -8,12 +10,12 @@ class CreateWorkflowProcesses < ActiveRecord::Migration
 
   def create_tables
     [
-      [:workflow_processes, :rails_workflow_processes],
-      [:workflow_operations, :rails_workflow_operations],
-      [:workflow_process_templates, :rails_workflow_process_templates],
-      [:workflow_operation_templates, :rails_workflow_operation_templates],
-      [:workflow_contexts, :rails_workflow_contexts],
-      [:workflow_errors, :rails_workflow_errors]
+      %i[workflow_processes rails_workflow_processes],
+      %i[workflow_operations rails_workflow_operations],
+      %i[workflow_process_templates rails_workflow_process_templates],
+      %i[workflow_operation_templates rails_workflow_operation_templates],
+      %i[workflow_contexts rails_workflow_contexts],
+      %i[workflow_errors rails_workflow_errors]
     ].map do |names|
       rename_table names[0], names[1] if table_exists? names[0]
 
@@ -23,13 +25,13 @@ class CreateWorkflowProcesses < ActiveRecord::Migration
 
   def create_indexes
     [
-      [:rails_workflow_contexts, [:parent_id, :parent_type]],
-      [:rails_workflow_errors, [:parent_id, :parent_type]],
-      [:rails_workflow_operation_templates, :process_template_id],
-      [:rails_workflow_operation_templates, :uuid],
-      [:rails_workflow_process_templates, :uuid],
-      [:rails_workflow_operations, :process_id],
-      [:rails_workflow_operations, :template_id]
+      [:rails_workflow_contexts, %i[parent_id parent_type]],
+      [:rails_workflow_errors, %i[parent_id parent_type]],
+      %i[rails_workflow_operation_templates process_template_id],
+      %i[rails_workflow_operation_templates uuid],
+      %i[rails_workflow_process_templates uuid],
+      %i[rails_workflow_operations process_id],
+      %i[rails_workflow_operations template_id]
     ].each do |idx|
       add_index idx[0], idx[1] unless index_exists? idx[0], idx[1]
     end
@@ -38,92 +40,92 @@ class CreateWorkflowProcesses < ActiveRecord::Migration
   def create_columns
     {
       rails_workflow_contexts: [
-        [:integer,  :parent_id],
-        [:string,   :parent_type],
-        [:text,     :body],
-        [:datetime, :created_at],
-        [:datetime, :updated_at]
+        %i[integer parent_id],
+        %i[string parent_type],
+        %i[text body],
+        %i[datetime created_at],
+        %i[datetime updated_at]
       ],
 
       rails_workflow_errors: [
-        [:string,   :message],
-        [:text, :stack_trace],
-        [:integer,  :parent_id],
-        [:string,   :parent_type],
-        [:datetime, :created_at],
-        [:datetime, :updated_at],
-        [:boolean,  :resolved]
+        %i[string message],
+        %i[text stack_trace],
+        %i[integer parent_id],
+        %i[string parent_type],
+        %i[datetime created_at],
+        %i[datetime updated_at],
+        %i[boolean resolved]
       ],
 
       rails_workflow_operation_templates: [
-        [:string,   :title],
-        [:string, :version],
-        [:string, :uuid],
-        [:string,   :tag],
-        [:text,     :source],
-        [:text,     :dependencies],
-        [:string,   :operation_class],
-        [:integer,  :process_template_id],
-        [:datetime, :created_at],
-        [:datetime, :updated_at],
-        [:boolean,  :async],
-        [:integer,  :child_process_id],
-        [:integer,  :assignment_id],
-        [:string,   :assignment_type],
-        [:string,   :kind],
-        [:string,   :role],
-        [:string,   :group],
-        [:text,     :instruction],
-        [:boolean,  :is_background],
-        [:string,   :type],
-        [:string,   :partial_name]
+        %i[string title],
+        %i[string version],
+        %i[string uuid],
+        %i[string tag],
+        %i[text source],
+        %i[text dependencies],
+        %i[string operation_class],
+        %i[integer process_template_id],
+        %i[datetime created_at],
+        %i[datetime updated_at],
+        %i[boolean async],
+        %i[integer child_process_id],
+        %i[integer assignment_id],
+        %i[string assignment_type],
+        %i[string kind],
+        %i[string role],
+        %i[string group],
+        %i[text instruction],
+        %i[boolean is_background],
+        %i[string type],
+        %i[string partial_name]
       ],
 
       rails_workflow_operations: [
-        [:integer,  :status],
-        [:boolean,  :async],
-        [:string,   :version],
-        [:string,   :tag],
-        [:string,   :title],
-        [:datetime, :created_at],
-        [:datetime, :updated_at],
-        [:integer,  :process_id],
-        [:integer,  :template_id],
-        [:text,     :dependencies],
-        [:integer,  :child_process_id],
-        [:integer,  :assignment_id],
-        [:string,   :assignment_type],
-        [:datetime, :assigned_at],
-        [:string,   :type],
-        [:boolean,  :is_active],
-        [:datetime, :completed_at],
-        [:boolean,  :is_background]
+        %i[integer status],
+        %i[boolean async],
+        %i[string version],
+        %i[string tag],
+        %i[string title],
+        %i[datetime created_at],
+        %i[datetime updated_at],
+        %i[integer process_id],
+        %i[integer template_id],
+        %i[text dependencies],
+        %i[integer child_process_id],
+        %i[integer assignment_id],
+        %i[string assignment_type],
+        %i[datetime assigned_at],
+        %i[string type],
+        %i[boolean is_active],
+        %i[datetime completed_at],
+        %i[boolean is_background]
       ],
 
       rails_workflow_process_templates: [
-        [:string,   :title],
-        [:text,     :source],
-        [:string,   :uuid],
-        [:string,   :version],
-        [:string,   :tag],
-        [:string,   :manager_class],
-        [:string,   :process_class],
-        [:datetime, :created_at],
-        [:datetime, :updated_at],
-        [:string,   :type],
-        [:string,   :partial_name]
+        %i[string title],
+        %i[text source],
+        %i[string uuid],
+        %i[string version],
+        %i[string tag],
+        %i[string manager_class],
+        %i[string process_class],
+        %i[datetime created_at],
+        %i[datetime updated_at],
+        %i[string type],
+        %i[string partial_name]
       ],
 
       rails_workflow_processes: [
-        [:integer,  :status],
-        [:string,   :version],
-        [:string,   :tag],
-        [:boolean,  :async],
-        [:string,   :title],
-        [:datetime, :created_at],
-        [:datetime, :updated_at],
-        [:integer,  :template_id],
-        [:string,   :type]
+        %i[integer status],
+        %i[string version],
+        %i[string tag],
+        %i[boolean async],
+        %i[string title],
+        %i[datetime created_at],
+        %i[datetime updated_at],
+        %i[integer template_id],
+        %i[string type]
       ]
     }.each do |table, columns|
       columns.map do |column|

data/lib/rails_workflow/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'guid'
 require 'bootstrap-rails-engine'
@@ -7,40 +9,50 @@ require 'draper'
 require 'sidekiq'
 require 'active_model_serializers'
 require 'rails_workflow/db/mysql'
+require_relative './error_builder'
+require_relative './error_resolver'
+require_relative './process_builder'
+require_relative './operation_builder'
+require_relative './process_runner'
+require_relative './operation_runner'
+require_relative './dependency_resolver'
+require_relative './process_manager'
 require 'rails_workflow/db/pg'
 
 module RailsWorkflow
+  # Engine configuration. Allows to set default or custom classes
+  # and other engine settings.
   class Config
     include Singleton
 
-    attr_accessor :operation_types, :activejob_enabled
-    attr_writer :sql_dialect, :assignment_by, :import_preprocessor, :process_class
-    attr_reader :cache
+    attr_accessor :operation_types
+    attr_accessor :activejob_enabled
 
-    def initialize
-      @default_operation_types = {
-        default: {
-          title: 'Default Operation',
-          class: 'RailsWorkflow::Operation'
-        },
-        user_role: {
-          title: 'Operation for User By Role',
-          class: 'RailsWorkflow::UserByRoleOperation'
-        },
-        user_group: {
-          title: 'Operation by User Group',
-          class: 'RailsWorkflow::UserByGroupOperation'
-        }
-      }
-      @default_import_preprocessor = 'RailsWorkflow::DefaultImporterPreprocessor'
+    def initialize # rubocop: disable Metrics/MethodLength
+      init_default_operation_types
+      # TODO: rework
+      @default_assignment_by = %i[group role]
+
+      @default_import_preprocessor =
+        'RailsWorkflow::DefaultImporterPreprocessor'
       @default_operation_template_type = 'RailsWorkflow::OperationTemplate'
       @default_process_manager = 'RailsWorkflow::ProcessManager'
+      @default_process_builder = 'RailsWorkflow::ProcessBuilder'
+      @default_operation_builder = 'RailsWorkflow::OperationBuilder'
+      @default_error_builder = 'RailsWorkflow::ErrorBuilder'
+      @default_error_resolver = 'RailsWorkflow::ErrorResolver'
       @default_process_class = 'RailsWorkflow::Process'
       @default_process_template_type = 'RailsWorkflow::ProcessTemplate'
-      @default_assignment_by = [:group, :role]
+
       @default_sql_dialect = 'pg'
+      @default_process_runner = 'RailsWorkflow::ProcessRunner'
+      @default_operation_runner = 'RailsWorkflow::OperationRunner'
+      @default_dependency_resolver = 'RailsWorkflow::DependencyResolver'
     end
 
+    # TODO: rework defaults
+
+    attr_writer :sql_dialect
     def sql_dialect
       case @sql_dialect || @default_sql_dialect
       when 'pg'
@@ -50,6 +62,7 @@ module RailsWorkflow
       end
     end
 
+    attr_writer :assignment_by
     def assignment_by
       @assignment_by || @default_assignment_by
     end
@@ -58,10 +71,13 @@ module RailsWorkflow
       @default_operation_types.merge(@operation_types || {})
     end
 
+    # TODO: fix
     def operation_template_klass=(value)
       @operation_template_type = value
     end
 
+    attr_writer :import_preprocessor
+
     def import_preprocessor
       processor = @import_preprocessor || @default_import_preprocessor
       processor.constantize.new
@@ -79,6 +95,8 @@ module RailsWorkflow
       @process_manager || @default_process_manager
     end
 
+    attr_writer :process_class
+
     def process_template_klass=(value)
       @process_template_type = value
     end
@@ -91,10 +109,33 @@ module RailsWorkflow
       @process_template_type || @default_process_template_type
     end
 
-    # template_id - Process Template Id
-    def template(template_id)
-      @cache ||= {}
-      @cache[template_id.to_i] ||= RailsWorkflow::ProcessTemplate.eager_load(:operations).find(template_id)
+    def process_manager
+      # Todo add custom managers support
+      ProcessManager
+    end
+
+    %i[dependency_resolver operation_runner process_runner
+       operation_builder process_builder error_builder error_resolver]
+      .each do |key|
+        instance_eval { attr_writer key }
+        class_eval <<-METHOD
+          def #{key}
+            (@#{key} || @default_#{key}).constantize
+          end
+        METHOD
+      end
+
+    private
+
+    def init_default_operation_types
+      @default_operation_types = {
+        default:    { title: 'Default Operation',
+                      class: 'RailsWorkflow::Operation' },
+        user_role:  { title: 'Operation for User By Role',
+                      class: 'RailsWorkflow::UserByRoleOperation' },
+        user_group: { title: 'Operation by User Group',
+                      class: 'RailsWorkflow::UserByGroupOperation' }
+      }
     end
   end
 end

data/lib/rails_workflow/db/mysql.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   module Db
     module Mysql
-      COUNT_STATUSES = <<-SQL.freeze
+      COUNT_STATUSES = <<-SQL
       SELECT status, cnt FROM
                (
                     SELECT @row_number:=CASE

data/lib/rails_workflow/db/pg.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   module Db
     module Pg
-      COUNT_STATUSES = <<-SQL.freeze
+      COUNT_STATUSES = <<-SQL
       select status, cnt from (
         select row_number() over (partition by status),
           count(*) over (partition by status) cnt,

data/lib/rails_workflow/dependency_resolver.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RailsWorkflow
+  # DependencyResolver
+  #
+  # New operation can be added to process if all it's dependencies
+  # are satisfied. For example current operation can depend on some
+  # existing process operation which should be completed - then current
+  # operation can be build
+  class DependencyResolver
+    attr_accessor :process
+
+    delegate :template, :operations, :uncompleted_statuses, to: :process
+
+    def initialize(process)
+      @process = process
+    end
+
+    def build_new_operations(operation)
+      [].tap do |new_operations|
+        matched_templates(operation).each do |operation_template|
+          completed_dependencies = [operation]
+
+          new_operations << operation_builder.new(
+            process, operation_template, completed_dependencies
+          ).create_operation
+        end
+      end.compact
+    rescue => exception
+      handle_exception(exception, operation)
+    end
+
+    private
+
+    def handle_exception(exception, operation)
+      error_builder.handle(
+        exception,
+        parent: process, target: :dependency_resolver,
+        method: :build_new_operations, args: [operation]
+      )
+    end
+
+    def error_builder
+      config.error_builder
+    end
+
+    def config
+      RailsWorkflow.config
+    end
+
+    def operation_runner
+      config.operation_runner
+    end
+
+    def operation_builder
+      config.operation_builder
+    end
+
+    def matched_templates(operation)
+      (dependent_templates(operation) - already_built_templates)
+        .select do |operation_template|
+          operation_template.resolve_dependency operation
+        end
+    end
+
+    def dependent_templates(operation)
+      template.dependent_operations(operation)
+    end
+
+    def already_built_templates
+      operations.map(&:template)
+    end
+  end
+end