nxt_state_machine 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 619dd3e81ce389fb16df746e5d940c48d48f6e2c30b2afb108a3a098aa687003
-  data.tar.gz: ee68dba22f251671e019a15f3e36bdbbb04fca5a5649e65fb1d0a43cedb60dbf
+  metadata.gz: 48ef8c1448e9b199d064eb4d4040e7187ca141cc1e41d7a4abef5914c71cae59
+  data.tar.gz: 500f0d1098da66be2c4da535061f3198177f5d6f3d314716a7154a423e6c7745
 SHA512:
-  metadata.gz: 74cdf937fa1653f1fea76c4cf6a0fb42625b97cf1c3a08dc3ffaef34b9571400c4fc759ee002be24158c58adfeab2b5ef437d2a750b924a10dd8c5af7bccf665
-  data.tar.gz: e1af7824092bb95bfe95b88d71c05b3f8262da0a95364fde1c2a55d31da44dc96113ec31c46539757d96d4a3d112fe12b1e8ba3684bb6740fbdb77a49011004f
+  metadata.gz: 134d73c9bfd5f12c9379a78d30ba601c8062ee530a469e4c7febda231202d1a0e4ff7ca4db9b84843ea7ff19eebadcd3f537b439738f7fc847b26884906dfbc3
+  data.tar.gz: 885c3d0c4898bb897cb16dcbd9bc19a7897c80fc58535dc539358ce9621f58bc1e5a183d9258715358680e2e7d77785adb790f08f3b84c2aa6bf46457ede6c84

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_state_machine (0.1.1)
+    nxt_state_machine (0.1.2)
       activesupport
       nxt_registry (~> 0.1.3)
 

data/README.md

@@ -41,25 +41,32 @@ class ArticleWorkflow
     # First we setup the states
     state :draft, initial: true
     states :written, :submitted # define multiple states at the same time 
-    state :approved
+    state :approved 
     state :published
-    state :rejected
-    state :deleted
+    state :rejected, negative: true # You can pass options to states that you can query in the transition
+    state :deleted, negative: true do # States can even have custom methods if options are not sufficient
+      def deleted_at
+        Time.current
+      end
+    end
+
 
     event :write do
       transition from: %i[draft written deleted], to: :written
     end
 
     event :submit do
-      # When the block takes arguments (instead of only keyword arguments!!) 
-      # the transition is always passed in as the first argument!!!
-      transition from: %i[written rejected deleted], to: :submitted do |transition|
+      # If you want transitions to take arguments, we recommend to use keyword arguments
+      # When the block takes arguments (instead of just keyword arguments) the first argument 
+      # passed to the block will always be the transition!
+      transition from: %i[written rejected deleted], to: :submitted do |transition, *others|
         puts transition.from.enum
         puts transition.to.enum
       end
     end
 
     event :approve do
+      # use methods as callbacks with run: 
       before_transition from: %i[written submitted deleted], to: :approved, run: :call_me_back
 
       transition from: %i[written submitted deleted], to: :approved do |headline:|
@@ -68,6 +75,7 @@ class ArticleWorkflow
 
       after_transition from: %i[written submitted deleted], to: :approved, run: :call_me_back
 
+      # use blocks with callbacks
       around_transition from: any_state, to: :approved do |block|
         # Note that around transition callbacks get passed a proc object that you have to call 
         puts 'around transition enter' 
@@ -176,7 +184,8 @@ state.next # will give you the next state in the order they have been registered
 state.previous # will give you the previously registered state
 state.first? # first registered state?
 state.last? # last registered state?
-state.index # gives you the index of the state in the registry (can also be overwritten by passing index as an option)
+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

data/lib/nxt_state_machine/callable.rb

@@ -19,9 +19,9 @@ module NxtStateMachine
       self
     end
 
-    # NOTE: allowing call(*args, **opts) is dangerous when called with a hash as an argument!
-    # It will automatically become the **opts which might not be what you want! Probably better
-    # to introduce arguments: [], options: { } or something
+    # NOTE: Currentl we only allow arguments! Not keyword args or **options
+    # If we would allow **options and we would pass a hash as the only argument it would
+    # automatically be parsed as the options!
     def call(*args)
       ensure_context_not_missing
 

