rails_workflow 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55fcad55bd2c2781da1a5af94e1bc0d4ebe57b9d
-  data.tar.gz: 562678cf4dd8eb9d71061d4148e0e1036ce4d5de
+  metadata.gz: c07990497523e329c81feb05d053eb3954244513
+  data.tar.gz: 4a0ff979e6fa4d83a589ac544594949b6148f9b3
 SHA512:
-  metadata.gz: 8ab16df3b4cbf71908f5772f2d8e66a8b3a4967e82b443cde4fac6ee6a07ce63f44a859095fb5062de5dcad2046523c5d3816e3697ffba243f526a647d84af97
-  data.tar.gz: 399aad732c6156c502327ed1cd0a31fbb0200728d61174a88c195ac63d4c2bd93d27811fcfbdabdfaae65a2af17319cc604365be01b089d00796f68997fc638b
+  metadata.gz: e9b13eb3223068b3db3fbbad1a2f1a42fb33f9af89f1eb9809911bb1b4b284188c6ae5b36b8e95a4c3043a8a36e365861a7d586d5754c7738513fd13226f35df
+  data.tar.gz: 3adbc1f3b1a9547aa6dc43e085e42800433ff148115f252499d1966af8088387a2cf3ff18d70514eba45e0499786070ed2f25f2883af305ebb68224f46ff11f0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError

data/app/concerns/rails_workflow/operation_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module RailsWorkflow

data/app/concerns/rails_workflow/operation_templates/assignments.rb

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 module RailsWorkflow
   module OperationTemplates
     module Assignments
@@ -6,7 +8,7 @@ module RailsWorkflow
 
       included do
         belongs_to :assignment, polymorphic: true
