Archives de
Mois : juin 2020

Publier une librairie sur packagist

Publier une librairie sur packagist

En PHP le gestionnaire de dépendance le plus utiliser est composer. Composer utilise par défaut packagist.org pour chercher une librairie. Nous allons voir comment ajouter une librairie sur packagist afin de la rendre disponible au plus grand nombre.

Création de la librairie

Nous allons donc commencer par créer notre librairie dans un dossier avec un composer init, il nous sera alors demandé les informations suivantes :

  • nom du projet, celui utiliser lors du require
  • auteur
  • stabilité minimum
  • type de projet
  • licence
  • définition des dépendances
  • définition des dépendances de développement

Dans mon cas voilà ce que ça donne :

{
    "name": "dayofr/sfdc-rest-client",
    "description": "A SalesForce REST API PHP Wrapper",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Dayo Fr",
            "email": "dayo@dayo.fr"
        }
    ],
    "require": {}
}

Nous créons ensuite un dossier src et tests afin de pouvoir définir les sections autoload et autoload-dev. Grace a ces définition nous pourrons utiliser les namespace PHP. Dans le code ci-dessous nous disons que les fichier situé dans le dossier src on pour namespace Dayofr :

"autoload": {
    "psr-4": {
      "Dayofr\\": "src/"
    }
  },
"autoload-dev": {
    "psr-4": {
      "Dayofr\\Tests\\": "tests/"
    }
  }

Les fichier PHP à la racine de src pourrons alors déclarer le namespace suivant :

<?php declare(strict_types=1);

namespace Dayofr;

Dans le cas où nous avons des sous dossiers sous la forme src/Responses/Limits le namespace serais alors :

<?php declare(strict_types=1);

namespace Dayofr\Responses\Limits;

Il en va de même pour les tests :

<?php

namespace Dayofr\Tests\Authentication;

Notre code peux donc est utiliser par l’autoloader de composer via :

use Dayofr\Authentication\LoginData;

Test en local

Afin de tester que tout fonctionne, vous pouvez créer un autre projet et ajouter une dépendance vers la libraire. Il nous faut rajouter un repository de type path. Pour cela modifier le composer.json de votre projet de test d’une des deux façon ci-dessous:

avec un lien symbolique :

"repositories": [
    {
        "type": "path",
        "url": "../sfdc-rest-client/",
    }
],

où en copiant le fichiers:

"repositories": [
    {
        "type": "path",
        "url": "../sfdc-rest-client/",
        "options": {
            "symlink": false
        }
    }
],

Il ne nous reste plus qu’a faire un

composer require dayofr/sfdc-rest-client:dev-master

Nous avons ici notre librairie copiée dans le dossier vendor. Vous pouvez alors utiliser votre librairie.

Déployer sur packagist

Pour ceci il vous faudra déployer votre code sur GitHub. Une fois fait, direction packagist.org. Premier étape, la connexion avec GitHub:

Ensuite direction la page d’ajout de librairie dans laquelle vous mettez l’url de projet sur GitHub:

Une fois envoyé, vous êtes redirigé vers la page de votre librairie, ou on vous dit que votre libraire va bientôt être ajouté.

Une fois ajouter vous avez plus d’information sur la page:

Suivez le lien en haut de la page pour activer le hook GitHub afin d’avoir la librairie à jour sur packagist.

Si vous voulez faire une version de votre librairie il vous suffit de créer un tag dans git et la version apparaitra dans packagist.

Votre libraire est prête à être utiliser par le monde entier 🙂

Pour en savoir plus sur packagist direction la page about.

Code Climate pour PHP

Code Climate pour PHP

Peu de temps après mon article sur Codecov, j’ai vu Codeclimate. En de fournir la couverture de code, Codeclimate donne aussi des information sur la qualité du code.

Première étape, la création d’un compte avec github en cliquant sur « Login » puis « Quality ».

Une fois connecté cliquez sur « Open source » puis sur « Add a repository ».

Dans la liste cliquez sur « Add Repo » pour en face de votre projet.

Lors de votre prochain build, vous aurez alors accès a des informations sur la qualité de votre code.

Dans mon cas, pour le moment tout va bien 🙂 Mais on peut voir qu’il manque la couverture de code.

Il nous faut pour cela rajouter un secret dans Travis CI. Pour le trouver direction « Repo Settings » => « Test coverage » => Copiez le « test reporter id »

Dans Travis CI ajoutez le dans la section « Settings ».

Et lors de votre prochain build vous aurez la couverture de code dans la section « Overview »

Dans la section « Issues » vous trouverez la liste des problèmes détecté par Code Climate. Vous pouvez alors les corriger, ou bien choisir un des options afin de ne plus le voir.

Dans la section « Code » vous trouverez des informations fichier par fichier.

En sélectionnant un fichier vous aurez plus détails sur celui-ci

Notamment la couverture de code.

Et voilà, il ne vous reste qu’a regardez tous ça.