finite_machine 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e70496d1e626025a2c8ad75e0c66f5dfacb5d1c5
-  data.tar.gz: 30b266427c011d60d77254c0740d34c843a55732
+  metadata.gz: d61855a6c9bcf4a134d260eed0b9926250c165e2
+  data.tar.gz: 8700fa2dccb31e106fa9fa7769466d4a4b22fc24
 SHA512:
-  metadata.gz: d7e2d93b571c333c64ec880d3665abdf1ca65b8abd4ba2389b7d6451ad179e4aca67c42811829bdb6cad23a61993efdaf1c225cb6927572222b6bb76828bec88
-  data.tar.gz: d72998f62c65ed6c5f74021926db45e99cfaf065665627f4a8f2e485215397c712326d80a36aa20e281879bb9d79dcab5f670d0ca71736d7bc6e09c4edb7182a
+  metadata.gz: 199260fd23c214d00e371a803178ee8693fb9f236ca3e68f08a59f181f8d8f251e9a5e340f60deb2b5894358517bf892a8410e6f97e80a717b12ca280c3e50b6
+  data.tar.gz: 53371bc2d260b5c9e2cf48c03769891540227b967f85039aa878731a9efe6b3be68dffce30a2b45375be409486449d410f3d521eb691fa8b9bc3296982c58402

data/.rspec

@@ -2,3 +2,4 @@
 --format progress
 --order random
 --warnings
+--require spec_helper

data/.travis.yml

@@ -1,19 +1,22 @@
+---
 language: ruby
-bundler_args: --without yard guard benchmarks
+sudo: false
+cache: bundler
+bundler_args: --without yard benchmarks
 script: "bundle exec rake ci"
 rvm:
   - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.0
+  - 2.1
+  - 2.2
   - ruby-head
+  - rbx-2
 matrix:
   include:
     - rvm: jruby-19mode
     - rvm: jruby-20mode
     - rvm: jruby-21mode
     - rvm: jruby-head
-    - rvm: rbx-2
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,8 +1,18 @@
-0.11.0 (Oct 11, 2015)
+# Change Log
 
+## [v0.11.1] - 2015-12-17
+
+### Fixed
+* Fix cancelling callbacks for halted transition by craiglittle
+
+## [v0.11.0] - 2015-10-11
+
+### Added
 * Add UndefinedTransition to mark self transition(e.i. no transition found)
 * Add StateDefinition for state query methods
 * Add #trigger and #trigger! to StateMachine to allow manual firing of events and split between dangerous and non-dangerous versions of api.
+
+### Changed
 * Change ThreadContext to require per thread setup
 * Change Transition to stop relying on global transitions
 * Change EventChain to manage all internal transitions
@@ -11,67 +21,91 @@
 * Change HookEvent to accept event name and from state
 * Remove Event class as duplicate of Transition
 * Remove unnecessary checks for StateMachine#can?
+
+### Fixed
 * Fix bug in Transition with current transition matching
 * Fix bug in Observer with cancelling inside event callback
 
-0.10.2 (July 5, 2015)
+## [v0.10.2] - 2015-07-05
 
-* Fix to run 'on_after' callbacks even when event cancalled by @craiglittle
-* Fix to cancel transition when no matching choice is found by @craiglittle
+### Changed
 * Change StateParser #parse method
 * Change EventBuilder to EventDefinition and invert dependencies
 * Change Event#call to #trigger
 * Change Transition#call to #execute
 
-0.10.1 (May 24, 2015)
+### Fixed
+* Fix to run 'on_after' callbacks even when event cancalled by @craiglittle
+* Fix to cancel transition when no matching choice is found by @craiglittle
 
+## [v0.10.1] - 2015-05-24
+
+### Added
 * Add ability to inherit state machine definitions
 * Add Env class for holiding machine envionment references
+
+### Changed
 * Change DSL to delegate calls to machine instance
 * Change ChoiceMerger to use machine directly
 
-0.10.0 (November 16, 2014)
+## [v0.10.0] - 2014-11-16
 
+### Added
 * Add #alias_target to allow renaming of target object by @reggieb
-* Fix issue with async calls passing wrong arguments to conditionals
-* Change TransitionEvent, AsyncCall to be immutable
 * Add :log_transitions option for easy transition debugging
+
+### Changed
+* Change TransitionEvent, AsyncCall to be immutable
 * Increase test coverage to 99%
 
-0.9.2 (September 27, 2014)
+### Fixed
+* Fix issue with async calls passing wrong arguments to conditionals
+
+## [v0.9.2] - 2014-09-27
 
+### Changed
 * Removes use of class variable to share Sync by @reggieb
+
+### Fixed
 * Fix observer to differentiate between any state and any event
 * [#23] Fix transition to correctly set :from and :to parameters for :any state
 * [#25] Fix passing parameters to choice events with same named events
 * Fix choice pseudostate to work with :any state
 
-0.9.1 (August 10, 2014)
+## [v0.9.1] - 2014-08-10
 
+### Added
 * Add TransitionBuilder to internally build transitions from states
-* Fix #choice to allow for multiple from states
 * Add #current? to Transition to determine if matches from state
 * Add #select_choice_transition to EventsChain to determine matching choice transition
+
+### Fixed
+* Fix #choice to allow for multiple from states
 * Fix #choice to work with same named events
 
-0.9.0 (August 3, 2014)
+## [v0.9.0] 2014-08-03
 
+### Added
 * Add Definition class to allow to define standalone state machine
-* Upgrade RSpec dependency and refactor specs
+* Add #build method to HookEvent
+
+### Changed
 * Change initial helper to simply state name with options
 * Change HookEvent to be immutable and extend comparison
 * Change Event to be immutable and extend comparison
-* Add #build method to HookEvent
 * Change finished? to terminated? and allow for multiple terminal states
 * Change to require explicit context to call target methods
+* Upgrade RSpec dependency and refactor specs
 
-0.8.1 (July 5, 2014)
+## [v0.8.1] - 2014-07-05
 
+### Added
 * Add EventsChain to handle internal events logic
 * Add EventBuilder to handle events construction
 
-0.8.0 (June 22, 2014)
+## [v0.8.0] - 2014-06-22
 
+### Added
 * Add silent option for state machine events to allow turning on/off
   selectively callbacks
 * Ensure that can? & cannot? take into account conditionl logic applied
@@ -80,83 +114,132 @@
 * Add ability to do dynamic conditional branching using the choice DSL or
   grouped events with different outgoing transitions [solves #13 and #6 issue]
 
-0.7.1 (June 8, 2014)
+## [v0.7.1] - 2014-06-08
 
+### Changed
 * Change to relax callback name checks to allow for duplicate state and event names
 * Change so that transition to initial state triggers callbacks
 
-0.7.0 (May 26, 2014)
+## [v0.7.0] - 2014-05-26
 
-* Change Event to EventHook for callback events
+### Added
 * Add Event to hold the logic for event specification
-* Fix issue #8 to preserve conditionals between event specifications
+* Add string inspection to hooks
+* Add check for callback name conflicts
+
+### Changed
+* Change Event to EventHook for callback events
 * Change to allow for self-transition - fixes issue #9
 * Change to detect attempt to overwrite already defined method - fixes issue #10
-* Fix #respond_to on state machine to include observer
-* Add string inspection to hooks
-* Fix observer missing methods resolution
 * Change to separate state and event callbacks. Introduced on_enter, on_before,
   once_on_enter, once_on_before new event callbacks.
 * Change generic callbacks to default to any state for on_enter, on_transition,
   on_exit and any event for on_before and on_after
-* Add check for callback name conflicts
-* Ensure proper callback lifecycle
+* Change to ensure proper callback lifecycle
 
-0.6.1 (May 10, 2014)
+### Fixed
+* Fix issue #8 to preserve conditionals between event specifications
+* Fix #respond_to on state machine to include observer
+* Fix observer missing methods resolution
 
+### [v0.6.1] - 2014-05-10
+
+### Fixed
 * Fix stdlib requirement
 
-0.6.0 (May 10, 2014)
+### [v0.6.0] - 2014-05-10
 
+### Added
 * Add StateParser to allow for grouping transition under same event name
-* Change Transition to store a map of transition for a given event
 * Add abilility to correctly extract :to state for Transition instance
+
+### Changed
+* Change Transition to store a map of transition for a given event
+
+### Fixed
 * Fix bug #6 with incorrect TransitionEvent payload information
 
-0.5.0 (April 28, 2014)
+## [v0.5.0] - 2014-04-28
 
+### Added
+* Add generic Listener interface
+* Add ability to fire callbacks asynchronously
+* Add initial state storage
+
+### Changed
 * Change to allow for machine to be constructed as plain object
 * Allow for :initial, :terminal and :target to be machine parameters
-* Add generic Listener interface
 * Change EventQueue to allow for subscription
 * Increase test coverage to 98%
 * Change to allow access to target inside machine dsl
-* Add ability to fire callbacks asynchronously
-* Add initial state storage
 
-0.4.0 (April 13, 2014)
+## [v0.4.0] - 2014-04-13
 
-* Change initial state to stop firing event notification
-* Fix initial to accept any state object
+### Added
 * Add logger
 * Add ability to cancel transitions inside callbacks
-* Fix proc conditions to accept aditional arguments
-* Increase test coverage to 97%
 * Add ability to force transitions
 
-0.3.0 (March 30, 2014)
+### Changed
+* Change initial state to stop firing event notification
+* Increase test coverage to 97%
 
-* Move development dependencies to Gemfile
-* Increase test coverage to 95%
-* Fix bug with event methods dynamic redefinition
-* Change attr_threadsafe to accept default values
-* Fix observer respond_to
+### Fixed
+* Fix initial to accept any state object
+* Fix proc conditions to accept aditional arguments
+
+## [v0.3.0] - 2014-03-30
+
+### Added
 * Add ability to specify callbacks on machine instance
 * Add once_on type of callback
 * Add off method for removing callbacks
 * Add async method to state_machine for asynchronous events firing
-* Fix Callable to correctly forward arguments
 * Add state helpers fsm.green? to allow easily check current state
 
-0.2.0 (March 01, 2014)
+### Changed
+* Change attr_threadsafe to accept default values
+* Move development dependencies to Gemfile
+* Increase test coverage to 95%
 
-* Ensure correct transition object state
-* Add methods synchronization for thread safety
-* Fix bug - callback event object returns correct from state
-* Add ability to define custom initial event
-* Add hooks class for callbacks registration
-* Extend threadable accessors
+### Fixed
+* Fix bug with event methods dynamic redefinition
+* Fix observer respond_to
+* Fix Callable to correctly forward arguments
+
+## [v0.2.0] - 2014-03-01
+
+### Added
 * Add generic state and event listeners
 * Add target to allow integration with external objects,
   and allow easy method lookup through callback context
 * Add ability to specify custom handlers for error conditions
+* Add methods synchronization for thread safety
+* Add ability to define custom initial event
+* Add hooks class for callbacks registration
+
+### Changed
+* Change to ensure correct transition object state
+* Extend threadable accessors
+
+### Fixed
+* Fix bug - callback event object returns correct from state
+
+[v0.11.1]: https://github.com/peter-murach/finite_machine/compare/v0.11.0...v0.11.1
+[v0.11.0]: https://github.com/peter-murach/finite_machine/compare/v0.10.2...v0.11.0
+[v0.10.2]: https://github.com/peter-murach/finite_machine/compare/v0.10.1...v0.10.2
+[v0.10.1]: https://github.com/peter-murach/finite_machine/compare/v0.10.0...v0.10.1
+[v0.10.0]: https://github.com/peter-murach/finite_machine/compare/v0.9.2...v0.10.0
+[v0.9.2]: https://github.com/peter-murach/finite_machine/compare/v0.9.1...v0.9.2
+[v0.9.1]: https://github.com/peter-murach/finite_machine/compare/v0.9.0...v0.9.1
+[v0.9.0]: https://github.com/peter-murach/finite_machine/compare/v0.8.1...v0.9.0
+[v0.8.1]: https://github.com/peter-murach/finite_machine/compare/v0.8.0...v0.8.1
+[v0.8.0]: https://github.com/peter-murach/finite_machine/compare/v0.7.1...v0.8.0
+[v0.7.1]: https://github.com/peter-murach/finite_machine/compare/v0.7.0...v0.7.1
+[v0.7.0]: https://github.com/peter-murach/finite_machine/compare/v0.6.1...v0.7.0
+[v0.6.1]: https://github.com/peter-murach/finite_machine/compare/v0.6.0...v0.6.1
+[v0.6.0]: https://github.com/peter-murach/finite_machine/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/peter-murach/finite_machine/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/peter-murach/finite_machine/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/peter-murach/finite_machine/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/peter-murach/finite_machine/compare/v0.1.0...v0.2.0

data/Gemfile

@@ -4,8 +4,7 @@ gemspec
 
 group :development do
   gem 'pry',   '~> 0.10.1'
-  gem 'rake',  '~> 10.4.2'
-  gem 'rspec', '~> 3.3.0'
+  gem 'rspec', '~> 3.4.0'
   gem 'yard',  '~> 0.8.7'
 end
 

data/finite_machine.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

data/lib/finite_machine/events_chain.rb

@@ -233,19 +233,17 @@ module FiniteMachine
       transition.to_state(from_state)
     end
 
-    # Set cancelled status for all transitions matching event name
+    # Set status to cancelled for all transitions matching event name
     #
     # @param [Symbol] name
     #   the event name
-    # @param [Symbol] status
-    #   true to cancel, false otherwise
     #
     # @return [nil]
     #
     # @api public
-    def cancel_transitions(name, status)
+    def cancel_transitions(name)
       chain[name].each do |trans|
-        trans.cancelled = status
+        trans.cancelled = true
       end
     end
 

data/lib/finite_machine/hooks.rb

@@ -61,7 +61,7 @@ module FiniteMachine
     # @param [Event] event
     #
     # @example
-    #   hooks.call(:entersate, :green, Event.new)
+    #   hooks.call(HookEvent::Enter, :green, Event.new)
     #
     # @return [Hash]
     #
@@ -79,6 +79,13 @@ module FiniteMachine
       collection.empty?
     end
 
+    # Remove all callbacks
+    #
+    # @api public
+    def clear
+      collection.clear
+    end
+
     # String representation
     #
     # @return [String]

data/lib/finite_machine/observer.rb

@@ -170,8 +170,10 @@ module FiniteMachine
         result = callable.call(trans_event, *data)
       end
 
-      machine.events_chain.cancel_transitions(event.event_name,
-                                              (result == CANCELLED))
+      if result == CANCELLED
+        hooks.clear
+        machine.events_chain.cancel_transitions(event.event_name)
+      end
     end
 
     # Callback names including all states and events

data/lib/finite_machine/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module FiniteMachine
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 end

data/spec/unit/callbacks_spec.rb

@@ -708,6 +708,34 @@ RSpec.describe FiniteMachine, 'callbacks' do
     expect(fsm.current).to eql(:green)
   end
 
+  it "stops executing callbacks when cancelled" do
+    called = []
+
+    fsm = FiniteMachine.define do
+      initial :initial
+
+      events { event :bump, initial: :low }
+
+      callbacks {
+        on_before do |event|
+          called << "enter_#{event.name}_#{event.from}_#{event.to}"
+
+          FiniteMachine::CANCELLED
+        end
+
+        on_exit :initial do |event| called << "exit_initial" end
+        on_exit          do |event| called << "exit_any" end
+        on_enter :low    do |event| called << "enter_low" end
+        on_after :bump   do |event| called << "after_#{event.name}" end
+        on_after         do |event| called << "after_any" end
+      }
+    end
+
+    fsm.bump
+
+    expect(called).to eq(['enter_bump_initial_low'])
+  end
+
   xit "groups callbacks"
 
   it "groups states from separate events with the same name" do

data/spec/unit/events_chain/cancel_transitions_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe FiniteMachine::EventsChain, '.cancel_transitions' do
     events_chain.add(:start, transition_b)
     events_chain.add(:finish, transition_c)
 
-    events_chain.cancel_transitions(:start, true)
+    events_chain.cancel_transitions(:start)
 
     expect(transition_a).to have_received(:cancelled=).with(true)
     expect(transition_b).to have_received(:cancelled=).with(true)

data/spec/unit/hooks/clear_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+RSpec.describe FiniteMachine::Hooks, '#clear' do
+  it "clears all registered hooks" do
+    hooks = described_class.new
+
+    event_type = FiniteMachine::HookEvent::Before
+    hook = -> { }
+    hooks.register(event_type, :foo, hook)
+    hooks.register(event_type, :bar, hook)
+
+    expect(hooks.empty?).to eq(false)
+    hooks.clear
+    expect(hooks.empty?).to eq(true)
+  end
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A minimal finite state machine with a straightforward syntax. You can
   quickly model states, add callbacks and use object-oriented techniques to integrate
   with ORMs.
@@ -104,6 +118,7 @@ files:
 - spec/unit/hook_event/initialize_spec.rb
 - spec/unit/hook_event/notify_spec.rb
 - spec/unit/hooks/call_spec.rb
+- spec/unit/hooks/clear_spec.rb
 - spec/unit/hooks/inspect_spec.rb
 - spec/unit/hooks/register_spec.rb
 - spec/unit/if_unless_spec.rb
@@ -181,6 +196,7 @@ test_files:
 - spec/unit/hook_event/initialize_spec.rb
 - spec/unit/hook_event/notify_spec.rb
 - spec/unit/hooks/call_spec.rb
+- spec/unit/hooks/clear_spec.rb
 - spec/unit/hooks/inspect_spec.rb
 - spec/unit/hooks/register_spec.rb
 - spec/unit/if_unless_spec.rb