nxt_state_machine 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89b1ad3a07fcc60e4b3541b770f1e1f287713e973d3a038f3496be0a145006c5
-  data.tar.gz: f213f914ffe2ff39a0d90d8c61f574857b312c9065e1241e9e09dce16cf6cc3a
+  metadata.gz: 6128e445380f2ed2b836b4c23ed58556efd2ff0728add08c2cbd45e97812e068
+  data.tar.gz: 05c8861e99afefec3c654366050b225d7a93c10ff984e508cd14d6345b1d0ff3
 SHA512:
-  metadata.gz: 48b17f521db0a19ccc500fff321b459f4e962875792e047923185a45691c20b81bfec5bbab03b77cf6eaeb10be2b8191ec73bfbc4d4b05c9e518389b1d9cc497
-  data.tar.gz: 286382b6dd9512abc0a0b1c1f177196edab5aced50bc8888d0febf4a58a86697ac152b8a7617c238f3268cbbada15f9767248b333264cf1608421d6a9b9c2b93
+  metadata.gz: d3038d32da3a7bfa5a49b4537e7c6f163259ddd0f3d2b48a05bfa838021350f648d75bfc493125529c9e1374dc34aa2c9abe94325790fe4ba82a09f01e2afdc8
+  data.tar.gz: 64178102f125d3b180f31b1a0bbebd766226b44351bbef906d907cc6339f2ff213c743c51b52238706827cfd597e410b828eb0824f8a4747f363c9b2b79a0ce9

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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)
+
+
 # v0.1.8 2020-0-05
 
 ### Added

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    nxt_state_machine (0.1.8)
+    nxt_state_machine (0.1.9)
       activesupport
-      nxt_registry (~> 0.1.3)
+      nxt_registry (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activerecord (6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activesupport (6.0.3.1)
+    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)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.1)
-    nxt_registry (0.1.5)
+    minitest (5.14.2)
+    nxt_registry (0.3.2)
       activesupport
     pry (0.13.1)
       coderay (~> 1.1)
@@ -37,15 +37,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     ruby-graphviz (1.2.5)
@@ -54,7 +54,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -241,12 +241,14 @@ 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. Transactions will be 
-rolled back in case of an exception 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 transitions on records with unpersisted changes
+**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. 
+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. 
+lock on modified records. You can also switch of 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.   
 
 ### Transitions
 
@@ -342,7 +344,10 @@ You want to break out of your transition (which is wrapped inside a lock)?
 You can raise an error, have everything rolled back and then have your error handler take over.
 **NOTE:** Unless you reload your model all assignments you did, previous to the error, should still be available in your
 error handler. You can also defuse errors. This means they will not cause a rollback of the transaction during the 
