just_state_machine 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c6bd3c8889f049fec253dd6f28baacef949905
-  data.tar.gz: 4886b6301006dae04f550c9ba3d98963ca75f2af
+  metadata.gz: ffaec8272814487f36a006b35a7fb4ba9d03e212
+  data.tar.gz: 9e6c7df7b81ee6e55d79f47c9a8e44ac36234df1
 SHA512:
-  metadata.gz: 84500a6b5717d563c659e6c999bb3d5f9a4f9102c5c63167bd035349c8efc8c30b3502cb74b95955f5941fd4694bb6d6e53eb7d0d1b143cdb31edf27e0ac134d
-  data.tar.gz: f3a632523feda1353f2e960dcd380f942f22d18a71fc53cddf5bcf0242ef6108077fc7a072999cfbe0ea819cb94e39eb479728df6f6f92f34a6d67ab8174349a
+  metadata.gz: a8f00e1451d1fb713f8000027239c1de502093bb658be3ee7a2c1106103b39b4573053ae88445e4e399a9f2b1b5e455c9b95f789ac498d5e5e32a02253ad7dc0
+  data.tar.gz: dd327c2a4857e9b2795ac11dbb081d31f2da958fa17ce0bcfb2de68288edb7936ccb39a666294ffc2b6bae79b2c8917f5768d990d421c1b79101a7f68104ae3d

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/jsm.svg)](https://badge.fury.io/rb/jsm)
+[![Gem Version](https://badge.fury.io/rb/just_state_machine.svg)](https://badge.fury.io/rb/just_state_machine)
 [![Code Climate](https://codeclimate.com/github/wendy0402/jsm/badges/gpa.svg)](https://codeclimate.com/github/wendy0402/jsm)
 # Jsm
 
@@ -9,7 +9,7 @@ JSM is abbreviation of Just State Machine. The purpose is to simplify and increa
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'jsm'
+gem 'just_state_machine'
 ```
 
 And then execute:
@@ -18,7 +18,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install jsm
+    $ gem install just_state_machine
 
 ## Usage
 
@@ -168,7 +168,15 @@ user.title # :beginner
 user.upgrade_title # true
 user.title # :intermediate
 ```
+### Transition
+Transition will transitioning your state from one state to other state. Params `from` in transition can receive one or multiple states.
+However to put multiple states, you need to put it in array.
 
+```ruby
+transition from: :intermediate, to: :beginner #one `from` states
+transition from: [:intermediate, :master], to: :beginner #multiple `from` states
+```
+What above code means for multiple `from` states is the current state either `:intermediate` or `:master`, transform it into `:beginner` state
 ## Active Model Integration
 ```ruby
 class UserStateMachine < Jsm::Base

data/lib/jsm.rb

@@ -17,4 +17,10 @@ module Jsm
     require "jsm/event_executor/active_model"
     require "jsm/event_executor/active_record"
   end
+
+  module Drawer
+    require "jsm/drawer/node"
+    require "jsm/drawer/digraph"
+    require "jsm/drawer/graphviz"
+  end
 end

data/lib/jsm/drawer/digraph.rb

@@ -0,0 +1,41 @@
+#list of all nodes
+class Jsm::Drawer::Digraph
+  attr_reader :state_machine
+  def initialize(state_machine)
+    @state_machine = state_machine
+  end
+
+  #list of all nodes
+  # TODO: move it to different class(?)
+  def nodes
+    unless @nodes
+      events = state_machine.events.values
+      @nodes = events.map{ |event| to_nodes(event) }.flatten
+    end
+    @nodes
+  end
+
+  # convert it to string that is compatible with api Graphviz
+  def to_s
+    nodes.map(&:to_s).join(';')
+  end
+
+  private
+
+  # convert transitions of event into nodes object
+  # return value is array
+  # e.g: [Jsm::Drawer::Node.new(:confirmed, :completed, :complete)]
+  def to_nodes(event)
+    nodes = []
+    event.transitions.each do |transition|
+      if transition.multiple_from?
+        temp_nodes = transition.from.map{ |from| Jsm::Drawer::Node.new(from: from, to: transition.to, label: event.name) }
+      else
+        from = transition.from[0] # even only one it is still in array e.g: [:confirmed]
+        temp_nodes = [Jsm::Drawer::Node.new(from: from, to: transition.to, label: event.name)]
+      end
+      nodes += temp_nodes
+    end
+    nodes
+  end
+end

data/lib/jsm/drawer/graphviz.rb

@@ -0,0 +1,16 @@
+class Jsm::Drawer::Graphviz
+  API_URL = "https://chart.googleapis.com/chart"
+  def self.generate_url(state_machine)
+    new(state_machine).generate_url
+  end
+
+  def initialize(state_machine)
+    @state_machine = state_machine
+    @diagraph = Jsm::Drawer::Digraph.new(@state_machine)
+  end
+
+  def generate_url
+    diagram = @diagraph
+    "#{API_URL}?cht=gv&chl=digraph{#{diagram}}"
+  end
+end

data/lib/jsm/drawer/node.rb

@@ -0,0 +1,12 @@
+class Jsm::Drawer::Node
+  attr_reader :from, :to, :label
+  def initialize(params = {})
+    @from = params[:from]
+    @to = params[:to]
+    @label = params[:label]
+  end
+
+  def to_s
+    "#{from.to_s}->#{to.to_s}[label=#{label.to_s}]"
+  end
+end

data/lib/jsm/event.rb

@@ -4,7 +4,12 @@ class Jsm::Event
   attr_reader :name, :states, :transitions
   attr_accessor :attribute_name
 
-  ::Jsm::Transition = Struct.new(:from, :to)
+  ::Jsm::Transition = Struct.new(:from, :to) do
+    def multiple_from?
+      from.size > 1
+    end
+  end
+
   def initialize(name, params = {}, &block)
     @name = name
     @states = params[:states]

data/lib/jsm/version.rb

@@ -1,3 +1,3 @@
 module Jsm
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - wendy0402
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-18 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,9 @@ files:
 - lib/jsm/client/active_model.rb
 - lib/jsm/client/active_record.rb
 - lib/jsm/client_extension.rb
+- lib/jsm/drawer/digraph.rb
+- lib/jsm/drawer/graphviz.rb
+- lib/jsm/drawer/node.rb
 - lib/jsm/event.rb
 - lib/jsm/event_executor/active_model.rb
 - lib/jsm/event_executor/active_record.rb