eventful.rb 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9a8e5622060297424496b78fc52312d8cb0acf7d62d67571a8990c75cb8580
-  data.tar.gz: 85aaf96637073d8e8aff7375e4977e74bd20ca9834535b7635ed936d4ae1db2a
+  metadata.gz: 6b1e4814ed3f3c820ac5a81d56e425b9d3f03eee9b8c819308c1bcd958ab40f8
+  data.tar.gz: 4de5ad6c6cf1c57147f5affa9bdf042c30eb68dadd0ef280326348de68f9f72b
 SHA512:
-  metadata.gz: 531ffe23a894e0337cf48d29c2f96415986771cf90523f0d3d3d2e8167868443b2538fbab98e30790baeb5dc445c8ad400b3d36a0afcd18817001fe23d492fd5
-  data.tar.gz: 6edb8b51096c9e2addc3ddbd8d6aab373d9fa4f0b4df97a28fd5d35c3878930b2351ba1f886887553717b286ea2f49f050154d4fe9141a454c7bd82adec54d41
+  metadata.gz: 2e80ddadfb01294f5e9bab2823d30bc43493ff76e040de7148950b5d22ea747b7345d8a9d453d441fb40e385f506af0f027a444bdd16f1f4a86e59890b24a104
+  data.tar.gz: a09be6861708162aa5638ad7b971aaa67bb60ae6f52cc0d816966950b1587322e87a9a0094ecb2faaa1ea2ca43f9b7ba4dd85d05cbe34d23eb135b9583c065d3

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem 'stateful.rb'
+
+group :development, :test do
+  gem 'minitest'
+  gem 'minitest-spec-context'
+end

data/README.md

