motion-state-machine 0.8.1 → 0.8.2

data/README.md

@@ -3,6 +3,30 @@
 Hey, this is `motion-state-machine` — a state machine gem designed for
 [RubyMotion](http://rubymotion.com) for iOS.
 
+It features:
+
+- A simple, nice-looking definition syntax
+- Reaction to sent events, defined timeouts and global NSNotifications
+- Transition guards and actions
+- State entry / exit actions
+- Internal transitions that don't leave the machine's current state
+- Optional verbose log output for easy debugging
+- [Grand Central Dispatch](https://developer.apple.com/library/mac/#documentation/Performance/Reference/GCD_libdispatch_Ref/Reference/reference.html)-awareness — uses GCD queues for synchronization
+
+Defining a state machine looks like this:
+
+```ruby
+fsm = StateMachine::Base.new start_state: :awake
+
+fsm.when :awake do |state|
+  state.on_entry { puts "I'm awake, started and alive!" }
+  state.transition_to :sleeping, on:  :finished_hard_work,
+  state.die on: :too_hard_work
+end
+```
+
+See below for more examples and usage instructions.
+
 ## Motivation
 
 Undefined states and visual glitches in applications with complex UIs can
@@ -15,20 +39,6 @@ asynchronous event handling does not lead to undefined results (a.k.a. bugs).
 MacRuby and Cocoa don't provide a simple library to address this —
 motion-state-machine should fill the gap for RubyMotion developers.
 
-motion-state-machine comes with a simple and nice-looking syntax to define
-states and transitions:
-
-    fsm = StateMachine::Base.new start_state: :awake
-
-	fsm.when :awake do |state|
-	   state.on_entry { puts "I'm awake, started and alive!" }
-	   state.transition_to :sleeping, on:  :finished_hard_work,
-	   state.die on: :too_hard_work
-	end
-
-It is [Grand Central Dispatch](https://developer.apple.com/library/mac/#documentation/Performance/Reference/GCD_libdispatch_Ref/Reference/reference.html)-aware
-and uses GCD queues for synchronization.
-
 ## Installation
 
 1. If not done yet, add `bundler` gem management to your RubyMotion app.
@@ -37,18 +47,23 @@ and uses GCD queues for synchronization.
 
 2. Add this line to your application's Gemfile:
 
-		gem 'motion-state-machine',
-		  git: "git://github.com/opyh/motion-state-machine.git"
+   ```ruby
+   gem 'motion-state-machine'
+   ```
 
 3. Execute:
 
-		$ bundle
+   ```bash
+   $ bundle
+   ```
 
 ## Usage
 
 The following example shows how to initialize and define a state machine:
 
-	fsm = StateMachine::Base.new start_state: :working, verbose: true
+```ruby
+fsm = StateMachine::Base.new start_state: :working, verbose: true
+```
 
 This initializes a state machine. Calling `fsm.start!` would start the
 machine in the defined start state `:working`. Using `:verbose` activates
@@ -58,19 +73,21 @@ debug output on the console.
 
 After initialization, you can define states and transitions:
 
-	fsm.when :working do |state|
+```ruby
+fsm.when :working do |state|
 
-	   state.on_entry { puts "I'm awake, started and alive!" }
-	   state.on_exit { puts "Phew. That was enough work." }
+  state.on_entry { puts "I'm awake, started and alive!" }
+  state.on_exit { puts "Phew. That was enough work." }
 
-	   state.transition_to :sleeping,
-	     on:      :finished_hard_work,
-	     if:      proc { really_worked_enough_for_now? },
-	     action:  proc { puts "Will go to sleep now." }
+  state.transition_to :sleeping,
+    on:      :finished_hard_work,
+    if:      proc { really_worked_enough_for_now? },
+    action:  proc { puts "Will go to sleep now." }
 
-	   state.die on: :too_hard_work
+  state.die on: :too_hard_work
 
-	end
+end
+```
 
 This defines…
 
@@ -100,19 +117,22 @@ Transitions can be triggered…
 - by calling the state machine's `#event` method (see above).
 
 - automatically after a given timeout:
-
-		fsm.when :sleeping do |state|
-		  state.transition_to :working, after: 20
-		end
+  
+  ```ruby
+  fsm.when :sleeping do |state|
+      state.transition_to :working, after: 20
+  end
+  ```
 
   (goes back to `:working` after 20 seconds in state `:sleeping`)
 
 - when a `NSNotification` is posted:
-
-		fsm.when :awake do |state|
-		  state.transition_to :in_background,
-		    on_notification: UIApplicationDidEnterBackgroundNotification
-		end
+  ```ruby
+  fsm.when :awake do |state|
+  state.transition_to :in_background,
+      on_notification: UIApplicationDidEnterBackgroundNotification
+  end
+  ```
 
 ### How fast is it?
 

data/Rakefile

@@ -11,21 +11,11 @@ Bundler.setup
 Bundler.require
 
 Motion::Project::App.setup do |app|
-  app.name = 'testSuite'
-  app.identifier = 'com.screenfashion.motion-state-machine.spec-app'
-  app.specs_dir = './spec/motion-state-machine'
+  app.name = 'Spec Suite'
+  app.identifier = 'com.screenfashion.motion.spec-app'
+  app.specs_dir = './spec'
   app.development do
     # TODO: How to use module namespacing here?
-    app.delegate_class = 'MotionStateMachineSpecAppDelegate'
+    app.delegate_class = 'SpecAppDelegate'
   end
 end
-
-namespace :spec do
-  task :lib do
-    sh "bacon #{Dir.glob("spec/lib/**/*_spec.rb").join(' ')}"
-  end
-
-  task :motion => 'spec'
-
-  task :all => [:lib, :motion]
-end

data/lib/motion-state-machine/spec_app_delegate.rb

@@ -1,4 +1,4 @@
-class MotionStateMachineSpecAppDelegate
+class SpecAppDelegate
   def application(application, didFinishLaunchingWithOptions:launchOptions)
     @window = UIWindow.alloc.initWithFrame(UIScreen.mainScreen.bounds)
     @window.rootViewController = UIViewController.alloc.init

data/lib/motion-state-machine/version.rb

@@ -1,3 +1,3 @@
 module StateMachine
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

data/spec/helpers/no_exception_logging.rb

@@ -0,0 +1 @@
+Exception.log_exceptions = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-state-machine
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000Z
+date: 2012-07-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70177501197480 !ruby/object:Gem::Requirement
+  requirement: &70164739051240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177501197480
+  version_requirements: *70164739051240
 description: A finite state machine for RubyMotion with a flavor of Grand Central
   Dispatch.
 email:
@@ -42,13 +42,14 @@ files:
 - lib/motion-state-machine/transition.rb
 - lib/motion-state-machine/version.rb
 - motion-state-machine.gemspec
-- spec/motion-state-machine/base_spec.rb
-- spec/motion-state-machine/benchmark_spec.rb
-- spec/motion-state-machine/notification_transition_spec.rb
-- spec/motion-state-machine/send_event_transition_spec.rb
-- spec/motion-state-machine/state_spec.rb
-- spec/motion-state-machine/timed_transition_spec.rb
-- spec/motion-state-machine/transition_spec.rb
+- spec/base_spec.rb
+- spec/benchmark_spec.rb
+- spec/helpers/no_exception_logging.rb
+- spec/notification_transition_spec.rb
+- spec/send_event_transition_spec.rb
+- spec/state_spec.rb
+- spec/timed_transition_spec.rb
+- spec/transition_spec.rb
 homepage: https://github.com/opyh/motion-state-machine
 licenses: []
 post_install_message: 
@@ -63,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 774551363156047026
+      hash: -1755037909543191418
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 774551363156047026
+      hash: -1755037909543191418
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -81,10 +82,11 @@ specification_version: 3
 summary: Comes with a nice syntax for state and transition definition. Supports triggering
   via events, timeouts and NSNotifications.
 test_files:
-- spec/motion-state-machine/base_spec.rb
-- spec/motion-state-machine/benchmark_spec.rb
-- spec/motion-state-machine/notification_transition_spec.rb
-- spec/motion-state-machine/send_event_transition_spec.rb
-- spec/motion-state-machine/state_spec.rb
-- spec/motion-state-machine/timed_transition_spec.rb
-- spec/motion-state-machine/transition_spec.rb
+- spec/base_spec.rb
+- spec/benchmark_spec.rb
+- spec/helpers/no_exception_logging.rb
+- spec/notification_transition_spec.rb
+- spec/send_event_transition_spec.rb
+- spec/state_spec.rb
+- spec/timed_transition_spec.rb
+- spec/transition_spec.rb