stateful.rb 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c897617cdd223bd354d7f7819341cd8dfd388bf412b479fcac7b757e76d004
-  data.tar.gz: 6742bb2396d64fcac9ee8678b32b187d5b020fc2757842bc79f3f790f5a9a26f
+  metadata.gz: 045517b47c6e558d4e414bc639973934c27abc955a5d6281088c3413c38e9a9b
+  data.tar.gz: db57952692bd309d8389c6d02de659c5dc3a0ab6ac361ecd491aeba5db3860e4
 SHA512:
-  metadata.gz: 1b396504ea4e1ad2f9f1e9c8419d8463749321e8e3ab64433c2cbbd7559377b2750a559099d25ab1e02c398cae2b20f3ec380cb27f83498b8808ddb0a7b4cbe0
-  data.tar.gz: eaf13d432db2b8df6f7785b009b2c837b434e051e01e318f3e82f497045b0c91af0cf02700f222c372a00478b093c4c98dd3c77f911550393ab8b8b1a89932c7
+  metadata.gz: 2ffcb05702b938f0f62d2d661adea0cdc64017eadcb3d6e328c369d88c8655f193ab58b2508706ed8ae3a7b71c0c09805a19bc8212493057b96a46d75e89fed5
+  data.tar.gz: bc0e1b4772f7e30f32df35542df5264c4ebe90c6d94ad52009362647f0c98a5450d9c9c303f5c87cfb0140ee03b7c81998ce492d19f85ed38e07ff3a3172772e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # stateful/CHANGELOG.md
 
+## 2.3.2 (20260418): Add Sequel examples to README.
+-----------------------------------------------------------------------------------------------------------------------
+
+### ~
+1. README.md: + Sequel examples (sections 5 and 6), updated description to include Sequel,
+   renumbered remaining sections.
+2. lib/Stateful/VERSION.rb: /2.3.1/2.3.2/
+
+
 ## 2.3.1 (20260418): Use require\_relative in tests.
 -----------------------------------------------------------------------------------------------------------------------
 

data/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-A Ruby state machine which allows you to easily add state to Poro and ActiveRecord objects. Works with both CRuby and mRuby.
+A Ruby state machine which allows you to easily add state to Poro, ActiveRecord, and Sequel objects. Works with both CRuby and mRuby.
 
 ## Installation
 
@@ -149,9 +149,67 @@ active_record_machine.final_state?
 # => true
 ```
 
-### 5. Custom variable/column name and non-deterministic event ordering
+### 5. Sequel with persistence-specific extend and a stateful block declaration
 
-It's also possible to define a state machine (either Poro or ActiveRecord) which has a custom variable (Poro) or column (ActiveRecord) name, which fires off the events in a random or non-deterministic order, and which has no final state.
+```ruby
+class SequelMachine < Sequel::Model
+  extend Stateful::Sequel
+
+  stateful do
+    initial_state :initial_state
+
+    state :initial_state do
+      on :an_event => :next_state
+      on :another_event => :final_state
+    end
+
+    state :next_state do
+      on :yet_another_event => :final_state
+    end
+
+    final_state :final_state
+  end
+end
+
+sequel_machine = SequelMachine.create
+sequel_machine.initial_state?
+# => true
+sequel_machine.an_event
+sequel_machine.next_state?
+# => true
+```
+
+### 6. Sequel with persistence non-specific extend, without a stateful block declaration, an initial_state block, and multiple final states
+
+```ruby
+class SequelMachine < Sequel::Model
+  extend Stateful
+
+  initial_state :initial_state do
+    on :an_event => :next_state
+    on :another_event => :final_state0
+  end
+
+  state :next_state do
+    on :yet_another_event => :final_state0
+    on :and_yet_another_event => :final_state1
+  end
+
+  final_state :final_state0, :final_state1
+end
+
+sequel_machine = SequelMachine.create
+sequel_machine.an_event
+sequel_machine.final_state?
+# => false
+sequel_machine.yet_another_event
+sequel_machine.final_state?
+# => true
+```
+
+### 7. Custom attribute name and non-deterministic event ordering
+
+It's also possible to define a state machine which has a custom attribute name, which fires off the events in a random or non-deterministic order, and which has no final state.
 
 ```ruby
 class ActiveRecordMachine < ActiveRecord::Base
@@ -285,7 +343,7 @@ class Order
 end
 ```
 
-For ActiveRecord, each machine uses a column named `<machine_name>_state`:
+For ActiveRecord and Sequel, each machine uses a column named `<machine_name>_state`:
 
 ```ruby
 class CreateOrders < ActiveRecord::Migration[6.0]

data/lib/Stateful/VERSION.rb

@@ -1,3 +1,3 @@
 module Stateful
-  VERSION = '2.3.1'
+  VERSION = '2.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stateful.rb
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.2
 platform: ruby
 authors:
 - thoran