volute 0.1.0 → 0.1.1

data/Rakefile

@@ -10,11 +10,11 @@ require 'rake'
 #
 # SPEC
 
-task :spec do
-  sh "spec -cfs spec/"
+task :rspec do
+  sh 'time rspec -cfs spec/'
 end
 
-task :default => :spec
+task :default => :rspec
 
 
 #
@@ -47,7 +47,7 @@ placing some [business] logic outside of classes
 
   #gem.add_dependency 'mime-types', '>= 1.16'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', '>= 2.0.0'
   gem.add_development_dependency 'jeweler'
 
   # gemspec spec : http://www.rubygems.org/read/chapter/20

data/TODO.txt

@@ -1,24 +1,38 @@
 
 [o] volute 'prev' => 'new' { ... }
 [o] volute Module { ... }
-[o] obj.volute_do_set(:a => 0, :b => 1)
+[o] obj.vset(:a => 0, :b => 1)
 [o] volute { over }
+[o] volute Class { volute :attr { } } --> Class AND attr
+    volute Class, :attr { } --> Class OR attr
+[o] volute :not, Light { ... }
+[o] volute /^att/ { ... }
+[o] not including Volute, but triggering Volute.xxx on some changes
+[o] volute :att => :not_nil { ... } (not a nil value)
+[o] volute :att => [ a, b ] { ... } (a or b)
+[o] volute previous_value => [ val0, val1 ] { ... } (OR)
+[o] volute [ pval0, pval1 ] => value { ... } (OR)
+[o] volute :att => /regex/ { ... }
+[o] volute /regex/ => /regex/ { ... }
+[o] rewrite README head
+[o] readme : list alternatives (aspects/hooks/callbacks)
 
-[ ] volute /^att/ { ... }
-[ ] volute /regex/ => /regex/ { ... }
-
-[ ] volute do
-      volute Invoice do
-        volute :paid do
-    
-          if is(true)
-            object.comment = 'got paid'
-          elsif was(nil)
-            object.comment = 'still not paid'
-          end
+[ ] volute Invoice do
+      volute :paid do
+        if is(true)
+          object.comment = 'got paid'
+        elsif was(nil)
+          object.comment = 'still not paid'
         end
       end
     end
 
-[ ] multi-entity state machine example
+[x] multi-entity state machine example
+    not happy with the traffic light example
+
+[ ] volutes
+    `-- volute x, y
+      `-- volute a, b
+
+[ ] pass the object as block binding ?
 

data/examples/diagnosis.rb

@@ -0,0 +1,82 @@
+
+# license is MIT
+
+# this example is strongly inspired by the diagnosis example
+# for Ruleby ( http://github.com/codeaspects/ruleby )
+# but please remember that Ruleby is a Rete implementation and is thus
+# vastly superior to what is implemented here
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'volute'
+
+
+#
+# some classes
+
+class Patient
+
+  attr_reader :name
+
+  attr_accessor :fever
+  attr_accessor :rash
+  attr_accessor :spots
+  attr_accessor :sore_throat
+  attr_accessor :innoculated
+
+  attr_accessor :diagnosis
+
+  def initialize(name)
+
+    @name = name
+    @symptoms = {}
+    @innoculated = false
+  end
+
+  def diagnose!
+
+    Volute.apply(self)
+
+    @diagnosis
+  end
+end
+
+#
+# the volutes
+
+volute Patient do
+
+  # These volutes are 'state' volutes, they trigger if all the attributes
+  # mentioned as keys yield the given value.
+  # unlike classical volutes that act as OR, these states volutes have an
+  # AND behaviour.
+
+  volute :fever => :high, :spots => :true, :innoculated => true do
+    object.diagnosis = 'measles'
+    over # prevent further evals
+  end
+  volute :spots => true do
+    object.diagnosis = 'allergy (spots but no measles)'
+  end
+  volute :rash => true do
+    object.diagnosis = 'allergy (rash)'
+  end
+  volute :sore_throat => true, :fever => :mild do
+    object.diagnosis = 'flu'
+  end
+  volute :sore_throat => true, :fever => :high do
+    object.diagnosis = 'flu'
+  end
+end
+
+pat = Patient.new('alice')
+pat.rash = true
+
+puts "#{pat.name} : diagnosed with #{pat.diagnose!}"
+
+pat = Patient.new('bob')
+pat.sore_throat = true
+pat.fever = :high
+
+puts "#{pat.name} : diagnosed with #{pat.diagnose!}"
+

data/examples/equation.rb

@@ -26,7 +26,7 @@ class Equation
 end
 
 #
-# a volute triggered for any 'set' operation on an attribute of book
+# a volute per attribute
 
 volute Equation do
 

data/examples/light.rb

@@ -0,0 +1,27 @@
+
+# license is MIT
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'volute' # gem install volute
+
+class Light
+  include Volute
+
+  attr_accessor :colour
+  attr_accessor :changed_at
+end
+
+volute Light do
+  volute :colour do
+    object.changed_at = Time.now
+  end
+end
+
+l = Light.new
+p l # => #<Light:0x10014c480>
+
+l.colour = :blue
+l.colour = :red
+p l # => #<Light:0x10014c480 @changed_at=Fri Oct 08 20:01:52 +0900 2010, @colour=:blue>
+

