Affichage d'une graphe de dépendance d'un programme Java en utilisant la bibliothèque Piccolo2D.

Guide pour les développeurs

Si vous êtes développeur de ce répo, après avoir cloné le répo veuillez suivre les instructions qui vous convient parmi les suivantes:

Si vous utilisez une version de git ≥ 2.9 (Vous pouvez le voir par la commande git --version).
Veuillez exécuter l'une des deux commandes suivantes:

• make init (Pour les utilisateurs des systèmes Unix)
• git config core.hooksPath .githooks (Pour tous les systèmes d'exploitations)

Si vous utilisez une version de git < 2.9 (Vous pouvez le voir par la commande git --version).
Veuillez exécuter la commande suivante:

• find .git/hooks -type l -exec rm {} \; find .githooks -type f -exec ln -sf ../../{} .git/hooks/ \;

L'exécution de la commande choisie permettra de changer le PATH (le chemin d'accès) des hooks de git sur votre machine locale avec le dossier .githooks.
Ce changement permettra de mettre à jour de la dernière version du fichier puck2.jar à chaque fois que vous faites un push sur ce répo.

Guide d'importation

Sur Eclipse

En utilisant l'intégration git

1. Cliquez sur Import dans l'onglet File de barre latérale d'Eclipse
2. Sur la fenêtre qui s'ouvre choisissez Projects from Git qui se trouve sous la section Git. Cliquez sur le bouton Next.
3. Choisissez Clone URI. Cliquez sur le bouton Next.
4. Entrez l'URL du répo qui est https://github.com/Misteryagci/pstl-upmc.git dans le champs de text libellé URI. Une fois c'est fait, si tout se passe bien comme il faut vous allez voir que tous les champs vont se compléter automatiquement. En suite cliquez sur le bouton Next.
5. La branche la plus récente est la branche master, donc vous pouvez décocher dans le menu déroulant la branche xml-reader. Cliquez sur le bouton Next.
6. Vérifiez si tout est bien configuré. Si c'est le cas cliquez sur le bouton Next.
7. Sélectionnez Import as general project et cliquez sur le bouton Next.
8. Renommez le projet sous Eclipse comme vous désirez ou laissez le comme tel et cliquez sur Finish
9. Happy coding 😊

En clonant le répo par vous même

1. Clonez le répo par en tapant la commande suivante dans une Terminal
   git clone https://github.com/Misteryagci/pstl-upmc.git
2. Cliquez sur Import dans l'onglet File de barre latérale d'Eclipse.
3. Sur la fenêtre qui s'ouvre choisissez Projects from Folder or Archive qui se trouve sous la section General. Cliquez sur le bouton Next.
4. Depuis l'explorateur de fichiers trouvez le dossier que vous venez de cloner et cliquez sur le bouton Open.
5. Pour compléter l'importation cliquez sur le bouton Finish
6. Happy coding 😊

Importez comme un pro 😎

1. Dans un Terminal dirigez vous à votre workspace d'Eclipse. Vous pouvez trouver le path exacte au démarrage de votre Eclipse.
   cd ~/Documents/workspace
2. Clonez le répo git en tapant la commande sur le même terminal dans le répertoire de votre workspace Eclipse
   git clone git clone https://github.com/Misteryagci/pstl-upmc.git
3. Cliquez sur Java Project dans la section New dans l'onglet File de barre latérale d'Eclipse.
4. Entrez le nom du dossier que vous avez sélectionné quand vous avez cloné le répo.Si vous n'avez pas entré d'autre paramètre que l'url de répo à la commande git clone par défaut c'est pstl-upmc. Et cliquez sur le bouton Finish.
5. Happy coding 😊

Sur IntelliJ

En utilisant l'intégration git

1. Au démarrage d'IntelliJ sur la fenêtre qui s'ouvre cliquez sur la section Check out from Version Control. Puis sur le menu déroulant cliquez sur la section Github.
2. Sur le champs de texte libellé Git Repository URL, entrez l'URL du répo de projet qui est https://github.com/Misteryagci/pstl-upmc.git. Puis appuyez sur le bouton Clone.
3. Appuyez sur bouton Yes sur la boîte de dialogue qui vous demande d'ouvrir le projet IntelliJ que vous venez de cloner.
   
4. Happy coding 😊

En clonant le répo par vous même

1. Clonez le répo en tapant la commande suivante sur un Terminal
   git clone https://github.com/Misteryagci/pstl-upmc.git
2. Au démarrage d'IntelliJ sur la fenêtre qui s'ouvre cliquez sur la section Open.
3. Depuis l'explorateur des fichier qui s'ouvre trouvez le dossier que vous venez de cloner et puis cliquez sur le bouton Open.
4. Happy coding 😊

Guide d'exécution

Uniquement la partie de graphe de dépendance

Sous Eclipse

• En exécutant manuellement le fichier NewDisplayDG (Risque de ne pas marcher si vous avez importé le projet en utilisant l'intégration git)

  1. Faites un clique droit sur le dossier principal contenant le projet. Puis dans le menu déroulant cliquez sur Java Application sous la section Run As.
     
  2. Sur la fenêtre intitulée Select Java Application sélectionnez NewDisplayDG - com.puck.display.piccolo2d. Puis cliquez sur le bouton OK.
     
• En utilisant le fichier build.xml

  1. Faites un clique droit sur le fichier build.xml dans le répertoire principal de projet. Puis dans le menu déroulant cliquez sur 2 Ant Build... sous la section Run As.
     
  2. Sur la fenêtre intitulée Edit Configuration chochez le case base. Vérifiez bien que l'ordre dans la section Target execution order: est base. Puis cliquez sur le bouton Run.
     

Sous IntelliJ

1. En exécutant manuellement le fichier NewDisplayDG

   1. Chargez le projet en sélectionnant le projet sur la fenêtre de démarrage.
      
   2. Trouvez le fichier NewDisplayDG qui se trouve dans le dossier display.piccolo2d qui se trouve dans le dossier com.puck qui se trouve dans le dossier src qui se trouve dans le dossier principal du projet. Faites un clique droit sur ce fichier et dans le menu déroulant cliquez sur Run 'NewDisplayDG.main()'.
      
2. En utilisant Ant Build

   1. Chargez le projet en sélectionnant le projet sur la fenêtre de démarrage.
      
   2. Cliquez deux fois sur la cible base sur la partie intitulé Ant Build qui se trouve à droite de la fenêtre d'IntelliJ.
      

Sur la ligne des commandes

• Sur un terminal lancer la commande suivante
  ant base
  
• En utilisant le script d'exécution selon votre système d'exécution
  • Sous systèmes UNIX
    Dans un terminal lancer le script run.sh par la commande suivante
    ./run.sh
  • Sous systèmes Windows
    Lancer le fichier run.bat

L'application complet

Sous Eclipse

• En exécutant manuellement le fichier GenrationToDisplayMain (Risque de ne pas marcher si vous avez importé le projet en utilisant l'intégration git)

  1. Faites un clique droit sur le dossier principal contenant le projet. Puis dans le menu déroulant cliquez sur Java Application sous la section Run As.
     
  2. Sur la fenêtre intitulée Select Java Application sélectionnez GenrationToDisplayMain - com.puck.utilities.javafx. Puis cliquez sur le bouton OK.
     
• En utilisant le fichier build.xml

  1. Faites un clique droit sur le fichier build.xml dans le répertoire principal de projet. Puis dans le menu déroulant cliquez sur 2 Ant Build... sous la section Run As.
     
  2. Sur la fenêtre intitulée Edit Configuration cochez le case admin. Vérifiez bien que l'ordre dans la section Target execution order: est admin. Puis cliquez sur le bouton Run.
     

Sous IntelliJ

• En exécutant manuellement le fichier GenrationToDisplayMain.

  1. Chargez le projet en sélectionnant le projet sur la fenêtre de démarrage.
     
  2. Trouvez le fichier GenrationToDisplayMain qui se trouve dans le dossier javafx qui se trouve dans le dossier utilities qui se trouve dans le dossier com.puck qui se trouve dans le dossier src qui se trouve dans le dossier principal du projet. Faites un clique droit sur ce fichier et dans le menu déroulant cliquez sur Run 'GenrationToDis....main()'.
     
• En utilisant Ant Build

  1. Chargez le projet en sélectionnant le projet sur la fenêtre de démarrage.
     
  2. Cliquez deux fois sur la cible admin sur la partie intitulé Ant Build qui se trouve à droite de la fenêtre d'IntelliJ.
     

Sur la ligne des commandes

1. Sur un terminal lancer la commande suivante
   ant admin
   

Guide d'utilisation

Une fois que vous avez réussi à lancer l'interface graphique principal en exécutant le fichier GenrationToDisplayMain vous devez avoir la fenêtre suivante :

Cette interface vous donne deux options tels que:

Génerer la graphe de dépendance à afficher par le code source Java.

• Pour cela vous devez charger le fichier jar du module qui permet de génerer le fichier xml contenant la graphe de dépendance. Pour cela vous pouvez utiliser ceci. Pour le charger cliquez sur le bouton JAR PUCK2 qui se trouve sur la première ligne de la section Utiliser la solution basée sur ExtendJ pour générer le fichier XML et trouvez le fichier .jar que vous cherchez à l'aide de l'exploirateur des fichiers.
• Ainsi vous devez indiquer au moins un fichier Java à générer le graph de dépendance. Pour ce faire vous avez deux options :
  • Vous pouvez charger un unique fichier Java à l'aide de bouton Class Java à afficher. Pour le faire cliquez sur le bouton Class Java à afficher et sélectionnez le fichier Java dont vous utilisez pour l'affichage de graphe de dépendance.
  • Vous pouvez charger projet complet en Java c'est à dire un dossier qui contient plusieurs fichiers Java à l'aide de bouton Projet Java à afficher. Pour le faire cliquez sur le bouton Projet Java à afficher et sélectionnez le dossier de votre projet Java dont vous utilisez pour l'affichage de graphe de dépendance.
• Une fois vous avez indiqué le fichier .jar et le(s) fichier(s) Java vous cliquez sur le bouton Run pour génerer la graphe de dépendance et l'afficher.

Chargez un fichier XML de graph de dépendance à afficher.

Vous pouvez utiliser un fichier XML qui représente une graphe de dépendance d'un programme Java. Pour ce faire cliquez sur le bouton Fichier XML dans la section Utiliser directement votre propre fichier XML. Une fois que vous avez cliquez sur ce bouton, sélectionnez le fichier XML depuis l'exploirateur des fichiers qui s'ouvre. Après avoir sélectionné le fichier XML appuyez sur le bouton Run.

Après avoir lancé le programme en utilisant le module ExtendJ et les fichiers Java ou en utilisant simplement un fichier XML vous arrivez sur l'interface graphique de la graphe de dépendance comme ceci: Au démarrage cet interface contient qu'un seul noeud qui s'appelle root. Ce noeud est considéré comme le noeud racine de toute la graphe.

• Si vous cliquez gauche sur la partie textuel d'un noeud fermé vous pouvez l'ouvrir pour voir ses noeuds enfants.
  
• De même pour un noeud ouvert cliquez gauche sur la partie textuel pour le refermer.
• Toujours sur la partie textuel d'un noeud, vous pouvez cliquez droit pour afficher le menu. Sur ce menu vous avez 10 options qui sont les suivantes:
  
  • Show outgoing edges: Cette option permet d'afficher les flèches partants du noeud sur lequel on a affiche le menu.
  • Show hierarchy outgoing edges: Cette option permet d'afficher les flèches partants du noeud sur lequel on a affiche le menu ainsi que tous ses noeuds enfants.
  • Show ingoing edges: Cette option permet d'afficher les flèches entrants du noeud sur lequel on a affiche le menu.
  • Show hierarchy ingoing edges: Cette option permet d'afficher les flèches entrants du noeud sur lequel on a affiche le menu ainsi que tous ses noeuds enfants.
    
  • Hide edges: Cette option permet de cacher les flèches concernant le noeud sur lequel on a affiché le menu.
  • Hide hierarchy edges: Cette option permet de cacher les flèches hiéarchiques concernant le noueud sur lequel on a affiché le menu.
  • Hide node: Cette option permet de cacher un noeud en entière. (Ceci n'est pas appliquable sur le noeud root)
    
  • Focus node: Cette option permet d'isoler le noeud sur lequel on a affiché le menu, en cachant tous les autres noeuds dans le même package.
  • Expand all: Cette option permet de développer (ouvrir) tous les noeuds de manière récursive depuis le noeud sur lequel on a affiché le menu.
  • Collapse all: Cette option permet de fermer tous les noeuds de manière récurive depuis le noued sur lequel on a affiché le menu.