4D Summit2013 refactoring

Refactoring
4D Summit Europe 2013

• Paris
Bruno LEGAY
A&C Consulting
Responsable Bureau d’Etudes

Gérer la complexité
• le code complexe est nuisible
• le code devrait être
• clair et simple
• facile à lire
• évident
• bien organisé
• robuste
• flexible
• Paris

Code propre ?
• nommage variable / champ / méthode / fonction
• convention nommage
• locale vs globale, paramètre vs globale, pointeur var locale
• commentaires
• constantes
• méthodes courtes vs méthodes longues fortes imbrication
• recopie de paramètres
• couplage fort / faible
• design modulaire, polymorphisme, encapsulation, etc...
• Paris

Code simple ?
• “Everyone knows that debugging is twice as hard as
writing a program in the first place. So if you’re as clever
as you can be when you write it, how will you ever debug
it ?”
The Elements of Programming Style (1978)
• Paris
Brian W. Kernighan and P. J. Plauger

Syndrome demoscene
• hackers qui font des tours de force en programmation bas
niveau et qui poussent les limites du matériel pour produire
des démos multimédia impressionnantes
• Paris

• one-liner
• Paris

• obfuscation ?
• Paris

• ascii art ?
• Paris

• frime ?
• Paris

Syndrome demoscene
• pas nécessairement plus rapide
• difficile à lire/comprendre/maintenir/débugger
• coder pour un humain
• Paris

Rapidité / optimisation
• la rapidité est importante
• optimisation prématurée est un fléau
• ne pas se fier à son intuition
• outils
• mesures
• bancs d’essai
• Paris

L’odeur du code
• Martin Fowler parle de “puanteur” du code
• expérience / intuition
• Paris

Dette technique
• métaphore de Ward Cunningham (XP, Wiki, etc...)
• emprunter / sortir l’application rapidement (connaissance
partielle)
• accumulation de dette => tous les revenus servent à payer
l'intérêt de la dette
• rembourser l’emprunt / affiner le code
• Paris

Définition du Refactoring
• définition proposée par Martin Fowler
• improving the design of existing code
• refactoring (noun) : a change made in the internal
structure of software to make it easier to
understand and cheaper to modify without
changing its observable behavior.
• Paris

Ethymologie
• facteur
• factorisation en mathématiques
ab + ac = a(b+c)
• expressions remarquables
a2 - b2 = (a+b)(a-b)
a2 + 2ab + b2 = (a+b)2
a2 - 2ab + b2 = (a-b)2 = (b-a)2
• Paris

Think different
• adage “if it aint broken don't fix it”
• pourquoi ?
• gérer le risque
• comment ?
• Paris

Identifier les objectifs
• nommage de variable/fonction abscond
• duplication
• méthodes longues
• trop de commentaires
• quand le débuggeur est nécessaire pour comprendre
• profondeur des boucles / conditions
• couplage fort
• Paris

Outils d’analyse
• nombre de lignes
• bugs / ligne de code
• densité des commentaires
• Thomas McCabe (1976) : complexité cyclomatique
• Sanity Check (RIP, Committed Software)
• accès objets développement / METHODE LIRE CODE
• Code Analysis Component (gratuit / Open Road Development)
• Inventive Toolkit 4D (commercial / Synectique)
• Paris

• Paris
Pratiques
• TODO tag
• re-lecture de code
• programmation en binôme

• Paris
Les outils
• IDE 4D
• compilateur / vérification de la syntaxe
• macros
• 4D Pop (éditeur de constantes, etc...)
• accès objets développement
• composants

Refactoring simple
• renommer une méthode (et mettre à jour les appelants)
• renommer un(e) table/champ (tokenisé, attention sql, html,
etc...)
• renommer une variable (chercher / remplacer)
• remplacer une expression littérale par une constante
• extraire un bloc de code et en faire une méthode/fonction
• extraire un module et en faire un composant
• etc...
• Paris

• Paris
Conseils
• déclaration des variables locales (haut vs bloc)
• recopier les paramètres dans des variables locales
• utiliser des variables locales si possible (les pointeurs sur
des variables comme paramètres)

Adopter le changement
• 4D apporte des nouvelles fonctionnalités
• Composants, Unicode, SQL, SVG, Listbox, Expression régulières,
Séparateur de dossier, WebArea, LPE, “r”, “n”, “t”, Executer sur
serveur, etc... (v11)
• PHP, Texte enrichi, UUID, ASSERT, Wigdets, PDFCreator (v12)
• Client HTTP, progress bar, Constantes XLIFF (v13)
• Objets / json (v14)
• Paris

Accepter le changement
• les nouvelles versions de 4D nécessitent parfois des
adaptations
• Sous-tables, Unicode, Resources, Extras, AP Sublaunch, 4D Draw,
4D open, 4D for Oracle (v11)
• Scrollable areas (v13)
• 4D Chart (v14)
• remplacer des plug-ins (manque de support ?, coût ?)
• aussi vrai pour 4D (QuickTime, Carbon, Altura)
• Paris

