standard_procedure_operations 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5804e91c48ca11b9306c1d8d2c3006df7916dcd3e768629cf492b1daa409725
-  data.tar.gz: 2c0f4a513bb1bd685f44daf46f28e7ecb2ac0909a703ae79240ff0587fc74d1c
+  metadata.gz: 462512e945573c5809f480e318e03c17a15604e8f8362934d2c730f2827f54a5
+  data.tar.gz: 3446e47c75e17db5384b8ba8a86a5740fbd095ea6a3f57ae6eb9d05dbac50e1c
 SHA512:
-  metadata.gz: 1f8335c58e7df31046d08ab67cf99d7bf1cd0a1a52aa24433b79932f418c9d0de945d702d7039eabb6e66ed4a94484a2aa3d9bdb415d60859b9007feff9c64e2
-  data.tar.gz: 8cb8aa2940d5b4658582c14aef3db7d715c3c6af2f66b1bd838514ad11e67a6edbc8a9b95eb9cd8e57fc8293156365acaf95e017d8d13572fe5d1259c2b27269
+  metadata.gz: 442ba282285358dc7baa1bbd9f00a4fa2aaa76ee4009a0638073f95e6e099c993d7eb0b9381884b781432874bd542a2a8fde4a6c150bd7c3fdf5028f94ac6951
+  data.tar.gz: 6458262e8f3efd03256c1a4e6efe7be32d925ce88852afc93869d28b6ed7e77e6fb0108020ea1c39ab15ca79feaaa5eb2d45e129ce0829064c1b779d727e39eb

data/README.md

@@ -9,7 +9,7 @@ In effect, that flowchart is a state machine - with "decision states" and "actio
 
 ## Breaking Change
 
-Version 0.7.0 includes breaking changes.  There are migrations which rename your existing `operations_tasks` and `operations_task_participants` tables (so the data is not deleted), then a new `operations_tasks` table is created with a simplified structure.  
+Version 0.7.0 includes breaking changes.  When you run `bin/rails operations:migrations:install` one of the migrations will drop your existing `operations_tasks` and `operations_task_participants` tables.  If you need the historic data in those tables, then edit the migration to rename the tables instead.  Also you will need to update your tests to use the new `test` method. 
 
 ## Usage
 
@@ -193,7 +193,7 @@ end
 ```
 #### Wait handlers 
 
-The registration process performs an action, `send_invitation` and then waits until a `name_provided?`.  A `wait handler` is similar to a `decision handler` but if the conditions are not met, instead of raising an error, the task goes to sleep.  A background process (see bwlow) wakes the task periodically to reevaluate the condition.  Or, an `interaction` can be triggered; this is similar to an action because it does something, but it also immediately reevaluates the current wait handler.  So in this case, when the `register!` interaction completes, the `name_provided?` wait handler is reevaluated and, because the `name` has now been supplied, it can move on to the `create_user` state.  
+The registration process performs an action, `send_invitation` and then waits until a `name_provided?`.  A `wait handler` is similar to a `decision handler` but if the conditions are not met, instead of raising an error, the task goes to sleep.  A background process (see below) wakes the task periodically to reevaluate the condition.  Or, an `interaction` can be triggered; this is similar to an action because it does something, but it also immediately reevaluates the current wait handler.  So in this case, when the `register!` interaction completes, the `name_provided?` wait handler is reevaluated and, because the `name` has now been supplied, it can move on to the `create_user` state.  
 
 When a task reaches a wait handler, it goes to sleep and expects to be woken up at some point in the future.  You can specify how often it is woken up by adding a `delay 10.minutes` declaration to your class.  The default is `1.minute`.  Likewise, if a task does not change state after a certain period it fails with an `Operations::Timeout` exception.  You can set this timeout by declaring `timeout 48.hours` (the default is `24.hours`).  
 
@@ -280,7 +280,30 @@ However, it also means that your database table could fill up with junk that you
 
 ## Testing
 
-TBD
+Because the flow for a task may be complex, it's best to test each state in isolation.  To help with this, there is a `test` method on the `Operations::Task` class, which creates a task, in your desired state, then runs the appropriate handler.  Then you can check that it has done what you expect.  
+
+```ruby 
+class WeekendChecker < Operations::Task
+  has_attribute :day_of_week, :string, default: "Monday"
+  validates :day_of_week, presence: true
+  starts_with :is_it_the_weekend?
+
+  decision :is_it_the_weekend? do
+    condition { %w[Saturday Sunday].include? day_of_week }
+    if_true :weekend
+    if_false :weekday
+  end
+
+  result :weekend
+  result :weekday
+end
+
+task = WeekendChecker.verify :is_it_the_weekend?, day_of_week: "Saturday"
+expect(task).to be_in :weekend
+
+task = WeekendChecker.verify :is_it_the_weekend?, day_of_week: "Wednesday"
+expect(task).to be_in :weekday
+```
 
 ## Installation
 Step 1: Add the gem to your Rails application's Gemfile:
@@ -327,4 +350,4 @@ The gem is available as open source under the terms of the [LGPL License](/LICEN
 - [x] Add visualization export for task flows
 - [ ] Replace ActiveJob with a background process
 - [ ] Rename StateManagent with Plan
-- [ ] Add interactions
+- [ ] Add interactions

data/app/models/operations/task/testing.rb

@@ -0,0 +1,11 @@
+module Operations::Task::Testing
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def test state, **attributes
+      create!(current_state: state, **attributes).tap do |task|
+        task.call_handler
+      end
+    end
+  end
+end

data/app/models/operations/task.rb

@@ -3,6 +3,8 @@ module Operations
     include HasAttributes
     include Plan
     include Index
+    include Testing
+
     scope :ready_to_wake, -> { ready_to_wake_at(Time.current) }
     scope :ready_to_wake_at, ->(time) { where(wakes_at: ..time) }
     scope :expired, -> { expires_at(Time.current) }
@@ -24,9 +26,11 @@ module Operations
     has_attribute :exception_backtrace, :string
 
     def call(immediate: false)
-      while active?
+      state = ""
+      while active? && (state != current_state)
+        state = current_state
         Rails.logger.debug { "--- #{self}: #{current_state}" }
-        (handler_for(current_state).immediate? || immediate) ? handler_for(current_state).call(self) : go_to_sleep!
+        (handler_for(current_state).immediate? || immediate) ? call_handler : go_to_sleep!
       end
     rescue => ex
       record_error! ex
@@ -41,6 +45,8 @@ module Operations
 
     def record_error!(exception) = update!(task_status: "failed", exception_class: exception.class.to_s, exception_message: exception.message.to_s, exception_backtrace: exception.backtrace)
 
+    def call_handler = handler_for(current_state).call(self)
+
     private def go_to_sleep! = update!(default_times.merge(task_status: "waiting"))
 
     private def activate_and_call

data/lib/operations/version.rb

@@ -1,3 +1,3 @@
 module Operations
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standard_procedure_operations
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Rahoul Baruah
 bindir: bin
 cert_chain: []
-date: 2025-07-02 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,6 +60,7 @@ files:
 - app/models/operations/task/plan/result_handler.rb
 - app/models/operations/task/plan/wait_handler.rb
 - app/models/operations/task/runner.rb
+- app/models/operations/task/testing.rb
 - app/models/operations/task_participant.rb
 - config/routes.rb
 - db/migrate/20250701190516_rename_existing_operations_tables.rb