nxt_state_machine 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6128e445380f2ed2b836b4c23ed58556efd2ff0728add08c2cbd45e97812e068
-  data.tar.gz: 05c8861e99afefec3c654366050b225d7a93c10ff984e508cd14d6345b1d0ff3
+  metadata.gz: c131c9fdbce2f5a605ecdfa39a63e0ea7ef21dda4a2f9600e790e56e0c4444a0
+  data.tar.gz: 49689f892d2262705c0248c05d7b0d6612b31255fb3da130494cbe200f105d83
 SHA512:
-  metadata.gz: d3038d32da3a7bfa5a49b4537e7c6f163259ddd0f3d2b48a05bfa838021350f648d75bfc493125529c9e1374dc34aa2c9abe94325790fe4ba82a09f01e2afdc8
-  data.tar.gz: 64178102f125d3b180f31b1a0bbebd766226b44351bbef906d907cc6339f2ff213c743c51b52238706827cfd597e410b828eb0824f8a4747f363c9b2b79a0ce9
+  metadata.gz: e176a5b1205cbfb3d901f5c7c768971b64eea974f613d4a298430f81473c13dc3852f6e4eb021d4fd1eb98cba2fd8b9d69a4671a64b0c9a5e1f2e46cc20c7580
+  data.tar.gz: 9dff03854918e23c0c0dc9ae00c55116a4244a314f0799ce2e3c81841d257e9406cff25eb68833c6c32a99e8d4c562ff1609d22fb307c63f44a12165f47a2997

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.3

data/CHANGELOG.md

@@ -1,7 +1,16 @@
-# v0.1.9 2020-09-23
+# 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.10)
       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 (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       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)
+      zeitwerk (~> 2.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.2)
-    nxt_registry (0.3.2)
+    minitest (5.14.4)
+    nxt_registry (0.3.10)
       activesupport
-    pry (0.13.1)
+    pry (0.14.1)
       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.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
     rspec_junit_formatter (0.4.1)
       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)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -298,7 +298,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 +312,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/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/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/version.rb

@@ -1,3 +1,3 @@
 module NxtStateMachine
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 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.10
 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: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -205,7 +205,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 +220,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.1.6
+signing_key:
 specification_version: 4
 summary: A rich but straight forward state machine library
 test_files: []