micromachine 0.0.11 → 1.0.0

data/README.md

@@ -0,0 +1,190 @@
+MicroMachine
+============
+
+Minimal Finite State Machine.
+
+Description
+-----------
+
+There are many finite state machine implementations for Ruby, and they
+all provide a nice DSL for declaring events, exceptions, callbacks,
+and all kinds of niceties in general.
+
+But if all you want is a finite state machine, look no further: this
+is only 22 lines of code and provides everything a finite state
+machine must have, and nothing more.
+
+Usage
+-----
+
+``` ruby
+require 'micromachine'
+
+machine = MicroMachine.new(:new) # Initial state.
+
+machine.transitions_for[:confirm] = { :new => :confirmed }
+machine.transitions_for[:ignore]  = { :new => :ignored }
+machine.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
+
+machine.trigger(:confirm)  #=> true
+machine.state              #=> :confirmed
+
+machine.trigger(:ignore)   #=> false
+machine.state              #=> :confirmed
+
+machine.trigger(:reset)    #=> true
+machine.state              #=> :new
+
+machine.trigger(:ignore)   #=> true
+machine.state              #=> :ignored
+```
+
+You can also ask if an event will trigger a change in state. Following
+the example above:
+
+``` ruby
+machine.state              #=> :ignored
+
+machine.trigger?(:ignore)  #=> false
+machine.trigger?(:reset)   #=> true
+
+# And the state is preserved, because you were only asking.
+machine.state              #=> :ignored
+```
+
+It can also have callbacks when entering some state:
+
+``` ruby
+machine.on(:confirmed) do
+  puts "Confirmed"
+end
+```
+
+Or callbacks on any transition:
+
+``` ruby
+machine.on(:any) do
+  puts "Transitioned..."
+end
+```
+
+Note that `:any` is a special key. Using it as a state when declaring
+transitions will give you unexpected results.
+
+Check the examples directory for more information.
+
+Adding MicroMachine to your models
+----------------------------------
+
+The most popular pattern among Ruby libraries that tackle this problem
+is to extend the model and transform it into a finite state machine.
+Instead of working as a mixin, MicroMachine's implementation is by
+composition: you instantiate a finite state machine (or many!) inside
+your model and you are in charge of querying and persisting the state.
+Here's an example of how to use it with an ActiveRecord model:
+
+``` ruby
+class Event < ActiveRecord::Base
+  before_save :persist_confirmation
+
+  def confirm!
+    confirmation.trigger(:confirm)
+  end
+
+  def cancel!
+    confirmation.trigger(:cancel)
+  end
+
+  def reset!
+    confirmation.trigger(:reset)
+  end
+
+  def confirmation
+    @confirmation ||= begin
+      fsm = MicroMachine.new(confirmation_state || "pending")
+
+      fsm.transitions_for[:confirm] = { "pending" => "confirmed" }
+      fsm.transitions_for[:cancel] = { "confirmed" => "cancelled" }
+      fsm.transitions_for[:reset] = { "confirmed" => "pending", "cancelled" => "pending" }
+
+      fsm
+    end
+  end
+
+private
+
+  def persist_confirmation
+    self.confirmation_state = confirmation.state
+  end
+end
+```
+
+This example asumes you have a `:confirmation_state` attribute in your
+model. This may look like a very verbose implementation, but you gain a
+lot in flexibility.
+
+An alternative approach, using callbacks:
+
+``` ruby
+class Event < ActiveRecord::Base
+  def confirm!
+    confirmation.trigger(:confirm)
+  end
+
+  def cancel!
+    confirmation.trigger(:cancel)
+  end
+
+  def reset!
+    confirmation.trigger(:reset)
+  end
+
+  def confirmation
+    @confirmation ||= begin
+      fsm = MicroMachine.new(confirmation_state || "pending")
+
+      fsm.transitions_for[:confirm] = { "pending" => "confirmed" }
+      fsm.transitions_for[:cancel] = { "confirmed" => "cancelled" }
+      fsm.transitions_for[:reset] = { "confirmed" => "pending", "cancelled" => "pending" }
+
+      fsm.on(:any) { self.confirmation_state = confirmation.state }
+
+      fsm
+    end
+  end
+end
+```
+
+Now, on any transition the `confirmation_state` attribute in the model
+will be updated.
+
+Installation
+------------
+
+    $ sudo gem install micromachine
+
+License
+-------
+
+Copyright (c) 2009 Michel Martens
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/lib/micromachine.rb

