phenomenal 0.99.0 → 1.0.0

data/Rakefile

@@ -1,11 +1,5 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
 desc "Run tests"
-task :default => :test
+task :default => :spec
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')

data/lib/phenomenal.rb

@@ -1,5 +1,7 @@
 # Load the gem files in the system
-module Phenomenal end
+module Phenomenal 
+  module Viewer end
+end
 #Relationships
 require_relative "./phenomenal/relationships/context_relationships.rb"
 require_relative "./phenomenal/relationships/feature_relationships.rb"
@@ -19,6 +21,13 @@ require_relative "./phenomenal/logger.rb"
 require_relative "./phenomenal/manager.rb"
 require_relative "./phenomenal/proc.rb"
 
+# Viewer
+require_relative "./phenomenal/viewer/graphical.rb"
+require_relative "./phenomenal/viewer/textual.rb"
+
 # DSL
 require_relative "./phenomenal/relationships/dsl.rb"
+require_relative "./phenomenal/viewer/dsl.rb"
 require_relative "./phenomenal/dsl.rb"
+
+

data/lib/phenomenal/adaptation.rb

@@ -2,6 +2,7 @@
 class  Phenomenal::Adaptation
   attr_accessor :context, :klass, :method_name, :implementation, :src_file,
                 :src_line,:instance_adaptation
+  alias_method :instance_adaptation?, :instance_adaptation
                 
   def initialize(context,klass, method_name,instance_adapatation,implementation)
     @context = context
@@ -9,11 +10,10 @@ class  Phenomenal::Adaptation
     @method_name = method_name
     @implementation = implementation
     @instance_adaptation=instance_adapatation
-    
     check_validity
     # Save the source location if any, this is used to find again the adaptation
-    # in a ctxt_proceed call. It always exists except for method directly
-    # implemented in C -> Not a problem because these one never use ctxt_proceed
+    # in a proceed call. It always exists except for method directly
+    # implemented in C -> Not a problem because these one never use proceed
     source_location = implementation.source_location
     if source_location
       @src_file = implementation.source_location[0]
@@ -33,9 +33,9 @@ class  Phenomenal::Adaptation
     end
   end
   
-  # IMPROVE check for better implementation
+  # IMPROVE try to find a better implementation
   # Bind the implementation corresponding to this adaptation to 'instance' when
-  # instance_method or to implementation klass when class method 
+  # instance_adaptation or to implementation class when class method 
   def bind(instance,*args,&block)
     if instance_adaptation?
       if implementation.class==Proc
@@ -58,9 +58,7 @@ class  Phenomenal::Adaptation
     self.method_name==method_name && 
     self.instance_adaptation==instance_adaptation
   end
-
-  alias_method :instance_adaptation?, :instance_adaptation
-  
+    
   # String representation
   def to_s
    ":#{context.name} => #{klass.name}.#{method_name} :: #{src_file}:#{src_line}"

data/lib/phenomenal/conflict_policies.rb

@@ -1,5 +1,6 @@
 # Context conflict resolution policies
 module Phenomenal::ConflictPolicies
+  
   # Prefer not default adaptation, error if two not default ones
     def no_resolution_conflict_policy(adaptation1,adaptation2)
       if adaptation1.context==default_context()
@@ -8,7 +9,7 @@ module Phenomenal::ConflictPolicies
         -1
       else #Fail if two non default adaptations
         Phenomenal::Logger.instance.error(
-            "Error: Illegal duplicate adapation of #{adaptation1.to_s}"
+            "Illegal duplicate adapation of #{adaptation1.to_s}"
         )
       end
     end

data/lib/phenomenal/context.rb

@@ -1,7 +1,12 @@
-# Represent a first class context
+# Represents a first class context
 class Phenomenal::Context
   include Phenomenal::ContextRelationships
   @@total_activations = 0
+  
+  attr_accessor :activation_age, :activation_frequency, :adaptations, 
+    :activation_count, :parent,:forgotten
+  attr_reader :manager,:name
+  
   def self.create(context,*contexts,nested,closest_feature,&block)
     manager = Phenomenal::Manager.instance
     contexts.insert(0,context)
