modelemvc/README.md

Mode d'emploi du projet mod�le MVC-entity

Historique

v0.1 19/07/2016 (Julien Legrand) : 1�re version

D�marrage d'un nouveau projet avec le mod�le : pas-�-pas

1. GIT 1.1. Cloner le projet mod�le dans le dossier de votre choix : "git clone [adresse du projet]" � faire dans le dossier parent (le dossier CD67.ModeleMVC sera cr�� automatiquement) 1.2. Renommer le dossier du projet avec le nom de votre choix 1.3. Supprimer le sous-dossier cach� ".git" � la racine du projet pour supprimer le lien avec le projet mod�le 1.4. Initialiser un nouveau d�p�t GIT : "git init" � faire dans le dossier du projet 1.5. C'est le bon moment pour faire un premier commit : "git commit -m "NEW Reprise du projet mod�le"" 1.6. Ajout de la r�f�rence du repository en ligne : "git remote add origin [adresse du nouveau projet]" 1.7. 1er envoi sur le serveur : "git push --set-upstream origin master" (par la suite, "git push" suffira)

2. Renommer et ex�ctuer la maquette : 2.1. Renommer la solution et les projets en suivant ce sch�ma : "CD67.[nom appli].[Entity/Factory/MVC/Tests/Batchs]" 2.2. Renommer �galement les assemblies et espaces de nom de chaque projet (dans les propri�t�s des projets, onglet "Application") 2.3. Quitter Visual Studio 2.4. Supprimer si n�cessaire tous les fichiers commencant par "CD67.ModeleMVC.*" dans les dossiers suivants : "\CD67.Toto.MVC\bin", "\CD67.Toto.Factory\bin\Debug", "\CD67.Toto.Entity\bin\Debug", "CD67.Toto.Tests\bin\Debug" 2.5. Modifier le noms des dossiers des projets en cons�quence et modifier le chemin des fichiers projets dans le fichier solution *.sln 2.6. Ouvrir � nouveau la solution et faire un rechercher/remplacer global � la solution pour remplacer "CD67.ModeleMVC" par "CD67.[nom appli]" 2.7. Nettoyer et r�g�nere la solution 2.8. Ex�cuter l� pour contr�ler qu'elle fonctionne correctement � ce stade avec les donn�es de tests 2.9. Noter dans le code les exemples � disposition 2.10. Un petit commit avant de continuer : "git commit -m "NEW Renommage du projet mod�le""

3. Nouvelle connexion : 3.1. Mettre � jour la chaine de connexion "Entities" dans les fichiers : "CD67.Toto.Entity\App.config" et "CD67.Toto.MVC\Web.config" 3.2. Option : il est possible d'ajouter une projet de type base de donn�es pour g�rer votre base de donn�es dans la m�me solution (en vous connectant avec la chaine de connexion mis � jour au point pr�c�dent) 3.3. Ouvrer le model Entity : "CD67.Toto.Entity\EntityModel.edmx" et supprimer les tables d'exemples 3.4. Supprimer les classes partielles d'exemple : "CD67.ModeleMVC.Entity\Extend\EXEMPLE_VIKINGS.cs" et "CD67.ModeleMVC.Entity\Extend\EXEMPLE_TYPE_VIKING.cs" 3.5. Supprimer les fichiers "Factory" d'exemple : "CD67.ModeleMVC.Factory\VIKINGSFactory.cs" et "CD67.ModeleMVC.Factory\TYPE_VIKINGFactory.cs" 3.6. Supprimer les contr�leurs et vues d'exemple dans : "CD67.ModeleMVC.MVC\Controllers" et "CD67.ModeleMVC.MVC\Views" 3.7. C'est le moment du commit : "git commit -m "NEW Fin de l'initialisation du projet mod�le"" 3.8. A ce stade le nouveau projet est pr�t � r�ellement d�marrer, on cr�er donc une nouvelle branche "develop" : "git branch develop" et "git checkout develop" 3.9. On pousse la nouvelle branche en ligne : "git push --set-upstream origin develop" (par la suite, "git push" suffira)

