stateful_enum 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5b8fa0430831e495e52e5fad80462db2100a9a8
-  data.tar.gz: ace6e802d2fa0abd9b047c23215dd0e2b8a70033
+  metadata.gz: ffeec178154391f427428dcb96dfe904071069a8
+  data.tar.gz: 9928fb31c685db67d2a9d70d232b0d9736fa88ad
 SHA512:
-  metadata.gz: c2b6c81796a16ded357ff40cac7c2cfc37eb6570516d685ef59afe897a8d34cb270ace9e5e3b514aeface34072f5c3186e26cb69b8320acdbdc6cef039431093
-  data.tar.gz: 43019bdc355a9352af8a674f42a10b4d12f4fe64776c17089e731ea15109f0ab5b7c95ff476fbc3c493ba601e4570f00f51aa28514b3d9ff14ad1adc97de3715
+  metadata.gz: 9330b01347ddc68584bd6b87417e22d0577eb6f15e4a902c40af48b5a60b408977ff799df33280eed09800421004b1c3e9bffe264d00b017f38a5545f22352cb
+  data.tar.gz: 9bad2968b578fcf1141fb78c1b69284a6750c64596a68056ff733173aba2492f58842ff6005bffd79ee435d7140f079e44e2ee0e52b814a065ce64e187f337d3

data/README.md

@@ -41,13 +41,26 @@ The stateful_enum gem extends AR::Enum definition to take a block with a similar
 Example:
 ```ruby
 class Bug < ApplicationRecord
-  enum status: {unassigned: 0, assigned: 1, resolved: 2} do
+  enum status: {unassigned: 0, assigned: 1, resolved: 2, closed: 3} do
     event :assign do
       transition :unassigned => :assigned
     end
+
     event :resolve do
+      before do
+        self.resolved_at = Time.zone.now
+      end
+
       transition [:unassigned, :assigned] => :resolved
     end
+
+    event :close do
+      after do
+        Notifier.notify "Bug##{id} has been closed."
+      end
+
+      transition all - [:closed] => :closed
+    end
   end
 end
 ```
@@ -91,22 +104,27 @@ There are a few important details to note regarding this feature:
 * The `transition` method takes a Hash each key of which is state "from" transitions to the Hash value.
 * The "from" states and the "to" states should both be given in Symbols.
 * The "from" state can be multiple states, in which case the key can be given as an Array of states, as shown in the usage example.
+* The "from" state can be `all` that means all defined states.
 
-### Error handling
+### :if and :unless Condition
 
-**TODO**
+The `transition` method takes an `:if` or `:unless` option as a Proc.
 
-### Event hooks
+Example:
+```ruby
+event :assign do
+  transition :unassigned => :assigned, if: -> { !!assigned_to }
+end
+```
 
-**TODO**
+### Event hooks
 
-### Guards (:if and :unless options)
+You can define `before` and `after` event hooks inside of an `event` block.
 
-**TODO**
 
-### Transition from "all"
+## TODO
 
-**TODO**
+* Better Error handling
 
 
 ## Contributing

data/lib/stateful_enum/machine.rb

@@ -27,11 +27,17 @@ module StatefulEnum
       end
 
       def define_transition_methods
-        column, name, transitions = @column, @name, @transitions
+        column, name, transitions, before, after = @column, @name, @transitions, @before, @after
 
         @model.send(:define_method, name) do
-          if (to = transitions[self.send(column).to_sym])
-            self.class.instance_variable_get(:@_enum_methods_module).instance_method("#{to}!").bind(self).call
+          to, condition = transitions[self.send(column).to_sym]
+          #TODO better error
+          if to && (!condition || instance_exec(&condition))
+            #TODO transaction?
+            instance_eval(&before) if before
+            ret = self.class.instance_variable_get(:@_enum_methods_module).instance_method("#{to}!").bind(self).call
+            instance_eval(&after) if after
+            ret
           else
             false
           end
@@ -46,19 +52,38 @@ module StatefulEnum
         end
 
         @model.send(:define_method, "#{name}_transition") do
-          transitions[self.send(column).to_sym]
+          transitions[self.send(column).to_sym].try! :first
         end
       end
 
-      def transition(transitions)
+      def transition(transitions, options = {})
+        if options.blank?
+          options[:if] = transitions.delete :if
+          #TODO should err if if & unless were specified together?
+          if (unless_condition = transitions.delete :unless)
+            options[:if] = -> { !instance_exec(&unless_condition) }
+          end
+        end
         transitions.each_pair do |from, to|
           raise "Undefined state #{to}" unless @states.has_key? to
           Array(from).each do |f|
             raise "Undefined state #{f}" unless @states.has_key? f
-            @transitions[f] = to
+            @transitions[f] = [to, options[:if]]
           end
         end
       end
+
+      def all
+        @states.keys
+      end
+
+      def before(&block)
+        @before = block
+      end
+
+      def after(&block)
+        @after = block
+      end
     end
   end
 end

data/lib/stateful_enum/version.rb

@@ -1,3 +1,3 @@
 module StatefulEnum
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stateful_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Akira Matsuda