2023-11-10 Composer (ārējās bibleotekas) un Unit Testing with Pest

[Rozkalns]

Composer

A Dependency Manager for PHP

https://getcomposer.org/

Rīks, kas palīdz programmētājiem vadīt un organizēt savus projektus.

• Dependency management (ārējo bibleotēku pārvaldība) - dod iespēju izmantot ārējās bibleotekas, ko rakstījuši citi programmetāji.
• Autoloading - Automātiski ielādēt kodu (lai nebūtu pašam visu laiku require 'file.php' jāraksta)
• Projekta struktūras ģenerēšana - izmantojot gatavu projekta templeitu var izveidot projekta struktūru automātiski.

Lai izmantotu composer, nepieciešams, vai nu instalēt composer uz datora, vai arī var izmantot docker image <command> vietā ierakstot nepieciešamo komandu:

docker run --rm -it \
  --volume $PWD:/app \
  --user $(id -u):$(id -g) \
  composer <command>

Pamatfīčas:

Skatīt šeit

Pāris komandas:

1. composer install - instalē visas ārējās bibleotēkas, kas norādītas composer.json failā. Kad projekts pārvietots uz citurieni, vendor mapīte neeksistē, tāpēc - jāpalaiž šī komanda.

composer install

2. composer update - atjauno visas ārējās bibleotēkas uz jaunākajām versijām, kas atbilst norādēm composer.json failā.

composer update

3. composer require - tiek izmantots, lai pievienotu jaunas ārējās bibleotekas projektam. Piemēram, ja vēlies pievienot Monolog bibleotēku

composer require monolog/monolog

4. composer remove - izmanto, kad vēlies dzēst ārējo bibleoteku no projekta, piemēram - atbrīvoties no Monolog bibleotekas

composer remove monolog/monolog

5. composer dump-autoload - izmanto, kad piemēram, pievieno jaunas projekta saknes, mainās namespaces, principā - lai atjaunotu autoloader.

composer dump-autoload

6. composer create-project - izveido jaunu projektu, pamatojoties uz noteiktu šablonu vai bibleoteku. Piemēram, izmantojot Laravel kā pamata projektu

composer create-project laravel/laravel example-app

7. composer show - parāda informāciju par visām ārējām bibleotekām projektā.

composer show

Pāris ārējās bibleotēkas, ko vēlētos izmantot

1. Symfony VarDumper: Ļauj skaisti un saprotami izvadīt mainīgos iun citus datus, kas noderīgi veidot kļūdu analīzi un koda izstrādi.
2. Monolog: Bibleoteka, kas palīdz viegli reģistrēt un pārvaldīt log failus
3. Guzzle: HTTP klienta bibleoteka, kas atvieglo darbu ar HTTP pieprasījumiem. To var izmantot, piemēram, lai sazinātos ar API vai iegūtu datus no cita servera.
4. PHPUnit un Pest: Unit testu veidošanas freimworks, kas ļauj vielgi veikt automātisko testēšanu.
5. Twig: Templeiting (šablonu) freimworks, kas padaa HTML layoutu veidošanu dinamiskāku, ērtāku un lasākāmu.
6. Carbon: Dauma un laika manipulāciju bibleotēka. Iebūvētā \Datetime objekta brālis on sterioids.

Unit Testing with Pest

pestphp/pest ir testēšanas bibleoteka, kas izveidota, lai vienkāršotu un uzlabotu PHPUnit testu rakstīšanu. Pest atšķirās no klasiskās PHPUnit sintakses un piedāvā daudz vienkāršāku un lasāmāku kodu testa veidošanai. Tas ir draudzīgāks cilvēkiem, un inspirācija nāk no Jest testing freimworka (By Facebook for React/Javascrtipt)

YT: Pest in practice

Lai izmantotu pestphp/pest, tā ir jāinstalē kā ārējā bibleoteka un pēc tam būs iespēja rakstīt testus izmantojot Pest sintaksi, piem:

// Piemērs izmantojot Pest
test('skaitļu summa', function () {
    $sum = array_sum([1,2]);
    expect($sum)->toBe(3);
});

// Tradicionāls PHPUnit piemērs
class ManiTesti extends \PHPUnit\Framework\TestCase {
    public function testJaunaisTests() {
        $sum = array_sum([1, 2]);
        $this->assertEquals(3, $sum);
    }
}

Getting Started

Instalēt Pest:

docker run --rm -it \
  --volume $PWD:/app \
  --user $(id -u):$(id -g) \
  composer require pestphp/pest --dev --with-all-dependencies

Uzstādīt Pest:

1. Atvērt termināli:
   

2. Izpildīt komandu

./vendor/bin/pest --init

Testing Real world problems

Lai testēšanu varētu veikt veiksmīgi, ir nepieciešams projektu strukturizēt.

Pārsvarā source kods, biznesa loģika parasti atrodas src mapītē. Un attiecīgi, visām klasēm ir jābūt šajā mapītē