• Paris
API
• interfaces
• fonction/méthode de composants (noms et paramètres)
• webservice (SOAP/REST)
• modèle de données (ODBC), couche d’abstraction avec
les vues
• formats de fichier
• notion public/private

Modèle de données
• il faut démystifier la modification du modèle de données
• ce n’est pas simple, mais la pratique aide
• le fichier de données doit contenir un numéro de version
(dans une table)
• la structure doit contenir un numéro de version et les
méthodes de mise à niveau
• exécution automatique des méthodes de mise à niveau
• on doit pouvoir exécuter plusieurs mises à niveau
séquentiellement
• Paris

Refactor vs Ré-écriture
• ça dépend
• le refactoring n’est envisageable que sur un produit qui
marche (à peu près)
• diviser pour mieux régner
• Paris

• Paris

Pas de panique
• le refactoring engendre des risques
• écrire des tests automatisés
• petites étapes validées par des tests automatisés
• Paris

Prendre le l’assurance
• ASSERT (exprBooléenne {;messageTexte})
• Asserted (exprBooléenne {; messageTexte}) -> booléen
• FIXER ACTIVATION ASSERTIONS (active {;*})
• désactive l’évaluation des expression booléenne d’ASSERT !!!
• Lire activation assertions -> booléen
• APPELER SUR ERREUR (erreur -10518, error, error method,
error line)
• dans la méthode (tester pré-conditions et post-conditions cf “programmation par
contrat”)
• en dehors de la méthode (“test unitaires” allégés)
• Paris

Programmation par
• Paris
contrat
• ASSERT dans la méthode
• échouer tout de suite vs échouer doucement
• pré-conditions / post-conditions
• nombre de paramètres, enregistrement courant,
enregistrement verrouillé, pointeur nil, type de pointeur,
valeurs attendues, valeurs vide, plage de valeur
• une autre façon de documenter les “limites opérationnelles”

Test unitaires
• ASSERT en dehors de la méthode
• valider le fonctionnement d’une méthode/fonction
• tester an une valeur attendue en sortie avec une valeur
connue en entrée
• Paris

Test unitaire
où commencer ?
• robots test vs test unitaire
• pas d’excuse pour ne pas commencer
• commencer par ce qui est facile a tester et fragile
• tester aux limites
• essayer de couvrir tous les chemins
• tester les formulaires
• adapter son code pour qu’il soit testable
• métadonnées de test
• Paris

Outils de tests unitaires
• 4DUnitTest de Rob Laveaux/pluggers.nl (gratuit, open-source)
• UnitTester4D de Mark Schaake (commercial, abandonné,
open source)
• Paris

• Paris
Jeu
• Objectif : écrire une fonction qui calcule l’âge (en années)

• Paris
Voter
1)
2)
3)
4)
5)
6)
7) aucune

Rendre la fonction
• Paris
testable
• Ajouter un paramètre optionnel

Test unitaire simple
avec ASSERT
• Paris

Composant de test
• Paris
unitaire
• configuration du test cases :

Test-cases : list des test
• méthode test cases “testCase_ageYearCalc”(partagée avec le composant) :
• Paris

Exemple de test
• Paris

Lancer les test-cases
• Paris

Test-cases stats
• Paris

Test-cases log
• Paris

• Paris
Résumé
• écrire le code pour les humains
• faire du refactoring de manière régulière
• rendre le code testable
• écrire des tests automatisés

Bibliographie
Refactoring: Improving the Design of Existing Code
de Martin Fowler, Kent Beck (http://www.refactoring.com/)
• Paris
Clean Code: A Handbook of Agile Software
Craftsmanship
de Robert C. Martin

Bibliographie
Test Driven Development: By Example
• Paris
de Kent Beck
The Pragmatic Programmer: From Journeyman to
Master
de Andrew Hunt, David Thomas

Bibliographie
WardCunningham explains tehcnical dept :
http://c2.com/cgi/wiki?WardExplainsDebtMetaphor
Unit Tester 4D (Mark Schaake) :
https://github.com/markschaake/UnitTester4D
4D Unit Test (Rob Laveaux / pluggers.nl) :
http://www.pluggers.nl/downloads/4DUnitTest.zip
Code analysis component (Open Road Development) :
http://openroaddevelopment.com/projects_4dComponent_CodeAnalysis.html
Inventive Toolkit 4D (Synectique) :
http://www.synectique.eu/
Don't be a White Rabbit anymore !
presentation by Christophe Keromen, october 2010, San Diego 2010
Refactoring datatbases
http://www.agiledata.org/essays/databaseRefactoring.html
Cyclomatic complexity
http://www.literateprogramming.com/mccabe.pdf
• Paris

• Paris
Merci !
Bon code, refactoring (et tests) !

4D Summit2013 refactoring

Recommandé

Recommandé

Contenu connexe

En vedette

En vedette (20)

Similaire à 4D Summit2013 refactoring

Similaire à 4D Summit2013 refactoring (20)

4D Summit2013 refactoring