@@ -0,0 +1,79 @@
+# eventful.rb
+
+Automatically change state with Stateful state machines.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventful.rb'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install eventful.rb
+```
+
+## Usage
+
+```ruby
+class Machine
+
+  include Eventful
+
+  initial_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
+
+  # An event that produces a boolean result and which corresponds with a state trigger, which for argument sake is true.
+  def an_event?
+    true
+  end
+
+  # Another event that produces a boolean result and which corresponds with a state trigger, which for argument sake is false
+  def another_event?
+    false
+  end
+
+  # Yet another event that produces a boolean result and which corresponds with a state trigger, which for argument sake is true.
+  def yet_another_event?
+    true
+  end
+end
+
+machine = Machine.new
+machine.current_state.name
+# => :initial_state
+
+Machine.run # Causes the state to transition from the initial_state through next_state and then to final_state.
+
+machine.current_state.name
+# => :final_state
+```
+
+## Contributing
+
+1. Fork it (https://github.com/thoran/eventful.rb/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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
+
+The gem is available as open source under the terms of the [Ruby License](https://opensource.org/licenses/MIT).

data/eventful.rb.gemspec

@@ -0,0 +1,28 @@
+require_relative './lib/Eventful/VERSION'
+
+Gem::Specification.new do |spec|
+  spec.name = 'eventful.rb'
+
+  spec.version = Eventful::VERSION
+  spec.date = '2025-07-28'
+
+  spec.summary = "Automatically change state with Stateful state machines."
+  spec.description = "By defining predicate methods which except for the addition of '?' matches a state machine event and then configuring an in memory or cron-based event loop, the state machine will be able to change state automatically."
+
+  spec.author = 'thoran'
+  spec.email = 'code@thoran.com'
+  spec.homepage = 'http://github.com/thoran/eventful.rb'
+  spec.license = 'Ruby'
+
+  spec.required_ruby_version = '>= 1.8.6'
+
+  spec.add_dependency('stateful.rb')
+  spec.files = [
+    'eventful.rb.gemspec',
+    'Gemfile',
+    Dir['lib/**/*.rb'],
+    'README.md',
+    Dir['test/**/*.rb']
+  ].flatten
+  spec.require_paths = ['lib']
+end

data/lib/Eventful/VERSION.rb

@@ -0,0 +1,6 @@
+# Eventful/VERSION.rb
+# Eventful::VERSION
+
+module Eventful
+  VERSION = '0.8.0'
+end

data/test/ActiveRecord.rb

@@ -0,0 +1,176 @@
+# test/ActiveRecord.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'active_record'
+require 'pg'
+require 'Eventful'
+
+class CreateTableActiveRecordMachines < ActiveRecord::Migration
+
+  def change
+    create_table :active_record_machines do |t|
+      t.string :current_state
+    end
+  end
+
+end
+
+class ActiveRecordMachine < ActiveRecord::Base
+
+  include Eventful
+
+  initial_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
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'postgresql',
+  host: 'localhost',
+  database: 'test'
+)
+unless ActiveRecord::Base.connection.tables.include?('active_record_machines')
+  CreateTableActiveRecordMachines.new.change
+end
+if ActiveRecord::Base.connection.tables.include?('active_record_machines')
+  ActiveRecordMachine.delete_all
+end
+
+describe Eventful do
+
+  let(:machine){ActiveRecordMachine.create}
+
+  before do
+    ActiveRecordMachine.delete_all
+  end
+
+  it "must have successfully extended the receiver class with Stateful methods" do
+    machine.class.methods.include?(:stateful_states).must_equal true
+  end
+
+  it "must have successfully extended the receiver class with Eventful methods" do
+    machine.class.methods.include?(:active).must_equal true
+  end
+
+  context "only an_event? is true" do
+
+    before do
+      class ActiveRecordMachine
+        def an_event?
+          true
+        end
+
+        def another_event?
+          false
+        end
+
+        def yet_another_event?
+          false
+        end
+      end
+    end
+
+    it "must know which instances are active (ie. not in a final state)" do
+      machine.current_state
+      ActiveRecordMachine.active.size.must_equal 1
+    end
+
+    it "must know whether an event has occurred" do
+      machine.an_event?.must_equal true
+    end
+
+    it "must know whether an event has not occurred" do
+      machine.another_event?.must_equal false
+      machine.yet_another_event?.must_equal false
+    end
+
+    it "must automatically trigger state changes" do
+      machine.current_state
+      ActiveRecordMachine.run
+      machine.reload.current_state.name.must_equal :next_state
+    end
+  end
+
+  context "an_event? and yet_another_event? are true" do
+
+    before do
+      class ActiveRecordMachine
+        def an_event?
+          true
+        end
+
+        def another_event?
+          false
+        end
+
+        def yet_another_event?
+          true
+        end
+      end
+    end
+
+    it "must know which instances are active (ie. not in a final state)" do
+      machine.current_state
+      ActiveRecordMachine.active.size.must_equal 1
+    end
+
+    it "must know whether an event has occurred" do
+      machine.an_event?.must_equal true
+      machine.yet_another_event?.must_equal true
+    end
+
+    it "must know whether an event has not occurred" do
+      machine.another_event?.must_equal false
+    end
+
+    it "must automatically trigger state changes" do
+      machine.current_state = :next_state
+      ActiveRecordMachine.run
+      machine.reload.current_state.name.must_equal :final_state
+    end
+  end
+
+  context "frequency_in_seconds and runtime_in_seconds given" do
+
+    before do
+      class ActiveRecordMachine
+        def an_event?
+          true
+        end
+
+        def another_event?
+          true
+        end
+
+        def yet_another_event?
+          true
+        end
+      end
+    end
+
+    it "must run for no longer than the specified runtime_in_seconds" do
+      start_time = Time.now
+      ActiveRecordMachine.run(2, 10) # Run every 2 seconds for not more than 10 seconds.
+      finish_time = Time.now
+      run_time = finish_time - start_time
+      run_time.must_be_close_to 10, 0.1
+    end
+  end
+
+end

data/test/ActiveRecordWhenNoFinalState.rb

@@ -0,0 +1,177 @@
+# test/ActiveRecordWhenNoFinalState.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'active_record'
+require 'pg'
+require 'Eventful'
+
+class CreateTableActiveRecordMachines2 < ActiveRecord::Migration
+
+  def change
+    create_table :active_record_machine2s do |t|
+      t.string :current_state
+    end
+  end
+
+end
+
+class ActiveRecordMachine2 < ActiveRecord::Base
+
+  include Eventful
+
+  initial_state :initial_state do
+    on :an_event => :another_state
+  end
+
+  state :another_state do
+    on :another_event => :yet_another_state
+  end
+
+  state :yet_another_state do
+    on :yet_another_event => :another_state
+  end
+
+end
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'postgresql',
+  host: 'localhost',
+  database: 'test'
+)
+unless ActiveRecord::Base.connection.tables.include?('active_record_machine2s')
+  CreateTableActiveRecordMachines2.new.change
+end
+if ActiveRecord::Base.connection.tables.include?('active_record_machine2s')
+  ActiveRecordMachine2.delete_all
+end
+
+describe Eventful do
+
+  let(:machine2){ActiveRecordMachine2.create}
+
+  before do
+    ActiveRecordMachine2.delete_all
+  end
+
+  it "must have successfully extended the receiver class with Stateful methods" do
+    machine2.class.methods.include?(:stateful_states).must_equal true
+  end
+
+  it "must have successfully extended the receiver class with Eventful methods" do
+    machine2.class.methods.include?(:active).must_equal true
+  end
+
+  context "only an_event? is true" do
+
+    before do
+      class ActiveRecordMachine2
+        def an_event?
+          true
+        end
+
+        def another_event?
+          false
+        end
+
+        def yet_another_event?
+          false
+        end
+      end
+    end
+
+    it "must know which instances are active (ie. not in a final state)" do
+      machine2.current_state
+      ActiveRecordMachine2.active.size.must_equal 1
+    end
+
+    it "must know whether an event has occurred" do
+      machine2.an_event?.must_equal true
+    end
+
+    it "must know whether an event has not occurred" do
+      machine2.another_event?.must_equal false
+      machine2.yet_another_event?.must_equal false
+    end
+
+    it "must automatically trigger state changes" do
+      machine2.current_state
+      ActiveRecordMachine2.run
+      machine2.reload.current_state.name.must_equal :another_state
+    end
+  end
+
+  context "an_event? and another_event? are true" do
+
+    before do
+      class ActiveRecordMachine2
+        def an_event?
+          true
+        end
+
+        def another_event?
+          true
+        end
+
+        def yet_another_event?
+          false
+        end
+      end
+    end
+
+    it "must know which instances are active (ie. not in a final state)" do
+      machine2.current_state
+      ActiveRecordMachine2.active.size.must_equal 1
+    end
+
+    it "must know whether an event has occurred" do
+      machine2.an_event?.must_equal true
+      machine2.another_event?.must_equal true
+    end
+
+    it "must know whether an event has not occurred" do
+      machine2.yet_another_event?.must_equal false
+    end
+
+    it "must automatically trigger state changes" do
+      machine2.current_state
+      2.times{ActiveRecordMachine2.run}
+      machine2.reload.current_state.name.must_equal :yet_another_state
+    end
+  end
+
+  context "frequency_in_seconds and runtime_in_seconds given" do
+
+    before do
+      class ActiveRecordMachine2
+        def an_event?
+          true
+        end
+
+        def another_event?
+          true
+        end
+
+        def yet_another_event?
+          true
+        end
+      end
+    end
+
+    it "must run for no longer than the specified runtime_in_seconds" do
+      start_time = Time.now
+      ActiveRecordMachine2.run(2, 10) # Run every 2 seconds for not more than 10 seconds.
+      finish_time = Time.now
+      run_time = finish_time - start_time
+      run_time.must_be_close_to 10, 0.1
+    end
+  end
+
+end

data/test/Eventful.rb

@@ -0,0 +1,7 @@
+# test/Eventful.rb
+
+# The two ActiveRecord specs don't like being run together, so I randomly pick one of them to run...
+active_record_test_file = ['ActiveRecord', 'ActiveRecordWhenNoFinalState'][rand(2)]
+require_relative active_record_test_file
+
+require_relative 'Poro'

data/test/Poro.rb

@@ -0,0 +1,145 @@
+# test/Poro.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'Eventful'
+
+class Machine
+
+  include Eventful
+
+  initial_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
+
+describe Eventful do
+
+  let(:machine){Machine.active.first || Machine.new}
+
+  it "must have successfully extended the receiver class with Stateful methods" do
+    machine.class.methods.include?(:stateful_states).must_equal true
+  end
+
+  it "must have successfully extended the receiver class with Eventful methods" do
+    machine.class.methods.include?(:active).must_equal true
+  end
+
+  context "only an_event? is true" do
+    before do
+      class Machine
+        def an_event?
+          true
+        end
+
+        def another_event?
+          false
+        end
+
+        def yet_another_event?
+          false
+        end
+      end
+    end
+
+    it "must know which instances are active (ie. not in a final state)" do
+      machine
+      Machine.active.size.must_equal 1
+    end
+
+    it "must know whether an event has occurred" do
+      machine.an_event?.must_equal true
+    end
+
+    it "must know whether an event has not occurred" do
+      machine.another_event?.must_equal false
+      machine.yet_another_event?.must_equal false
+    end
+
+    it "must automatically trigger state changes" do
+      machine
+      Machine.run
+      machine.current_state.name.must_equal :next_state
+    end
+  end
+
+  context "an_event? and yet_another_event? are true" do
+    before do
+      class Machine
+        def an_event?
+          true
+        end
+
+        def another_event?
+          false
+        end
+
+        def yet_another_event?
+          true
+        end
+      end
+    end
+
+    it "must know which instances are active (ie. not in a final state)" do
+      machine
+      Machine.active.size.must_equal 1
+    end
+
+    it "must know whether an event has occurred" do
+      machine.an_event?.must_equal true
+      machine.yet_another_event?.must_equal true
+    end
+
+    it "must know whether an event has not occurred" do
+      machine.another_event?.must_equal false
+    end
+
+    it "must automatically trigger state changes" do
+      machine.current_state = :next_state
+      Machine.run
+      machine.current_state.name.must_equal :final_state
+    end
+  end
+
+  context "frequency_in_seconds and runtime_in_seconds given" do
+    before do
+      class Machine
+        def an_event?
+          true
+        end
+
+        def another_event?
+          true
+        end
+
+        def yet_another_event?
+          true
+        end
+      end
+    end
+
+    it "must run for no longer than the specified runtime_in_seconds" do
+      start_time = Time.now
+      Machine.run(2, 10) # Run every 2 seconds for not more than 10 seconds.
+      finish_time = Time.now
+      run_time = finish_time - start_time
+      run_time.must_be_close_to 10, 0.1
+    end
+  end
+
+end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: eventful.rb
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - thoran
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
-dependencies: []
+date: 2025-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stateful.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: By defining predicate methods which except for the addition of '?' matches
   a state machine event and then configuring an in memory or cron-based event loop,
   the state machine will be able to change state automatically.
@@ -18,18 +31,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
+- eventful.rb.gemspec
 - lib/Eventful.rb
 - lib/Eventful/ActiveRecord.rb
 - lib/Eventful/ActiveRecord/ClassMethods.rb
 - lib/Eventful/ClassMethods.rb
 - lib/Eventful/Poro.rb
 - lib/Eventful/Poro/ClassMethods.rb
+- lib/Eventful/VERSION.rb
 - lib/ObjectSpace/self.select_objects.rb
-homepage: http://github.com/thoran/Eventful
+- test/ActiveRecord.rb
+- test/ActiveRecordWhenNoFinalState.rb
+- test/Eventful.rb
+- test/Poro.rb
+homepage: http://github.com/thoran/eventful.rb
 licenses:
-- MIT
+- Ruby
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Automatically change state with Stateful state machines.
 test_files: []