phenomenal 0.99.0 → 1.0.0

data/lib/phenomenal/relationships/feature_relationships.rb

@@ -1,3 +1,5 @@
+# Define the methods that can be called by a feature to
+# define relationships
 module Phenomenal::FeatureRelationships 
   attr_accessor :relationships
   
@@ -20,7 +22,6 @@ module Phenomenal::FeatureRelationships
   private 
   def add_relationship(source,targets,type)
     targets[:on]=Array.new.push(targets[:on]) if !targets[:on].is_a?(Array)
-    
     if targets[:on].nil?
       Phenomenal::Logger.instance.error(
         "Invalid relationship, missing target context"
@@ -37,6 +38,5 @@ module Phenomenal::FeatureRelationships
         end
       end
     end
-    
   end
 end

data/lib/phenomenal/relationships/implication.rb

@@ -1,3 +1,4 @@
+# Define the behavior of the Implication relationship
 class Phenomenal::Implication < Phenomenal::Relationship  
   attr_accessor :activation_counter
   def initialize(source,target,feature)
@@ -8,28 +9,33 @@ class Phenomenal::Implication < Phenomenal::Relationship
   def activate_feature
     if source.active?
       target.activate
-      activation_counter+=1
+      self.activation_counter+=1
     end
   end
   
   def deactivate_feature
     if activation_counter>0
       target.deactivate
-      activation_coutner-=1
+      self.activation_counter-=1
     end
   end
   
   def activate_context(context)
     if source==context
       target.activate
+      self.activation_counter+=1
     end
   end
   
   def deactivate_context(context)
-    if source==context
+    if source==context && activation_counter>0
       target.deactivate
-    else
+      self.activation_counter-=1
+    elsif activation_counter>0
       source.deactivate
+      self.activation_counter-=1
+    else
+      # Nothing to do
     end
   end
 end

data/lib/phenomenal/relationships/relationship.rb

@@ -1,3 +1,4 @@
+# Define a first class relationship
 class Phenomenal::Relationship
   attr_accessor :source,:target,:manager,:feature
   
@@ -24,15 +25,27 @@ class Phenomenal::Relationship
     self.target=t if !t.nil?
   end
   
+  # Must be redifined for each type of relation
+  # if necessary
+  # Called when a context is activated
   def activate_context(context)
   end
   
+  # Must be redifined for each type of relation
+  # if necessary
+  # Called when a context is deactivated
   def deactivate_context(context)
   end
   
+  # Must be redifined for each type of relation
+  # if necessary
+  # Called when a feature is activated
   def activate_feature
   end
   
+  # Must be redifined for each type of relation
+  # if necessary
+  # Called when a feature is deactivated
   def deactivate_feature
   end
 

data/lib/phenomenal/relationships/relationships_manager.rb

@@ -1,5 +1,5 @@
 require 'singleton'
-
+# This class manage the different relatiohsips in the system between contexts
 class Phenomenal::RelationshipsManager
   include Singleton
   

data/lib/phenomenal/relationships/relationships_store.rb

@@ -1,3 +1,5 @@
+# Define the class where all the actives relationships are
+# efficiently stored
 class Phenomenal::RelationshipsStore
   attr_accessor :sources, :targets
   
@@ -34,16 +36,20 @@ class Phenomenal::RelationshipsStore
   def update_references(context)
     # Do nothing when anonymous, references are already valid
     return if context.anonymous?
-    # Update sources 
-    @sources[context.name].each do |relationship|
-      relationship.source=context
+    # Update sources
+    if not @sources[context.name].nil?
+      @sources[context.name].each do |relationship|
+        relationship.source=context
+      end
+      @sources[context]=@source.delete(context.name)
     end
-    @sources[context]=@source.delete(context.name)
     # Update targets
-    @targets[context.name].each do |relationship|
-      relationship.target=context
+    if not @targets[context.name].nil?
+      @targets[context.name].each do |relationship|
+        relationship.target=context
+      end
+      @targets[context]=@targets.delete(context.name)
     end
-    @targets[context]=@targets.delete(context.name)
   end
   
   def get_for(context)

data/lib/phenomenal/relationships/requirement.rb

@@ -1,8 +1,13 @@
+# Define the behavior of the Requirement relationship
 class Phenomenal::Requirement < Phenomenal::Relationship
+  
   def activate_feature
     check_requirement
   end
   
+  def deactivate_feature
+  end
+  
   def activate_context(context)
     if(source==context)
       check_requirement

data/lib/phenomenal/relationships/suggestion.rb

@@ -1,3 +1,4 @@
+# Define the behavior of the Suggestion relationship
 class Phenomenal::Suggestion < Phenomenal::Relationship
   attr_accessor :activation_counter
   
@@ -20,22 +21,29 @@ class Phenomenal::Suggestion < Phenomenal::Relationship
     begin
       if activation_counter>0
         target.deactivate
-        self.activation_coutner-=1
+        self.activation_counter-=1
       end
     rescue
     end
   end
   
-  
   def activate_context(context)
-    if source==context
-      target.activate
+    begin
+      if source==context
+        target.activate
+        self.activation_counter+=1
+      end
+    rescue
     end
   end
   
   def deactivate_context(context)
-    if source==context
-      target.deactivate
+    begin
+      if source==context && activation_counter>0
+        target.deactivate
+        self.activation_counter-=1
+      end
+    rescue
     end
   end
 end

data/lib/phenomenal/version.rb

@@ -1,3 +1,3 @@
 module Phenomenal
-  VERSION = "0.99.0"
+  VERSION = "1.0.0"
 end

data/lib/phenomenal/viewer/dsl.rb

@@ -0,0 +1,15 @@
+module Phenomenal::DSL
+  def self.define_viewers(klass)
+    klass.class_eval do
+      # Graphical
+      def phen_graphical_view(file="view.png")
+        Phenomenal::Viewer::Graphical.new(file).generate
+      end
+      
+      #Textual
+      def phen_textual_view
+        Phenomenal::Viewer::Textual.new.generate
+      end
+    end
+  end
+end

data/lib/phenomenal/viewer/graphical.rb

@@ -0,0 +1,136 @@
+# Define the way to generate a representation of the system
+# using the graphical library graphviz
+class Phenomenal::Viewer::Graphical
+  begin
+    require "graphviz"
+    @@graphviz=true
+  rescue LoadError
+    @@graphviz=false
+  end  
+  
+  attr_reader :manager, :rmanager
+  attr_accessor :main_graph, :feature_nodes, :r_feature_nodes, :context_nodes, :destination_file
+  
+  def initialize(destination_file)
+    if !@@graphviz
+      Phenomenal::Logger.instance.error(
+        "The 'ruby-graphviz' gem isn't available. Please install it to generate graphic visualitations\n"+
+        " Otherwise use the text version"
+      )
+    end
+    
+    @manager=Phenomenal::Manager.instance
+    @rmanager=Phenomenal::RelationshipsManager.instance
+    @destination_file=destination_file
+    @main_graph=nil
+    @feature_nodes={}
+    @r_feature_nodes={}
+    @context_nodes={}
+  end
+  
+  def generate()
+    # Create main graph
+    self.main_graph = GraphViz::new("")
+    # Default options
+    self.main_graph[:compound] = "true"
+    self.main_graph.edge[:lhead] = ""
+    self.main_graph.edge[:ltail] = ""
+    self.main_graph.edge[:fontsize]=10.0
+    # Add nodes to the graph
+    self.manager.contexts.each do |key,context|
+      if not self.feature_nodes.include?(context) and not @context_nodes.include?(context)
+        add_node_for(context)
+      end
+    end
+    # Create a relationship links
+    self.manager.contexts.each do |key,context|
+      add_edges_for(context)
+    end
+    self.main_graph.output( :png => self.destination_file )
+  end
+  
+  private
+  def add_edges_for(context)
+    if context.is_a?(Phenomenal::Feature)
+      context.relationships.each do |relationship|
+        # Get source and destionation node
+        ltail=""
+        lhead=""
+        relationship.refresh
+        if self.feature_nodes.include?(relationship.source)
+          source_node=self.r_feature_nodes[relationship.source]
+          ltail="cluster_#{relationship.source.to_s}"
+        else 
+          source_node=self.context_nodes[relationship.source]
+        end
+        if self.feature_nodes.include?(relationship.target)
+          target_node=self.r_feature_nodes[relationship.target]
+          lhead="cluster_#{relationship.target.to_s}"
+        else
+          target_node=self.context_nodes[relationship.target]
+        end
+        # Define graph container
+        s_parent_feature=relationship.source.parent_feature
+        t_parent_feature=relationship.target.parent_feature
+        if s_parent_feature==t_parent_feature && s_parent_feature!=self.manager.default_context
+          graph=self.feature_nodes[relationship.source.parent_feature]
+        else
+          graph=self.main_graph
+        end
+        # Add edge
+        edge=graph.add_edges(source_node,target_node,:ltail=>ltail,:lhead=>lhead)   
+        # Define edge label
+        if context!=self.manager.default_context
+          edge[:label]=context.to_s
+         end
+        # Define edge color
+        if self.rmanager.relationships.include?(relationship)
+          edge[:color]="red"
+        end
+        # Define arrow type
+        if relationship.is_a?(Phenomenal::Implication)
+          edge[:arrowhead]="normal"
+        elsif relationship.is_a?(Phenomenal::Suggestion)
+          edge[:arrowhead]="empty"
+        elsif relationship.is_a?(Phenomenal::Requirement)
+          edge[:arrowhead]="inv"
+        else
+        end
+      end
+    end
+  end
+  
+  def add_node_for(context)
+    # The default context is the first to be added to the main graph
+    if self.feature_nodes[context.parent_feature].nil? and context==self.manager.default_context 
+      current_graph=self.main_graph
+    # Always add the parent_feature before the contexts inside
+    elsif @feature_nodes[context.parent_feature].nil?
+      self.add_node_for(context.parent_feature)
+    else
+      current_graph=self.feature_nodes[context.parent_feature]
+    end
+    # Add node
+    if context.is_a?(Phenomenal::Feature)
+      node=current_graph.add_graph("cluster_#{context.to_s}")
+      node[:label]="#{context.to_s}"
+      # Add hidden node for feature relationship
+      fr=node.add_nodes("#{context.to_s}_relationship")
+      fr[:style]="invis"
+      fr[:height]=0.02
+      fr[:width]=0.02
+      fr[:fixedsize]=true
+      self.feature_nodes[context]=node
+      self.r_feature_nodes[context]=fr
+    else
+      node=current_graph.add_nodes(context.to_s) 
+      self.context_nodes[context]=node
+    end
+    # Define node color
+    if context.active?
+      node[:color]="red"
+    else
+      node[:color]="black"
+    end
+  end
+end

data/lib/phenomenal/viewer/textual.rb

@@ -0,0 +1,36 @@
+# Define the way to generate a textual representation of the system
+class Phenomenal::Viewer::Textual
+  attr_reader :manager, :rmanager
+  
+  def initialize()
+    @manager=Phenomenal::Manager.instance
+    @rmanager=Phenomenal::RelationshipsManager.instance
+  end
+  
+  def generate()
+    str=""
+    offset="  "
+    self.manager.contexts.each do |key,context|
+      if context.is_a?(Phenomenal::Feature)
+        type="Feature"
+        str=str+"#{type}: #{context.to_s} \n"
+        context.relationships.each do |relationship|
+          if relationship.is_a?(Phenomenal::Implication)
+            relation="=>"
+          elsif relationship.is_a?(Phenomenal::Suggestion)
+            relation="->"
+          elsif relationship.is_a?(Phenomenal::Requirement)
+            relation="=<"
+          else
+            relation="??"
+          end
+          str=str+"#{offset} #{relationship.source.to_s} #{relation} #{relationship.target.to_s} \n"
+       end
+     else
+       type="Context"
+       str=str+"#{type}: #{context.to_s} \n"
+     end
+   end
+     str
+  end
+end

data/spec/context_spec.rb

@@ -5,6 +5,7 @@ describe Phenomenal::Context do
   before :each do
     @context = Phenomenal::Context.new(:test)
     @context2 = Phenomenal::Context.new(:test2)
+    @manager = Phenomenal::Manager.instance
   end
   
   after :each  do
@@ -34,7 +35,9 @@ describe Phenomenal::Context do
     end
     
     it "should be anonymous if the name wasn't set" do
-      Phenomenal::Context.new.name.should be_nil
+      context = Phenomenal::Context.new
+      context.name.should be_nil
+      force_forget_context(context)
     end
     
     it "should be anonymous if it is the default context" do
@@ -42,24 +45,76 @@ describe Phenomenal::Context do
     end
   end
   
-  describe ".create" do
-    pending "TODO"
-  end
-  
   describe "#forget" do
-    pending "TODO"
+    it "should raise an error if the context is active" do
+      @context.activate
+      expect{@context.forget}.to raise_error Phenomenal::Error
+    end
+    
+    it "should unregister the context from the manager" do
+      @context.forget
+      @manager.contexts[@context].should be_nil
+      @context = Phenomenal::Context.new(:test)
+    end
+    
+    it "should raise an error if used after being forgotted" do
+      @context.forget
+      expect{@context.activate}.to raise_error Phenomenal::Error
+      @context = Phenomenal::Context.new(:test)
+    end
   end
   
   describe "#add_adaptation" do
-    pending "TODO"
+    it "should save the default behavior in the default context" do
+      @context.add_adaptation(TestString, :size,true) do
+        42
+      end
+      a = phen_default_context.adaptations.find{|a| a.concern?(TestString,:size,true)}
+      a.bind(TestString.new("1234")).should==4
+    end
+    
+    it "should activate the adaptation if the context is active"do
+      string = TestString.new("1234")
+      string.size.should==4
+      @context.activate
+      string.size.should==4
+      @context.add_adaptation(TestString, :size,true) do
+        42
+      end
+      string.size.should==42
+    end
+    
+    it "should  not activate the adaptation if the context is inactive"do
+      string = TestString.new("1234")
+      string.size.should==4
+      @context.add_adaptation(TestString, :size,true) do
+        42
+      end
+      string.size.should==4
+    end
   end
   
   describe "#remove_adaptation" do
-    pending "TODO"
+    it "should deactivate the adaptation if the context is active" do
+      string = TestString.new("1234")
+      string.size.should==4
+      @context.activate
+      @context.add_adaptation(TestString, :size,true) do
+        42
+      end
+      string.size.should==42
+      phen_remove_adaptation(:test, TestString, :size)
+      string.size.should==4
+      context(:test).active?.should be_true
+    end
   end
   
   describe "#context" do
-    pending "TODO"
+    it "should create a combined context of itself and the argument context" do
+      c = phen_context(:test).context(:new_context)
+      phen_context(:test,:new_context).should==c
+      force_forget_context(:new_context)
+    end
     
     describe "#phen_context" do
       it "should be an alias of #context" do
@@ -69,7 +124,11 @@ describe Phenomenal::Context do
   end
   
   describe "#feature" do
-    pending "TODO"
+    it "should create a combined context of itself and the feature" do
+      c = phen_context(:test).feature(:new_feature)
+      phen_context(:test).feature(:new_feature).should==c
+      force_forget_context(:new_feature)
+    end
     
     describe "#phen_feature" do
       it "should be an alias of #feature" do
@@ -79,19 +138,28 @@ describe Phenomenal::Context do
   end
   
   describe "#add_adaptations" do
-    pending "TODO"
+    it "should be able to adapt multiple instance method" do
+      @context.should respond_to :add_adaptations
+    end
   end
   
   describe "#adapatations_for" do
-    pending "TODO"
+    it "should set the current adapted class" do
+      @context.adaptations_for String
+      @context.instance_variable_get("@current_adapted_class").should == String
+    end
   end
   
   describe "#adapt" do
-    pending "TODO"
+    it "should be able to adapt an instance method" do
+      @context.should respond_to :adapt
+    end
   end
   
-  describe "#adapt_klass" do
-    pending "TODO"
+  describe "#adapt_class" do
+    it "should be able to adapt a  method" do
+      @context.should respond_to :adapt_class
+    end
   end
   
   
@@ -189,14 +257,6 @@ describe Phenomenal::Context do
   end
   
   describe "#anonymous?" do
-    after do
-      force_forget_context(@context3)
-    end
-    it "should be true when the context has no name" do
-      @context3 = Phenomenal::Context.new
-      @context3.anonymous?.should be_true
-    end
-    
     it "should be false when the context has a name" do
       @context.anonymous?.should be_false
     end
@@ -204,6 +264,12 @@ describe Phenomenal::Context do
     it "should be true for the default context" do
       Phenomenal::Manager.instance.default_context.anonymous?.should be_true
     end
+    
+    it "should be true when the context has no name" do
+      @context3 = Phenomenal::Context.new
+      @context3.anonymous?.should be_true
+      force_forget_context(@context3)
+    end    
   end
   
   describe "#information" do
@@ -235,13 +301,12 @@ describe Phenomenal::Context do
       @context.activate
       @context.information[:activation_count].should==1
     end
-    after do
-      force_forget_context(@feature)
-    end
+
     it "should have a matching :type field" do
       @context.information[:type].should=="Phenomenal::Context"
       @feature = Phenomenal::Feature.new
       @feature.information[:type].should=="Phenomenal::Feature"
+      force_forget_context(@feature)
     end
     
       
@@ -260,8 +325,9 @@ describe Phenomenal::Context do
         end
       end
       c.parent_feature.should be f
-      c.forget
+      
       f.forget
+      context(:c).forget
     end
   end
 end