end_state 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1d64ebcbb974d3190a824a6cf1c77742c009339
-  data.tar.gz: 6acbeb81100f52bf97956a2bcbe7c5680bf02cba
+  metadata.gz: 04263dcaee90aaa630e9e16fd1648a71717b5c49
+  data.tar.gz: 1e5cba77cd2f71faa5792ba9374f7c14c941dda9
 SHA512:
-  metadata.gz: 16a4bc9c85e10fce41a81659aa9bb70b182a3378030e2531f4b5077c2749cda53de5dec0b49e94862d6d71aaf698c047c5b5532dffd0079b5fc7dd459a4caf56
-  data.tar.gz: 953922dc24b1bccd281564ee4769d515e45ef4fa4cd30d28c945368e2bba89defb92c6da22464ff8f83ecbaa96d5b1ec0b0bd689c32c8acd8f18d4e229d01f95
+  metadata.gz: f9e25308af4b71252f6e3709949077ffe7dee67312aea2eff0e310848b8f1215c2fa84f6259901ceee0a0560ee6e5dd6b6064c81720c87fc19cb1ce5a9962dd2
+  data.tar.gz: 4d9db32fc84ae115f6f6ae02e0a901f1f366351bc6291ae6c535f5633b12347fab002fb67322f627bb152f8084ff4c1e7adf773221fd4150b2f0fd01b5a7f979

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in end_state.gemspec
 gemspec
+gem 'ruby-graphviz'

data/README.md

@@ -77,7 +77,12 @@ These will only be called during the check performed during the transition and w
 These hooks can be useful for things like logging.
 
 The wrapped object has an array `failure_messages` available for tracking reasons for invalid transitions. You may shovel
-a reason (string) into this if you want to provide information on why your guard failed.
+a reason (string) into this if you want to provide information on why your guard failed. You can also use the helper method in
+the `Guard` class called `add_error` which takes a string.
+
+The wrapped object has an array `success_messages` available for tracking reasons for valid transitions. You may shovel
+a reason (string) into this if you want to provide information on why your guard passed. You can also use the helper method in
+the `Guard` class called `add_success` which takes a string.
 
 ```ruby
 class EasyGuard < EndState::Guard
@@ -121,7 +126,12 @@ set up a little differently and you have access to:
 * `params` - A hash of params passed when calling transition on the machine.
 
 The wrapped object has an array `failure_messages` available for tracking reasons for invalid transitions. You may shovel
-a reason (string) into this if you want to provide information on why your finalizer failed.
+a reason (string) into this if you want to provide information on why your finalizer failed. You can also use the helper method in
+the `Finalizer` class called `add_error` which takes a string.
+
+The wrapped object has an array `success_messages` available for tracking reasons for valid transitions. You may shovel
+a reason (string) into this if you want to provide information on why your finalizer succeeded. You can also use the helper method in
+the `Finalizer` class called `add_success` which takes a string.
 
 ```ruby
 class WrapUp < EndState::Finalizer
@@ -195,6 +205,12 @@ transition to the new state.
 You also have the option to use `transition!` which will instead raise an error for failures. If your guards and/or finalizers
 add to the `failure_messages` array then they will be included in the error message.
 
+## Graphing
+
+If you install `GraphViz` and the gem `ruby-graphviz` you can create images representing your state machines.
+
+`EndState::Graph.new(MyMachine).draw.output png: 'my_machine.png'`
+
 ## Testing
 
 Included is a custom RSpec matcher for testing your machines.

data/Rakefile

@@ -4,3 +4,11 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'end_state'
+  ARGV.clear
+  IRB.start
+end

data/lib/end_state/finalizer.rb

@@ -1,5 +1,6 @@
 module EndState
   class Finalizer
+    include Messages
     attr_reader :object, :state, :params
 
     def initialize(object, state, params)

data/lib/end_state/graph.rb

@@ -0,0 +1,21 @@
+module EndState
+  class Graph < GraphViz
+    attr_reader :machine, :nodes
+
+    def initialize(machine)
+      @machine = machine
+      @nodes = {}
+      super machine.name.to_sym
+    end
+
+    def draw
+      machine.transitions.keys.each do |t|
+        left, right = t.to_a.flatten
+        nodes[left] ||= add_node(left.to_s)
+        nodes[right] ||= add_node(right.to_s)
+        add_edge nodes[left], nodes[right]
+      end
+      self
+    end
+  end
+end

data/lib/end_state/guard.rb

@@ -1,5 +1,6 @@
 module EndState
   class Guard
+    include Messages
     attr_reader :object, :state, :params
 
     def initialize(object, state, params)

data/lib/end_state/messages.rb

