PadelClub/PadelClub/Data/README.md

Procédure de création de classe

Dans Swift:

• Dans Data > Gen > créer un nouveau fichier json pour la classe
  • Le paramètre "foreignKey" permet de générer une méthode qui récupère l'objet parent. Ajouter une étoile permet d'indiquer que l'on cherche l'objet dans le Store de l'objet et non le Store.main.
• Pour générer les fichiers, on se place dans le répertoire de generator.py et on lance la commande : python generator.py -i . -o .
• il faut avoir inflect: pip install inflect

Dans Django:

• Les modèles de base doivent étendre BaseModel
• Les modèles stockés dans des répertoires doivent étendre SideStoreModel
• Les classes d'admin doivent étendre SyncedObjectAdmin
• Les ForeignKey doivent toujours avoir on_delete=models.SET_NULL
  • Pour se faciliter la vie dans l'admin, on veut que les delete effacent les enfants malgré tout. Il faut donc implémenter la méthode delete_dependencies(self) de la classe

Procédure d'ajout de champ dans une classe

Dans Swift:

• Ouvrir le fichier .json correspondant à la classe
• Regénérer la classe, voir ci-dessus pour la commande
• Ouvrir ServerDataTests et ajouter un test sur le champ
  • Pour que les tests sur les dates fonctionnent, on peut tester date.formatted() par exemple

Dans Django:

• Ajouter le champ dans la classe
• Si c'est une ForeignKey, toujours mettre un related_name sinon la synchro casse
• Si c'est un champ dans CustomUser:
  • Ajouter le champ à la méthode fields_for_update
  • Ajouter le champ dans UserSerializer > create > create_user dans serializers.py
  • L'ajouter aussi dans admin.py si nécéssaire
• Faire le makemigrations + migrate

Note: Les nouvelles classes de model doivent étendre BaseModel ou SideStoreModel

Enfin, revenir dans Xcode, ouvrir ServerDataTests et lancer le test mis à jour