Reimplementig EmComponent::__setattr__ to call migration handler

Addding a method to indicate the end of a component initialisation phase (used in Model.load and Model.create_component)
Adding a method that dump component attributes (used in Model.create_component and Model.delete_component to call the migration_handler)

EditorialModel/components.py

@@ -45,9 +45,26 @@ class EmComponent(object):
 
         #Handling specials ranks for component creation
         self.rank = rank
-
         pass
 
+    @property
+    ## @brief Return a dict with attributes name as key and attributes value as value
+    # @note Used at creation and deletion to call the migration handler
+    def attr_dump(self):
+        return { fname : fval for fname, fval in self.__dict__.items() if not fname.startswith('__') }
+        
+    ## @brief This function has to be called after the instanciation, checks, and init manipulations are done
+    # @note Create a new attribute _inited that allow __setattr__ to know if it has or not to call the migration handler
+    def init_ended(self):
+        self._inited = True
+
+    ## @brief Reimplementation for calling the migration handler to register the change
+    def __setattr__(self, attr_name, value):
+        if '_inited' in self.__dict__:
+            # if fails raise MigrationHandlerChangeError
+            self.model.migration_handler.register_change(self.uid, {attr_name: getattr(self, attr_name) }, {attr_name: value} )
+        super(EmComponent, self).__setattr__(attr_name, value)
+
     ## Check the type of attribute named var_name
     # @param var_name str : the attribute name
     # @param excepted_type tuple|type : Tuple of type or a type 

EditorialModel/exceptions.py

@@ -17,3 +17,6 @@ class EmComponentRankingNotExistError(Exception):
 ## @brief An exception class to return a failure reason for EmComponent.check() method
 class EmComponentCheckError(Exception):
     pass
+
+class MigrationHandlerChangeError(Exception):
+    pass

EditorialModel/migrationhandler/dummy.py

@@ -2,13 +2,38 @@
 
 ## Manage Model changes
 class DummyMigrationHandler(object):
+
+    def __init__(self, debug = False):
+        self.debug = debug
     
     ## @brief Record a change in the EditorialModel and indicate wether or not it is possible to make it
     # @note The states ( initial_state and new_state ) contains only fields that changes
     # @param uid int : The uid of the change EmComponent
-    # @param initial_state dict : dict with field name as key and field value as value representing the original state
-    # @param new_state dict : dict with field name as key and field value as value representing the new state
-    # @return True if the modification is allowed False if not.
+    # @param initial_state dict | None : dict with field name as key and field value as value. Representing the original state. None mean creation of a new component.
+    # @param new_state dict | None : dict with field name as key and field value as value. Representing the new state. None mean component deletion
+    # @throw EditorialModel.exceptions.MigrationHandlerChangeError if the change was refused
     def register_change(self, uid, initial_state, new_state):
-        return True
+        if self.debug:
+            print("\n##############")
+            print("DummyMigrationHandler debug. Changes for component with uid %d :"%uid)
+            if initial_state is None:
+                print("Component creation (uid = %d): \n\t"%uid,new_state)
+            elif new_state is None:
+                print("Component deletion (uid = %d): \n\t"%uid,initial_state)
+            else:
+                field_list = set(initial_state.keys()).union(set(new_state.keys()))
+                for field_name in field_list:
+                    str_chg = "\t%s "%field_name
+                    if field_name in initial_state:
+                        str_chg += "'"+str(initial_state[field_name])+"'"
+                    else:
+                        str_chg += " creating "
+                    str_chg += " => "
+                    if field_name in new_state:
+                        str_chg += "'"+str(new_state[field_name])+"'"
+                    else:
+                        str_chg += " deletion "
+                    print(str_chg)
+            print("##############\n")
+        pass
         

EditorialModel/model.py

@@ -75,6 +75,8 @@ class Model(object):
                 component.check()
             except EmComponentCheckError as e:
                 raise EmComponentCheckError("The component with uid %d is not valid. Check returns the following error : \"%s\"" % (uid, str(e)))
+            #Everything is done. Indicating that the component initialisation is over
+            component.init_ended()
 
     ## Saves data using the current backend
     def save(self):
@@ -115,6 +117,7 @@ class Model(object):
     # @param component_type str : a component type ( component_class, component_fieldgroup, component_field or component_type )
     # @param datas dict : the options needed by the component creation
     # @throw ValueError if datas['rank'] is not valid (too big or too small, not an integer nor 'last' or 'first' )
+    # @todo Handle a raise from the migration handler
     def create_component(self, component_type, datas):
         
         em_obj = self.emclass_from_name(component_type)
@@ -134,13 +137,23 @@ class Model(object):
         if rank != 'last':
             em_component.set_rank( 1 if rank == 'first' else rank)
 
+        #everything done, indicating that initialisation is over
+        em_component.init_ended()
+
+        #register the creation in migration handler
+        self.migration_handler.register_change(em_component.uid, None, em_component.attr_dump)
+
         return em_component
 
     ## Delete a component
     # @param uid int : Component identifier
     # @throw EditorialModel.components.EmComponentNotExistError
     # @todo unable uid check
+    # @todo Handle a raise from the migration handler
     def delete_component(self, uid):
+        #register the deletion in migration handler
+        self.migration_handler.register_change(uid, self.component(uid).attr_dump, None)
+
         if uid not in self._components[uid]:
             raise EditorialModel.components.EmComponentNotExistError()
         em_component = self._components[uid]