-transition and you can actually persist changes to your model before the defused error is raised and handled. 
+transition and you can actually persist changes to your model before the defused error is raised and handled. You can 
+also switch off locking (and transactions) for events by passing the `lock_transitions: false` option when defining an event. This
+can also by set globally for a state_machine by passing the `lock_transitions: false` option when setting up the state 
+machine.  
 
 ```ruby
 state_machine do 
@@ -360,6 +365,14 @@ state_machine do
       raise CustomError, 'This does not rollback the headline update above'
     end
   end
+
+  event :approve_without_lock, lock_transitions: false do
+    transition from: %i[written submitted deleted], to: :approved do |headline:|
+      # This will be saved to the database because the event does not wrap the transition in a transaction 
+      article.update!(headline: headline)
+      raise StandardError, 'This does not rollback the headline update above'
+    end
+  end 
     
   on_error! CustomError from: any_state, to: :approved do |error, transition|
     # You can still handle the defused Error if you want to 

data/lib/nxt_state_machine.rb

@@ -25,7 +25,6 @@ require "nxt_state_machine/transition/interface"
 require "nxt_state_machine/transition"
 require "nxt_state_machine/transition/factory"
 require "nxt_state_machine/transition/proxy"
-require "nxt_state_machine/transition/store"
 require "nxt_state_machine/transition/around_callback_chain"
 require "nxt_state_machine/state_machine"
 require "nxt_state_machine/integrations/active_record"
@@ -38,7 +37,7 @@ module NxtStateMachine
     include NxtRegistry
 
     def state_machine(name = :default, **opts, &config)
-      state_machines.resolve!(name) || state_machines.register(
+      state_machines.resolve(name) || state_machines.register(
         name,
         StateMachine.new(name, self, state_machine_event_registry, **opts).configure(&config)
       )
@@ -76,15 +75,15 @@ module NxtStateMachine
     end
 
     def state_machine(name = :default)
-      @state_machine ||= self.class.state_machines.resolve(name)
+      @state_machine ||= self.class.state_machines.resolve!(name)
     end
 
     def current_state_name(name = :default)
-      state_machines.resolve(name).current_state_name(self)
+      state_machines.resolve!(name).current_state_name(self)
     end
 
     def current_state(name = :default)
-      state_machines.resolve(name).states.resolve(current_state_name(name))
+      state_machines.resolve!(name).states.resolve!(current_state_name(name))
     end
 
     def halt_transition(*args, **opts)

data/lib/nxt_state_machine/callback_registry.rb

@@ -8,13 +8,13 @@ module NxtStateMachine
 
       Array(from).each do |from_state|
         Array(to).each do |to_state|
-          callbacks.from(from_state).to(to_state).kind(kind) << method_or_block
+          callbacks.from!(from_state).to!(to_state).kind!(kind) << method_or_block
         end
       end
     end
 
-    def resolve(transition, kind = nil)
-      all_callbacks = callbacks.from(transition.from.enum).to(transition.to.enum)
+    def resolve!(transition, kind = nil)
+      all_callbacks = callbacks.from!(transition.from.enum).to!(transition.to.enum)
       return all_callbacks unless kind
 
       all_callbacks.kind(kind)
@@ -24,8 +24,8 @@ module NxtStateMachine
 
     def callbacks
       @callbacks ||= registry :from do
-        nested :to do
-          nested :kind, default: -> { [] } do
+        level :to do
+          level :kind, default: -> { [] } do
             attrs :before, :after
           end
         end

data/lib/nxt_state_machine/defuse_registry.rb

@@ -11,15 +11,15 @@ module NxtStateMachine
       end
     end
 
-    def resolve(transition)
-      errors.from(transition.from.enum).to(transition.to.enum)
+    def resolve!(transition)
+      errors.from!(transition.from.enum).to!(transition.to.enum)
     end
 
     private
 
     def errors
       @errors ||= registry :from do
-        nested :to, default: -> { [] }
+        level :to, default: -> { [] }
       end
     end
   end

data/lib/nxt_state_machine/error_callback_registry.rb

@@ -29,8 +29,8 @@ module NxtStateMachine
 
     def callbacks
       @callbacks ||= registry :from do
-        nested :to do
-          nested :error, transform_keys: false, call: false
+        level :to do
+          level :error, transform_keys: false, call: false
         end
       end
     end

data/lib/nxt_state_machine/event.rb

@@ -7,13 +7,14 @@ module NxtStateMachine
       @name = name
       @event_transitions = registry("#{name} event transitions")
       @names = Event::Names.build(name)
+      @options = options.with_indifferent_access
 
       configure(&block)
 
       ensure_event_has_transitions
     end
 
-    attr_reader :name, :state_machine, :event_transitions, :names
+    attr_reader :name, :state_machine, :event_transitions, :names, :options
 
     delegate :before_transition,
              :after_transition,
@@ -38,7 +39,7 @@ module NxtStateMachine
     alias_method :transition, :transitions
 
     def transitions_from?(state)
-      event_transitions.resolve!(state).present?
+      event_transitions.resolve(state).present?
     end
 
     def to_s

data/lib/nxt_state_machine/graph.rb

@@ -38,7 +38,6 @@ module NxtStateMachine
     end
 
     def add_nodes(state_machine)
-      binding.pry
       state_machine.states.values.each do |state|
         add_node(state)
       end

data/lib/nxt_state_machine/integrations/active_record.rb

@@ -1,11 +1,12 @@
 module NxtStateMachine
   module ActiveRecord
     module ClassMethods
-      def state_machine(name = :default, state_attr: :state, target: nil, &config)
+      def state_machine(name = :default, state_attr: :state, target: nil, lock_transitions: true, &config)
         machine = super(
           name,
           state_attr: state_attr,
           target: target,
+          lock_transitions: lock_transitions,
           &config
         )
 
@@ -49,14 +50,14 @@ module NxtStateMachine
         result = nil
         defused_error = nil
 
-        target.with_lock do
+        with_conditional_lock(target, transition.event) do
           transition.run_before_callbacks
           result = execute_transition(target, transition, state_attr, save_with_method)
           transition.run_after_callbacks
 
           result
         rescue StandardError => error
-          if machine.defuse_registry.resolve(transition).find { |error_class| error.is_a?(error_class) }
+          if machine.defuse_registry.resolve!(transition).find { |error_class| error.is_a?(error_class) }
             defused_error = error
           else
             raise error
@@ -82,6 +83,16 @@ module NxtStateMachine
           block ? result : set_state_result
         end
       end
+
+      def with_conditional_lock(target, event, &block)
+        return block.call unless lock_transition?(event)
+
+        target.with_lock { block.call }
+      end
+
+      def lock_transition?(event)
+        event.options.fetch(:lock_transitions) { state_machine.options.fetch(:lock_transitions) }
+      end
     end
 
     def self.included(base)

data/lib/nxt_state_machine/state_machine.rb

@@ -6,7 +6,7 @@ module NxtStateMachine
       @options = opts
 
       @states = NxtStateMachine::StateRegistry.new
-      @transitions = Transition::Store.new
+      @transitions = []
       @events = event_registry
       @callbacks = CallbackRegistry.new
       @error_callback_registry = ErrorCallbackRegistry.new
@@ -89,9 +89,9 @@ module NxtStateMachine
       Event::Names.set_state_method_map(name).each do |event_name, set_state_method|
         class_context.define_method event_name do |*args, **opts|
           event.state_machine.can_transition!(name, event.state_machine.current_state_name(self))
-          transition = event.event_transitions.resolve(event.state_machine.current_state_name(self))
+          transition = event.event_transitions.resolve!(event.state_machine.current_state_name(self))
           # Transition is build every time and thus should be thread safe!
-          transition.build_transition(event_name, self, set_state_method, *args, **opts)
+          transition.build_transition(event, self, set_state_method, *args, **opts)
         end
       end
 
@@ -101,7 +101,7 @@ module NxtStateMachine
     end
 
     def can_transition?(event_name, from)
-      event = events.resolve(event_name)
+      event = events.resolve!(event_name)
       event && event.event_transitions.key?(from)
     end
 
@@ -161,7 +161,7 @@ module NxtStateMachine
     end
 
     def run_callbacks(transition, kind, context)
-      current_callbacks = callbacks.resolve(transition, kind)
+      current_callbacks = callbacks.resolve!(transition, kind)
       return unless current_callbacks.any?
 
       current_callbacks.each do |callback|

data/lib/nxt_state_machine/transition.rb

@@ -5,8 +5,8 @@ module NxtStateMachine
     def initialize(name, event:, from:, to:, state_machine:, context:, set_state_method:, &block)
       @name = name
       @event = event
-      @from = state_machine.states.resolve(from)
-      @to = state_machine.states.resolve(to)
+      @from = state_machine.states.resolve!(from)
+      @to = state_machine.states.resolve!(to)
       @state_machine = state_machine
       @set_state_method = set_state_method
       @context = context

data/lib/nxt_state_machine/transition/around_callback_chain.rb

@@ -18,7 +18,7 @@ module NxtStateMachine
     private
 
     def callbacks
-      @callbacks ||= state_machine.callbacks.resolve(transition).kind(:around)
+      @callbacks ||= state_machine.callbacks.resolve!(transition).kind(:around)
     end
 
     attr_reader :transition, :context, :state_machine

data/lib/nxt_state_machine/transition/factory.rb

@@ -4,8 +4,8 @@ module NxtStateMachine
 
     def initialize(name, from:, to:, state_machine:, &block)
       @name = name
-      @from = state_machine.states.resolve(from)
-      @to = state_machine.states.resolve(to)
+      @from = state_machine.states.resolve!(from)
+      @to = state_machine.states.resolve!(to)
       @state_machine = state_machine
       @block = block
 
@@ -28,7 +28,7 @@ module NxtStateMachine
         set_state_method: set_state_method
       }
 
-      transition = Transition.new(name, **options)
+      transition = Transition.new(event.name, **options)
 
       if block
         # if the transition takes a block we make it available through a proxy on the transition itself!

data/lib/nxt_state_machine/version.rb

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

data/nxt_state_machine.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "nxt_registry", "~> 0.1.3"
+  spec.add_dependency "nxt_registry", "~> 0.3.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -33,14 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +193,6 @@ files:
 - lib/nxt_state_machine/transition/factory.rb
 - lib/nxt_state_machine/transition/interface.rb
 - lib/nxt_state_machine/transition/proxy.rb
-- lib/nxt_state_machine/transition/store.rb
 - lib/nxt_state_machine/version.rb
 - lib/railtie.rb
 - lib/tasks/draw_graph.rake

data/lib/nxt_state_machine/transition/store.rb

@@ -1,19 +0,0 @@
-module NxtStateMachine
-  class Transition::Store < Array
-    def <<(transition)
-      ensure_transition_unique(transition)
-      super
-    end
-
-    alias_method :add, :<<
-
-    private
-
-    def ensure_transition_unique(transition)
-      return unless find { |other| other.from.enum == transition.from.enum && other.to.enum == transition.to.enum }
-
-      raise NxtStateMachine::Errors::TransitionAlreadyRegistered,
-            "A transition from :#{transition.from.enum} to :#{transition.to.enum} was already registered"
-    end
-  end
-end