refs #335 Display dynamically referentials in informations_tab

Add formula and description in referentials classes

res/ui/informations_tab.ui

@@ -38,8 +38,8 @@ QGroupBox::title {
        <rect>
         <x>0</x>
         <y>0</y>
-        <width>522</width>
-        <height>721</height>
+        <width>518</width>
+        <height>717</height>
        </rect>
       </property>
       <layout class="QVBoxLayout" name="verticalLayout_5">
@@ -90,6 +90,22 @@ QGroupBox::title {
          </layout>
         </widget>
        </item>
+       <item>
+        <widget class="QGroupBox" name="group_referentials">
+         <property name="title">
+          <string>Referentials</string>
+         </property>
+         <layout class="QGridLayout" name="gridLayout_2">
+          <item row="0" column="0">
+           <widget class="QLabel" name="label_referentials">
+            <property name="text">
+             <string/>
+            </property>
+           </widget>
+          </item>
+         </layout>
+        </widget>
+       </item>
        <item>
         <widget class="QGroupBox" name="group_money">
          <property name="title">

src/sakia/core/money/quant_zerosum.py

@@ -7,6 +7,24 @@ class QuantitativeZSum:
     _NAME_STR_ = QT_TRANSLATE_NOOP('QuantitativeZSum', 'Quant Z-sum')
     _REF_STR_ = QT_TRANSLATE_NOOP('QuantitativeZSum', "{0} Q0 {1}")
     _UNITS_STR_ = QT_TRANSLATE_NOOP('QuantitativeZSum', "Q0 {0}")
+    _FORMULA_STR_ = QT_TRANSLATE_NOOP('QuantitativeZSum',
+                                      """Z0 = Q - ( M(t-1) / N(t) )
+                                        <br >
+                                        <table>
+                                        <tr><td>Z0</td><td>Quantitative value at zero sum</td></tr>
+                                        <tr><td>Q</td><td>Quantitative value</td></tr>
+                                        <tr><td>M</td><td>Monetary mass</td></tr>
+                                        <tr><td>N</td><td>Members count</td></tr>
+                                        <tr><td>t</td><td>Last UD time</td></tr>
+                                        <tr><td>t-1</td><td>Penultimate UD time</td></tr>
+                                        </table>"""
+                                      )
+    _DESCRIPTION_STR_ = QT_TRANSLATE_NOOP('QuantitativeZSum',
+                                          """Quantitative at zero sum is used to display the difference between
+                                            the quantitative value and the average quantitative value.
+                                            If it is positive, the value is above the average value, and if it is negative,
+                                            the value is under the average value.
+                                           """.replace('\n', '<br >'))
 
     def __init__(self, amount, community, app):
         self.amount = amount
@@ -21,6 +39,14 @@ class QuantitativeZSum:
     def units(cls, currency):
         return QCoreApplication.translate("QuantitativeZSum", QuantitativeZSum._UNITS_STR_).format(currency)
 
+    @classmethod
+    def formula(cls):
+        return QCoreApplication.translate('QuantitativeZSum', QuantitativeZSum._FORMULA_STR_)
+
+    @classmethod
+    def description(cls):
+        return QCoreApplication.translate("QuantitativeZSum", QuantitativeZSum._DESCRIPTION_STR_)
+
     @classmethod
     def diff_units(cls, currency):
         return Quantitative.units(currency)
@@ -30,13 +56,15 @@ class QuantitativeZSum:
         """
         Return quantitative value of amount minus the average value
 
-        t = last UD block
-        t-1 = penultimate UD block
+        Z0 = Q - ( M(t-1) / N(t) )
+
+        Z0 = Quantitative value at zero sum
+        Q = Quantitative value
+        t = last UD block time
+        t-1 = penultimate UD block time
         M = Monetary mass
         N = Members count
 
-        zsum value = value - ( M(t-1) / N(t) )
-
         :param int amount:   Value
         :param sakia.core.community.Community community: Community instance
         :return: int
@@ -74,5 +102,6 @@ class QuantitativeZSum:
 
     @asyncio.coroutine
     def diff_localized(self, units=False, international_system=False):
-        localized = yield from Quantitative(self.amount, self.community, self.app).localized(units, international_system)
+        localized = yield from Quantitative(self.amount, self.community, self.app).localized(units,
+                                                                                             international_system)
         return localized

src/sakia/core/money/quantitative.py

@@ -2,10 +2,19 @@ from PyQt5.QtCore import QCoreApplication, QT_TRANSLATE_NOOP, QObject, QLocale
 import asyncio
 
 
-class Quantitative():
+class Quantitative:
     _NAME_STR_ = QT_TRANSLATE_NOOP('Quantitative', 'Units')
     _REF_STR_ = QT_TRANSLATE_NOOP('Quantitative', "{0} {1}{2}")
     _UNITS_STR_ = QT_TRANSLATE_NOOP('Quantitative', "{0}")
+    _FORMULA_STR_ = QT_TRANSLATE_NOOP('Quantitative',
+                                      """Q = Q
+                                        <br >
+                                        <table>
+                                        <tr><td>Q</td><td>Quantitative value</td></tr>
+                                        </table>
+                                      """
+                                      )
+    _DESCRIPTION_STR_ = QT_TRANSLATE_NOOP('Quantitative', "Base referential of the money. Units values are used here.")
 
     def __init__(self, amount, community, app):
         self.amount = amount
@@ -20,6 +29,14 @@ class Quantitative():
     def units(cls, currency):
         return QCoreApplication.translate("Quantitative", Quantitative._UNITS_STR_).format(currency)
 
+    @classmethod
+    def formula(cls):
+        return QCoreApplication.translate('Quantitative', Quantitative._FORMULA_STR_)
+
+    @classmethod
+    def description(cls):
+        return QCoreApplication.translate("Quantitative", Quantitative._DESCRIPTION_STR_)
+
     @classmethod
     def diff_units(cls, currency):
         return Quantitative.units(currency)

src/sakia/core/money/relative.py

-from PyQt5.QtCore import QObject, QCoreApplication, QT_TRANSLATE_NOOP, QLocale
 import asyncio
 
+from PyQt5.QtCore import QCoreApplication, QT_TRANSLATE_NOOP, QLocale
+
 
 class Relative:
     _NAME_STR_ = QT_TRANSLATE_NOOP('Relative', 'UD')
-    _REF_STR_ = QT_TRANSLATE_NOOP('Relative',  "{0} {1}UD {2}")
-    _UNITS_STR_ = QT_TRANSLATE_NOOP('Relative',  "UD {0}")
+    _REF_STR_ = QT_TRANSLATE_NOOP('Relative', "{0} {1}UD {2}")
+    _UNITS_STR_ = QT_TRANSLATE_NOOP('Relative', "UD {0}")
+    _FORMULA_STR_ = QT_TRANSLATE_NOOP('Relative',
+                                      """R = Q / UD(t)
+                                        <br >
+                                        <table>
+                                        <tr><td>R</td><td>Relative value</td></tr>
+                                        <tr><td>Q</td><td>Quantitative value</td></tr>
+                                        <tr><td>UD</td><td>Universal Dividend</td></tr>
+                                        <tr><td>t</td><td>Last UD time</td></tr>
+                                        </table>"""
+                                      )
+    _DESCRIPTION_STR_ = QT_TRANSLATE_NOOP('Relative',
+                                          """Relative referential of the money.
+                                          Relative value R is calculated by dividing the quantitative value Q by the last
+                                           Universal Dividend UD.
+                                          This referential is the most practical one to display prices and accounts.
+                                          No money creation or destruction is apparent here and every account tend to
+                                           the average.
+                                          """.replace('\n', '<br >'))
 
     def __init__(self, amount, community, app):
         self.amount = amount
@@ -20,6 +39,14 @@ class Relative:
     def units(self, currency):
         return QCoreApplication.translate("Relative", Relative._UNITS_STR_).format(currency)
 
+    @classmethod
+    def formula(cls):
+        return QCoreApplication.translate('Relative', Relative._FORMULA_STR_)
+
+    @classmethod
+    def description(cls):
+        return QCoreApplication.translate("Relative", Relative._DESCRIPTION_STR_)
+
     @classmethod
     def diff_units(self, currency):
         return self.units(currency)
@@ -28,6 +55,9 @@ class Relative:
     def value(self):
         """
         Return relative value of amount
+
+        value = amount / UD(t)
+
         :param int amount:   Value
         :param sakia.core.community.Community community: Community instance
         :return: float
@@ -97,9 +127,9 @@ class Relative:
             localized_value = QLocale().toString(float(value), 'f', self.app.preferences['digits_after_comma'])
 
         if units or international_system:
-            return QCoreApplication.translate("Relative", Relative._REF_STR_)\
+            return QCoreApplication.translate("Relative", Relative._REF_STR_) \
                 .format(localized_value,
-                    prefix,
-                    self.community.short_currency if units else "")
+                        prefix,
+                        self.community.short_currency if units else "")
         else:
             return localized_value

src/sakia/core/money/relative_zerosum.py

@@ -7,6 +7,23 @@ class RelativeZSum:
     _NAME_STR_ = QT_TRANSLATE_NOOP('RelativeZSum', 'Relat Z-sum')
     _REF_STR_ = QT_TRANSLATE_NOOP('RelativeZSum', "{0} R0 {1}")
     _UNITS_STR_ = QT_TRANSLATE_NOOP('RelativeZSum', "R0 {0}")
+    _FORMULA_STR_ = QT_TRANSLATE_NOOP('RelativeZSum',
+                                      """R0 = (R / UD(t)) - (( M(t-1) / N(t) ) / UD(t))
+                                        <br >
+                                        <table>
+                                        <tr><td>R0</td><td>Relative value at zero sum</td></tr>
+                                        <tr><td>R</td><td>Relative value</td></tr>
+                                        <tr><td>M</td><td>Monetary mass</td></tr>
+                                        <tr><td>N</td><td>Members count</td></tr>
+                                        <tr><td>t</td><td>Last UD time</td></tr>
+                                        <tr><td>t-1</td><td>Penultimate UD time</td></tr>
+                                        </table>""")
+    _DESCRIPTION_STR_ = QT_TRANSLATE_NOOP('RelativeZSum',
+                                          """Relative at zero sum is used to display the difference between
+                                            the relative value and the average relative value.
+                                            If it is positive, the value is above the average value, and if it is negative,
+                                            the value is under the average value.
+                                           """.replace('\n', '<br >'))
 
     def __init__(self, amount, community, app):
         self.amount = amount
@@ -21,6 +38,14 @@ class RelativeZSum:
     def units(cls, currency):
         return QCoreApplication.translate("RelativeZSum", RelativeZSum._UNITS_STR_).format(currency)
 
+    @classmethod
+    def formula(cls):
+        return QCoreApplication.translate('RelativeZSum', RelativeZSum._FORMULA_STR_)
+
+    @classmethod
+    def description(cls):
+        return QCoreApplication.translate("RelativeZSum", RelativeZSum._DESCRIPTION_STR_)
+
     @classmethod
     def diff_units(cls, currency):
         return Relative.units(currency)
@@ -67,7 +92,7 @@ class RelativeZSum:
             localized_value = QLocale().toString(float(value), 'f', self.app.preferences['digits_after_comma'])
 
         if units:
-            return QCoreApplication.translate("RelativeZSum", RelativeZSum._REF_STR_)\
+            return QCoreApplication.translate("RelativeZSum", RelativeZSum._REF_STR_) \
                 .format(localized_value,
                         self.community.short_currency if units else "")
         else:
@@ -83,7 +108,7 @@ class RelativeZSum:
             localized_value = QLocale().toString(float(value), 'f', self.app.preferences['digits_after_comma'])
 
         if units:
-            return QCoreApplication.translate("RelativeZSum", RelativeZSum._REF_STR_)\
+            return QCoreApplication.translate("RelativeZSum", RelativeZSum._REF_STR_) \
                 .format(localized_value, self.community.short_currency if units else "")
         else:
             return localized_value