nxt_state_machine 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6128e445380f2ed2b836b4c23ed58556efd2ff0728add08c2cbd45e97812e068
-  data.tar.gz: 05c8861e99afefec3c654366050b225d7a93c10ff984e508cd14d6345b1d0ff3
+  metadata.gz: bc37e9d88ae62233544b548a5085fe81f67be0957f498ebf0490a191ac37af8d
+  data.tar.gz: b999a6f14950de8f1bcca65082ff6c7ff9d7e61d29aeb0323e65d126502a5cdc
 SHA512:
-  metadata.gz: d3038d32da3a7bfa5a49b4537e7c6f163259ddd0f3d2b48a05bfa838021350f648d75bfc493125529c9e1374dc34aa2c9abe94325790fe4ba82a09f01e2afdc8
-  data.tar.gz: 64178102f125d3b180f31b1a0bbebd766226b44351bbef906d907cc6339f2ff213c743c51b52238706827cfd597e410b828eb0824f8a4747f363c9b2b79a0ce9
+  metadata.gz: bd80fa569f48c50ab81bc1380e1683d4d646a128ed5bae016d46a4c8263411f0de0bdf39934a480fdf55d0849fc516201444f2e2eecdf75ee903f45df5373661
+  data.tar.gz: af346178ff3e9321a4592862babffe717aceeabde96aa625768bd163070c99bad477514a9b2d4aa3b16553ebf3886039beed0748fee67a60c7cc4f96ed66b1dd

data/.circleci/config.yml

@@ -1,15 +1,13 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-version: 2
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@2.0.1
+  coveralls: coveralls/coveralls@1.0.6
+
 jobs:
   build:
     docker:
-      # specify the version you desire here
-      - image: circleci/ruby:2.6.5-node
-    environment:
-      BUNDLER_VERSION: 2.0.2
+      - image: 'cimg/ruby:3.2.2-node'
 
     working_directory: ~/repo
 
@@ -17,46 +15,12 @@ jobs:
       - checkout
 
       - run:
-          name: Install apt dependencies
+          name: Install apt dependencies (graphviz)
           command: |
             sudo apt update -q \
             && sudo apt upgrade -q \
             && sudo apt install -qq graphviz
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run: gem install bundler --version $BUNDLER_VERSION
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
-              circleci tests split --split-by=timings)"
-
-            bundle exec rspec \
-              --format progress \
-              --format RspecJunitFormatter \
-              --out /tmp/test-results/rspec.xml \
-              --format progress \
-              $TEST_FILES
-
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
+      - ruby/install-deps:
+          key: gems-v2
+          include-branch-in-cache-key: false
+      - ruby/rspec-test

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.2.2

data/CHANGELOG.md