-        scope :for_user, -> (user) {
+        scope :for_user, ->(user) {
           keys = RailsWorkflow.config.assignment_by.select { |k| user.respond_to? k }
 
           assignment_condition = keys.map do |key|

data/app/concerns/rails_workflow/operation_templates/dependencies.rb

@@ -1,34 +1,34 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module RailsWorkflow
   module OperationTemplates
-    # = Workflow::ProcessTemplate::Dependenceis
-    #
-    # Operation dependencies is a set of conditions. Operation can be build if all that
-    # dependenceis / conditions are satisfied. This is default implementation of dependenceis
-    # which used to build operation dependency on other operations. You can customize dependency
-    # for example you can add some additional logic depending on existiong processes / operations
-    # or other conditions in your system.
-    #
-
+    # Dependencies defines which operations in which states should be.
     module Dependencies
       extend ActiveSupport::Concern
 
       included do
         serialize :dependencies, JSON
+        scope :independent_only, lambda {
+          where(
+            "dependencies is null or dependencies = 'null' or dependencies='[]'"
+          )
+        }
 
-        def independent?
-          dependencies.nil? || dependencies.empty? || dependencies == 'null'
-        end
-
-        def resolve_dependency(_operation)
+        # When some operation changes its status engine tries to
+        # resolve dependencies to understand if a new operation
+        # should be created.
+        # For example, if operation A depends on B (DONE) and C (DONE),
+        # by default it will be created if any of B or C changed status
+        # to DONE.
+        # Overwriting this method on some specific operation template
+        # allows you to modify this logic - for example, to build
+        # dependency B (DONE) AND C(DONE) etc.
+        def resolve_dependency(_completed_operation)
           true
         end
 
-        # def dependencies=(dependencies)
-        #   write_attribute(:dependencies, dependencies.to_json.to_s)
-        # end
-        #
         def dependencies
           read_attribute(:dependencies) || []
         end

data/app/concerns/rails_workflow/operations/assignments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   module Operations
     module Assignments
@@ -6,22 +8,22 @@ module RailsWorkflow
       included do
         belongs_to :assignment, polymorphic: true
 
-        scope :by_role, -> (role) { joins(:template).where(rails_workflow_operation_templates: { role: role }) }
-        scope :by_group, -> (group) { joins(:template).where(rails_workflow_operation_templates: { group: group }) }
+        scope :by_role, ->(role) { joins(:template).where(rails_workflow_operation_templates: { role: role }) }
+        scope :by_group, ->(group) { joins(:template).where(rails_workflow_operation_templates: { group: group }) }
         scope :unassigned, -> { where(assignment_id: nil) }
 
         scope :waiting, -> { where(status: Operation.user_ready_statuses) }
 
-        scope :available_for_user, -> (user) {
+        scope :available_for_user, ->(user) {
           waiting.unassigned.joins(:template)
                  .merge(OperationTemplate.for_user(user))
         }
 
-        scope :by_role_or_group, -> (role, group) do
+        scope :by_role_or_group, ->(role, group) do
           joins(:template).by_role_or_group(role, group)
         end
 
-        scope :assigned_to, -> (user) {
+        scope :assigned_to, ->(user) {
           where(assignment_id: user.id, assignment_type: user.class.to_s)
         }
 

data/app/concerns/rails_workflow/operations/dependencies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module RailsWorkflow

data/app/concerns/rails_workflow/status.rb

@@ -1,6 +1,7 @@
-require 'active_support/concern'
+# frozen_string_literal: true
 
 module RailsWorkflow
+  # Describes process and operation statuses
   module Status
     extend ActiveSupport::Concern
 
@@ -18,24 +19,19 @@ module RailsWorkflow
         (NOT_STARTED..ROLLBACK).to_a
       end
 
-      def get_status_code(status)
-        case status
-        when 'in_progress'
-          IN_PROGRESS
-        when 'done'
-          DONE
-        when 'not_started'
-          NOT_STARTED
-        when 'waiting'
-          WAITING
-        when 'error'
-          ERROR
-        end
+      def status_code_for(status)
+        [
+          ['in_progress', IN_PROGRESS],
+          ['done', DONE],
+          ['not_started', NOT_STARTED],
+          ['waiting', WAITING],
+          ['error', ERROR]
+        ].assoc(status).last
       end
     end
 
     included do
-      def incomplete_statuses
+      def uncompleted_statuses
         [NOT_STARTED, IN_PROGRESS, WAITING]
       end
 

data/app/concerns/rails_workflow/user/assignment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   module User
     module Assignment

data/app/concerns/rails_workflow/uuid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow::Uuid
   extend ActiveSupport::Concern
 

data/app/controllers/rails_workflow/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ApplicationController < ::ApplicationController
   end

data/app/controllers/rails_workflow/errors_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ErrorsController < ApplicationController
     def retry

data/app/controllers/rails_workflow/operation_templates_controller.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class OperationTemplatesController < ApplicationController
     layout 'rails_workflow/application'
-    before_action :set_operation_template, only: [:show, :edit, :update, :destroy]
+    before_action :set_operation_template, only: %i[show edit update destroy]
     before_action :set_process_template
     respond_to :html
 

data/app/controllers/rails_workflow/operations_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   # Operations controller. Allows to pickup (start),
   # skip, postpone, cancel, complete operations.
@@ -6,7 +8,7 @@ module RailsWorkflow
     respond_to :html
 
     before_action :set_operation,
-                  only: [:show, :edit, :pickup, :continue, :update, :destroy]
+                  only: %i[show edit pickup continue update destroy]
 
     before_filter do
       if @process.present?

data/app/controllers/rails_workflow/process_templates_controller.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ProcessTemplatesController < ApplicationController
     layout 'rails_workflow/application'
     respond_to :html, :json
 
-    before_action :set_process_template, only: [:show, :edit, :update, :destroy]
+    before_action :set_process_template, only: %i[show edit update destroy]
 
     before_filter do
       @config_section_active = true
@@ -56,13 +58,13 @@ module RailsWorkflow
 
     def permitted_params
       params.permit(
-        process_template: [
-          :title,
-          :source,
-          :manager_class,
-          :partial_name,
-          :process_class,
-          :type
+        process_template: %i[
+          title
+          source
+          manager_class
+          partial_name
+          process_class
+          type
         ]
       )[:process_template]
     end

data/app/controllers/rails_workflow/processes_controller.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ProcessesController < ApplicationController
     layout 'rails_workflow/application'
     respond_to :html
-    before_action :set_process, only: [:show, :edit, :update, :destroy]
+    before_action :set_process, only: %i[show edit update destroy]
 
     before_filter do
       @processes_section_active = true
@@ -17,7 +19,7 @@ module RailsWorkflow
 
       @open_user_operations = OperationDecorator
                               .decorate_collection(
-                                RailsWorkflow::Operation.incompleted
+                                RailsWorkflow::Operation.uncompleted
                                     .unassigned.includes(:template)
                                     .limit(20)
                               )
@@ -54,11 +56,11 @@ module RailsWorkflow
 
     def permitted_params
       params.permit(
-        process: [
-          :status,
-          :async,
-          :title,
-          :template_id
+        process: %i[
+          status
+          async
+          title
+          template_id
         ],
         filter: [:status]
       )[:process]
@@ -68,7 +70,7 @@ module RailsWorkflow
       collection_scope = Process.default_scoped
 
       if params[:filter]
-        status = Process.get_status_code(params[:filter]['status'])
+        status = Process.status_code_for(params[:filter]['status'])
         collection_scope = collection_scope.by_status(status)
       end
 

data/app/decorators/rails_workflow/context_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ContextDecorator < Draper::Decorator
     def partial_name

data/app/decorators/rails_workflow/decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class Decorator < Draper::Decorator
     def self.collection_decorator_class

data/app/decorators/rails_workflow/operation_decorator.rb

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 module RailsWorkflow
   class OperationDecorator < OperationHelperDecorator
     delegate_all

data/app/decorators/rails_workflow/operation_helper_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class OperationHelperDecorator < Decorator
     include StatusDecorator

data/app/decorators/rails_workflow/operation_template_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class OperationTemplateDecorator < Decorator
     delegate_all

data/app/decorators/rails_workflow/paginating_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class PaginatingDecorator < Draper::CollectionDecorator
     delegate :current_page, :per_page, :offset, :total_entries, :total_pages

data/app/decorators/rails_workflow/process_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ProcessDecorator < Decorator
     include StatusDecorator

data/app/decorators/rails_workflow/process_template_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class ProcessTemplateDecorator < Decorator
     delegate_all

data/app/decorators/rails_workflow/status_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   module StatusDecorator
     extend ActiveSupport::Concern

data/app/helpers/rails_workflow/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   module ApplicationHelper
   end

data/app/jobs/rails_workflow/operation_execution_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   # Rails workflow operation can run in background
   # (if is_background = true). This job is responsible
@@ -9,7 +11,15 @@ module RailsWorkflow
       operation_id = args[0]
 
       operation = Operation.find operation_id
-      operation.execute_in_transaction
+      operation_runner.new(operation).execute_in_transaction
+    end
+
+    def config
+      RailsWorkflow.config
+    end
+
+    def operation_runner
+      config.operation_runner
     end
   end
 end

data/app/models/rails_workflow/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
   class Context < ActiveRecord::Base
     belongs_to :parent, polymorphic: true
@@ -23,7 +25,7 @@ module RailsWorkflow
         end
       elsif body.is_a? Hash
 
-        if body.keys == %w(id class)
+        if body.keys == %w[id class]
           body['class'].constantize.find(body['id'])
         else
           res = {}

data/app/models/rails_workflow/error.rb

@@ -1,70 +1,43 @@
+# frozen_string_literal: true
+
 module RailsWorkflow
+  # Stores error information
   class Error < ActiveRecord::Base
     belongs_to :parent, polymorphic: true
     has_one :context, class_name: 'RailsWorkflow::Context', as: :parent
     scope :unresolved, -> { where('resolved is null or resolved = false') }
 
     delegate :data, to: :context
+    delegate :retry, to: :error_resolver
 
-    def retry
-      update_attribute(:resolved, true)
-
-      target = data[:target]
-      method = data[:method]
-      args = data[:args]
-
-      target.send(method, *args)
-
-      operation = parent if parent.is_a? RailsWorkflow::Operation
-
-      process = if operation
-                  operation.process
-                elsif target.is_a? RailsWorkflow::Process
-                  target
-                elsif parent.is_a? RailsWorkflow::Process
-                  parent
-                end
-
-      if operation.present?
-        operation.reload
-        if operation.status == RailsWorkflow::Operation::ERROR
-          operation.update_attribute(
-            :status,
-            RailsWorkflow::Operation::NOT_STARTED
-          )
-        end
-      end
-
-      if process.present? && can_restart_process(process)
-        process.update_attribute(:status, RailsWorkflow::Process::IN_PROGRESS)
-        process.start
-      end
+    def can_restart_process?
+      process.unresolved_errors.count.zero?
     end
 
-    def can_restart_process(process)
-      process.workflow_errors
-             .unresolved.where.not(id: id).count.zero?
+    def target
+      data[:target]
     end
 
-    def self.create_from(exception, context)
-      parent = context[:parent]
+    def operation
+      parent if parent.is_a? RailsWorkflow::Operation
+    end
 
-      if parent.is_a? RailsWorkflow::Operation
-        correct_parent = parent.becomes(RailsWorkflow::Operation)
+    def process
+      if operation
+        operation.process
+      elsif target.is_a? RailsWorkflow::Process
+        target
       elsif parent.is_a? RailsWorkflow::Process
-        correct_parent = parent.becomes(RailsWorkflow::Process)
+        parent
       end
+    end
 
-      error = RailsWorkflow::Error.create(
-        parent_id: parent.id,
-        parent_type: (correct_parent || parent).class.to_s,
-        message: exception.message.first(250),
-        stack_trace: exception.backtrace.join("<br/>\n")
-      )
-
-      error.create_context(data: context)
+    def config
+      RailsWorkflow.config
+    end
 
-      RailsWorkflow::OperationErrorJob.new.perform(parent.id, parent.class.to_s)
+    def error_resolver
+      @error_resolver ||= config.error_resolver.new(self)
     end
   end
 end