@@ -12,7 +17,7 @@ class Phenomenal::Context
         context = manager.find_context(context)
         if !context.instance_of?(self)
           Phenomenal::Logger.instance.error(
-            "Only #{self.name} can be used with this keyword"
+            "Only #{self.name} can be used with this keyword."
           )
         end
       end
@@ -29,7 +34,7 @@ class Phenomenal::Context
             c = manager.find_context(c) 
             if !nested && c!=first && !c.instance_of?(self)
               Phenomenal::Logger.instance.error(
-                "Only #{self.name} can be used with this keyword"
+                "Only #{self.name} can be used with this keyword."
               )
             end
           else
@@ -42,16 +47,17 @@ class Phenomenal::Context
         manager.combined_contexts[context] = instances
       else
         context = manager.find_context(*contexts)
+        if !context.instance_of?(self)
+          Phenomenal::Logger.instance.error(
+            "Only #{self.name} can be used with this keyword."
+          )
+        end
       end
     end
     context.add_adaptations(&block)
     context
   end
   
-  attr_accessor :activation_age, :activation_frequency, :adaptations, 
-    :activation_count, :parent,:forgotten
-  attr_reader :manager,:name
-  
   def initialize(name=nil, manager=nil)
     @manager = manager || Phenomenal::Manager.instance
     @name = name
@@ -64,7 +70,7 @@ class Phenomenal::Context
   end
   
   # Unregister the context from the context manager,
-  # This context shoudn't be used after.
+  # This context shouldn't be used after.
   # The context has to be inactive before being forgetted
   # TODO handle relationships references
   def forget
@@ -74,7 +80,7 @@ class Phenomenal::Context
       )
     else
       manager.unregister_context(self)
-      forgotten=true
+      self.forgotten=true
     end
   end
   
@@ -87,8 +93,8 @@ class Phenomenal::Context
     end
     if adaptations.find{ |i| i.concern?(klass,method_name,instance) }
       Phenomenal::Logger.instance.error(
-        "Error: Illegal duplicated adaptation in context: #{self} for " + 
-        "#{klass.name}:#{method_name}"
+        "Illegal duplicated adaptation in context: #{self} for " + 
+        "#{klass.name}:#{method_name}."
       )
     else
       if klass.instance_methods.include?(method_name) && instance
@@ -97,20 +103,19 @@ class Phenomenal::Context
         method = klass.method(method_name)
       else
         Phenomenal::Logger.instance.error(
-          "Error: Illegal adaptation for context #{self},a method with "+
+          "Illegal adaptation for context #{self},a method with "+
           "name: #{method_name} should exist in class #{klass.name} to "+ 
-          "be adapted"
+          "be adapted."
         )
       end
       if method.arity != implementation.arity
         Phenomenal::Logger.instance.error(
-          "Error: Illegal adaptation for context #{self},the adaptation "+ 
+          "Illegal adaptation for context #{self},the adaptation "+ 
           "have to keep the original method arity for method: " +
           "#{klass.name}.#{method_name}: (#{method.arity} instead of " +
-          "#{implementation.arity})" 
+          "#{implementation.arity})." 
         )
       end
-      
       adaptation = Phenomenal::Adaptation.new(
         self, klass, method_name,instance, implementation
       )
@@ -149,8 +154,8 @@ class Phenomenal::Context
     add_adaptation(@current_adapted_class,method,true,&block)
   end
   
-  # Adapt a method for @current_adapted_class
-  def adapt_klass(method,&block)
+  # Adapt a class method for @current_adapted_class
+  def adapt_class(method,&block)
     add_adaptation(@current_adapted_class,method,false,&block)
   end
 
@@ -160,8 +165,8 @@ class Phenomenal::Context
       adaptations.find_index{ |i| i.concern?(klass, method_name,instance) }
     if !adaptation_index
       Phenomenal::Logger.instance.error(
-        "Error: Illegal deleting of an inexistent adaptation in context: " +
-        "#{self} for #{klass.name}.#{method_name})"
+        "Illegal deleting of an inexistent adaptation in context: " +
+        "#{self} for #{klass.name}.#{method_name})."
       )
     end
     
