4d summit2013 refactoring

Refactoring4D Summit Europe 2013

4D Summit Europe 2013 • Paris

Bruno LEGAYA&C ConsultingResponsable 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


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...


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)

Brian W. Kernighan and P. J. Plauger

http://www.amazon.com/Brian-W.-Kernighan/e/B000AQ1TNQ/ref=ntt_athr_dp_pel_1

http://www.amazon.com/Brian-W.-Kernighan/e/B000AQ1TNQ/ref=ntt_athr_dp_pel_1

http://www.amazon.com/P.-J.-Plauger/e/B000AQ1RS8/ref=ntt_athr_dp_pel_2

http://www.amazon.com/P.-J.-Plauger/e/B000AQ1RS8/ref=ntt_athr_dp_pel_2


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


• one-liner


• obfuscation ?


• ascii art ?


• frime ?


Syndrome demoscene

• pas nécessairement plus rapide

• difficile à lire/comprendre/maintenir/débugger

• coder pour un humain


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


L’odeur du code• Martin Fowler parle de “puanteur” du code

• expérience / intuition


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


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.


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


Think different

• adage “if it aint broken don't fix it”

• pourquoi ?

• gérer le risque

• comment ?


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


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)

http://openroaddevelopment.com/

http://openroaddevelopment.com/

http://www.synectique.eu/fr/files/4D-Flyer-fr.pdf

http://www.synectique.eu/fr/files/4D-Flyer-fr.pdf


Pratiques

• TODO tag

• re-lecture de code

• programmation en binôme


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...


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)


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)


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


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


Pas de panique

• le refactoring engendre des risques

• écrire des tests automatisés

• petites étapes validées par des tests automatisés


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)


Programmation par 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


Test unitaireoù 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


Outils de tests unitaires

• 4DUnitTest de Rob Laveaux/pluggers.nl (gratuit, open-source)

• UnitTester4D de Mark Schaake (commercial, abandonné, open source)

https://github.com/markschaake/UnitTester4D


https://github.com/markschaake

https://github.com/markschaake


Jeu

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


Voter1)

2)

3)

4)

5)

6)

7) aucune


Rendre la fonction testable

• Ajouter un paramètre optionnel


Test unitaire simple avec ASSERT


Composant de test unitaire

• configuration du test cases :


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


Exemple de test


Lancer les test-cases


Test-cases stats


Test-cases log


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


BibliographieRefactoring: Improving the Design of Existing Code

de Martin Fowler, Kent Beck (http://www.refactoring.com/)

Clean Code: A Handbook of Agile Software Craftsmanship

de Robert C. Martin

http://www.amazon.com/Refactoring-Improving-Design-Existing-Code/dp/0201485672/ref=sr_1_1?ie=UTF8&qid=1384771567&sr=8-1&keywords=refactor


http://www.amazon.com/Martin-Fowler/e/B000AQ6PGM/ref=sr_ntt_srch_lnk_1?qid=1384771567&sr=8-1

http://www.amazon.com/Martin-Fowler/e/B000AQ6PGM/ref=sr_ntt_srch_lnk_1?qid=1384771567&sr=8-1

http://www.amazon.com/Kent-Beck/e/B000APC0EY/ref=sr_ntt_srch_lnk_1?qid=1384771567&sr=8-1


http://www.refactoring.com

http://www.refactoring.com





http://www.amazon.com/Robert-C.-Martin/e/B000APG87E/ref=ntt_athr_dp_pel_1



BibliographieTest Driven Development: By Example

de Kent Beck

The Pragmatic Programmer: From Journeyman to Master

de Andrew Hunt, David Thomas












BibliographieWardCunningham 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 datatbaseshttp://www.agiledata.org/essays/databaseRefactoring.html

Cyclomatic complexityhttp://www.literateprogramming.com/mccabe.pdf

http://c2.com/cgi/wiki?WardCunningham

http://c2.com/cgi/wiki?WardCunningham





http://www.pluggers.nl/downloads/4DUnitTest.zip

http://www.pluggers.nl/downloads/4DUnitTest.zip

http://openroaddevelopment.com/projects_4dComponent_CodeAnalysis.html

http://openroaddevelopment.com/projects_4dComponent_CodeAnalysis.html

http://www.synectique.eu

http://www.synectique.eu

http://www.agiledata.org/essays/databaseRefactoring.html

http://www.agiledata.org/essays/databaseRefactoring.html


Merci !Bon code, refactoring (et tests) !

4d summit2013 refactoring

Small Business & Entrepreneurship