state_jacket 0.0.3 → 0.0.4

data/README.md

@@ -11,7 +11,7 @@ and how they transition to other states.
 
 *The examples below are somewhat contrived, but should clearly illustrate the usage.*
 
-## Quick Start
+## The Basics
 
 #### Install
 
@@ -32,6 +32,7 @@ states.add :closed => [:open, :error]
 states.add :error
 states.lock
 
+states.inspect # => {:open=>[:closed, :error], :closed=>[:open, :error], :error=>nil}
 states.transitioners # => [:open, :closed]
 states.terminators # => [:error]
 
@@ -71,3 +72,59 @@ states.can_transition? :connected => :idle # => true
 states.can_transition? :idle => [:dialing, :connected] # => false
 ```
 
+## Deep Cuts
+
+Lets add state awareness and behavior to another class.
+We'll reuse the turnstyle states from the example from above.
+
+```ruby
+require "state_jacket"
+
+class Turnstyle
+  attr_reader :states, :current_state
+
+  def initialize
+    @states = StateJacket::Catalog.new
+    @states.add :open => [:closed, :error]
+    @states.add :closed => [:open, :error]
+    @states.add :error
+    @states.lock
+    @current_state = :closed
+  end
+
+  def open
+    if states.can_transition? current_state => :open
+      @current_state = :open
+    else
+      raise "Can't transition from #{@current_state} to :open"
+    end
+  end
+
+  def close
+    if states.can_transition? current_state => :closed
+      @current_state = :closed
+    else
+      raise "Can't transition from #{@current_state} to :closed"
+    end
+  end
+
+  def break
+    @current_state = :error
+  end
+end
+
+# example usage
+turnstyle = Turnstyle.new
+turnstyle.current_state # => :closed
+turnstyle.open
+turnstyle.current_state # => :open
+turnstyle.close
+turnstyle.current_state # => :closed
+turnstyle.close # => RuntimeError: Can't transition from closed to :closed
+turnstyle.open
+turnstyle.current_state # => :open
+turnstyle.open # => RuntimeError: Can't transition from open to :open
+turnstyle.break
+turnstyle.open # => RuntimeError: Can't transition from error to :open
+turnstyle.close # => RuntimeError: Can't transition from error to :closed
+```

data/lib/state_jacket/catalog.rb

@@ -31,12 +31,20 @@ module StateJacket
       end
     end
 
+    def transitioner?(state)
+      transitioners.include?(state.to_sym)
+    end
+
     def terminators
       keys.select do |state|
         self[state] == nil
       end
     end
 
+    def terminator?(state)
+      terminators.include?(state.to_sym)
+    end
+
     def lock
       values.flatten.each do |value|
         next if value.nil?
@@ -46,6 +54,11 @@ module StateJacket
       end
       freeze
     end
+
+    def supports_state?(state)
+      keys.include?(state.to_sym)
+    end
+
   end
 
 end

data/lib/state_jacket/version.rb

@@ -1,3 +1,3 @@
 module StateJacket
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_jacket
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -50,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Intuitively define state machine like states and transitions.