4. D�marrage du nouveau projet : 4.1. Mettre � jour le mod�le par rapport � la base de donn�es pour ajouter de nouvelles tables et vues n�cessaire � l'application 4.2. V�rifier les types des entit�s g�n�r�es depuis la base de donn�es, particuli�rement les chiffres et cl�s en num�ro auto ou avec un trigger/sequence Oracle (le champ "StoreGeneratedPattern" doit �tre �gal � "Identity" pour les cl�s automatiques) 4.3. Cr�er vos propres fichiers d'extension avec DataAnnotation ici : "CD67.ModeleMVC.Entity\Extend" 4.4. Cr�er vos propres factory ici : "CD67.ModeleMVC.Factory" 4.5. Cr�er vos propres controller/vues ici : "CD67.ModeleMVC.MVC\Controllers" et "CD67.ModeleMVC.MVC\Views" (NOTE : personellement j'utilise � la cr�ation du controller le mod�le "Contr�leur MV5 avec vues, utilisant Entity Framework" en g�n�rant les vues et avec la page de disposition que je souhaite, ensuite je modifie le code du contr�leur pour utiliser les classes "Factory") 4.6. Modifier le fichier "CD67.ModeleMVC.MVC\App_Start\RouteConfig.cs" par rapport � vos contr�leurs et variables n�cessaires 4.7. Ajout des tests unitaires pour tester les fonctions principales dans le projet d�di� "CD67.ModeleMVC.Tests" (CRUD sur les classes, processus complet, etc.) 4.8. On fait des commits � chaque avanc�e majeure, on fait une fusion avec la branche "master" d�s que l'outil est en production, puis son continue les d�veloppements sur "develop"

5. Supprimer ce fichier � la fin pour ne pas que l'on sache que vous avez utilis� un mod�le :p

Description g�n�rale

La solution est consitu�e de 4 projets :

• CD67.ModeleMVC.Entity : Projet qui contient les objets m�tiers, c'est � dire dans le cas de projets Entity : le mod�le entity framework
• CD67.ModeleMVC.Factory : Projet qui contient les classes permettant la gestion des objets : les actions CRUD pour chacun � minima
• CD67.ModeleMVC.MVC : Projet qui comprend le site Web MVC, les packages Bootstrap et FontAwesome sont d�j� install�s
• CD67.ModeleMVC.Tests : Tests unitaires

Description du projet : CD67.ModeleMVC.Entity

Le mod�le se nomme par d�faut "EntityModel". Pour se connecter � la base de donn�es afin de faire �voluer le mod�le, il faut utiliser la connexion "OracleConnection (CD67.ModeleMVC.MVC)".

Le dossier "Extend" contient les extensions �ventuelles de classe Entity (qui se trouvent dans "EntityModel.edmx\EntityModel.tt\"). C'est notamment utile pour ajouter les DataAnnotations permettant de d�crire le donn�es en vue d'une g�n�ration de contr�les plus appropi�s dans les vues MVC. Attention � bien surveiller l'espace de noms lors de la cr�ation d'une classe dans ce sous-dossier (erreur fr�quente) :

• par d�faut ce sera : "CD67.ModeleMVC.Entity.Extend",
• mais il faut "CD67.ModeleMVC.Entity" (le m�me que les classes de bases Entity).

Le dossier "Internal" contient :

• "FormattedDbEntityValidationException.cs" : classe h�rit�e de Exception qui permet un affichage plus complet dans les messages d'erreur pour les exceptions li�es au format de donn�es du mod�le Entity
• "Entities.cs" : classe partielle permettant d'utiliser les nouvelles Exceptions FormattedDbEntityValidationException en surchargeant "SaveChanges()" En cas d'ajout d'une nouvelle connexion avec Entity Framework, il faut ajouter une nouvelle classe d'extension du m�me type.

Description du projet : CD67.ModeleMVC.Factory

Les classes Factory sont nomm�es ainsi : "[Nom objet]Factory" On cr�e autant de classe Factory que d'objet � g�rer Elles doivent contenir un constructeur public avec le context Entities en param�tre qui se base sur le constructeur de la classe parente. Elles contiennent g�n�ralement les fonctions suivantes : getById, getAll, add, update, delete. C'est � adapter � chaque cas.

Le dossier "Internal" contient la classe de base "baseFactory" dont chaque "Factory" h�rite.

Description du projet : CD67.ModeleMVC.MVC

La partie Model du projet n'est pas n�cessaire que pour d�finir des classes ne servant qu'� l'affichage, les classes m�tiers �tant dans le projet Entity.

Le dossier "Views" contient par d�faut :

• "Shared_AppLayout.cshtml" : une page de disposition pour l'application
• "DisplayTemplates\YesNo.cshtml" et "EditorTemplates\YesNo.cshtml" : ils s'agit d'exemple de personnalisation d'affichage pour un type de champ, ici "YesNo". On attribut un type avec la DataAnnotation "[UIHint("YesNo")]" dans la classe Metadata et ce sont les fichiers dans DisplayTemplates et EditorTemplates du m�me nom qui seront utilis�s pour cr�er le contr�le � l'affichage.

Le dossier "style" contient :

• un sous dossier "images" destin� � contenir toutes les images utilis�es dans la mise en page
• "AppStyleSheet.css" : feuille de style � modifier pour le projet courant
• "ModeleStyleSheet.css" : feuille de style du mod�le CD67 � ne pas modifier

Les scripts et styles sont charg�s � l'aide des commandes : "@Scripts.Render("~/bundles/jquery")", "@Scripts.Render("~/bundles/bootstrap")" et "@Styles.Render("~/Content/css")". La configuration de ceci se trouve dans ce fichier : "App_Start\BundleConfig.cs"

Les Glyphicons Bootstrap sont ici : http://getbootstrap.com/components/#glyphicons Et les ic�nes FontAwesome l� : http://fontawesome.io/icons/

Le dossier "Internal" contient du code permettant l'ajout de la commande "@Html.DescriptionFor" dans les vues.

Description du projet : CD67.ModeleMVC.Tests

Projet le plus important de la solution :)