Wiki UIConsult

Guide du développeur

Pour commencer il faut savoir comment sont organiser les fichiers donc voici une description de la structure de fichier du projet.

Structure des fichiers

• branches ( là où tu va créer ta branche pour travailler de ton côté )
• trunk ( là où se trouve la version de prod )
  • donneesSujetB ( Toutes les données à traiter )
    • nom_P
      • dossier de messagerie
        • X (X étant le numéro du mail, il est suivi par un underscore, non marqué car problème de police avec l'éditeur de texte )
  • Parser ( toutes les classes définissant la structure d'un Mail )
  • graph.js
  • ResearchUtils.js
  • spec_X.js ( X étant le numéro de la spec )

Parser

Normalement les mails, leurs structures ne changeront pas de si tôt donc pas besoin de s'en préoccuper en vue d'amélioration ou évolution du logiciel.

Mais à titre d'information voilà les fichier dedans :

-DataStructures/Mail.js : Définition d'un mail avec ces attributs et ces accesseurs
-DataStructures/MailSet.js : Définition d'un tableau de Mail avec les méthodes classique pour un tableau d'objet
-MailUtils.js : Perm et de lire les Mails dans la Structure de fichier de donneesSujetB
-Parser.js : Défini comment lire un fichier afin d'en extraire les informations souhaiter dans l'objectif de créer un Objet Mail.

graph.js

Fichier utilisant le module node caporal

Il s'agit du lieu où décrire les commandes que l'utilisateurs pourra taper. Le comportement de ses commandes seront défini par les fichiers spec_X.js

ResearchUtils.js

Ensemble de méthode permettant de trier les mails en prenant que ceux que l'on souhaite afin de les traiter dans les specs_X.js
On s'en sert comme une préselection des données.

spec_X.js

Une specification (aka. spec) est un fichier js qui sera apellé par graph.js pour définir comment une commande doit agir.
Donc de manière général, on commence par séléctionner les mails souhaité à l'aide d'une méthode défini dans ResearchUtils.js
Cette séléction dépends donc de la commande et des arguments de cette commande.
Un fois la séléction des mails terminé, traiter les commes vous le souhaitez.
Si vous envisager de créer des graphiques, nous utilisons vega-lite.

Documentation utile

caporal : https://www.npmjs.com/package/caporal
vega-lite : https://vega.github.io/vega-lite/
fs : https://nodejs.org/api/fs.html