soveran-micromachine 0.0.6 → 0.0.7

data/README.markdown

@@ -11,7 +11,7 @@ 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
-15 lines of code and provides everything a finite state machine must have, and
+22 lines of code and provides everything a finite state machine must have, and
 nothing more.
 
 Usage
@@ -36,11 +36,56 @@ It can also have callbacks when entering some state:
       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
 ------------
 
-    $ gem sources -a http://gems.github.com (you only have to do this once)
-    $ sudo gem install soveran-micromachine
+    $ sudo gem install micromachine
 
 License
 -------

data/Rakefile

@@ -1,11 +1,4 @@
-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
 
@@ -13,23 +6,3 @@ 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/lib/micromachine.rb

@@ -1,23 +1,3 @@
-# Finite State Machine
-#
-# Usage:
-#
-#   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 also handles callbacks that are executed when entering a different state.
-#
-#   machine.on(:confirmed) do
-#     puts "Confirmed"
-#   end
 class MicroMachine
   attr :transitions_for
   attr :state

data/micromachine.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = 'micromachine'
+  s.version = '0.0.7'
+  s.summary = %{Minimal Finite State Machine.}
+  s.date = %q{2009-03-07}
+  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.require_paths = ['lib']
+  s.has_rdoc = false
+  s.specification_version = 2 if s.respond_to? :specification_version=
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: soveran-micromachine
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Michel Martens
@@ -26,6 +26,7 @@ files:
 - README.markdown
 - LICENSE
 - Rakefile
+- micromachine.gemspec
 - example/micromachine_sample.rb
 - example/micromachine_sample_gem.rb
 has_rdoc: false