data/examples/state_machine.rb

@@ -9,50 +9,52 @@ $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'volute'
 
 #
-# our class
+# our classes
 
-class Book
-  include Volute
+module Bookshop
 
-  attr_accessor :stock
-  attr_accessor :discontinued
+  class Book
+    include Volute
 
-  attr_reader :state
+    attr_accessor :stock
+    attr_accessor :discontinued
+    attr_accessor :state
 
-  def initialize (stock)
-    @stock = stock
-    @discontinued = false
-    @state = :in_stock
+    def initialize (stock)
+      @stock = stock
+      @discontinued = false
+      @state = :in_stock
+    end
   end
 end
 
 #
-# a volute triggered for any 'set' operation on an attribute of book
+# volutes
 
-volute Book do
+volute Bookshop do
 
-  # object.volute_do_set(:state, x)
-  #   is equivalent to
-  # object.instance_variable_set(:@state, x)
+  volute :stock, :discontinued do
 
-  if object.stock <= 0
-    object.volute_do_set(
-      :state, object.discontinued ? :discontinued : :out_of_stock)
-  else
-    object.volute_do_set(
-      :state, :in_stock)
+    # anything in the module Bookshop that has an attribute :stock
+    # or :discontinued
+
+    if object.stock <= 0
+      object.state = object.discontinued ? :discontinued : :out_of_stock
+    else
+      object.state = :in_stock
+    end
   end
 end
 
 #
 # trying
 
-emma = Book.new(10)
+emma = Bookshop::Book.new(10)
 
-emma.stock = 2
+emma.stock -= 8
 p emma.state # => :in_stock
 
-emma.stock = 0
+emma.stock -= 2
 p emma.state # => :out_of_stock
 
 emma.discontinued = true

data/examples/state_machine_2.rb

@@ -0,0 +1,64 @@
+
+# license is MIT
+#
+# a state-machine-ish example, inspired by the example at
+# http://github.com/qoobaa/transitions
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'volute'
+
+#
+# our classes
+
+module Bookshop
+
+  class Book
+    include Volute
+
+    attr_accessor :stock
+    attr_accessor :discontinued
+    attr_accessor :state
+
+    def initialize (stock)
+      @stock = stock
+      @discontinued = false
+      @state = :in_stock
+    end
+  end
+end
+
+#
+# volutes
+
+volute Bookshop do
+
+  volute :stock, :discontinued do
+
+    # anything in the module Bookshop that has an attribute :stock
+    # or :discontinued
+
+    volute :any => [ 0, true ] do
+      object.state = object.discontinued ? :discontinued : :out_of_stock
+      over
+    end
+    volute do
+      object.state = :in_stock
+    end
+  end
+end
+
+#
+# trying
+
+emma = Bookshop::Book.new(10)
+
+emma.stock -= 8
+p emma.state # => :in_stock
+
+emma.stock -= 2
+p emma.state # => :out_of_stock
+
+emma.discontinued = true
+p emma.state # => :discontinued
+

data/examples/traffic.rb

@@ -0,0 +1,115 @@
+
+# license is MIT
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'volute'
+
+#
+# our classes
+
+class Light
+  include Volute
+
+  attr_accessor :colour
+  attr_accessor :changed_at
+
+  def initialize(colour)
+    self.colour = colour
+  end
+
+  def green?
+    self.colour == :green
+  end
+
+  def red!
+    self.colour = :red
+  end
+  def green!
+    self.colour = :green
+  end
+
+  def seconds
+    Time.now - @changed_at
+  end
+end
+
+class Line
+  include Volute
+
+  attr_accessor :name
+  attr_accessor :cars
+  attr_accessor :light
+  attr_accessor :complement
+
+  def initialize(name, colour)
+    @name = name
+    @cars = 0
+    @light = Light.new(colour)
+  end
+
+  def one_car
+    self.cars = self.cars + 1
+  end
+
+  def log(message)
+    puts "#{@name} : #{message} (#{@cars} cars)"
+  end
+end
+
+
+#
+# 'business logic'
+
+volute Light do
+
+  volute :colour do
+    object.changed_at = Time.now
+  end
+end
+
+volute Line do
+
+  volute :cars do
+
+    delta = value - object.complement.cars
+
+    if object.light.green?
+      object.vset(:cars, value - 1)
+      object.log('cars pass')
+    else
+      if delta > 4 || object.light.seconds > 5
+        object.complement.light.red!
+        object.light.green!
+        object.log('now green')
+        object.vset(:cars, 0)
+      else
+        object.log('car stops')
+      end
+    end
+  end
+end
+
+#
+# initialize system
+
+north_south = Line.new('north-south', :green)
+east_west = Line.new('east-west', :red)
+
+north_south.complement = east_west
+east_west.complement = north_south
+
+#
+# play
+
+north_south.one_car
+east_west.one_car
+east_west.one_car
+north_south.one_car
+east_west.one_car
+east_west.one_car
+north_south.one_car
+east_west.one_car
+east_west.one_car
+north_south.one_car
+