@@ -0,0 +1,11 @@
+module EndState
+  module Messages
+    def add_error(message)
+      object.failure_messages << message
+    end
+
+    def add_success(message)
+      object.success_messages << message
+    end
+  end
+end

data/lib/end_state/state_machine.rb

@@ -1,6 +1,6 @@
 module EndState
   class StateMachine < SimpleDelegator
-    attr_accessor :failure_messages
+    attr_accessor :failure_messages, :success_messages
 
     def self.transition(state_map)
       initial_states = Array(state_map.keys.first)
@@ -59,6 +59,7 @@ module EndState
 
     def transition(state, params = {}, mode = :soft)
       @failure_messages = []
+      @success_messages = []
       previous_state = self.state
       transition = self.class.transitions[{ previous_state => state }]
       return block_transistion(transition, state, mode) unless transition

data/lib/end_state/version.rb

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

data/lib/end_state.rb

@@ -1,12 +1,18 @@
 require 'delegate'
 require 'end_state/version'
 require 'end_state/errors'
+require 'end_state/messages'
 require 'end_state/guard'
 require 'end_state/finalizer'
 require 'end_state/finalizers'
 require 'end_state/transition'
 require 'end_state/action'
 require 'end_state/state_machine'
+begin
+  require 'graphviz'
+  require 'end_state/graph'
+rescue LoadError
+end
 
 module EndState
 end

data/lib/tasks/end_state.rake

@@ -0,0 +1,14 @@
+namespace :end_state do
+  desc 'Draw the statemachine using GraphViz (options: machine=MyMachine, format=png, output=machine.png'
+  task :draw do
+    options = {}
+    options[:machine] = ENV['machine']
+    options[:format] = ENV['format'] || :png
+    options[:output] = ENV['output'] || "#{options[:machine].to_s}.#{options[:format].to_s}"
+    if options[:machine]
+      EndState::Graph.new(Object.const_get(options[:machine])).draw.output options[:format] => options[:output]
+    else
+      puts 'A machine is required'
+    end
+  end
+end

data/spec/end_state/finalizer_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module EndState
+  describe Finalizer do
+    subject(:finalizer) { Finalizer.new(object, state, params) }
+    let(:object) { Struct.new('Machine', :failure_messages, :success_messages, :state).new }
+    let(:state) { :a }
+    let(:params) { {} }
+    before do
+      object.failure_messages = []
+      object.success_messages = []
+    end
+
+    describe '#add_error' do
+      it 'adds an error' do
+        finalizer.add_error('error')
+        expect(object.failure_messages).to eq ['error']
+      end
+    end
+
+    describe '#add_success' do
+      it 'adds an success' do
+        finalizer.add_error('success')
+        expect(object.failure_messages).to eq ['success']
+      end
+    end
+  end
+end

data/spec/end_state/guard_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module EndState
+  describe Guard do
+    subject(:guard) { Guard.new(object, state, params) }
+    let(:object) { Struct.new('Machine', :failure_messages, :success_messages, :state).new }
+    let(:state) { :a }
+    let(:params) { {} }
+    before do
+      object.failure_messages = []
+      object.success_messages = []
+    end
+
+    describe '#add_error' do
+      it 'adds an error' do
+        guard.add_error('error')
+        expect(object.failure_messages).to eq ['error']
+      end
+    end
+
+    describe '#add_success' do
+      it 'adds an success' do
+        guard.add_error('success')
+        expect(object.failure_messages).to eq ['success']
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: end_state
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,13 +91,18 @@ files:
 - lib/end_state/finalizer.rb
 - lib/end_state/finalizers.rb
 - lib/end_state/finalizers/persistence.rb
+- lib/end_state/graph.rb
 - lib/end_state/guard.rb
+- lib/end_state/messages.rb
 - lib/end_state/state_machine.rb
 - lib/end_state/transition.rb
 - lib/end_state/version.rb
 - lib/end_state_matchers.rb
+- lib/tasks/end_state.rake
 - spec/end_state/action_spec.rb
+- spec/end_state/finalizer_spec.rb
 - spec/end_state/finalizers/persistence_spec.rb
+- spec/end_state/guard_spec.rb
 - spec/end_state/state_machine_spec.rb
 - spec/end_state/transition_spec.rb
 - spec/end_state_spec.rb
@@ -128,7 +133,9 @@ specification_version: 4
 summary: A State Machine implementation
 test_files:
 - spec/end_state/action_spec.rb
+- spec/end_state/finalizer_spec.rb
 - spec/end_state/finalizers/persistence_spec.rb
+- spec/end_state/guard_spec.rb
 - spec/end_state/state_machine_spec.rb
 - spec/end_state/transition_spec.rb
 - spec/end_state_spec.rb