data/lib/nxt_state_machine/errors/error.rb

@@ -1 +1,3 @@
-Error = Class.new(StandardError)
+module NxtStateMachine
+  Error = Class.new(StandardError)
+end

data/lib/nxt_state_machine/errors/state_with_same_index_already_registered.rb

@@ -0,0 +1,5 @@
+module NxtStateMachine
+  module Errors
+    StateWithSameIndexAlreadyRegistered = Class.new(Error)
+  end
+end

data/lib/nxt_state_machine/state.rb

@@ -7,6 +7,8 @@ module NxtStateMachine
       @transitions = []
       @options = opts.with_indifferent_access
       @index = opts.fetch(:index)
+
+      ensure_index_not_occupied
     end
 
     attr_accessor :enum, :initial, :index, :transitions, :state_machine, :options
@@ -16,23 +18,34 @@ module NxtStateMachine
     end
 
     def previous
-      previous_index = (index - 1) % state_machine.states.size
-      key = state_machine.states.keys[previous_index]
-      state_machine.states.resolve(key)
+      current_index = sorted_states.index { |state| state.index == index }
+      sorted_states[(current_index - 1) % sorted_states.size]
     end
 
     def next
-      next_index = (index + 1) % state_machine.states.size
-      key = state_machine.states.keys[next_index]
-      state_machine.states.resolve(key)
+      current_index = sorted_states.index { |state| state.index == index }
+      sorted_states[(current_index + 1) % sorted_states.size]
     end
 
     def last?
-      index == state_machine.states.size - 1
+      sorted_states.last.index == index
     end
 
     def first?
-      index == 0
+      sorted_states.first.index == index
+    end
+
+    private
+
+    def sorted_states
+      state_machine.states.values.sort_by(&:index)
+    end
+
+    def ensure_index_not_occupied
+      state_with_same_index = state_machine.states.values.find { |state| state.index == index }
+      return unless state_with_same_index
+
+      raise StateWithSameIndexAlreadyRegistered, "The index #{index} is already occupied by state: #{state_with_same_index.enum}"
     end
   end
 end

data/lib/nxt_state_machine/state_machine.rb

@@ -18,21 +18,15 @@ module NxtStateMachine
     attr_accessor :initial_state
 
     def get_state_with(method = nil, &block)
-      method_or_block = (method || block)
-      @get_state_with ||= method_or_block ||
-        raise_missing_configuration_error(:get_state_with)
+      @get_state_with ||= (method || block) || raise_missing_configuration_error(:get_state_with)
     end
 
     def set_state_with(method = nil, &block)
-      method_or_block = (method || block)
-      @set_state_with ||= method_or_block ||
-        raise_missing_configuration_error(:set_state_with)
+      @set_state_with ||= (method || block) || raise_missing_configuration_error(:set_state_with)
     end
 
     def set_state_with!(method = nil, &block)
-      method_or_block = (method || block)
-      @set_state_with_bang ||= method_or_block ||
-        raise_missing_configuration_error(:set_state_with!)
+      @set_state_with_bang ||= (method || block) || raise_missing_configuration_error(:set_state_with!)
     end
 
     def state(*names, **opts, &block)

data/lib/nxt_state_machine/version.rb

@@ -1,3 +1,3 @@
 module NxtStateMachine
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -157,6 +157,7 @@ files:
 - lib/nxt_state_machine/errors/invalid_callback_option.rb
 - lib/nxt_state_machine/errors/missing_configuration.rb
 - lib/nxt_state_machine/errors/state_already_registered.rb
+- lib/nxt_state_machine/errors/state_with_same_index_already_registered.rb
 - lib/nxt_state_machine/errors/transition_already_registered.rb
 - lib/nxt_state_machine/errors/transition_halted.rb
 - lib/nxt_state_machine/errors/transition_not_defined.rb