just_state_machine 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c74ea95f48cdea857973b9cd65ff7985ef34f21
-  data.tar.gz: 0fa48156ccd7ef61c450855c053b2d362a5e34ee
+  metadata.gz: a3c6bd3c8889f049fec253dd6f28baacef949905
+  data.tar.gz: 4886b6301006dae04f550c9ba3d98963ca75f2af
 SHA512:
-  metadata.gz: 0ca6342ddbe7928a00f6afa8bc9adc5cb9ee09832e877c275f431a22e7a97e411e9d8913a8243b57213e3fa33956e4d4182af0e3168a56137231e2d64270a172
-  data.tar.gz: bfa61404cbf03c319c0e09ccf46ca01298ee8a1c12f6a2b17d26db169689bef2b3d03d1d764797eec1395810af7e4e45419461a2450ab90ef9329f97ed0a7f00
+  metadata.gz: 84500a6b5717d563c659e6c999bb3d5f9a4f9102c5c63167bd035349c8efc8c30b3502cb74b95955f5941fd4694bb6d6e53eb7d0d1b143cdb31edf27e0ac134d
+  data.tar.gz: f3a632523feda1353f2e960dcd380f942f22d18a71fc53cddf5bcf0242ef6108077fc7a072999cfbe0ea819cb94e39eb479728df6f6f92f34a6d67ab8174349a

data/README.md

@@ -82,7 +82,38 @@ user.downgrade_title
 user.downgrade_title!
 user.can_downgrade_title?
 ```
+### State
+Define your state **before** define others(validation, event, etc). It is to prevent you define transition, validation for unwanted state.
+You can also define the `initial state`. Initial State is state value that is given when you don't set any value to state attribute in the instance on initialization. Initial State is optional.
 
+```ruby
+class UserStateMachine < Jsm::Base
+  attribute_name :title
+
+  state :beginner, initial: true
+  state :intermediate
+  state :master
+# more code here
+end
+
+class User
+  include Jsm::Client
+  jsm_use UserStateMachine
+
+  attr_accessor :title
+  #your code here
+
+  def initialize(title = nil)
+    @title = title
+  end
+end
+
+user = User.new
+user.current_state # :beginner
+
+user = User.new(:intermediate)
+user.current_state # :intermediate
+```
 ### Validation
 This is useful, when you want to allow transition to a specified state allowed when it pass the validation. Validation should return true if passed validation and false if failed.
 **note**: Dont forget to define the state first, because if not then Jsm will raise error `Jsm::InvalidStateError`. This is to prevent typo when add new validation
@@ -204,7 +235,6 @@ user.errors[:title] # ["is not between 20 and 50"]
 class UserStateMachine < Jsm::Base
   attribute_name :title
 
-  state :unconfirmed
   state :beginner
   state :intermediate
   state :master
@@ -217,7 +247,7 @@ class UserStateMachine < Jsm::Base
 
   validate :master do |user|
     unless user.current_level > 50
-     errors.add(:title, 'have not reached 50')
+     user.errors.add(:title, 'have not reached 50')
     end
   end
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "jsm"
+require "just_state_machine"
 Dir[File.expand_path("../../examples/**/*.rb",__FILE__)].each{ |f| require f }
 
 # You can add fixtures and/or initialization code here to make experimenting

data/examples/simple_state_machine.rb

@@ -1,7 +1,7 @@
 class UserStateMachine < Jsm::Base
   attribute_name :relationship
 
-  state :single
+  state :single, initial: true
   state :in_relationship
   state :married
   state :divorced
@@ -31,4 +31,7 @@ class UserBasic
   jsm_use UserStateMachine
 
   attr_accessor :relationship
+  def initialize(relationship = nil)
+    @relationship = relationship
+  end
 end

data/jsm.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-doc"
   spec.add_development_dependency "looksee"
-  spec.add_development_dependency "activerecord", "~> 4.1"
+  spec.add_development_dependency "activerecord", ">= 4.0"
   spec.add_development_dependency "sqlite3"
 end

data/lib/jsm/base.rb

@@ -15,6 +15,10 @@ class Jsm::Base
   # example
   # state :x
   # state :y
+  # if put params initial true
+  # it will be treated as initial_state
+  # example:
+  # state :x, initial: true
   def self.state(name, params = {})
     @states ||= Jsm::States.new
     @states.add_state(name, initial: params[:initial])
@@ -25,6 +29,14 @@ class Jsm::Base
     @states.list
   end
 
+  # return initial_state
+  # if empty return nil
+  def self.initial_state
+    if @states
+     @states.initial_state
+   end
+  end
+
   # add new event to the class and add its transition
   # example:
   # event :do_this do

data/lib/jsm/client.rb

@@ -38,6 +38,19 @@ module Jsm::Client
       Jsm::Machines.add_machines(self, state_machine.new(self))
     end
 
+    # override method new
+    # it is used for set the instance state attribute with initial_state
+    # if initial_state present & instance state attribute is nil
+    def new(*args, &block)
+      obj = super
+      initial_state = self.state_machine.initial_state
+
+      if initial_state && !obj.current_state
+        obj.send(:jsm_set_state, initial_state.name)
+      end
+      obj
+    end
+
     #define type of event executor to be used
     def jsm_event_executor
       Jsm::EventExecutor::Base

data/lib/jsm/event_executor/active_model.rb

@@ -1,15 +1,4 @@
 class Jsm::EventExecutor::ActiveModel < Jsm::EventExecutor::Base
-  # it execute event for the object.
-  # If transition failed or invalid by validation toward the object,
-  # then it will return false
-  def execute(event, obj)
-    if can_be_executed?(event, obj)
-      event.execute(obj)
-    else
-      false
-    end
-  end
-
   # check if the obj possible to execute the event
   def can_be_executed?(event, obj)
     state = event.can_be_transitioning_to(obj)

data/lib/jsm/states.rb

@@ -9,14 +9,25 @@ class Jsm::States
 
   # register new state into the list
   # @param state_name
+  # @param params: allowed params is `initial`(boolean value, default is false)
   def add_state(state_name, params = {})
     initial = params.fetch(:initial) { false }
     if !state_unique?(state_name)
       raise Jsm::NotUniqueStateError, "state #{state_name} has been defined"
     end
 
+    if initial && !initial_state.nil?
+      raise Jsm::InvalidStateError,"can not set initial state to #{state_name}. current initial state is #{initial_state.name}"
+    end
+
     state = create_state(state_name, initial)
     list.push(state)
+
+    @initial_state = state if state.initial
+  end
+
+  def initial_state
+    @initial_state
   end
 
   def has_state?(state_name)

data/lib/jsm/version.rb

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

data/lib/just_state_machine.rb

@@ -0,0 +1 @@
+require 'jsm'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - wendy0402
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2015-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +158,7 @@ files:
 - lib/jsm/validator.rb
 - lib/jsm/validators.rb
 - lib/jsm/version.rb
+- lib/just_state_machine.rb
 homepage: https://github.com/wendy0402/jsm
 licenses:
 - MIT