Analyse statique en PHP avec PhpMetrics

Ces bulles colorées (chaque cercle représente un fichier) indiquent deux choses :

• leur couleur indique l'indice de maintenabilité du code ;
• leur taille indique la complexité cyclomatique du code

L'indice de maintenabilité est un indicateur qui donne… la maintenabilité du code concerné. Cet indicateur est calculé sur de nombreux critères : le volume du code, la complexité, le nombre de lignes, le poids des commentaires… Il existe plusieurs formules possibles pour calculer cet indice, si vous êtes curieux, vous pouvez jeter un œil à la formule utilisée directement dans le code source.

Il s'agit d'une note de 0 à 118, 118 étant la meilleure note, 0 la plus mauvaise. On considère en général qu'un code avec :

• un score supérieur à 85 est très maintenable ;
• un score supérieur à 65 est relativement maintenable ;
• un score inférieur à 65 est difficilement maintenable.

La complexité cyclomatique est un indicateur assez classique qui représente la complexité du code source. En schématisant, chaque accolade (if, foreach, while...) et chaque opérateur logique augmentent ce score de 1. Une grande complexité cyclomatique indique généralement un code dont l'algorithme est complexe.

Ce graphique permet d'afficher n'importe quel indicateur. Il suffit de le sélectionner dans les listes déroulantes, en choisissant s'il représente la taille des cercles, leur position sur l'axe X ou leur position sur l'axe Y.

Par défaut, sont sélectionnés :

• taille des cercles : le nombre de lignes de code (LOC) ;
• axe X : manque de cohésion des méthodes (LCOM4) ;
• axe Y : la complexité cyclomatique (CC).

Vu que nous avons déjà parlé de la complexité cyclomatique, examinons cet indicateur : le manque de cohésion des méthodes (Lack of Cohesion of methods)

Prenons ce code :

<?php
class Example {
    private $a;

    public function m1() {
        $this->m2();
    }

    public function m2() {
        $this->a = 1;
    }

    public function m3() {
        $this->a = 1;
    }

    public function m4() {
        $this->m5();
    }

    public function m5() {
        echo 'ok';
    }
}

Si on regarde bien, on distingue deux flux de code dans cette classe :

1. m1()utilise m2(). m2()partage avec m3() un attribut en commun a.
2. m4() utilise m5().

On peut donc logiquement en déduire que cette classe a probablement plusieurs responsabilités (au moins deux), et qu'elle pourrait probablement être redécoupée en deux classes distinctes pour respecter le principe de responsabilité unique.

L'abstraction concerne la souplesse d'un code. Plus un code utilise de composants abstraits (interfaces) plutôt que concrets (des classes) plus son abstraction est haute, et plus il sera facile de le faire évoluer.

La stabilité indique la résistance au changement d'un code source. Cet indicateur est directement corrélé à l'interdépendance des classes entre elles, qui détermine s'il sera facile de les faire évoluer sans tout casser (code spaghetti).

Ces indicateurs sont donc calculés selon différentes informations :

• le nombre de classes utilisées par une autre (AC) ;
• le nombre de classes dont dépend la classe courante (EC).

Si vous êtes curieux, n'hésitez pas à jeter un œil au code source (Abstraction, Instabilité) pour en savoir plus.

Le code le plus instable et concret est donc en bas à droite, tandis que le code le plus stable et abstrait en haut à gauche. En théorie un code en bas à droite a un coût de production très faible et un coût de maintenance très élevé (et vice-versa).

Toutefois, il existe des paliers : un équilibre peut (doit) exister entre l'instabilité et l'abstraction.

Imaginons qu'une classe ait une abstraction A=5 et une instabilité I=5. Cette classe est partiellement évolutive, car partiellement abstraite, et partiellement stable, car ces évolutions ne sont pas sujettes à une instabilité maximale.

On dit alors que cette classe est sur un chemin intermédiaire (« Main Sequence »). Dans la vraie vie, c'est sur ce chemin intermédiaire qu'un code classique devrait se situer pour être pragmatique. L'écart entre la classe et ce chemin intermédiaire est noté distance.