@@ -209,18 +214,18 @@ class Phenomenal::Context
   end
   
   # Return the activation age of the context:
-  #  The age counter minus the age counter when the context was activated
-  #  for the last time
+  # (The age counter minus the age counter when the context was activated
+  # for the last time)
   def age
     @@total_activations-activation_age
   end
   
   # Return context informations:
-  #   - Name
-  #   - List of the adaptations
-  #   - Active state
-  #   - Activation age
-  #   - Activation count
+  # - Name
+  # - List of the adaptations
+  # - Active state
+  # - Activation age
+  # - Activation count
   def information
     {
       :name=>name,
@@ -250,11 +255,11 @@ class Phenomenal::Context
     if name
       name.to_s
     elsif self==manager.default_context
-      "'Default context'"
+      "Default context"
     elsif manager.combined_contexts[self]
-       "'Combined context : #{manager.combined_contexts[self].flatten}'"
+       "#{manager.combined_contexts[self].flatten}"
     else
-      "'Anonymous context'"
+      "Anonymous context"
     end
   end
   
@@ -262,7 +267,7 @@ class Phenomenal::Context
   def check_validity
     if forgotten
       Phenomenal::Logger.instance.error(
-        "Action not allowed anymore when context has been forgotten"
+        "Action not allowed anymore when context has been forgotten."
       )
     end
   end

data/lib/phenomenal/dsl.rb

@@ -3,10 +3,6 @@ module Phenomenal::DSL
   #Override included hook method
   def self.included(klass)
     klass.class_eval do
-      #Define Context
-      def phen_define_context(name=nil,priority=nil)
-        Phenomenal::Context.new(name,priority)     
-      end
       # Define context with adaptations
       def phen_context(context,*contexts,&block)
         Phenomenal::Context.create(context,*contexts,false,nil,&block)
@@ -19,7 +15,6 @@ module Phenomenal::DSL
       end
       Phenomenal::DSL.phen_alias(:feature,klass)
       
-      
       # Forget Context
       def phen_forget_context(context)
         Phenomenal::Manager.instance.find_context(context).forget
@@ -52,14 +47,22 @@ module Phenomenal::DSL
       end
       
       # Activate Context
-      def phen_activate_context(context)
-        Phenomenal::Manager.instance.find_context(context).activate
+      def phen_activate_context(context,*contexts)
+        contexts=[] if contexts.nil?
+        contexts.push(context)
+        contexts.each do |c|
+          Phenomenal::Manager.instance.find_context(c).activate
+        end
       end
       Phenomenal::DSL.phen_alias(:activate_context,klass)
       
       # Deactivate Context
-      def phen_deactivate_context(context)
-        Phenomenal::Manager.instance.find_context(context).deactivate   
+      def phen_deactivate_context(context,*contexts)
+        contexts=[] if contexts.nil?
+        contexts.push(context)
+        contexts.each do |c|
+          Phenomenal::Manager.instance.find_context(c).deactivate 
+        end 
       end
       Phenomenal::DSL.phen_alias(:deactivate_context,klass)
       
@@ -96,6 +99,8 @@ module Phenomenal::DSL
     end
     # Add relationships specific DSL
     define_relationships(klass)
+    # Add Viewers specific DSL
+    define_viewers(klass)
   end
   
   private

data/lib/phenomenal/feature.rb

@@ -1,3 +1,4 @@
+# Represents a first class feature from context
 class Phenomenal::Feature < Phenomenal::Context
   include Phenomenal::FeatureRelationships
 

data/lib/phenomenal/manager.rb

@@ -5,7 +5,7 @@ class Phenomenal::Manager
   include Phenomenal::ConflictPolicies
   
   attr_accessor :active_adaptations, :deployed_adaptations, :contexts, 
-:default_context, :combined_contexts, :shared_contexts, :rmanager
+  :default_context, :combined_contexts, :shared_contexts, :rmanager
   
   # Register a new context 
   def register_context(context)
@@ -20,18 +20,20 @@ class Phenomenal::Manager
         " If you want to have named context it has to be a globally unique name"
       )
     end
