switcher 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -7,5 +7,6 @@ gem "guard-rspec"
 
 group "activerecord" do
   gem "activerecord", "~> 3.0.0"
-  gem "sqlite3"
+  gem 'sqlite3-ruby', :platforms => :ruby
+  gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
 end

data/README.md

@@ -1,11 +1,113 @@
-Not for production use
+[![Build Status](https://secure.travis-ci.org/Ptico/switcher.png)](http://travis-ci.org/Ptico/switcher)
 
-Docs: See specs
+Switcher is lightweight event-driven state machine.
+
+## Basic usage:
+
+```ruby
+class Package
+  include Switcher::Object
+
+  def initialize(weight)
+    @sent_weight = weight.to_f
+    @tracking_number = nil
+  end
+
+  switcher :delivery do
+    state :requested do
+      on :send, switch_to: :sent do |ev, num|
+        @tracking_number = num
+      end
+    end
+
+    state :sent do
+      before :receive, call: :check_number
+
+      on :receive do |ev, number, weight|
+        if weight < (@weight - 0.3)
+          ev.switch_to :stolen
+        else
+          ev.switch_to :received
+        end
+      end
+
+      after :receive do |ev|
+        unpack if delivery_received?
+      end
+
+      on :miss, switch_to: :missed
+    end
+
+    state :received
+    state :stolen
+    state :missed
+  end
+
+  def check_number(ev, number, weight)
+    ev.stop if number.to_s != @tracking_number
+  end
+
+  def unpack
+    puts "TADA!"
+  end
+end
+
+package = Package.new(4.2)
+
+package.delivery # => :requested
+package.can_send? # => true
+package.send! "AB123456CD"
+package.delivery # => :sent
+package.receive!(3.5, "CD654321AB")
+package.delivery # => :sent
+package.receive!(4.1, "AB123456CD")
+# > TADA!
+
+package.delivery # => :received
+package.delivery_prev # => :sent
+package.delivery_received? # => true
+package.can_miss? # => false
+```
+
+## Usage with Active Record:
+
+```ruby
+class User < ActiveRecord::Base
+  include Switcher::ActiveRecord
+
+  switcher :membership do
+    state :guest do
+      on :approve, switch_to: :member
+    end
+    state :member do
+      on :ban, switch_to: :banned do |ev, reason|
+        ev.stop unless reason
+        ban_reason = reason
+      end
+    end
+    state :banned do
+      on :unban, switch_to: :member
+      after :unban do
+        ban_reason = nil
+      end
+    end
+  end
+end
+
+user = User.find(5)
+user.ban! "Stupid bastard"
+user.membership # => :banned
+user.save
+```
+
+## More examples:
+
+* [Wiki](https://github.com/Ptico/switcher/wiki)
+* [Specs](https://github.com/Ptico/switcher/tree/master/spec)
 
 ## TODO:
 
 * 1.8 compat
-* Write README
 * Refactoring
 * Events without state
 * Ability to define validations, associations etc. in state (ability to call static methods from object)

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Test switcher"
+RSpec::Core::RakeTask.new('spec')

data/lib/switcher/adapters/active_record.rb

@@ -13,6 +13,9 @@ module Switcher
           define_method(:"#{spec_name}_prev") { self.instance_variable_get(:"@#{spec_name}_statement").state_prev }
 
           define_method(:"#{spec_name}") { self.instance_variable_get(:"@#{spec_name}_statement").state_current }
+          define_method(:"#{spec_name}=") { nil } # FIXME - raise exception
+
+          define_method(:"#{spec_name}_force") { |state| self.instance_variable_get(:"@#{spec_name}_statement").force_state(state.to_sym) }
 
           events = []
 
@@ -62,6 +65,8 @@ module Switcher
     end
 
     def switch_from(orig, event, *args)
+      return false unless (self.respond_to?(:"can_#{event}?") and self.send(:"can_#{event}?"))
+
       self.class.class_variable_get(:@@__specs__).each do |spc|
         spc_name = spc.name
 
@@ -72,6 +77,8 @@ module Switcher
           write_attribute("#{spc_name}_prev", self.send(:"#{spc_name}_prev"))
         end
       end
+
+      true
     end
 
   end

data/lib/switcher/adapters/object.rb

@@ -20,6 +20,9 @@ module Switcher
           define_method(:"#{spec_name}_prev") { self.instance_variable_get(:"@#{spec_name}_statement").state_prev }
 
           define_method(:"#{spec_name}") { self.instance_variable_get(:"@#{spec_name}_statement").state_current }
+          define_method(:"#{spec_name}=") { nil }
+
+          define_method(:"#{spec_name}_force") { |state| self.instance_variable_get(:"@#{spec_name}_statement").force_state(state.to_sym) }
 
           events = []
 
@@ -57,9 +60,13 @@ module Switcher
     end
 
     def switch_from(orig, event, *args)
+      return false unless (self.respond_to?(:"can_#{event}?") and self.send(:"can_#{event}?"))
+
       self.class.class_variable_get(:@@__specs__).each do |spc|
         self.instance_variable_get(:"@#{spc.name}_statement").publish(event, orig, args)
       end
+
+      true
     end
   end
 end

data/lib/switcher/listener.rb

@@ -28,6 +28,9 @@ module Switcher
 
     def trigger(event, facade, instance, args)
       if ev = @events[event]
+        if ev[:options][:call]
+          instance.instance_exec(facade, *args) { |facad, *arguments| self.send(ev[:options][:call], facad, *arguments) }
+        end
         instance.instance_exec(facade, *args, &ev[:callback]) if ev[:callback].respond_to?(:call)
         if !facade.stopped && ev[:options][:allow_switch] && switch_to = ev[:options][:switch_to]
           facade.switch_to(switch_to)

data/lib/switcher/statement.rb

@@ -51,6 +51,12 @@ module Switcher
       end
     end
 
+    def force_state(state)
+      return unless @spec.states_list.include?(state.to_sym) # FIXME - raise exception
+      @state_prev    = state_current
+      @state_current = state.to_sym
+    end
+
   private
 
     def set_state(facade)

data/lib/switcher/version.rb

@@ -1,3 +1,3 @@
 module Switcher
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/fixtures/human.rb

@@ -68,9 +68,7 @@ class Human
     end
 
     state :civil do
-      on :find_job, switch_to: :manager do |ev, cv|
-        ev.restrict unless cv
-      end
+      on :find_job, call: :employment, switch_to: :manager
     end
 
     state :manager do
@@ -89,4 +87,8 @@ class Human
   def hard_to?(learn=false)
     !!learn
   end
+
+  def employment(ev, cv)
+    ev.restrict unless cv
+  end
 end

data/spec/switcher_spec.rb

@@ -59,6 +59,13 @@ describe Switcher do
       person.state_manager?.should be_true
       person.state_civil?.should   be_false
     end
+
+    it "should force state if needed" do
+      crashed_car = Car.new
+
+      crashed_car.state_force(:damaged)
+      crashed_car.state.should eq(:damaged)
+    end
   end
 
   describe "Multiple states" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-04 00:00:00.000000000Z
+date: 2012-03-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70251275731280 !ruby/object:Gem::Requirement
+  requirement: &70322138874120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251275731280
+  version_requirements: *70322138874120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70251275730860 !ruby/object:Gem::Requirement
+  requirement: &70322138873700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251275730860
+  version_requirements: *70322138873700
 description: Switcher is simple, event-driven state machine
 email:
 - andrey@aejis.eu
@@ -41,6 +41,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - README.md