Skip to content

Commit 9ccd403

Browse files
TSS-35: Rename UserTask to StaffTask (#78)
- Renamed UserTask class to StaffTask - Renamed UserTaskCreationService to StaffTaskCreationService - Updated all references in documentation and example code --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Loren Yu <loren@navapbc.com>
1 parent 3a97375 commit 9ccd403

6 files changed

Lines changed: 25 additions & 25 deletions

File tree

app/models/flex/business_process.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ module Flex
66
#
77
# @example Defining a basic business process in app/business_processes/my_business_process.rb
88
# MyBusinessProcess = Flex::BusinessProcess.define(:my_process, MyCase) do |bp|
9-
# # Define steps - can be UserTask or SystemProcess
9+
# # Define steps - can be StaffTask or SystemProcess
1010
# bp.step('collect_info',
11-
# Flex::UserTask.new("Collect Information", TaskCreationService))
11+
# Flex::StaffTask.new("Collect Information", TaskCreationService))
1212
#
1313
# bp.step('process_data',
1414
# Flex::SystemProcess.new("Process Data", ->(kase) {
@@ -24,7 +24,7 @@ module Flex
2424
# end
2525
#
2626
# Steps can be either:
27-
# - UserTask: Tasks that require human interaction, created through a TaskCreationService
27+
# - StaffTask: Tasks that require human interaction, created through a TaskCreationService
2828
# - SystemProcess: Automated tasks that run without user intervention, defined with a callable
2929
#
3030
# The process automatically listens for events and transitions between steps
@@ -33,7 +33,7 @@ module Flex
3333
#
3434
# Event payloads must contain either case_id or application_form_id to identify the case.
3535
#
36-
# @see Flex::UserTask
36+
# @see Flex::StaffTask
3737
# @see Flex::SystemProcess
3838
#
3939
# Key Methods:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module Flex
2-
class UserTask
2+
class StaffTask
33
include Step
44

55
attr_accessor :name, :task_management_service

spec/dummy/app/business_processes/passport_business_process.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
PassportBusinessProcess = Flex::BusinessProcess.define(:passport, PassportCase) do |bp|
22
# Define steps
33
bp.step('collect_application_info',
4-
Flex::UserTask.new("Collect App Info", UserTaskCreationService))
4+
Flex::StaffTask.new("Collect App Info", StaffTaskCreationService))
55

66
bp.step('verify_identity',
77
Flex::SystemProcess.new("Verify Identity", ->(kase) {
88
IdentityVerificationService.new(kase).verify_identity
99
}))
1010

1111
bp.step('manual_adjudicator_review',
12-
Flex::UserTask.new("Manual Adjudicator Review", AdjudicatorTaskCreationService))
12+
Flex::StaffTask.new("Manual Adjudicator Review", AdjudicatorTaskCreationService))
1313

1414
bp.step('review_passport_photo',
1515
Flex::SystemProcess.new("Review Passport Photo", ->(kase) {
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
TestBusinessProcess = Flex::BusinessProcess.define(:test, TestCase) do |bp|
22
# Define steps
3-
bp.step('user_task',
4-
Flex::UserTask.new("user_task", UserTaskCreationService))
3+
bp.step('staff_task',
4+
Flex::StaffTask.new("staff_task", StaffTaskCreationService))
55

66
bp.step('system_process',
77
Flex::SystemProcess.new("system_process", ->(kase) {
88
Flex::EventManager.publish("event2", { case_id: kase.id })
99
}))
1010

11-
bp.step('user_task_2',
12-
Flex::UserTask.new("user_task_2", UserTaskCreationService))
11+
bp.step('staff_task_2',
12+
Flex::StaffTask.new("staff_task_2", StaffTaskCreationService))
1313

1414
bp.step('system_process_2',
1515
Flex::SystemProcess.new("system_process_2", ->(kase) {
1616
Flex::EventManager.publish("event4", { case_id: kase.id })
1717
}))
1818

1919
# Define start step
20-
bp.start('user_task')
20+
bp.start('staff_task')
2121

2222
# Define transitions
23-
bp.transition('user_task', 'event1', 'system_process')
24-
bp.transition('system_process', 'event2', 'user_task_2')
25-
bp.transition('user_task_2', 'event3', 'system_process_2')
23+
bp.transition('staff_task', 'event1', 'system_process')
24+
bp.transition('system_process', 'event2', 'staff_task_2')
25+
bp.transition('staff_task_2', 'event3', 'system_process_2')
2626
bp.transition('system_process_2', 'event4', 'end')
2727
end

spec/dummy/app/services/user_task_creation_service.rb renamed to spec/dummy/app/services/staff_task_creation_service.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
class UserTaskCreationService
1+
class StaffTaskCreationService
22
include Flex::TaskHandlerService
33

44
def self.create_task(kase:)

spec/models/flex/business_process_spec.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616

1717
describe '#handle_event' do
1818
before do
19-
kase.business_process_current_step = 'user_task'
19+
kase.business_process_current_step = 'staff_task'
2020
kase.save!
2121
end
2222

2323
it 'executes the complete process chain' do
2424
Flex::EventManager.publish('event1', { case_id: kase.id })
2525
# system_process automatically publishes event2
2626
kase.reload
27-
expect(kase.business_process_current_step).to eq('user_task_2')
27+
expect(kase.business_process_current_step).to eq('staff_task_2')
2828

2929
Flex::EventManager.publish('event3', { case_id: kase.id })
3030
# system_process_2 automatically publishes event4
@@ -38,15 +38,15 @@
3838
[ 'event2', 'event3', 'event4' ].each do |event|
3939
Flex::EventManager.publish(event, { case_id: kase.id })
4040
end
41-
expect(kase.business_process_current_step).to eq('user_task')
41+
expect(kase.business_process_current_step).to eq('staff_task')
4242
end
4343

4444
it 'does not re-execute the current step' do
45-
allow(UserTaskCreationService).to receive(:create_task)
45+
allow(StaffTaskCreationService).to receive(:create_task)
4646
[ 'event2', 'event3', 'event4' ].each do |event|
4747
Flex::EventManager.publish(event, { case_id: kase.id })
4848
end
49-
expect(UserTaskCreationService).not_to have_received(:create_task)
49+
expect(StaffTaskCreationService).not_to have_received(:create_task)
5050
end
5151
end
5252
end
@@ -61,20 +61,20 @@
6161
business_process.stop_listening_for_events
6262

6363
# Try publishing various events
64-
kase.business_process_current_step = 'user_task'
64+
kase.business_process_current_step = 'staff_task'
6565
kase.save!
6666

6767
Flex::EventManager.publish('event1', { case_id: kase.id })
6868
kase.reload
69-
expect(kase.business_process_current_step).to eq('user_task') # Should not change
69+
expect(kase.business_process_current_step).to eq('staff_task') # Should not change
7070

7171
Flex::EventManager.publish('event2', { case_id: kase.id })
7272
kase.reload
73-
expect(kase.business_process_current_step).to eq('user_task') # Should not change
73+
expect(kase.business_process_current_step).to eq('staff_task') # Should not change
7474

7575
Flex::EventManager.publish('event3', { case_id: kase.id })
7676
kase.reload
77-
expect(kase.business_process_current_step).to eq('user_task') # Should not change
77+
expect(kase.business_process_current_step).to eq('staff_task') # Should not change
7878
end
7979
end
8080
end

0 commit comments

Comments
 (0)