stateful.rb 2.3.1 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c897617cdd223bd354d7f7819341cd8dfd388bf412b479fcac7b757e76d004
-  data.tar.gz: 6742bb2396d64fcac9ee8678b32b187d5b020fc2757842bc79f3f790f5a9a26f
+  metadata.gz: 36b830fd690c778367717cc317ffe39d53801ee9dc93e0fea1d42ba60ad099f1
+  data.tar.gz: 4e9ea424b04703d2202afdcb9b73df9fb7b17514176e64202f54d3ae98092535
 SHA512:
-  metadata.gz: 1b396504ea4e1ad2f9f1e9c8419d8463749321e8e3ab64433c2cbbd7559377b2750a559099d25ab1e02c398cae2b20f3ec380cb27f83498b8808ddb0a7b4cbe0
-  data.tar.gz: eaf13d432db2b8df6f7785b009b2c837b434e051e01e318f3e82f497045b0c91af0cf02700f222c372a00478b093c4c98dd3c77f911550393ab8b8b1a89932c7
+  metadata.gz: a24a02097f130a4993bab84684fbfd060c4a95c7a33cf1090bd8d02cf1468b11daba5fa99190670a4a42273b8881574dac0c52519198a40affbe903115c174f4
+  data.tar.gz: 5b21b16363b87c18ba78034102072e84cd7f5696cfbd1810bf766732cc798641434800275768d4c241940347c3ce7db39e169997cfcf6df1f411123359951bb0

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # stateful/CHANGELOG.md
 
+## 2.3.3 (20260822): + LICENSE, and correct the README.
+-----------------------------------------------------------------------------------------------------------------------
+### +
+1. LICENSE: the MIT text, copyright 2014-2026 thoran. The gemspec has declared MIT while the repository carried no licence text at all.
+2. README.md: a License section, saying MIT, last.
+### ~
+1. stateful.rb.gemspec: + 'LICENSE' to spec.files, so the gem carries what the declaration claims.
+2. README.md: /thoran\/Stateful/thoran\/stateful/ in the mruby install line, the repository having been renamed.
+3. README.md: /### 6. Multiple state machines per class/### 8. Multiple state machines per class/, the sequence having run 1 to 7 and then 6 again.
+4. lib/Stateful/VERSION.rb: /2.3.2/2.3.3/
+
+## 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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2026 thoran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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
 
@@ -31,7 +31,7 @@ $ gem install stateful.rb
 Add this to your `build_config.rb`:
 
 ```ruby
-conf.gem github: 'thoran/Stateful'
+conf.gem github: 'thoran/stateful'
 ```
 
 ## Usage
@@ -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
@@ -189,7 +247,7 @@ active_record_machine.final_state?
 # => false
 ```
 
-### 6. Multiple state machines per class
+### 8. Multiple state machines per class
 
 A single class can have multiple independent (orthogonal) state machines. Each machine gets its own namespaced methods, while domain predicates and event methods remain unnamespaced.
 
@@ -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]
@@ -307,3 +365,8 @@ For Poro, each machine uses an instance variable named `@<machine_name>_state`.
 3. Commit your changes: `git commit -am 'Add some feature'`
 4. Push to the branch: `git push origin my-new-feature`
 5. Create a new pull request
+
+
+## License
+
+MIT

data/lib/Stateful/VERSION.rb

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

data/stateful.rb.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
     'stateful.rb.gemspec',
     'CHANGELOG.md',
     'Gemfile',
+    'LICENSE',
     'README.md',
     Dir['lib/**/*.rb'],
     Dir['test/**/*.rb']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stateful.rb
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.3
 platform: ruby
 authors:
 - thoran
@@ -87,6 +87,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - lib/Stateful.rb
 - lib/Stateful/ActiveRecord.rb
@@ -165,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.19
 specification_version: 4
 summary: A Ruby state machine.
 test_files: []