phenomenal 1.2.2 → 1.2.3

data/lib/phenomenal.rb

@@ -1,3 +1,4 @@
+require 'singleton'
 # Load the gem files in the system
 module Phenomenal 
   module Viewer end

data/lib/phenomenal/context/context.rb

@@ -7,7 +7,7 @@ class Phenomenal::Context
   
   attr_accessor :activation_age, :activation_frequency, :adaptations, 
     :activation_count, :parent, :forgotten
-  attr_reader :manager,:name  
+  attr_reader :manager,:name, :priority  
   # Instance methods
   def initialize(name=nil, manager=nil)
     @manager = manager || Phenomenal::Manager.instance
@@ -18,6 +18,7 @@ class Phenomenal::Context
     @manager.register_context(self)
     @parent=nil
     @forgotten=false
+    @priority=nil
   end
   
   # Unregister the context from the context manager,
@@ -200,6 +201,13 @@ class Phenomenal::Context
     end
   end
   
+  def priority=(priority)
+    @priority=priority
+    return unless manager.shared_contexts[self]
+    manager.shared_contexts[self].each do |shared_context|
+      shared_context.priority=[priority,shared_context.priority].compact.min
+    end
+  end
   private
   def check_validity
     if forgotten

data/lib/phenomenal/context/context_creation.rb

@@ -58,6 +58,9 @@ module Phenomenal::ContextCreation
       else
         c = self.new(c) 
       end
+      # Inherit from parent priority
+      context.priority=[c.priority,context.priority].compact.min
+      
       instances.push(c)
       manager.shared_contexts[c]= Array.new if !manager.shared_contexts[c]
       manager.shared_contexts[c].push(context)

data/lib/phenomenal/manager/conflict_policies.rb

@@ -19,6 +19,19 @@ module Phenomenal::ConflictPolicies
        context1.age <=> context2.age
     end
     
+    # Priority based conflict resolution
+    def priority_conflict_policy(context1, context2)
+      if context1.priority && !context2.priority
+        -1
+      elsif context2.priority && !context1.priority
+        1
+      elsif context1.priority!=context2.priority
+        context1.priority <=> context2.priority
+      else
+        context1.age <=> context2.age
+      end
+    end
+    
     # Resolution policy
     def conflict_policy(context1, context2)
       age_conflict_policy(context1, context2)

data/lib/phenomenal/manager/manager.rb

@@ -1,4 +1,3 @@
-require 'singleton'
 # This class manage the different contexts in the system and their interactions
 class Phenomenal::Manager
   include Singleton

data/lib/phenomenal/version.rb

@@ -1,3 +1,3 @@
 module Phenomenal
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

data/lib/phenomenal/viewer/graphical.rb

@@ -50,6 +50,7 @@ class Phenomenal::Viewer::Graphical
     self.main_graph = GraphViz::new("")
     # Default options
     self.main_graph[:compound] = "true"
+    self.main_graph[:rankdir]="LR"
     self.main_graph.edge[:lhead] = ""
     self.main_graph.edge[:ltail] = ""
     self.main_graph.edge[:fontsize] = 10.0

data/spec/integration/conflict_policy_spec.rb

@@ -16,7 +16,7 @@ describe "Conflict policies" do
       adapt :advertise do |a_call| 
         "vibrator" 
       end
-    end    
+    end
   end
   
   after :each do
@@ -25,119 +25,266 @@ describe "Conflict policies" do
     phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
   end
   
-  it "should not allow two contexts with an adaptation for the same method to be active at the same time" do
+  describe "No resolution conflict policy" do
+    it "should not allow two contexts with an adaptation for the same method to be active at the same time" do
   
-  expect{activate_context(:screening)}.to_not raise_error
-  expect{activate_context(:quiet)}.to raise_error Phenomenal::Error  
+    expect{activate_context(:screening)}.to_not raise_error
+    expect{activate_context(:quiet)}.to raise_error Phenomenal::Error  
+    end
   end
   
-  it "should set the age of the context such that the most recent one has the smaller age" do
-    phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
+  describe "Age resolution conflict policy" do
+    it "should set the age of the context such that the most recent one has the smaller age" do
+      phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
     
-    phen_context_active?(phen_default_feature).should be_true
-    phen_context_active?(:screening).should be_false
-    phen_context_active?(:quiet).should be_false
+      phen_context_active?(phen_default_feature).should be_true
+      phen_context_active?(:screening).should be_false
+      phen_context_active?(:quiet).should be_false
 
-    phen_activate_context(:screening)
+      phen_activate_context(:screening)
     
