dev_guide

GUIDE DEVELOPPEUR DU LOGICIEL DE PARSING
développé par A2VCCorp

Bonjour, et bienvenue dans ce guide destiné aux développeurs qui vous permettra de comprendre et de maintenir notre logiciel de façon optimale.
Vous trouvez dans ce guide une explication de la structure logicielle, des fonctions développées et des aspects à développer pour la maintenance du projet.

**Explication du logiciel **

Ce logiciel permet, grâce à des commandes développées par notre équipe, de répondre à tous les besoins énumérés dans le cahier des charges, et qui à terme permettront d’extraire des informations essentielles sur un ensemble de mail (Nombre échangé, graphique représentant les proportions par personne etc..).

Ce logiciel se lance en ligne de commande via nodeJS, en passant par le fichier caporalCli.js qui contient toutes les commandes à exécuter.

Tout le matériel est contenu dans « code_source », dans lequel vous trouverez les fichiers suivants :

Mail.js : fichier qui correspond à l’objet « mail », contient toute la structure d'un mail et permet de récupérer et d’assigner toutes les informations que peut transmettre un mail, avec le nom, le « from », le « to », la date etc.. Ce fichier constitue le squelette d’un mail.

MailParser.js : fichier important du processus, celui-ci contient tout le code responsable du parsing d’un mail. Chaque fonction permet un traitement bien définit et est lancé toujours dans le même ordre, dès qu’un parsing est demandé. Vous trouverez également le prototype d’un mail, et toutes les fonctions « regex » qui permettent de vérifier les formats et ainsi pouvoir parser correctement. Chaque fonction est commentée et les prototypes de chaque élément sont nominatifs. (ex : MailParser.prototype.To = prototype du champ « To »).

README.txt : fichier contenant l’explication claire de toutes les fonctions, les arguments et les options accessibles.

CaporalCli.js : centre névralgique du système, c’est via ce fichier que nous lançons toues les commandes via le terminal. Ainsi, pour de amples informations, référez-vous au fichier README.txt qui développe toutes les fonctions utilisées dans ce logiciel.

Stopwords.txt : fichier .txt correspondant a la liste des « Stopwords », les mots non retenus dans la fonction ConsultObj, que l’utilisateur peut modifier à sa guise pour plus de précision dans le tri.

**Maintenance et évolution **

Malgré le fait que notre équipe a tenté de garder au maximum toutes les spécificités du cahier des charges, quelques fonctionnalités n’ont pas été implémenté. Ainsi, pour développer le logiciel les développeurs peuvent s’attarder sur :

• l’export au format PNG pour la commande topInterlocutors.
• La fonctionnalité « buzzyDay » dans la commande consultListMails qui n’a pas été recommandée explicitement dans le cahier des charges mais présent dans le sujet initial sur les mails.

Vous pouvez bien entendu repasser sur le code pour optimiser et « refactorer » le code pour plus d’optimisation.