moody 0.1.1 → 0.2.0

data/README.md

@@ -7,7 +7,7 @@ object can change its behavior at runtime, depending on its internal state.
 If you want more information about this pattern, read [the explanation by
 SourceMaking](http://sourcemaking.com/design_patterns/state).
 
-For a stupid example of how you would use this, here's a traffic light:
+For a stupid example of how you would use this, here is a traffic light:
 
     class Stop < Moody::State
       def color
@@ -18,6 +18,14 @@ For a stupid example of how you would use this, here's a traffic light:
         sleep 3
         switch_to Go
       end
+
+      def enter
+        # turn on camera tu see who crosses on a red light
+      end
+
+      def leave
+        # turn off camera
+      end
     end
 
     class Go < Moody::State
@@ -56,11 +64,18 @@ For a stupid example of how you would use this, here's a traffic light:
       traffic_light.next
     end
 
+Callbacks
+---------
+
+As you can see from the example above, Moody also provides callbacks when
+entering and leaving a state. If your state classes define instance methods
+`enter` and `leave`, then they will be called at the appropriate times.
+
 Inspiration
 -----------
 
 This is a reimplementation of the State Pattern gem by Daniel Cadenas. Check out
-his implementation at [http://github.com/dcadenas/state_pattern]().
+his implementation at [his repository](http://github.com/dcadenas/state_pattern).
 
 Installing
 ----------

data/lib/moody.rb

@@ -35,7 +35,15 @@ module Moody
     end
 
     def switch_to(next_state)
+      context.state.leave if context.state.respond_to?(:leave)
       context.state = next_state.new(context)
+      context.state.enter if context.state.respond_to?(:enter)
+    end
+
+    def leave
+    end
+
+    def enter
     end
   end
 end

data/moody.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = "moody"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
   s.date    = "2010-10-23"
 
   s.description = "Simple and straightforward implementation of the state pattern, inspired by the StatePattern gem"

data/test/test_moody.rb

@@ -1,68 +1,110 @@
 require "test/unit"
 require "moody"
-require "ostruct"
 
-class Stop < Moody::State
-  def color
-    "red"
-  end
+class TestMoodyByExample < Test::Unit::TestCase
+  class SiegeMode < Moody::State
+    def strength
+      50
+    end
 
-  def next
-    switch_to Go
-  end
-end
+    def siege_mode!
+    end
 
-class Go < Moody::State
-  def color
-    "green"
-  end
+    def tank_mode!
+      switch_to TankMode
+    end
 
-  def next
-    switch_to Caution
+    def cheat!
+      switch_to CheatMode
+    end
   end
-end
 
-class Caution < Moody::State
-  def color
-    "yellow"
+  class TankMode < Moody::State
+    def strength
+      20
+    end
+
+    def siege_mode!
+      switch_to SiegeMode
+    end
+
+    def tank_mode!
+    end
+
+    def cheat!
+      switch_to CheatMode
+    end
   end
 
-  def next
-    switch_to Stop
+  class CheatMode < Moody::State
+    def strength
+      100
+    end
+
+    def siege_mode!
+      switch_to SiegeMode
+    end
+
+    def tank_mode!
+      switch_to TankMode
+    end
+
+    def cheat!
+    end
+
+    def enter
+      $callbacks << "You're a cheat!"
+    end
+
+    def leave
+      $callbacks << "Honesty is valuable!"
+    end
   end
-end
 
-class TrafficLight
-  extend  Moody::Context
+  class SiegeTank
+    extend Moody::Context
 
-  initial_state Stop
-  delegate_to_state :color, :next
-end
+    initial_state TankMode
+    delegate_to_state :strength, :tank_mode!, :siege_mode!, :cheat!
+
+    def attack(target)
+      "dealt #{strength} to #{target}"
+    end
+  end
 
-class TestMoodyByExample < Test::Unit::TestCase
   def setup
-    @context = TrafficLight.new
+    $callbacks = []
+    @context_class = Class.new(SiegeTank)
   end
 
   def test_initial_state
-    assert @context.state.is_a?(Stop)
+    @context_class.initial_state SiegeMode
+
+    test_context = @context_class.new
+    assert test_context.state.is_a?(SiegeMode)
   end
 
   def test_switch_state
-    @context.next
-    assert @context.state.is_a?(Go)
-    @context.next
-    assert @context.state.is_a?(Caution)
-    @context.next
-    assert @context.state.is_a?(Stop)
+    test_context = @context_class.new
+    test_context.siege_mode!
+    assert test_context.state.is_a?(SiegeMode)
+    test_context.tank_mode!
+    assert test_context.state.is_a?(TankMode)
+  end
+
+  def test_delegates_methods
+    test_context = @context_class.new
+    test_context.siege_mode!
+    assert_equal "dealt 50 to target", test_context.attack("target")
+    test_context.tank_mode!
+    assert_equal "dealt 20 to target", test_context.attack("target")
   end
 
-  def test_delegate_properties
-    @context.next
-    assert_equal "green",  @context.color
-    @context.next
-    assert_equal "yellow", @context.color
-    @context.next
-    assert_equal "red",    @context.color
+  def test_provides_callbacks
+    test_context = @context_class.new
+    test_context.cheat!
+    assert_equal "You're a cheat!", $callbacks.pop
+    test_context.siege_mode!
+    assert_equal "Honesty is valuable!", $callbacks.pop
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Nicol\xC3\xA1s Sanguinetti"