flow_machine 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ddc0a3879f962108fb9bc5616667131e0e3830e
-  data.tar.gz: 1ce4561e9efd33531e4d3754b24ef653b3c047bc
+  metadata.gz: 4f2854b32591eca32664799e2989ca782d48a210
+  data.tar.gz: 67dc2d6d227bfd8d9d6e206cabd68fe9744a671f
 SHA512:
-  metadata.gz: 569a2f85b79f0328cf6af65d4a2f5e11a783b7c06c88380f6ef7f6a6e7e551a2b96d541d0ead6681b5f27eeaf99f0cfd6ed50327d843895750dc6e5ee199aea0
-  data.tar.gz: 12b15553a5ec36b9e49d1fc8f801c4ccf554a0d809b75ddcafbc0cea4b64043b35f8d6a1148f423546b34fbf52d4057c33fde101296262f535b15140c47d04b3
+  metadata.gz: 66e5f0523da68517a158f700e6a8513ca0fc39988e105ac047c6e23d44a1ed389471f95f7ce6af1f577305cbd6d0b888053e25dc5d3296e16e5e26d4f30eb211
+  data.tar.gz: e439a8fc84df57039721fb849e39037f045b0d6ed82711710091c03506271ee529f94401500be86aba05866e1e941aae0174ffaf9df37729f685372eb4f27f1a

data/README.md

@@ -12,6 +12,10 @@ After exploring several of the existing Ruby state machine options, they all see
 
 See [UPGRADE.md](UPGRADE.md) for details
 
+## Requirements
+
+Ruby 2.0+
+
 ## Simple Usage
 
 ```ruby
@@ -75,7 +79,7 @@ Calling the transition with a failing guard will result in the object not being
 
 #### guard_errors
 
-After calling `may_xxx?`, the workflow will have an array of the guard methods that failed. to avoid additional dependencies, the developer is responsible for converting these to human readable messages (using I18n or the like).
+After calling `may_xxx?`, the workflow will have an array of the guard methods that failed. To avoid additional dependencies, the developer is responsible for converting these to human readable messages (using I18n or the like). This may include `:invalid_event` in the case where a transition from the current state is not defined.
 
 ```ruby
 class DraftState < FlowMachine::WorkflowState

data/lib/flow_machine/version.rb

@@ -1,3 +1,3 @@
 module FlowMachine
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/flow_machine/workflow.rb

@@ -91,10 +91,16 @@ module FlowMachine
       end
 
       # Defines an instance method on Workflow that delegates to the
-      # current state, but only if the current_state implements the method
+      # current state. If the current state does not support the method, then
+      # add an :invalid_event error to the guard_errors.
       def define_state_method(method_name)
         define_method method_name do |*args|
-          current_state.respond_to?(method_name) && current_state.send(method_name, *args)
+          if current_state.respond_to?(method_name)
+            current_state.send(method_name, *args)
+          else
+            self.guard_errors = [:invalid_event]
+            false
+          end
         end
       end
 
@@ -114,7 +120,7 @@ module FlowMachine
 
     # extend Forwardable
     # def_delegators :current_state, :guard_errors
-    delegate :guard_errors, to: :current_state
+    delegate :guard_errors, :guard_errors=, to: :current_state
 
     def initialize(object, options = {})
       @object = object

data/spec/flow_machine/workflow_state_spec.rb

@@ -42,12 +42,13 @@ RSpec.describe FlowMachine::WorkflowState do
     end
   end
 
-  describe 'events' do
+  describe 'invalid transitions' do
     let(:state_class2) do
       Class.new(described_class) do
         def self.state_name; :test2; end
       end
     end
+
     before :each do
       state_class.event(:event1) { transition to: :test2 }
       workflow_class.refresh_state_methods!
@@ -58,6 +59,18 @@ RSpec.describe FlowMachine::WorkflowState do
       expect(object).to receive(:state).and_return :test2
       expect(workflow.event1).to be false
     end
+
+    it 'sets an invalid_event error when trying to transition to the curent state' do
+      expect(object).to receive(:state).and_return :test2
+      workflow.event1
+      expect(workflow.guard_errors).to eq([:invalid_event])
+    end
+
+    it 'sets an invalid_event error when trying to may to the current state' do
+      expect(object).to receive(:state).and_return :test2
+      expect(workflow).not_to be_may_event1
+      expect(workflow.guard_errors).to eq([:invalid_event])
+    end
   end
 
   describe 'guards' do
@@ -70,7 +83,7 @@ RSpec.describe FlowMachine::WorkflowState do
         state.event1
       end
 
-      context 'may?' do
+      describe 'may?' do
         it 'is able to transition if the guard returns true' do
           expect(state).to receive(:guard1?).and_return true
           expect(state.may_event1?).to be true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_machine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jason Hanggi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A class-based state machine.
@@ -110,3 +110,4 @@ test_files:
 - spec/flow_machine/workflow_spec.rb
 - spec/flow_machine/workflow_state_spec.rb
 - spec/spec_helper.rb
+has_rdoc: