finite_machine 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ac2b8cf6f6e899a7d6b2f04c240703d45a4b67d
-  data.tar.gz: f556b050c651d3120b5a2fe990fd1efc94abf961
+  metadata.gz: d0521fc82d97ac5139abe2fcea0ed72532af05fe
+  data.tar.gz: 260b8c31a86e2c3f80018aad2640c62222cea2af
 SHA512:
-  metadata.gz: f5871e7adbd4a10e4a44a9bd4916f09843890490fd967d9bc8ce7b7c0a20033b72f2344d23fd7cd6bd2a3369cc5f622f343ea3ce1c2b817e8332909d754806fe
-  data.tar.gz: a1feb862d90d7da38db41ce326ab3a9dbcc241555a4d65e216eeb4260442f5d1a942ac474551f2b41853ab7bb6b5aeb62b474e7efab2bb2571c22a0bfe0da0bf
+  metadata.gz: f443039daa14568b5bc2424d6346b89da989494bde20c416e6c7186d1692dd878a1a1bae3e9dcd9a6271c4bfa2bed42d7c795b24c53883a692ffc672a9ec05bc
+  data.tar.gz: 4cc03728f4c4694f3ebac12bb3f112622b84f877efcbea2ef0f783a0005ee93d889b9317922e09e87f2f5a0ddc189d5618baa17bf498024c8263d783f1e77e83

data/.travis.yml

@@ -12,13 +12,13 @@ matrix:
     - rvm: jruby-20mode
     - rvm: jruby-21mode
     - rvm: jruby-head
-    - rvm: rbx
+    - rvm: rbx-2
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: jruby-20mode
     - rvm: jruby-21mode
-    - rvm: rbx
+    - rvm: rbx-2
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.7.1 (June 8, 2014)
+
+* 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)
 
 * Change Event to EventHook for callback events

data/README.md

@@ -3,13 +3,13 @@
 [![Build Status](https://secure.travis-ci.org/peter-murach/finite_machine.png?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/peter-murach/finite_machine.png)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/peter-murach/finite_machine/badge.png)][coverage]
-[![Inline docs](http://inch-pages.github.io/github/peter-murach/finite_machine.png)][inchpages]
+[![Inline docs](http://inch-ci.org/github/peter-murach/finite_machine.png)][inchpages]
 
 [gem]: http://badge.fury.io/rb/finite_machine
 [travis]: http://travis-ci.org/peter-murach/finite_machine
 [codeclimate]: https://codeclimate.com/github/peter-murach/finite_machine
 [coverage]: https://coveralls.io/r/peter-murach/finite_machine
-[inchpages]: http://inch-pages.github.io/github/peter-murach/finite_machine
+[inchpages]: http://inch-ci.org/github/peter-murach/finite_machine
 
 A minimal finite state machine with a straightforward and intuitive syntax. You can quickly model states and add callbacks that can be triggered synchronously or asynchronously. The machine is event driven with a focus on passing synchronous and asynchronous messages to trigger state transitions.
 

data/lib/finite_machine.rb

@@ -27,13 +27,16 @@ require "finite_machine/observer"
 require "finite_machine/listener"
 
 module FiniteMachine
-
+  # Default state name
   DEFAULT_STATE = :none
 
+  # Initial default event name
   DEFAULT_EVENT_NAME = :init
 
+  # Describe any state transition
   ANY_STATE = :any
 
+  # Describe any event name
   ANY_EVENT = :any
 
   # Returned when transition has successfully performed
@@ -75,6 +78,15 @@ module FiniteMachine
 
     # TODO: this should instantiate system not the state machine
     # and then delegate calls to StateMachine instance etc...
+    #
+    # @example
+    #   FiniteMachine.define do
+    #     ...
+    #   end
+    #
+    # @return [FiniteMachine::StateMachine]
+    #
+    # @api public
     def define(*args, &block)
       StateMachine.new(*args, &block)
     end

data/lib/finite_machine/dsl.rb

@@ -68,12 +68,17 @@ module FiniteMachine
     # @api public
     def initial(value)
       state, name, self.defer = parse(value)
-      unless defer
-        machine.state         = state
-        machine.initial_state = state
-      end
-      event = proc { event name, from: FiniteMachine::DEFAULT_STATE, to: state }
-      machine.events_dsl.call(&event)
+      self.initial_event      = name
+      machine.event(name, from: FiniteMachine::DEFAULT_STATE, to: state)
+    end
+
+    # Trigger initial event
+    #
+    # @return [nil]
+    #
+    # @api private
+    def trigger_init
+      machine.send(:"#{initial_event}") unless defer
     end
 
     # Attach state machine to an object

data/lib/finite_machine/safety.rb

@@ -3,7 +3,6 @@
 module FiniteMachine
   # Module for responsible for safety checks against known methods
   module Safety
-
     EVENT_CONFLICT_MESSAGE = \
       "You tried to define an event named \"%{name}\", however this would " \
       "generate \"%{type}\" method \"%{method}\", which is already defined " \
@@ -54,14 +53,12 @@ module FiniteMachine
     #
     # @api public
     def ensure_valid_callback_name!(event_type, name)
-      message = if machine.states.include?(name) &&
-                   event_type < HookEvent::Anyaction
+      message = if wrong_event_name?(name, event_type)
         EVENT_CALLBACK_CONFLICT_MESSAGE % {
           type: "on_#{event_type.to_s}",
           name: name
         }
-      elsif machine.event_names.include?(name) &&
-            event_type < HookEvent::Anystate
+      elsif wrong_state_name?(name, event_type)
         STATE_CALLBACK_CONFLICT_MESSAGE % {
           type: "on_#{event_type.to_s}",
           name: name
@@ -79,6 +76,36 @@ module FiniteMachine
 
     private
 
+    # Check if event name exists
+    #
+    # @param [Symbol] name
+    #
+    # @param [FiniteMachine::HookEvent] event_type
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def wrong_event_name?(name, event_type)
+      machine.states.include?(name) &&
+      !machine.event_names.include?(name) &&
+      event_type < HookEvent::Anyaction
+    end
+
+    # Check if state name exists
+    #
+    # @param [Symbol] name
+    #
+    # @param [FiniteMachine::HookEvent] event_type
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def wrong_state_name?(name, event_type)
+      machine.event_names.include?(name) &&
+      !machine.states.include?(name) &&
+      event_type < HookEvent::Anystate
+    end
+
     def fail_invalid_callback_error(message)
       exception = InvalidCallbackNameError
       machine.catch_error(exception) || fail(exception, message)

data/lib/finite_machine/state_machine.rb

@@ -43,7 +43,7 @@ module FiniteMachine
     # The state machine event definitions
     attr_threadsafe :events_chain
 
-    def_delegators :@dsl, :initial, :terminal, :target
+    def_delegators :@dsl, :initial, :terminal, :target, :trigger_init
 
     def_delegator :@events_dsl, :event
 
@@ -63,6 +63,7 @@ module FiniteMachine
       @dsl           = DSL.new(self, attributes)
 
       @dsl.call(&block) if block_given?
+      trigger_init
     end
 
     # @example

data/lib/finite_machine/version.rb

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

data/spec/unit/async_events_spec.rb

@@ -91,8 +91,9 @@ describe FiniteMachine, 'async_events' do
     expect(called).to match_array([
       'on_enter_green',
       'on_before_slow',
-      'on_after_go',
-      'on_exit_yellow'
+      'on_exit_yellow',
+      'on_enter_green',
+      'on_after_go'
     ])
   end
 end

data/spec/unit/callbacks_spec.rb

@@ -98,6 +98,17 @@ describe FiniteMachine, 'callbacks' do
       }
     end
 
+    expect(fsm.current).to eq(:green)
+    expect(called).to eq([
+      'on_before',
+      'on_exit',
+      'on_transition_green',
+      'on_transition',
+      'on_enter_green',
+      'on_enter',
+      'on_after'
+    ])
+
     called = []
     fsm.slow
     expect(called).to eql([
@@ -179,6 +190,11 @@ describe FiniteMachine, 'callbacks' do
     expect(fsm.current).to eq(:previous)
     fsm.go
     expect(called).to eq([
+      'before_init',
+      'exit_none',
+      'transition_none_previous',
+      'enter_previous',
+      'after_init',
       'before_go',
       'guard',
       'exit_previous',
@@ -226,6 +242,14 @@ describe FiniteMachine, 'callbacks' do
       }
     end
 
+    expect(fsm.current).to eql(:green)
+    expect(called).to eql([
+      'on_before',
+      'on_exit',
+      'on_transition',
+      'on_enter',
+      'on_after'
+    ])
     called = []
     fsm.slow
     expect(fsm.current).to eql(:yellow)
@@ -539,14 +563,16 @@ describe FiniteMachine, 'callbacks' do
 
         once_on_transition_green do |event| called << 'once_on_transition_green' end
         once_on_transition_yellow do |event| called << 'once_on_transition_yellow' end
-
+        once_on_exit_none   do |event| called << 'once_on_exit_none' end
         once_on_exit_green  do |event| called << 'once_on_exit_green' end
         once_on_exit_yellow do |event| called << 'once_on_exit_yellow' end
 
         # event callbacks
+        once_on_before_init do |event| called << 'once_on_before_init' end
         once_on_before_slow do |event| called << 'once_on_before_slow' end
         once_on_before_go   do |event| called << 'once_on_before_go' end
 
+        once_on_after_init do |event| called << 'once_on_after_init' end
         once_on_after_slow do |event| called << 'once_on_after_slow' end
         once_on_after_go   do |event| called << 'once_on_after_go' end
       }
@@ -559,6 +585,11 @@ describe FiniteMachine, 'callbacks' do
     fsm.slow
     expect(fsm.current).to eql(:yellow)
     expect(called).to eql([
+      'once_on_before_init',
+      'once_on_exit_none',
+      'once_on_transition_green',
+      'once_on_enter_green',
+      'once_on_after_init',
       'once_on_before_slow',
       'once_on_exit_green',
       'once_on_transition_yellow',
@@ -566,8 +597,6 @@ describe FiniteMachine, 'callbacks' do
       'once_on_after_slow',
       'once_on_before_go',
       'once_on_exit_yellow',
-      'once_on_transition_green',
-      'once_on_enter_green',
       'once_on_after_go'
     ])
   end
@@ -643,6 +672,10 @@ describe FiniteMachine, 'callbacks' do
     expect(fsm.current).to eq(:initial)
     fsm.bump
     expect(callbacks).to eq([
+      'before_init_none_initial',
+      'exit_init_none_initial',
+      'enter_init_none_initial',
+      'after_init_none_initial',
       'before_bump_initial_low',
       'exit_bump_initial_low',
       'enter_bump_initial_low',
@@ -650,6 +683,10 @@ describe FiniteMachine, 'callbacks' do
     ])
     fsm.bump
     expect(callbacks).to eq([
+      'before_init_none_initial',
+      'exit_init_none_initial',
+      'enter_init_none_initial',
+      'after_init_none_initial',
       'before_bump_initial_low',
       'exit_bump_initial_low',
       'enter_bump_initial_low',
@@ -661,6 +698,10 @@ describe FiniteMachine, 'callbacks' do
     ])
     fsm.bump
     expect(callbacks).to eq([
+      'before_init_none_initial',
+      'exit_init_none_initial',
+      'enter_init_none_initial',
+      'after_init_none_initial',
       'before_bump_initial_low',
       'exit_bump_initial_low',
       'enter_bump_initial_low',
@@ -699,11 +740,15 @@ describe FiniteMachine, 'callbacks' do
     expect(fsm.current).to eq(:initial)
     fsm.bump
     expect(callbacks).to eq([
+      'before_init_none_initial',
+      'enter_init_none_initial',
       'before_bump_initial_low',
       'enter_bump_initial_low'
     ])
     fsm.bump
     expect(callbacks).to eq([
+      'before_init_none_initial',
+      'enter_init_none_initial',
       'before_bump_initial_low',
       'enter_bump_initial_low',
       'before_bump_low_medium',
@@ -711,6 +756,8 @@ describe FiniteMachine, 'callbacks' do
     ])
     fsm.bump
     expect(callbacks).to eq([
+      'before_init_none_initial',
+      'enter_init_none_initial',
       'before_bump_initial_low',
       'enter_bump_initial_low',
       'before_bump_low_medium',
@@ -719,4 +766,33 @@ describe FiniteMachine, 'callbacks' do
       'enter_bump_medium_high'
     ])
   end
+
+  it "permits state and event with the same name" do
+    called = []
+    fsm = FiniteMachine.define do
+      initial :on_hook
+
+      events {
+        event :off_hook, :on_hook => :off_hook
+        event :on_hook,  :off_hook => :on_hook
+      }
+
+      callbacks {
+        on_before(:on_hook) { |event| called << "on_before_#{event.name}"}
+        on_enter(:on_hook)  { |event| called << "on_enter_#{event.to}"}
+      }
+    end
+    expect(fsm.current).to eq(:on_hook)
+    expect(called).to eq([
+      'on_enter_on_hook'
+    ])
+    fsm.off_hook
+    expect(fsm.current).to eq(:off_hook)
+    fsm.on_hook
+    expect(called).to eq([
+      'on_enter_on_hook',
+      'on_before_on_hook',
+      'on_enter_on_hook'
+    ]);
+  end
 end

data/spec/unit/define_spec.rb

@@ -43,7 +43,7 @@ describe FiniteMachine, 'define' do
       fsm.handle(FiniteMachine::InvalidStateError) { |exception|
         called << 'error_handler'
       }
-
+      fsm.init
       expect(fsm.current).to eql(:green)
       fsm.slow
       expect(fsm.current).to eql(:yellow)

data/spec/unit/initialize_spec.rb

@@ -49,11 +49,15 @@ describe FiniteMachine, 'initialize' do
         event :stop, :yellow => :red
       }
       callbacks {
+        on_exit :none   do |event| called << 'on_exit_none' end
         on_enter :green do |event| called << 'on_enter_green' end
       }
     end
     expect(fsm.current).to eql(:green)
-    expect(called).to be_empty
+    expect(called).to eq([
+      'on_exit_none',
+      'on_enter_green'
+    ])
   end
 
   it "allows to specify initial state through parameter" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler