switcher 0.0.1.beta

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in switcher.gemspec
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+TODO - write README
+
+See specs

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/switcher/facade.rb

@@ -0,0 +1,21 @@
+module Switcher
+  class Facade
+    def initialize(data, target_state=nil)
+      @args    = data
+      @stopped = false
+      @target_state = target_state
+    end
+
+    attr_reader :args, :stopped, :target_state
+
+    def stop
+      @stopped = true
+    end
+
+    alias :restrict :stop
+
+    def switch_to(state)
+      @target_state = state.to_sym
+    end
+  end
+end

data/lib/switcher/listener.rb

@@ -0,0 +1,38 @@
+module Switcher
+  class Listener
+    def initialize(name)
+      @events      = {}
+      @event_names = []
+      @name        = name
+    end
+
+    attr_reader :events, :event_names, :name
+
+    def before(event, options={}, &block)
+      options[:allow_switch] = true
+      data = { callback: block, options: options }
+      @events["before_#{event}"] = data
+    end
+
+    def on(event, options={}, &block)
+      options[:allow_switch] = true
+      data = { callback: block, options: options }
+      @event_names << event.to_sym
+      @events[event.to_s] = data
+    end
+
+    def after(event, options={}, &block)
+      data = { callback: block, options: options }
+      @events["after_#{event}"] = data
+    end
+
+    def trigger(event, facade, instance, args)
+      if ev = @events[event]
+        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)
+        end
+      end
+    end
+  end
+end

data/lib/switcher/machine.rb

@@ -0,0 +1,43 @@
+require 'switcher/spec'
+
+module Switcher
+  module Machine
+
+    module ClassMethods
+      def switcher(name, options={}, &block)
+        self.class_variable_defined?(:@@__specs__) or self.class_variable_set(:@@__specs__, [])
+
+        spec = Spec.new(name, options)
+        spec.instance_eval(&block)
+
+        self.class_variable_get(:@@__specs__) << spec # dup and destroy?
+
+        self.class_eval do
+          define_method(:"#{spec.name}_spec") { spec }
+          define_method(:"#{spec.name}_prev") { spec.state_prev }
+
+          define_method(:"#{spec.name}") { spec.current_state }
+
+          events = []
+
+          spec.states.each_pair do |state_name, state|
+            define_method(:"#{state_name}?") { state_name == self.send(:"#{spec.name}") }
+
+            events << state.event_names
+          end
+
+          events.flatten.each do |event_name|
+            define_method(:"can_#{event_name}?") { spec.states[self.send(:"#{spec.name}")].event_names.include?(event_name) }
+            define_method(:"#{event_name}!") do |*args|
+              spec.publish(self.send(:"#{spec.name}"), event_name, self, args)
+            end
+          end
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/switcher/spec.rb

@@ -0,0 +1,45 @@
+require 'switcher/listener'
+require 'switcher/facade'
+
+module Switcher
+  class Spec
+    def initialize(name, options={})
+      @name        = name.to_sym
+      @states      = {}
+      @states_list = []
+      @state_prev  = nil
+    end
+
+    attr_reader :name, :states, :state_prev
+
+    def state(name, &block)
+      listener = Listener.new(name)
+      listener.instance_eval(&block) if block_given?
+
+      @states_list << name.to_sym
+      @states[name.to_sym] = listener
+    end
+
+    def current_state
+      @current_state || @states_list.first
+    end
+
+    def publish(current_state, event, instance, args)
+      facade = Facade.new(args)
+      ["before_#{event}", event.to_s].each do |ev|
+        @states[current_state.to_sym].trigger(ev, facade, instance, args)
+      end
+      set_state(facade)
+      @states[current_state.to_sym].trigger("after_#{event}", facade, instance, args)
+    end
+
+  private
+
+    def set_state(facade)
+      unless facade.stopped && facade.target_state.nil?
+        @state_prev    = @current_state
+        @current_state = facade.target_state.to_sym
+      end
+    end
+  end
+end

data/lib/switcher/version.rb

@@ -0,0 +1,3 @@
+module Switcher
+  VERSION = "0.0.1.beta"
+end

data/lib/switcher.rb

@@ -0,0 +1,7 @@
+require "switcher/version"
+
+module Switcher
+  # Your code goes here...
+end
+
+require 'switcher/machine'

data/spec/fixtures/human.rb

@@ -0,0 +1,92 @@
+class Human
+  include Switcher::Machine
+
+  def initialize
+    @easy_to_fight = false
+    @honor = 0
+  end
+
+  attr_reader :easy_to_fight, :honor
+
+  switcher :state do
+    state :newborn do
+      on :go_to_school, switch_to: :scholar
+    end
+
+    state :scholar do
+      on :finish_school do |ev, exams|
+        if pass?(exams)
+          ev.switch_to :student
+        else
+          ev.switch_to :worker
+        end
+      end
+    end
+
+    state :student do
+      on :finish_university do |ev, exams|
+        if pass?(exams)
+          ev.switch_to :manager
+        else
+          ev.switch_to :soldier
+        end
+      end
+    end
+
+    state :worker do
+      on :full_age do |ev, money|
+        if enough?(money)
+          ev.switch_to :manager
+        else
+          ev.switch_to :soldier
+        end
+      end
+    end
+
+    state :soldier do
+      on :die, switch_to: :dead
+
+      before :fight do |ev, learn|
+        if hard_to?(learn)
+          @easy_to_fight = true
+        end
+      end
+
+      on :fight do |ev|
+        if @easy_to_fight
+          ev.switch_to :civil
+        else
+          rand(2).even? ? ev.switch_to(:dead) : ev.switch_to(:civil)
+        end
+      end
+
+      after :fight do
+        if self.state == :civil
+          @honor = 100
+        end
+      end
+    end
+
+    state :civil do
+      on :find_job, switch_to: :manager do |ev, cv|
+        ev.restrict unless cv
+      end
+    end
+
+    state :manager do
+      on :die, switch_to: :dead
+    end
+  end
+
+  def pass?(score)
+    score > 3
+  end
+
+  def enough?(num)
+    num > 9000
+  end
+
+  def hard_to?(learn=false)
+    !!learn
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'switcher'

data/spec/switcher_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+require 'fixtures/human'
+
+describe Switcher do
+
+  describe "Basic functionality" do
+    people = Human.new
+
+    it "should switch to state with option" do
+      people.go_to_school!
+      people.state.should eq(:scholar)
+    end
+
+    it "should switch to state by internal condition" do
+      people.finish_school!(2)
+      people.state.should eq(:worker)
+    end
+
+    it "should have before and after callbacks" do
+      people.full_age!(100)
+      people.fight!(true)
+
+      people.state.should eq(:civil)
+      people.easy_to_fight.should be_true
+      people.honor.should eq(100)
+    end
+
+    it "can prevent switch" do
+      people.find_job!(false)
+      people.state.should eq(:civil)
+    end
+
+    it "and can not" do
+      people.find_job!(true)
+      people.state.should eq(:manager)
+    end
+
+    it "can detect possibility to switch" do
+      people.can_fight?.should be_false
+      people.can_die?.should   be_true
+    end
+
+    it "should remember previous state" do
+      people.state_prev.should eq(:civil)
+    end
+
+    it "should have state predicate" do
+      people.manager?.should be_true
+      people.civil?.should   be_false
+    end
+  end
+
+end

data/switcher.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "switcher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "switcher"
+  s.version     = Switcher::VERSION
+  s.authors     = ["Andrey Savchenko"]
+  s.email       = ["andrey@aejis.eu"]
+  s.homepage    = "https://github.com/Ptico/switcher"
+  s.summary     = %q{Switcher is simple, event-driven state machine}
+  s.description = %q{Switcher is simple, event-driven state machine}
+
+  s.rubyforge_project = "switcher"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: switcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta
+  prerelease: 6
+platform: ruby
+authors:
+- Andrey Savchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70269386935900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70269386935900
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70269386935320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70269386935320
+description: Switcher is simple, event-driven state machine
+email:
+- andrey@aejis.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/switcher.rb
+- lib/switcher/facade.rb
+- lib/switcher/listener.rb
+- lib/switcher/machine.rb
+- lib/switcher/spec.rb
+- lib/switcher/version.rb
+- spec/fixtures/human.rb
+- spec/spec_helper.rb
+- spec/switcher_spec.rb
+- switcher.gemspec
+homepage: https://github.com/Ptico/switcher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: switcher
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Switcher is simple, event-driven state machine
+test_files:
+- spec/fixtures/human.rb
+- spec/spec_helper.rb
+- spec/switcher_spec.rb