Perl moderne : 2014

La maintenabilité évalue de façon nébuleuse dans quelle mesure un programme est facile à comprendre et à modifier. Écrivez du code. Revenez-y dans six mois. Combien de temps vous faut-il pour corriger un bogue ou ajouter une fonctionnalité ? C'est cela la maintenabilité.

La maintenabilité ne prend pas en compte si vous devez rechercher la syntaxe d'une commande interne ou une fonction d'une bibliothèque. Elle ne mesure pas la façon dont quelqu'un qui n'a jamais programmé avant lira ou pas votre code. Il est plus intéressant de se demander si un programmeur compétent qui comprend le problème que vous essayez de résoudre trouvera facile ou difficile de modifier le programme. Quels sont les problèmes qui gênent la correction d'un bogue ou l'ajout correct d'une amélioration ?

Pour écrire un logiciel facile à maintenir, vous avez besoin d'expérience dans la résolution des problèmes réels, une compréhension des idiomes, des techniques et du style de votre langage de programmation et du bon goût. Vous pouvez développer tout cela en vous concentrant sur quelques principes :

• supprimez le code dupliqué. Les bogues se cachent dans les sections de code répété et similaire — lorsque vous corrigez un bogue dans un morceau de code, est-ce que vous devez le corriger aussi ailleurs ? Lorsque vous mettez à jour une section, devez-vous en mettre à jour d'autres ?
  Les systèmes bien conçus ont peu de duplication. Ils utilisent des fonctions, des modules, des objets et des rôles pour extraire le code dupliqué dans des composants distincts qui modélisent avec précision le domaine du problème. Les meilleures conceptions vous permettent d'ajouter des fonctionnalités en supprimant du code ;
• nommez bien les entités. Votre code raconte une histoire. Chaque nom que vous choisissez pour une variable, une fonction, un module et une classe vous permet de clarifier ou d'obscurcir votre intention. Choisissez soigneusement vos noms. Si vous rencontrez des difficultés à choisir de bons noms, vous devrez peut-être repenser votre conception ou étudier votre problème plus en détail ;
• évitez l'ingéniosité inutile. Le code concis est bon lorsqu'il révèle ses intentions. Le code ingénieux cache votre intention derrière des astuces voyantes. Perl vous permet d'écrire le bon code au bon moment. Choisissez la solution la plus évidente lorsque cela est possible. L'expérience et le bon goût vous guideront.
  Certains problèmes exigent des solutions astucieuses. Lorsque cela se produit, encapsulez ce code derrière une interface simple et documentez votre ingéniosité ;
• embrassez la simplicité. Si tout le reste est égal, un programme simple est plus facile à maintenir que sa version plus complexe. La simplicité signifie savoir ce qui est le plus important et faire exactement cela.
  Parfois, vous avez besoin d'un code puissant, robuste. Parfois, vous avez besoin d'une seule ligne de script. La simplicité signifie faire la différence entre les deux cas de figure et utiliser seulement ce dont vous avez besoin. Il n'existe aucune excuse pour éviter la vérification des erreurs ou la modularité ou la validation ou la sécurité. Le code simple peut utiliser des fonctionnalités avancées. Le code simple peut utiliser des modules du CPAN et beaucoup d'entre eux. Le code simple peut nécessiter du travail pour être compris. Pourtant le code simple résout les problèmes de manière efficace, sans travail inutile.

Perl s'inspire largement d'autres langages. Perl vous permet d'écrire le code que vous voulez écrire. Les programmeurs C écrivent souvent en Perl dans un style ressemblant au C, tout comme les programmeurs Java écrivent du Perl du style du Java. Les programmeurs Perl efficaces écrivent du Perl « perlien », embrassant les idiomes du langage.

• Comprenez la sagesse de la communauté. Les programmeurs Perl débattent souvent farouchement des techniques et des idiomes. Les programmeurs Perl partagent également souvent leur travail et pas seulement sur le CPAN. Faites attention et obtenez l'illumination sur les compromis entre les différents idéaux et styles.
  Les développeurs du CPAN, les Mongueurs de Perl et les participants aux listes de diffusion ont de l'expérience durement acquise lors de la résolution des problèmes de multiples façons. Parlez-leur. Lisez leur code. Posez des questions. Apprenez d'eux et ils apprendront de vous.
• Suivez les normes de la communauté. Perl est une communauté de créateurs d'outils. Nous résolvons des problèmes divers, y compris l'analyse du code statique (Perl::Critic), le reformatage (Perl::Tidy) et les systèmes privés de distribution (CPAN::Mini, Carton, Pinto). Profitez de l'infrastructure du CPAN ; suivez le modèle du CPAN dans l'écriture, la documentation, le paquetage, les tests et la distribution de votre code.
• Lisez du code. Rejoignez des listes de diffusion telles que Perl Beginners (http://learn.perl.org/faq/beginners.html) ou, en français, perl@mongueurs.net, participez à des forums Perl (https://www.developpez.net/forums/f82/autres-langages/perl/), parcourez PerlMonks (http://perlmonks.org/), et immergez-vous dans la communauté en général. Voir http://www.perl.org/community.html. Lisez du code et essayez de répondre à des questions — même si vous ne postez jamais les réponses, c'est une excellente occasion d'apprendre.

Écrire du code maintenable signifie concevoir du code maintenable. Une bonne conception vient des bonnes habitudes :

• écrivez du code testable. L'écriture d'une suite de tests efficaces demande les mêmes compétences en conception que l'écriture du code efficace. Un code est un code. De bons tests vous donnent aussi la confiance nécessaire pour modifier un programme tout en conservant son fonctionnement correct ;
• modularisez. Tracez des frontières en appliquant l'encapsulation et l'abstraction. Trouvez les bonnes interfaces entre composants. Nommez bien les choses et mettez-les au bon endroit. La modularité vous oblige à penser aux modèles et abstractions dans votre code pour comprendre comment ils s’emboîtent. Trouvez les parties qui ne correspondent pas bien. Améliorez-les jusqu'à ce qu'elles le fassent ;
• suivez des normes de codage sensées. Des directives efficaces discutent la gestion des erreurs, la sécurité, l'encapsulation, la conception des API, la mise en page du projet et d'autres facettes du code maintenable. D'excellentes directives aident les développeurs à communiquer entre eux et avec le code. Votre travail consiste à résoudre des problèmes avec du code. Laissez votre code parler clairement ;
• exploitez le CPAN. Les programmeurs Perl résolvent des problèmes. Ensuite, nous partageons ces solutions. Le CPAN est un démultiplicateur de force ; recherchez une solution ou une solution partielle à votre problème. Investissez du temps dans la recherche afin de trouver des solutions complètes ou partielles que vous pouvez réutiliser. Cela se révélera payant.
  Si vous trouvez un bogue, signalez-le. Corrigez-le, si possible. Corrigez une faute de frappe. Demandez une nouvelle fonctionnalité. Dites « Merci ! » Nous sommes meilleurs ensemble que nous le sommes séparément. Nous sommes puissants et efficaces lorsque nous réutilisons du code.
  Lorsque vous êtes prêt — lorsque vous créez quelque chose de nouveau ou corrigez quelque chose de vieux d'une manière réutilisable, partagez votre code. Rejoignez-nous. Nous résolvons des problèmes.

Les bons programmeurs anticipent l'imprévu. Les fichiers qui devaient exister n'existeront pas. Un disque énorme qui ne serait jamais plein se remplira. Le réseau qui marche toujours tombe en panne. La base de données la plus fiable sera endommagée. Les exceptions se produisent. Un logiciel robuste doit les gérer. Si vous pouvez résoudre le problème, tant mieux ! Si vous ne le pouvez pas, collectez les informations pertinentes et réessayez.

Perl gère des circonstances exceptionnelles par des exceptions : un mécanisme dynamique de flot d'exécution, conçu pour détecter et traiter les erreurs.

IX-D-1. Signalez les exceptions▲

sub open_log_file
{
    my $nom = shift;
    open my $fh, '>>', $nom
        or die "Impossible d'ouvrir le fichier journal '$nom': $!";
    return $fh;
}

IX-D-2. Intercepter les exceptions▲

# le fichier journal ne peut pas s'ouvrir
my $fh = eval { open_log_file( 'monkeytown.log' ) };

local $@;

# le fichier journal ne peut pas s'ouvrir
my $fh = eval { open_log_file( 'monkeytown.log' ) };

# exception interceptée
if (my $exception = $@) { ... }

if (my $exception = $@)
{
    die $exception
       unless $exception =~ /^Can't open logging/;
    $fh = log_to_syslog();
}

package Zoo::Exceptions
{
    use Exception::Class
        'Zoo::AnimalEchappe',
        'Zoo::HandlerEchappe';
}

sub cage_ouverte
{
    my $self = shift;
    Zoo::AnimalEchappe->throw
        unless $self->contient_animal;
    ...
}

sub breche_ouverte
{
    my $self = shift;
    Zoo::HandlerEchappe->throw
        unless $self->contient_handler;
    ...
}

IX-D-3. Dangers des exceptions▲

use Try::Tiny;

my $fh = try   { open_log_file( 'monkeytown.log' ) }
         catch { log_exception( $_ ) };

IX-D-4. Exceptions internes▲

La majorité des modules Perl fournissent de nouvelles fonctions ou définissent des classes (MooseMoose). D'autres, tels que strict ou warnings, influencent le comportement du langage même. Cette seconde classe de module s'appelle pragma ou module pragmatique. Par convention, les pragmas ont des noms en minuscules pour les différencier des autres modules.

IX-E-1. Pragmas et portée▲

{
    # $lexical pas visible; strict pas en vigueur
    {
        use strict;
        my $lexical = 'disponible ici';
        # $lexical est visible; strict est en vigueur
    }
    # $lexical à nouveau invisible; strict pas en vigueur
}

# portée du fichier
use strict;

{
    # portée intérieure, mais strict toujours en vigueur
    my $interne = 'autre lexical';
}

IX-E-2. Utiliser des pragmas▲

# nécessite des déclarations de variables, interdit les mots nus
use strict qw( subs vars );

# basé sur la sémantique du livre de 2012
use Modern::Perl '2012';

use Modern::Perl; # ou use strict;

{
    no strict 'refs';
    # manipulez la table des symboles ici
}

IX-E-3. Pragmas utiles▲