@@ -20,11 +20,13 @@ class MicroMachine
       callbacks = @callbacks[@state] + @callbacks[:any]
       callbacks.each { |callback| callback.call }
       true
+    else
+      false
     end
   end
 
   def trigger?(event)
-    transitions_for[event][state]
+    transitions_for[event][state] ? true : false
   rescue NoMethodError
     raise InvalidEvent
   end

data/micromachine.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = 'micromachine'
-  s.version = '0.0.11'
+  s.version = '1.0.0'
   s.summary = %{Minimal Finite State Machine.}
   s.description = %Q{There are many finite state machine implementations for Ruby, and they all provide a nice DSL for declaring events, exceptions, callbacks, and all kinds of niceties in general.\n\nBut if all you want is a finite state machine, look no further: this is only 22 lines of code and provides everything a finite state machine must have, and nothing more.}
   s.author = "Michel Martens"
   s.email = "michel@soveran.com"
   s.homepage = "http://github.com/soveran/micromachine"
-  s.files = ["lib/micromachine.rb", "README.markdown", "LICENSE", "Rakefile", "micromachine.gemspec", "example/micromachine_sample.rb", "example/micromachine_sample_gem.rb"]
+  s.files = Dir["lib/**/*.rb", "README*", "LICENSE", "Rakefile", "*.gemspec", "example/**/*.*"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micromachine
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-17 00:00:00.000000000 -03:00
-default_executable: 
+date: 2012-03-28 00:00:00.000000000 Z
 dependencies: []
 description: ! 'There are many finite state machine implementations for Ruby, and
   they all provide a nice DSL for declaring events, exceptions, callbacks, and all
@@ -26,13 +25,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/micromachine.rb
-- README.markdown
+- README.md
 - LICENSE
 - Rakefile
 - micromachine.gemspec
-- example/micromachine_sample.rb
-- example/micromachine_sample_gem.rb
-has_rdoc: true
 homepage: http://github.com/soveran/micromachine
 licenses: []
 post_install_message: 
@@ -53,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Minimal Finite State Machine.

data/README.markdown

@@ -1,152 +0,0 @@
-MicroMachine
-============
-
-Minimal Finite State Machine.
-
-Description
------------
-
-There are many finite state machine implementations for Ruby, and they
-all provide a nice DSL for declaring events, exceptions, callbacks,
-and all kinds of niceties in general.
-
-But if all you want is a finite state machine, look no further: this is only
-22 lines of code and provides everything a finite state machine must have, and
-nothing more.
-
-Usage
------
-
-    require 'micromachine'
-
-    machine = MicroMachine.new(:new) # Initial state.
-
-    machine.transitions_for[:confirm] = { :new => :confirmed }
-    machine.transitions_for[:ignore]  = { :new => :ignored }
-    machine.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
-
-    machine.trigger(:confirm)  #=> true
-    machine.trigger(:ignore)   #=> false
-    machine.trigger(:reset)    #=> true
-    machine.trigger(:ignore)   #=> true
-
-It can also have callbacks when entering some state:
-
-    machine.on(:confirmed) do
-      puts "Confirmed"
-    end
-
-Or callbacks on any transition:
-
-    machine.on(:any) do
-      puts "Transitioned..."
-    end
-
-Note that `:any` is a special key. Using it as a state when declaring
-transitions will give you unexpected results.
-
-Adding MicroMachine to your models
-----------------------------------
-
-The most popular pattern among Ruby libraries that tackle this problem
-is to extend the model and transform it into a finite state machine.
-Instead of working as a mixin, MicroMachine's implementation is by
-composition: you instantiate a finite state machine (or many!) inside
-your model and you are in charge of querying and persisting the state.
-Here's an example of how to use it with an ActiveRecord model:
-
-    class Event < ActiveRecord::Base
-      before_save :persist_confirmation
-
-      def confirm!
-        confirmation.trigger(:confirm)
-      end
-
-      def cancel!
-        confirmation.trigger(:cancel)
-      end
-
-      def reset!
-        confirmation.trigger(:reset)
-      end
-
-      def confirmation
-        @confirmation ||= begin
-          @confirmation = MicroMachine.new(confirmation_state || "pending")
-          @confirmation.transitions_for[:confirm] = { "pending" => "confirmed" }
-          @confirmation.transitions_for[:cancel] = { "confirmed" => "cancelled" }
-          @confirmation.transitions_for[:reset] = { "confirmed" => "pending", "cancelled" => "pending" }
-          @confirmation
-        end
-      end
-
-    private
-
-      def persist_confirmation
-        self.confirmation_state = confirmation.state
-      end
-    end
-
-This example asumes you have a :confirmation_state attribute in your
-model. This may look like a very verbose implementation, but you gain a
-lot in flexibility.
-
-An alternative approach, using callbacks:
-
-    class Event < ActiveRecord::Base
-      def confirm!
-        confirmation.trigger(:confirm)
-      end
-
-      def cancel!
-        confirmation.trigger(:cancel)
-      end
-
-      def reset!
-        confirmation.trigger(:reset)
-      end
-
-      def confirmation
-        @confirmation ||= begin
-          confirmation = MicroMachine.new(confirmation_state || "pending")
-          confirmation.transitions_for[:confirm] = { "pending" => "confirmed" }
-          confirmation.transitions_for[:cancel] = { "confirmed" => "cancelled" }
-          confirmation.transitions_for[:reset] = { "confirmed" => "pending", "cancelled" => "pending" }
-          confirmation.on(:any) { self.confirmation_state = confirmation.state }
-          confirmation
-        end
-      end
-    end
-
-Now, on any transition the `confirmation_state` attribute in the model will be updated.
-
-Installation
-------------
-
-    $ sudo gem install micromachine
-
-License
--------
-
-Copyright (c) 2009 Michel Martens for Citrusbyte
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.

data/example/micromachine_sample.rb

@@ -1,24 +0,0 @@
-require File.join(File.dirname(__FILE__), '../lib/micromachine')
-
-fsm = MicroMachine.new(:pending)
-fsm.transitions_for[:confirm]  = { :pending => :confirmed }
-fsm.transitions_for[:ignore]   = { :pending => :ignored }
-fsm.transitions_for[:reset]    = { :confirmed => :pending, :ignored => :pending }
-
-puts "Should print Confirmed, Reset and Ignored."
-
-if fsm.trigger(:confirm)
-  puts "Confirmed"
-end
-
-if fsm.trigger(:ignore)
-  puts "Ignored"
-end
-
-if fsm.trigger(:reset)
-  puts "Reset"
-end
-
-if fsm.trigger(:ignore)
-  puts "Ignored"
-end

data/example/micromachine_sample_gem.rb

@@ -1,25 +0,0 @@
-require 'rubygems'
-require 'micromachine'
-
-fsm = MicroMachine.new(:pending)
-fsm.transitions_for[:confirm]  = { :pending => :confirmed }
-fsm.transitions_for[:ignore]   = { :pending => :ignored }
-fsm.transitions_for[:reset]    = { :confirmed => :pending, :ignored => :pending }
-
-puts "Should print Confirmed, Reset and Ignored."
-
-if fsm.trigger(:confirm)
-  puts "Confirmed"
-end
-
-if fsm.trigger(:ignore)
-  puts "Ignored"
-end
-
-if fsm.trigger(:reset)
-  puts "Reset"
-end
-
-if fsm.trigger(:ignore)
-  puts "Ignored"
-end