Charge unit is ETP

hitier
2 parents 96ef779b 2ae54c01
Showing 11 changed files with 74 additions and 52 deletions Show diff stats
CHANGELOG.md
INSTALL.md
VERSION.txt
app/commands/commands.py
app/db_mgr.py
app/main/static/js/charges.js
app/main/templates/agent.html
app/main/templates/agents.html
app/main/templates/projects.html
app/templates/base_page.html
resources/pdc_config.py
@@ -24,6 +24,10 @@ or major refactoring improvments.
 ## Unreleased
+## [0.3.pre-2] - 2021-04-21 - Display ETP 
+### Changed
+Chart now displays charge in ETP base 1 (was base 100 )
+
 ## [0.3.pre-1] - 2021-04-16 - Irap db integration
 ### New
 Irap db feed from csv file
@@ -3,9 +3,9 @@
 ## Prérequis
 - python3
-- sqlite ( pour le développement et les tests unitaires )
-- chrome-driver et chromium ( pour les tests unitaires)
-- postgresql ou mysql/mariadb ( pour la production )
+- SQLite (pour le développement et les tests unitaires)
+- chrome-driver et chromium (pour les tests unitaires)
+- postgresql ou mysql/mariadb (pour la production)
 ## Obtenir un répertoire fonctionnel
@@ -23,8 +23,8 @@
 ### Configurer l'application
-Les fichiers de configuration fournis dans le répertoire ./resources sont à copier à la racine du projet,
-mais peuvent être laissés tels quels pour un premier test après installation.
+Les fichiers de configuration fournis dans le répertoire ./resources sont à copier à la racine du projet, mais peuvent
+être laissés tels quels pour un premier test après installation.
 Il est bon d'y jeter un oeil, les commentaires sont là pour vous aider.
 (mais en anglais comme tout le code source du projet)
@@ -46,7 +46,7 @@ Il est bon d&#39;y jeter un oeil, les commentaires sont là pour vous aider.
     cp ./resources/flaskenv ./.flaskenv # ! noter le '.' devant le fichier destination
     $(EDITOR) .flaskenv
-### Créer la base de données 
+### Créer la base de données
 Dans un premier temps, pour tester l'installation, on peut s'appuyer sur une base déjà disponible.
@@ -57,12 +57,11 @@ la diffusion de ces données de test avec le projet plan-de-charge.
     cp resources/lesia-btp.sqlite ./pdc-dev.db
 Vérifier que ce chemin correspond avec celui configuré dans le fichier `db_config.py` pour la
-variable `sqlalchemy_devdb_uri`.
-C'est le cas dans le fichier initial pour une variable `FLASK_ENV` positionnée à 'development'.
+variable `sqlalchemy_devdb_uri`. C'est le cas dans le fichier initial pour une variable `FLASK_ENV` positionnée à '
+development'.
 Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'application.
-(sinon, passez directement à la section suivante )
-
+(sinon, passez directement à la section suivante)
     # Créer la structure de la base
     #
@@ -89,7 +88,6 @@ Pour un usage plus avancé, voyez l&#39;outil en ligne de commande fourni avec l&#39;app
     flask --help
     flask pdc_db --help
-
 ## Jouer les tests et exécuter un serveur local
     pip install -r requirements-tests.txt
@@ -100,13 +98,13 @@ Pour un usage plus avancé, voyez l&#39;outil en ligne de commande fourni avec l&#39;app
     #
     PYTHONPATH=. pytest  --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" 
-Enfin, ouvrir un serveur sur localhost:5000 et y accéder avec son navigateur.
+Enfin, ouvrir un serveur sur `localhost:5000` et y accéder avec son navigateur.
     flask run
-## Configurer l'appli web avec apache 
+## Configurer l'appli web avec apache
-### Les fichiers concernés:
+### Les fichiers concernés :
 - pdc_web.wsgi
 - pdc_web.py
@@ -137,14 +135,13 @@ Enfin, ouvrir un serveur sur localhost:5000 et y accéder avec son navigateur.
     a2ensite pdc-web 
     apachectl restart
-
-## Mise à jour 
+## Mise à jour
 ### git pull
 ### git autodeploy
-Les fichiers concernés:
+Les fichiers concernés :
 - scripts/post-deploy.sh
 - resources/post-receive.git-hook
@@ -163,8 +160,8 @@ La procédure:
 ## Gestion des utilisateurs
-La table `users` stocke les utilisateur qui se connectent à l'applicationa avec leur rôle et les droits associés.
-Un ensemble de commandes permet de les gérer:
+La table `users` stocke les utilisateurs qui se connectent à l'applicationa avec leur rôle et les droits associés. Un
+ensemble de commandes permet de les gérer :
     flask pdc_db user_show_all  # liste existante
     flask pdc_db user_add       # ajouter un nouveau login
@@ -172,31 +169,28 @@ Un ensemble de commandes permet de les gérer:
     flask pdc_db user_delete    # effacer un login existant
     flask pdc_db show_roles     # lister les rôles disponibles
