activerecord-fsm 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b281902b922a683073baf632654a0657f7e9bdbb3c3348960491432428a68444
-  data.tar.gz: 157d440eb10fd597a283e677c6f698c2cf5b76e3888599a0d26d960678132eca
+  metadata.gz: 351276a49e27c515507b1e7857e9a67f554014b0d104f3044b7564ef3c8f1b60
+  data.tar.gz: b6820092158ca95745e4d4286539b1bb3a2b89995a639415a753cb2815bfedad
 SHA512:
-  metadata.gz: 696e9bc135f6c6b755102e5fb535a941bebf6d9e1fd224312673b889bb9ee1628b7551aa1cc939fc520b9570f9eff8495aa7470b3946e87dcbb2a2a5595c1524
-  data.tar.gz: e9d4c60a0d9eed133867c619bdf4558cdbb31766f225c3d892f55f5a76ed2eb691f745c8ae7b468d1aa91b0e9cb4001cf634788735acb5bd918ceaa6e8690a30
+  metadata.gz: 16bb26cfdd1bea69b4f740e575b7d7c3319e1acce307650fdc999ae1dea86b9477d07b9e3352ec61e7abc13a3b6e688a7ce9f9c7435e691901c5f2cba05c4d25
+  data.tar.gz: ac6f2bd60084ac177923c03afa8934d90cc7a12709c77b402237f6f3b8e8a19699cbdbdcffaf5af643c6bca95fdfcfc7e70828ccec03dfb2cf2e992d35bbfb6b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-fsm (0.1.1)
+    activerecord-fsm (0.1.2)
       activerecord (>= 5.2, < 7.0)
       activesupport (>= 5.2, < 7.0)
 

data/README.md

@@ -42,15 +42,25 @@ Maybe you need to do migration, add one column named `status`:
         end
       end
     ```
-    **Model without using `fsm_define` will only act as the same with `NomalModel` which doesn't has fsm mechanic.**  
-    In other words, using `fsm_define` will make `NomalModel` become `FsmModel`.
+    **Model without using `fsm_define` will only act as the same with `NormalModel` which doesn't has fsm mechanic.**  
+    In other words, using `fsm_define` will make `NormalModel` become `FsmModel`.
 
-3. Use `FsmModel.fsm_graph.states` to get permit_transition you defined.
-4. Use `ActiveRecord::Fsm::Graph.defined_klasses` to get all the models which really used `ActiveRecord::Fsm`.
+3. Use `FsmModel.fsm_graph.transitions` to get all permit_transition you defined.
+4. Use `FsmModel.fsm_graph.states` to get all permit_status you defined.
+5. Use `FsmModel.fsm_graph.final_states.include?(fsm_instance.status)` to judge FsmModel instance `fsm_instance` terminate?.
+6. Use `ActiveRecord::Fsm::Graph.defined_klasses` to get all the models which really used `ActiveRecord::Fsm`.
 
 e.g.  
 
 ```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include ActiveRecord::Fsm
+
+  self.abstract_class = true
+  # blabalbla......
+end
+
+# FsmModel need call fsm_define
 class FsmModel < ApplicationRecord
   STATE_1 = 1
   STATE_2 = 2
@@ -65,12 +75,16 @@ class FsmModel < ApplicationRecord
   fsm_define(PERMIT_TRANSITIONS)
 end
 
+# FsmModel can be shown having used ActiveRecord::Fsm
 ActiveRecord::Fsm::Graph.defined_klasses
 # => [FsmModel]
 
+# NormalModel doesn't call fsm_define
+# although inherited from ApplicationRecord
 class NormalModel < ApplicationRecord
 end
 
+# NormalModel is not included
 ActiveRecord::Fsm::Graph.defined_klasses
 # => [FsmModel]
 ```

data/lib/activerecord/fsm/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Fsm
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-fsm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ElliotCui