Refactoring (#12)

* Переход на PHP 8.2

* refactoring

* datetime immutable

* fix github actions

* fix github actions

* add getDuration() into README

* changelog

.github/workflows/tests.yml

@@ -1,18 +1,18 @@
-name: PHPUnit
-on: [push]
+name: Tests
+on: [ push ]
 
 jobs:
   PHPUnit:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        PHP: [ "7.3", "7.4", "8.0", "8.1", "8.2" ]
     steps:
       - uses: actions/checkout@v3
       - uses: php-actions/composer@v6
+        with:
+          php_version: 8.2
       - name: PHPUnit Tests
         uses: php-actions/phpunit@master
         with:
           configuration: test/phpunit/phpunit.xml
           args: --testdox
           version: 9
+          php_version: 8.2

.gitignore

@@ -2,5 +2,6 @@
 /.idea
 
 composer.lock
+example.php
 
 /vendor

CHANGELOG.md

@@ -0,0 +1,14 @@
+# v3.0.0
+
+### Compatibility-breaking changes:
+- PHP version has been upgraded to 8.2.
+- The namespace `exceptions` has been renamed to `Exceptions`
+- The file `bootstrap.php` has been removed.
+- The `getTypeString()` method of the `Entry` class now returns an `EntryTypeEnum`.
+- `DateTime` has been changed to `DateTimeImmutable`.
+
+### Non-compatibility-breaking changes:
+- DTO classes are now readonly.
+- All parser exceptions now inherit from the `ParserException` class.
+- The Demo class has added a `getDuration()` method that returns the duration of the demo file in seconds.
+- An `EntryTypeEnum` enum has been added.

Makefile

@@ -1,3 +1,6 @@
+composer-bash:
+	docker run --rm -it -v `pwd`/:/app composer:2 bash
+
 composer-install:
 	docker run --rm -v `pwd`/:/app composer:2 composer install
 
@@ -20,5 +23,5 @@ run-php80-tests:
 run-php81-tests:
 	docker run --rm -v `pwd`/:/app php:8.1 /app/vendor/phpunit/phpunit/phpunit --testdox --bootstrap /app/vendor/autoload.php /app/test/phpunit
 
-run-php81-tests:
+run-php82-tests:
 	docker run --rm -v `pwd`/:/app php:8.2 /app/vendor/phpunit/phpunit/phpunit --testdox --bootstrap /app/vendor/autoload.php /app/test/phpunit

README.md

@@ -7,8 +7,7 @@
 
 This package is designed to obtain information from the demo of the servers or games on the Half-Life 1 engine.
 Installation is possible in two versions:
-1. Composer
-To install with composer, either run
+1. Install with composer, either run
 
 ```
 $ php composer.phar require vitalyart/hltv-demo-parser "*"
@@ -22,14 +21,6 @@ or add
 
 to the ```require``` section of your `composer.json` file.
 
-2. Manual installation (Without composer)
-
-Clone or download package from github and include bootstrap file
-
-```
-include '/path/to/hltv-demo-parser/src/bootstrap.php';
-```
-
 ```php
 $parser = new \VitalyArt\DemoParser\Parser();
 $parser->setDemoFile('/path/to/demo/pub-1609152130-de_dust2_2x2.dem');
@@ -42,6 +33,7 @@ $demo->getMapName();
 $demo->getClientName();
 $demo->getStartTime();
 $demo->getEndTime();
+$demo->getDuration();
 
 foreach($demo->getEntries() as $entry) {
     $entry->getTypeString();

composer.json

@@ -5,7 +5,7 @@
     "GPL-3.0-or-later"
   ],
   "require": {
-    "php": ">=7.3",
+    "php": "^8.2",
     "ext-mbstring": "*"
   },
   "require-dev": {

src/Demo.php

@@ -1,38 +1,27 @@
 <?php
 
+declare(strict_types=1);
+
 namespace VitalyArt\DemoParser;
 
-use DateTime;
+use DateTimeImmutable;
 
-class Demo
+readonly class Demo
 {
-    private $demoProtocol;
-    private $netProtocol;
-    private $mapName;
-    private $clientName;
-    private $entries;
-    private $startTime;
-    private $endTime;
-
     public function __construct(
-        int $demoProtocol,
-        int $netProtocol,
-        string $mapName,
-        string $clientName,
-        array $entries,
-        ?DateTime $startTime,
-        ?DateTime $endTime
+        private int $demoProtocol,
+        private int $netProtocol,
+        private string $mapName,
+        private string $clientName,
+        private array $entries,
+        private DateTimeImmutable|null $startTime,
+        private DateTimeImmutable|null $endTime,
+        private int|false $duration,
     )
     {
-        $this->demoProtocol = $demoProtocol;
-        $this->netProtocol = $netProtocol;
-        $this->mapName = $mapName;
-        $this->clientName = $clientName;
-        $this->entries = $entries;
-        $this->startTime = $startTime;
-        $this->endTime = $endTime;
+
     }
-    
+
     public function getDemoProtocol(): int
     {
         return $this->demoProtocol;
@@ -58,13 +47,18 @@ public function getEntries(): array
         return $this->entries;
     }
 
-    public function getStartTime(): ?DateTime
+    public function getStartTime(): DateTimeImmutable|null
     {
         return $this->startTime;
     }
 
-    public function getEndTime(): ?DateTime
+    public function getEndTime(): DateTimeImmutable|null
     {
         return $this->endTime;
     }
+
+    public function getDuration(): int|false
+    {
+        return $this->duration;
+    }
 }

src/Entry.php

@@ -1,65 +1,38 @@
 <?php
 
+declare(strict_types=1);
+
 namespace VitalyArt\DemoParser;
 
-class Entry
-{
-    private $typeString;
-    private $type;
-    private $description;
-    private $flags;
-    private $CDTrack;
-    private $trackTime;
-    private $frames;
-    private $offset;
-    private $fileLength;
+use VitalyArt\DemoParser\Enums\EntryTypeEnum;
 
-    /**
-     * @param string $typeString
-     * @param integer $type
-     * @param string $description
-     * @param integer $flags
-     * @param string $CDTrack
-     * @param float $trackTime
-     * @param integer $frames
-     * @param integer $offset
-     * @param integer $fileLength
-     */
+readonly class Entry
+{
     public function __construct(
-        string $typeString,
-        int $type,
-        string $description,
-        int $flags,
-        string $CDTrack,
-        float $trackTime,
-        int $frames,
-        int $offset,
-        int $fileLength
+        private EntryTypeEnum $typeString,
+        private int $type,
+        private string $description,
+        private int $flags,
+        private int $CDTrack,
+        private float $trackTime,
+        private int $frames,
+        private int $offset,
+        private int $fileLength,
     )
     {
-        $this->typeString = $typeString;
-        $this->type = $type;
-        $this->description = $description;
-        $this->flags = $flags;
-        $this->CDTrack = $CDTrack;
-        $this->trackTime = $trackTime;
-        $this->frames = $frames;
-        $this->offset = $offset;
-        $this->fileLength = $fileLength;
+
     }
 
     /**
      * Entry type
-     * @return string
      */
-    public function getTypeString(): string
+    public function getTypeString(): EntryTypeEnum
     {
         return $this->typeString;
     }
 
     /**
      * Integer entry type
-     * @return int
      */
     public function getType(): int
     {
@@ -68,7 +41,6 @@ public function getType(): int
 
     /**
      * Description
-     * @return string
      */
     public function getDescription(): string
     {
@@ -77,7 +49,6 @@ public function getDescription(): string
 
     /**
      * Flags
-     * @return int
      */
     public function getFlags(): int
     {
@@ -86,7 +57,6 @@ public function getFlags(): int
 
     /**
      * CD track
-     * @return string
      */
     public function getCDTrack(): string
     {
@@ -95,7 +65,6 @@ public function getCDTrack(): string
 
     /**
      * Track time
-     * @return float
      */
     public function getTrackTime(): float
     {
@@ -104,7 +73,6 @@ public function getTrackTime(): float
 
     /**
      * Frames
-     * @return int
      */
     public function getFrames(): int
     {
@@ -113,7 +81,6 @@ public function getFrames(): int
 
     /**
      * Offset
-     * @return int
      */
     public function getOffset(): int
     {
@@ -122,7 +89,6 @@ public function getOffset(): int
 
     /**
      * File length
-     * @return int
      */
     public function getFileLength(): int
     {

src/Enums/EntryTypeEnum.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Enums;
+
+enum EntryTypeEnum: string
+{
+    case LOADING  = 'loading';
+    case PLAYBACK = 'playback';
+}

src/Exceptions/FileNotExistsException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Exceptions;
+
+class FileNotExistsException extends ParserException
+{
+
+}

src/Exceptions/FileNotSpecifiedException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Exceptions;
+
+class FileNotSpecifiedException extends ParserException
+{
+
+}

src/Exceptions/IsNotADemoException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Exceptions;
+
+class IsNotADemoException extends ParserException
+{
+
+}

src/Exceptions/NotReadableException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Exceptions;
+
+class NotReadableException extends ParserException
+{
+
+}

src/Exceptions/ParserException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Exceptions;
+
+class ParserException extends \Exception
+{
+
+}

src/Exceptions/WrongExtensionException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VitalyArt\DemoParser\Exceptions;
+
+class WrongExtensionException extends ParserException
+{
+
+}