-## Intégration Pycharm 
+## Intégration Pycharm
-Ce projet utilisant le pattern "factory", il faut procéder
-à quelques configuration afin de le faire tourner avec
+Ce projet utilisant le pattern "factory", il faut procéder à quelques configurations afin de le faire tourner avec
 pycharm.
-Pour une procédure détaillée, voir la page:
+Pour une procédure détaillée, voir la page :
 https://flask.palletsprojects.com/en/1.1.x/cli/#pycharm-integration
-Dans le menu 'Edit Configurations', changer les champs:
+Dans le menu 'Edit Configurations', changer les champs :
 - 'module name' positionné à 'flask'
-- et dans le champs 'Parameters' choisir 'run'
+- et dans le champ 'Parameters' choisir 'run'
-
-Cette configuration permet de lire les variables positionées dans le fichier .flaskenv
+Cette configuration permet de lire les variables positionées dans le fichier `.flaskenv`
     FLASK_ENV=development
     FLASK_APP=pdc_web
-
-Ainsi fait, exécutez votre projet depuis pycharm et essayez sur un navigateur à l'adresse localhost:5000.
+Ainsi fait, exécutez votre projet depuis pycharm et essayez sur un navigateur à l'adresse `localhost:5000`.
 ## Troubleshooting
-* Q: parfois le module Flask-Migrate n'est pas correctement chargé aprés son installation.
-* R: simplement recharger l'environnement virtuel avec `source venv/bin/activate`
+* Q : parfois le module Flask-Migrate n'est pas correctement chargé aprés son installation.
+* R : simplement recharger l'environnement virtuel avec `source venv/bin/activate`
-0.3.pre-1
+0.3.pre-2
@@ -131,6 +131,8 @@ def feed_from_irap(csv_file_name):
         for period_name in range(2011, 2030):
             t = Period.query.filter(Period.name == period_name).one()
             charge = r[f"{period_name}"]
+            # Charge are stored as percent in db, but as fraction of ETP in irap csv
+            # we make the conversion here.
             try:
                 charge = int(100 * float(charge))
             except ValueError:
-from app.models import db
+from app.models import db, Period
+
+# TODO: make this configurable, and choose another place to use it,
+#       in 'routes.py' maybe
+# Charge as stored on a 100% basis, percent of total worked time;
+# Here it is possible to convert to an ETP basis, dividing by 100
+# or we set it to '1' if we want to keep the percent basis
+charge_unit = 100
 def projects():
@@ -8,7 +15,7 @@ def projects():
     """
     current_period_id = get_current_period()
     sql_txt = """
-            select p.id, p.name, sum(tc.charge_rate) as total_charge
+            select p.id, p.name, IFNULL(sum(tc.charge_rate), 0) as total_charge
             from project as p left join
                ( select c.project_id, c.charge_rate from charge c where c.period_id = {})
             tc
@@ -27,7 +34,7 @@ def agents():
     """
     current_period_id = get_current_period()
     sql_txt = """
-            select a.id, a.firstname, a.secondname, sum(tc.charge_rate) as total_charge
+            select a.id, a.firstname, a.secondname, IFNULL (sum(tc.charge_rate), 0) as total_charge
             from agent as a left join
                ( select c.agent_id, c.charge_rate from charge c where c.period_id = {})
             tc
@@ -86,6 +93,8 @@ def charges_by_project_stacked(project_id, category=&quot;service&quot;):
                 .
                 .
             per_n, value_n0, value_n1, ....., value_nn,
+
+    TODO: common with charges_by_agent_stacked(agent_id): code to extrat
     """
     if category == 'capacity':
         category_table = 'capacity'
@@ -117,7 +126,7 @@ def charges_by_project_stacked(project_id, category=&quot;service&quot;):
         # build the charges line for the current period
         category_charges = [period_name]
         for (category_rate,) in db.session.execute(charge_by_categorie_req):
-            category_rate = str(category_rate) if category_rate else '0'
+            category_rate = str(round(category_rate / charge_unit, 2)) if category_rate else '0'
             category_charges.append(category_rate)
         all_charges.append(category_charges)
@@ -127,6 +136,7 @@ def charges_by_project_stacked(project_id, category=&quot;service&quot;):
 def charges_by_agent_stacked(agent_id):
     """
     Build the list of charges for all projects of one agent, period by period
+    TODO: common with charges_by_project_stacked(project_id, ..) code to extrat
     :param agent_id:
     :return:
     """
@@ -143,10 +153,9 @@ def charges_by_agent_stacked(agent_id):
                                 group by p.id
                                 order by p.id 
                             """.format(agent_id, period_id)
-        print(charge_by_project_req)
         category_charges = [period_name]
         for (category_rate,) in db.session.execute(charge_by_project_req):
-            category_rate = str(category_rate) if category_rate else '0'
+            category_rate = str(round(category_rate / charge_unit, 2)) if category_rate else '0'
             category_charges.append(category_rate)
         all_charges.append(category_charges)
     return all_charges