-    (phen_context_information(:screening)[:age] <
-            phen_context_information(phen_default_feature)[:age]).should be_true,
-            "screening context has been activated more recently than default"
-
-    phen_activate_context(:quiet)
-    (phen_context_information(:quiet)[:age] <
-            phen_context_information(:screening)[:age]).should be_true
-            "quiet context has been activated more recently than screening"
-    (phen_context_information(:screening)[:age] <
-            phen_context_information(phen_default_feature)[:age]).should be_true,
-            "quiet context has still been activated more recently than default"
-    phen_deactivate_context(:quiet)
-    phen_deactivate_context(:screening)
-    phen_activate_context(:screening)
-    (phen_context_information(:screening)[:age] <
-          phen_context_information(:quiet)[:age]).should be_true,
-            "screening context has now been activated more recently than quiet"
-  end
+      (phen_context_information(:screening)[:age] <
+              phen_context_information(phen_default_feature)[:age]).should be_true,
+              "screening context has been activated more recently than default"
+
+      phen_activate_context(:quiet)
+      (phen_context_information(:quiet)[:age] <
+              phen_context_information(:screening)[:age]).should be_true
+              "quiet context has been activated more recently than screening"
+      (phen_context_information(:screening)[:age] <
+              phen_context_information(phen_default_feature)[:age]).should be_true,
+              "quiet context has still been activated more recently than default"
+      phen_deactivate_context(:quiet)
+      phen_deactivate_context(:screening)
+      phen_activate_context(:screening)
+      (phen_context_information(:screening)[:age] <
+            phen_context_information(:quiet)[:age]).should be_true,
+              "screening context has now been activated more recently than quiet"
+    end
   
-  it "should choose the context the most recently activated" do
-    phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
-    expect{activate_context(:screening)}.to_not raise_error
-    expect{activate_context(:quiet)}.to_not raise_error
-  end
+    it "should choose the context the most recently activated" do
+      phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
+      expect{activate_context(:screening)}.to_not raise_error
+      expect{activate_context(:quiet)}.to_not raise_error
+    end
   
-  it "should work with interleaved activation of contexts" do
-    phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
-    phone = Phone.new
-    call = Call.new("Alice")
-    phone.receive(call)
+    it "should work with interleaved activation of contexts" do
+      phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      phone.receive(call)
 
-    phone.advertise(call).should=="ringtone"
+      phone.advertise(call).should=="ringtone"
 
-    activate_context(:quiet)
-    phone.advertise(call).should=="vibrator"
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
 
-    activate_context(:screening)
-    phone.advertise(call).should=="vibrator with screening"
+      activate_context(:screening)
+      phone.advertise(call).should=="vibrator with screening"
 
-    deactivate_context(:quiet)
-    phone.advertise(call).should=="ringtone with screening"
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
 
-    deactivate_context(:screening)
-    phone.advertise(call).should=="ringtone"
-  end
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
+    end
   
-  it "should nest calls with the age policy" do
-    phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
-    phone = Phone.new
-    call = Call.new("Alice")
-    phone.receive(call)
+    it "should nest calls with the age policy" do
+      phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      phone.receive(call)
 
-    phone.advertise(call).should=="ringtone"
+      phone.advertise(call).should=="ringtone"
 
-    activate_context(:quiet)
-    phone.advertise(call).should=="vibrator"
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
 
-    activate_context(:screening)
-    phone.advertise(call).should=="vibrator with screening"
+      activate_context(:screening)
+      phone.advertise(call).should=="vibrator with screening"
 
-    deactivate_context(:screening)
-    phone.advertise(call).should=="vibrator"
+      deactivate_context(:screening)
+      phone.advertise(call).should=="vibrator"
 
-    deactivate_context(:quiet)
-    phone.advertise(call).should=="ringtone"
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone"
+    end
+  
+    it "should proceed adaptations in the rigth order" do
+      phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
+      context(:level1)
+      phen_add_adaptation(:level1,TestClass,:print) do |arg|
+        phen_proceed(arg) + " 1 -> ARG1: #{arg.to_s}"
+      end
+
+      context(:level2)
+      phen_add_adaptation(:level2,TestClass,:print) do |arg|
+        phen_proceed(arg) + " 2 -> ARG2: #{arg.to_s}"
+      end
+
+      context(:level3)
+      phen_add_adaptation(:level3,TestClass,:print) do |arg|
+        phen_proceed(arg) + " 3 -> ARG3: #{arg.to_s}"
+      end
+
+      context(:level4)
+      phen_add_adaptation(:level4,TestClass,:print) do |arg|
+        phen_proceed(arg) + " 4 -> ARG4: #{arg.to_s}"
+      end
+      t = TestClass.new("Foo")
+      t.print("bar").should=="0 -> ARG: bar"
+      activate_context(:level1)
+      activate_context(:level2)
+      activate_context(:level3)
+      activate_context(:level4)
+      t.print("bar").should=="0 -> ARG: bar 1 -> ARG1: bar 2 -> ARG2: bar 3 -> ARG3: bar 4 -> ARG4: bar"
+      force_forget_context(:level1)
+      force_forget_context(:level2)
+      force_forget_context(:level3)
+      force_forget_context(:level4)
+    end
   end
   