+    # Update the relationships that concern this context
+    rmanager.update_relationships_references(context)
+    # Store the context at its ID
     contexts[context]=context
   end
   
   # Unregister a context (forget)
   def unregister_context(context)
-    if context==default_context && !contexts.size==1
+    if context==default_context && contexts.size>1
       Phenomenal::Logger.instance.error(
         "Default context can only be forgotten when alone"
       )
     else
       contexts.delete(context)
-      
       # Forgot combined contexts
       combined_contexts.delete(context)
       if shared_contexts[context]
@@ -39,7 +41,6 @@ class Phenomenal::Manager
           c.forget
         end
       end
-      
       # Restore default context
       init_default() if context==default_context
     end
@@ -65,8 +66,7 @@ class Phenomenal::Manager
   def activate_context(context)
     begin
       # Relationships managment
-      rmanager.activate_relationships(context) if context.just_activated?
-      
+      rmanager.activate_relationships(context) if context.just_activated?   
       # Activation of adaptations
       context.adaptations.each{ |i| activate_adaptation(i) }
       #puts "activation of #{context}"
@@ -114,9 +114,7 @@ class Phenomenal::Manager
     adaptations_stack = sorted_adaptations_for(calling_adaptation.klass,  
       calling_adaptation.method_name,calling_adaptation.instance_adaptation?)
     calling_adaptation_index = adaptations_stack.find_index(calling_adaptation)
-
     next_adaptation = adaptations_stack[calling_adaptation_index+1]
-
     next_adaptation.bind(instance,*args, &block)
   end
   
@@ -127,8 +125,8 @@ class Phenomenal::Manager
     self.class.class_eval{define_method(:conflict_policy,&block)}
   end
   
-  # Return the corresponding context or raise an error if the context isn't 
-  # currently registered.
+  # Return the corresponding context (or combined context) or raise an error 
+  # if the context isn't currently registered.
   # The 'context' parameter can be either a reference to a context instance or
   # a Symbol with the name of a named (not anonymous) context.
   def find_context(context, *contexts)
@@ -140,7 +138,7 @@ class Phenomenal::Manager
     end
   end
   
-  # Check wether context 'context' exist in the context manager
+  # Check wether context 'context' (or combined context) exist in the context manager
   # Context can be either the context name or the context instance itself
   # Return the context if found, or nil otherwise
   def context_defined?(context, *contexts)
@@ -152,7 +150,7 @@ class Phenomenal::Manager
     end
     return c
   end
-  # ==== Private methods ==== #
+
   private
   def find_simple_context(context)
     find=nil

data/lib/phenomenal/proc.rb

@@ -2,7 +2,7 @@
 class Proc
   # Define a bind method on Proc object,
   # This allow to execute a Proc as it was an instance method of reciever
-  #  --> used for composition of instance methods adaptations
+  # Used for composition of instance methods adaptations
   # Src: http://www.ruby-forum.com/topic/173699
   def phenomenal_bind(receiver)
     block, time = self, Time.now
@@ -17,7 +17,7 @@ class Proc
 
   # Define a bind_class method on Proc object,
   # This allow to execute a Proc as it was an class method of klass
-  # --> used for composition of class methods adaptations
+  # Used for composition of class methods adaptations
   def phenomenal_class_bind(klass)
     block, time = self, Time.now
       method_name = "__bind_#{time.to_i}_#{time.usec}-#{rand(100000)}"

data/lib/phenomenal/relationships/context_relationships.rb

@@ -1,3 +1,5 @@
+# Define the methods that can be called by a context to 
+# define relationships
 module Phenomenal::ContextRelationships
   def requires(context,*contexts)
     contexts = contexts.push(context)

data/lib/phenomenal/relationships/dsl.rb

@@ -1,3 +1,4 @@
+# Define the DSL methods for relationships
 module Phenomenal::DSL
   def self.define_relationships(klass)
     klass.class_eval do