@@ -207,4 +216,5 @@ def get_current_period():
     :return:  the id of the period of current day
     """
     # TODO: request on dates as soon as periods are dated
-    return 14
+    p = Period.query.filter((Period.name == '2021') | (Period.name == '2021_S1')).one()
+    return p.id
+function roundToTwo(num) {
+    return +(Math.round(num + "e+2")  + "e-2");
+}
+
 function build_chart(div_selector, data_url, entity_name, category_type) {
     const main_elt = document.getElementById("main")
@@ -99,7 +103,7 @@ function build_chart(div_selector, data_url, entity_name, category_type) {
             .duration(200)
             .style("opacity", 1);
         tooltip
-            .html("<b>" + category_title + ":</b> " + category_name + "<br>" + "<b>Charge:</b> " + category_charge + "%")
+            .html("<b>" + category_title + ":</b> " + category_name + "<br>" + "<b>Charge:</b> " + category_charge + " ETP")
             .style("left", (e.pageX - tooltip_offset.dx) + "px")
             .style("top", (e.pageY - tooltip_offset.dy) + "px")
     }
@@ -120,7 +124,7 @@ function build_chart(div_selector, data_url, entity_name, category_type) {
             .duration(200)
             .style("opacity", 1)
         tooltip
-            .html("<b>" + d.period + ": </b>" + d.total + "%")
+            .html("<b>" + d.period + ": </b>" + d.total + " ETP")
             .style("left", (e.pageX - tooltip_offset_dot.dx) + "px")
             .style("top", (e.pageY - tooltip_offset_dot.dy) + "px")
     }
@@ -247,7 +251,7 @@ function build_chart(div_selector, data_url, entity_name, category_type) {
             var period_values = Object.values(d).slice(1)
             var row = {}
             row['period'] = d.period
-            row['total'] = d3.sum(period_values)
+            row['total'] = roundToTwo(d3.sum(period_values))
             periods_total_charge.push(row)
         });
@@ -308,8 +312,9 @@ function build_chart(div_selector, data_url, entity_name, category_type) {
                     if (categories_total_charge.hasOwnProperty(k)) {
                         categories_total_charge[k] += +d[k]
                     } else {
-                        categories_total_charge[k] = d[k]
+                        categories_total_charge[k] = +d[k]
                     }
+                    categories_total_charge[k] = roundToTwo(categories_total_charge[k])
                 }
             )
         })
@@ -384,7 +389,7 @@ function build_chart(div_selector, data_url, entity_name, category_type) {
             .attr("transform", "rotate(-90)")
             .attr("y", -margin.left + 40)
             .attr("x", -margin.top - 70)
-            .text("Charge (% ETP)");
+            .text("Charge en ETP");
         //
         // Write chart Title
@@ -17,8 +17,12 @@
   <tbody>
   {% for line in charges[1:] %}
   <tr>
-    {% for cell in line %}
-      <td>{{cell}}</td>
+    {% for i in range(line|length) %}
+      {%if  'Charge' in charges[0][i]  %}
+        <td>{{line[i]}} %</td>
+      {%else%}
+        <td>{{line[i]}}</td>
+      {%endif%}
     {% endfor %}
   </tr>
   {% endfor %}
@@ -15,7 +15,7 @@
       {{ agent.firstname }}
       {{ agent.secondname }}
     </a></td>
-    <td>{{agent.total_charge}}</td>
+    <td>{{agent.total_charge}} %</td>
     <td>{{agent.num_projects}}</td>
   </tr>
   {% endfor %}
@@ -13,9 +13,7 @@
     <td><a href="{{url_for('main.project', project_id=project.id)}}">
       {{ project.name }}</a>
     </td>
-    <td>
-      {{ project.total_charge }}</a>
-    </td>
+    <td>{{ project.total_charge }} % </td>
   </tr>
   {% endfor %}
   </tbody>
@@ -17,11 +17,11 @@
         <span class="navbar-brand">{{current_user.name}}</span>
       </li>
       <li class="nav-item text-nowrap">
-        <a class="nav-link" href="{{ url_for('auth.logout') }}">Déconnection</a>
+        <a class="nav-link" href="{{ url_for('auth.logout') }}">Déconnexion</a>
       </li>
       {% else %}
       <li class="nav-item text-nowrap">
-        <a class="nav-link" href="{{ url_for('auth.login') }}">Connection</a>
+        <a class="nav-link" href="{{ url_for('auth.login') }}">Connexion</a>
       </li>
       {% endif %}
     </ul>
@@ -96,6 +96,11 @@ class DevConfig(Config):
     # ignores @role_required decorator
     ROLE_DISABLED = True
+    from datetime import datetime
+    import re
+    date = datetime.now().strftime("%y%m%d%H%M")
+    VERSION = re.sub(r"^(\d\.\d)\..*$", r"\1" + f".pre-{date}", Config.VERSION)
+
 # Testing configuration
 #