-  it "should proceed adaptations in the rigth order" do
-    phen_change_conflict_policy { |a,b| age_conflict_policy(a,b) }
-    context(:level1)
-    phen_add_adaptation(:level1,TestClass,:print) do |arg|
-      phen_proceed(arg) + " 1 -> ARG1: #{arg.to_s}"
+  describe "Priority conflict resolution policy" do
+    it "should behave like age when no priorities defined" do
+      phen_change_conflict_policy { |a,b| priority_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      phone.receive(call)
+
+      phone.advertise(call).should=="ringtone"
+
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
+
+      activate_context(:screening)
+      phone.advertise(call).should=="vibrator with screening"
+
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
+
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
     end
+  
+    it "should use priorities when defined" do
+      phen_change_conflict_policy { |a,b| priority_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      context(:quiet).priority=1
+      context(:screening).priority=2
+
+      phone.receive(call)
+
+      phone.advertise(call).should=="ringtone"
 
-    context(:level2)
-    phen_add_adaptation(:level2,TestClass,:print) do |arg|
-      phen_proceed(arg) + " 2 -> ARG2: #{arg.to_s}"
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
+
+      activate_context(:screening)
+      phone.advertise(call).should=="vibrator"
+
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
+
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
     end
+    it "should behave like age when priorities are equal" do
+      phen_change_conflict_policy { |a,b| priority_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      context(:quiet).priority=2
+      context(:screening).priority=2
+      phone.receive(call)
+
+      phone.advertise(call).should=="ringtone"
+
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
+
+      activate_context(:screening)
+      phone.advertise(call).should=="vibrator with screening"
+
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
+
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
+    end
+    
+    it "should prefer priority over age" do
+      phen_change_conflict_policy { |a,b| priority_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      context(:quiet).priority=1
+
+      phone.receive(call)
 
-    context(:level3)
-    phen_add_adaptation(:level3,TestClass,:print) do |arg|
-      phen_proceed(arg) + " 3 -> ARG3: #{arg.to_s}"
+      phone.advertise(call).should=="ringtone"
+
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
+
+      activate_context(:screening)
+      phone.advertise(call).should=="vibrator"
+
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
+
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
     end
+    
+    it "should prefer combined context" do
+      phen_change_conflict_policy { |a,b| priority_conflict_policy(a,b) }
+      phone = Phone.new
+      call = Call.new("Alice")
+      combined_context=context :screening, :quiet do
+        adaptations_for Phone
+        adapt :advertise do |a_call|
+          "combined"
+        end
+      end
+      context(:quiet).priority=1
+      context(:screening).priority=2
+      
+      
+      phone.receive(call)
+
+      phone.advertise(call).should=="ringtone"
+
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
+
+      activate_context(:screening)
+      phone.advertise(call).should=="combined"
+
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
+
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
+      
+      # Invert priority
+      context(:quiet).priority=2
+      context(:screening).priority=1
+
+      phone.advertise(call).should=="ringtone"
+
+      activate_context(:quiet)
+      phone.advertise(call).should=="vibrator"
+
+      activate_context(:screening)
+      phone.advertise(call).should=="combined"
+
+      deactivate_context(:quiet)
+      phone.advertise(call).should=="ringtone with screening"
 
-    context(:level4)
-    phen_add_adaptation(:level4,TestClass,:print) do |arg|
-      phen_proceed(arg) + " 4 -> ARG4: #{arg.to_s}"
+      deactivate_context(:screening)
+      phone.advertise(call).should=="ringtone"
+      
+      combined_context.forget
     end
-    t = TestClass.new("Foo")
-    t.print("bar").should=="0 -> ARG: bar"
-    activate_context(:level1)
-    activate_context(:level2)
-    activate_context(:level3)
-    activate_context(:level4)
-    t.print("bar").should=="0 -> ARG: bar 1 -> ARG1: bar 2 -> ARG2: bar 3 -> ARG3: bar 4 -> ARG4: bar"
-    force_forget_context(:level1)
-    force_forget_context(:level2)
-    force_forget_context(:level3)
-    force_forget_context(:level4)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phenomenal
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec