More doc + tests fixes and rank fieldtype fix

EditorialModel/fieldtypes/generic.py

@@ -14,12 +14,15 @@ class GenericFieldType(object):
     ## @brief List fields that will be exposed to the construct_data_method
     _construct_datas_deps = []
 
-    ## @param internal False | str : define wheter or not a field is internal
+    ## @brief Generic constructor for fieldtypes 
+    # @param internal False | str : define wheter or not a field is internal
+    # @param immutable bool : indicate if the fieldtype has to be defined in child classes of LeObject or if it is defined globally and immutable
     # @throw NotImplementedError if called from bad class
-    def __init__(self, internal = False, **args):
+    def __init__(self, internal = False, immutable = False, **args):
         if self.__class__ == GenericFieldType:
             raise NotImplementedError("Abstract class")
         self.internal = internal #Check this value ?
+        self.immutable = bool(immutable)
     
         for argname, argval in args.items():
             setattr(self, argname, argval)
@@ -234,4 +237,52 @@ class FieldTypeDataCheckError(FieldTypeError):
             msg += "{expt_name}:{expt_msg}; ".format(expt_name=expt.__class__.__name__, expt_msg=str(expt))
         return msg
 
-
+## @page lodel2_fieldtypes Lodel2 fieldtypes
+#
+# @section fieldtypes_features Main features
+#
+# Lodel2 defines Class and Types containing fields that handle values.
+# Fields are defined by FieldTypes. It's objects that are able to check datas value, to construct values (~cast) and to check datas consistency given the list of datas of an Lodel2 object (Class or Type)
+#
+# @subsection fieldtypes_hierarchy Fieldtypes family
+#
+# Fieldtypes are python objects. We use inheritance to defines FieldTypes. Here is a list of main FieldTypes inheritance :
+# - GenericFieldType
+#  - SingleValueFieldType <- handles a single value
+#   - ReferenceFieldType <- handles a reference to another field
+#    - leo.EmFieldType <- handles references to a LeObject (designed for LeRelation)
+#   - char.EmFieldType <- handles string
+#   - integer.EmFieldType <- handles integer
+#    - pk.EmFieldType <- handles primary keys (identifier)
+#  - MultiValueFieldType <- handles multiple values identified by a key
+#   - i18n.EmFieldType <- handles a string and its translations
+#
+# @subsection fieldtypes_options Fieldtypes main options
+#
+# There is 2 options that are common for every fieldtypes :
+# - internal : that indicate who construct the data. Possible values are
+#  - False : the field is not internal, its user that provides datas
+#  - 'automatic' : The field is internal, its leapi that provides datas (see construct in @ref fieldtypes_validator )
+#  - 'autosql' : BAD NAME. The field is internal but it is the datasource that provide the data
+# - immutable : Its a boolean that indicate if a fieldtype defined in EditorialModel.classtypes is immutable or HAVE TO be defined in EmClass
+# 
+# @subsubsection fieldtypes_options_single_value SingleValueFieldType options
+#
+# SingleValueFieldType have more standart options :
+# - nullable (boolean) : is None allowed as value
+# - uniq (boolean) : if True the value has to be uniq in all instances of concerned Lodel2 API object
+# - primary (boolean) : if True the field is an identifier (primary key)
+# - default : if given as argument defines a default value for the FieldType
+#
+# @subsection fieldtypes_validator Data validation
+#
+# For each Lodel2 API objects (LeObject, LeRelation, ...) there is a sequence that is run to check datas and transform them. Each step is run for each fieldtypes of a Lodel2 API object
+#
+# -# Check data : this is a basic data check (for example if an integer is expected and the string 'foo' is given the check will fails)
+# -# Construct data : this is a data 'casting' step, this method is called with all other datas from the Lodel2 API object as argument (to be able to construct datas with other parts of the object) @ref fieldtypes_construct_order
+# -# Datas consistency checks : this step, as the construct step, has all datas from the Lodel2 API object as argument, and check for the whole datas consistency
+#
+# @subsubsection fieldtypes_construct_order Data construction dependencies
+#
+# To handle data construction dependencies there is an object DatasConstructor able to call the data construction when needed and to detect (not tested yet) circular dependencies
+# 

EditorialModel/fieldtypes/rank.py

@@ -16,13 +16,12 @@ class EmFieldType(integer.EmFieldType):
         super().__init__(**kwargs)
 
     def construct_data(self, lec, fname, datas, cur_value):
-        superior_id = datas[EditorialModel.classtypes.relation_superior]
+        superior = datas[EditorialModel.classtypes.relation_superior]
         if lec.is_lerel2type():
-            subordinate = lec._subordinate_cls
-            sub_em_type_id = subordinate._type_id
-            cur_value = lec.get_max_rank(superior_id, sub_em_type_id)
+            relation_name = datas[EditorialModel.classtypes.relation_name]
+            cur_value = lec.get_max_rank(superior, relation_name)
         elif lec.is_lehierarch():
-            cur_value = lec.get_max_rank(superior_id, datas['nature'])
+            cur_value = lec.get_max_rank(superior, datas['nature'])
         else:
             raise ValueError("Called with bad class : ", lec.__name__)
         return cur_value

Lodel/__init__.py

@@ -4,6 +4,19 @@
 #
 # For basics Lodel2 configuration & usage see README.md
 #
+# @tableofcontents
+#
+# @section mainpage_docs Documentation
+#
+# - Fieldtypes : @subpage lodel2_fieldtypes
+# @subsection mainpage_docs_leapi LeAPI
+#
+# - LeAPI objects instanciation : @subpage lecrud_instanciation
+# - Querying leapi : @subpage api_user_side
+#
+# @subsection mainpage_docs_configs Lodel2 settings
+# - Lodel2 settings handling : @subpage lodel_settings
+#
 # @section mainpage_pkg_list Main packages
 #
 # - Lodel
@@ -15,12 +28,3 @@
 # - DataSource
 #  - DataSource.MySQL
 # 
-# @section mainpage_docs Dev ressources
-#
-# @subsection mainpage_docs_leapi LeAPI
-#
-# - LeAPI objects instanciation : @ref lecrud_instanciation
-# - Querying leapi : @ref api_user_side
-#
-# @subsection mainpage_docs_configs Lodel2 settings
-# - Lodel2 settings handling : @ref lodel_settings

leapi/lerelation.py

@@ -216,17 +216,24 @@ class _LeRel2Type(_LeRelation):
     # @return True in case of success, False in case of failure
     # @throw ValueError if step is not castable into an integer
     def set_rank(self, new_rank):
-        return self._set_rank(
-                                new_rank,
-                                id_superior=getattr(self, self.uidname()),
-                                type_em_id=self._subordinate_cls._type_id
-        )
+        if self._relation_name is None:
+            raise NotImplementedError("Abstract method")
+        return self._set_rank(new_rank, superior = self.superior, relation_name = self._relation_name)
 
     @classmethod
-    def get_max_rank(cls, id_superior, type_em_id):
-       # SELECT rank FROM relation JOIN object ON object.lodel_id = id_subordinate WHERE object.type_id = <type_em_id>
-        warnings.warn("LeRel2Type.get_max_rank() is not implemented yet and will always return 0")
-        return 0
+    def get_max_rank(cls, superior, relation_name):
+        # SELECT rank FROM relation JOIN object ON object.lodel_id = id_subordinate WHERE object.type_id = <type_em_id>
+        ret = cls.get(
+            query_filters = [
+                (EditorialModel.classtypes.relation_name, '=', relation_name),
+                (EditorialModel.classtypes.relation_superior, '=', superior),
+            ],
+            field_list = ['rank'],
+            order = [('rank', 'DESC')],
+            limit = 1,
+            instanciate = False
+        )
+        return 1 if ret is None else ret[0]['rank']
 
     ## @brief Implements insert for rel2type
     # @todo checks when autodetecing the rel2type class

leapi/test/test_lerelation.py

@@ -249,7 +249,7 @@ class LeRel2TypeTestCase(LeRelationTestCase):
             eres = {
                     'nature': None,
                     'depth': None,
-                    'rank': 0,
+                    'rank': 1,
                     EditorialModel.classtypes.relation_name: None,
             }
             eres.update(query)