micromachine 0.0.6

data/LICENSE

@@ -0,0 +1,19 @@
+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/README.markdown

@@ -0,0 +1,114 @@
+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
+
+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.
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/clean'
+
+gem_spec_file = 'micromachine.gemspec'
+
+gem_spec = eval(File.read(gem_spec_file)) rescue nil
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+  rm_f FileList['pkg/**/*.*']
+end if gem_spec
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
+end
+
+desc "Builds and installs the gem."
+task :install => :repackage do
+  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
+end

data/example/micromachine_sample.rb

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,25 @@
+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

data/lib/micromachine.rb

@@ -0,0 +1,22 @@
+class MicroMachine
+  attr :transitions_for
+  attr :state
+
+  def initialize initial_state
+    @state = initial_state
+    @transitions_for = Hash.new
+    @callbacks = Hash.new { |hash, key| hash[key] = [] }
+  end
+
+  def on key, &block
+    @callbacks[key] << block
+  end
+
+  def trigger event
+    if transitions_for[event][@state]
+      @state = transitions_for[event][@state]
+      @callbacks[@state].each { |callback| callback.call }
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: micromachine
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
+platform: ruby
+authors: 
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-07 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michel@soveran.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/micromachine.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- example/micromachine_sample.rb
+- example/micromachine_sample_gem.rb
+has_rdoc: false
+homepage: http://github.com/soveran/micromachine
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Minimal Finite State Machine.
+test_files: []
+