@@ -1,7 +1,23 @@
-# v0.1.9 2020-09-23
+# v0.1.11 2023-06-29
+
+### Added
+- Added `state_machine.event_methods`
+
+[Compare v0.1.10...v0.1.11](https://github.com/nxt-insurance/nxt_state_machine/compare/v0.1.10...v0.1.11)
+
+# v0.1.10 2021-07-19
 
 ### Added
 
+- Transition now optionally get passed the transition object that allows to access transition arguments and options.
+
+[Compare v0.1.9...v0.1.10](https://github.com/nxt-insurance/nxt_state_machine/compare/v0.1.9...v0.1.10)
+
+
+# v0.1.9 2020-09-23
+
+### Added 
+
 - Allow to toggle locking of transitions for active record adapter per event or globally 
 
 [Compare v0.1.8...v0.1.9](https://github.com/nxt-insurance/nxt_state_machine/compare/v0.1.8...v0.1.9)

data/Gemfile.lock

@@ -1,60 +1,59 @@
 PATH
   remote: .
   specs:
-    nxt_state_machine (0.1.9)
+    nxt_state_machine (0.1.11)
       activesupport
       nxt_registry (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activerecord (6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activesupport (6.0.3.3)
+    activemodel (7.0.5.1)
+      activesupport (= 7.0.5.1)
+    activerecord (7.0.5.1)
+      activemodel (= 7.0.5.1)
+      activesupport (= 7.0.5.1)
+    activesupport (7.0.5.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    i18n (1.8.5)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.2)
-    nxt_registry (0.3.2)
+    mini_portile2 (2.8.2)
+    minitest (5.18.1)
+    nxt_registry (0.3.10)
       activesupport
-    pry (0.13.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (12.3.3)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
     ruby-graphviz (1.2.5)
       rexml
-    sqlite3 (1.4.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    sqlite3 (1.6.3)
+      mini_portile2 (~> 2.8.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -181,7 +181,14 @@ class Article < ApplicationRecord
 end
 ```
 
-You can also navigate between states 
+You can retrieve a list of states using the `states` method:
+
+```rb
+states = Article.state_machine.states # returns a NxtStateMachine::StateRegistry instance
+states.keys # ["draft", "written", "submitted", "approved", "published", "rejected", "deleted"]
+```
+
+You can also navigate between states:
 
 ```ruby
 state.next # will give you the next state in the order they have been registered
@@ -192,6 +199,7 @@ state.index # gives you the index of the state in the registry
 # You can also set indexes manually by passing in indexes when defining states. Make sure they are in order! 
 ```
 
+
 ### Events
 
 Once you have defined your states you can define events and their transitions. Events trigger state transitions based
@@ -241,15 +249,27 @@ article.approve(approved_at: Time.current)
 article.approve!(approved_at: Time.current)
 ```
 
-**NOTE:** Transitions run in transactions that acquire a lock to prevent concurrency issues per default. 
-Transactions will be rolled back in case of an exception or if your target cannot be saved due to validation errors. 
+> **Note**:
+> 
+> By default, transitions run in transactions that acquire a lock to prevent concurrency issues. 
+Transactions will be rolled back if an exception occurs or if your target cannot be saved due to validation errors. 
 The state is set back to the state before the transition! If you try to transition on records with unpersisted changes
 you will get a `RuntimeError: Locking a record with unpersisted changes is not supported.` error saying something
 like `Use :save to persist the changes, or :reload to discard them explicitly.` since it's not possible to acquire a 
-lock on modified records. You can also switch of locking and transactions for events by passing in the `lock_transitions: false` 
+lock on modified records. 
+> 
+> You can switch off locking and transactions for events by passing in the `lock_transitions: false` 
 option when defining an event or globally on the state machine with the `lock_transitions: false` option. Currently 
 there is no option to toggle locking at runtime.   
 
+
+You can retrieve a list of event methods with `event_methods`:
+
+```rb
+Article.state_machine.event_methods 
+# => [:write, :submit, :approve, :publish, :reject, :delete, :write!, :submit!, :approve!, :publish!, :reject!, :delete!]
+```
+
 ### Transitions
 
 When your transition takes arguments other than keyword arguments, it will always be passed the transition object itself
@@ -298,7 +318,7 @@ event :approve do
 
   after_transition from: %i[written submitted deleted], to: :approved, run: :call_me_back
 
-  around_transition from: any_state, to: :approved do |block|
+  around_transition from: any_state, to: :approved do |block, _transition|
     # Note that around transition callbacks get passed a proc object that you have to call 
     puts 'around transition enter' 
     block.call  
@@ -312,6 +332,16 @@ event :approve do
 end
 ```
 
+In callbacks you also have access to the current transition object. Through it you also have access to the arguments
+and options that have been passed in when the transition was triggered:
+
+```ruby
+before_transition from: any_state, to: :processed do |transition|
+  puts transition.arguments # => :arg_1, :arg_2 what was passed to the process!(:arg_1, :arg_2)
+  puts transition.options # => { arg_1: 'arg 1', arg_2: 'arg 2' } what was passed to the process!(arg_1: 'arg 1', arg_2: 'arg 2')
+end
+```
+
 ### Error Callbacks
 
 You can also register callbacks that run in case of an error occurs. By defining the error class you can restrict

data/lib/nxt_state_machine/state_machine.rb

@@ -75,6 +75,13 @@ module NxtStateMachine
       states.values.map(&:enum)
     end
 
+    def event_methods
+      event_names = events.keys
+      event_names_with_bang = event_names.map { |e| e + '!' }
+
+      (event_names + event_names_with_bang).map(&:to_sym)
+    end
+
     alias_method :all_states, :any_state
 
     def all_states_except(*excluded)

data/lib/nxt_state_machine/transition/factory.rb

@@ -25,7 +25,9 @@ module NxtStateMachine
         state_machine: state_machine,
         context: context,
         event: event,
-        set_state_method: set_state_method
+        set_state_method: set_state_method,
+        arguments: args,
+        options: opts
       }
 
       transition = Transition.new(event.name, **options)
@@ -33,8 +35,12 @@ module NxtStateMachine
       if block
         # if the transition takes a block we make it available through a proxy on the transition itself!
         transition.send(:block=, Proc.new do
-          # if the block takes arguments we always pass the transition as the first one
-          args.prepend(transition) if block.arity > 0
+          # if the transition block takes arguments we always pass the transition itself as the first argument
+          # callbacks also get passed the transition object in case they take an argument and can access args and
+          # options passed to the transition when invoked through that transition object
+          if block.arity > 0
+            args = [transition] + args
+          end
           context.instance_exec(*args, **opts, &block)
         end)
       end

data/lib/nxt_state_machine/transition.rb

@@ -2,7 +2,7 @@ module NxtStateMachine
   class Transition
     include Transition::Interface
 
-    def initialize(name, event:, from:, to:, state_machine:, context:, set_state_method:, &block)
+    def initialize(name, event:, from:, to:, state_machine:, context:, set_state_method:, arguments:, options:, &block)
       @name = name
       @event = event
       @from = state_machine.states.resolve!(from)
@@ -11,10 +11,12 @@ module NxtStateMachine
       @set_state_method = set_state_method
       @context = context
       @block = block
+      @arguments = arguments
+      @options = options
       @result = nil
     end
 
-    attr_reader :name, :from, :to, :block, :event, :result
+    attr_reader :name, :from, :to, :block, :event, :result, :arguments, :options
 
     # This triggers the set state method
     def trigger

data/lib/nxt_state_machine/version.rb

@@ -1,3 +1,3 @@
 module NxtStateMachine
-  VERSION = '0.1.9'
+  VERSION = '0.1.11'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: nxt_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Andreas Robecke
 - Nils Sommer
 - Raphael Kallensee
 - Lütfi Demirci
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -152,7 +152,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -205,7 +204,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/nxt-insurance/nxt_state_machine
   source_code_uri: https://github.com/nxt-insurance/nxt_state_machine
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,8 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A rich but straight forward state machine library
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 2.0.2