Merge remote-tracking branch 'origin/main'

# Conflicts:
#	sources/classes/File.php

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "62046e22c8307ed8e1f622a0f7bd7a05",
+    "content-hash": "0c5a35b9c8987ac3fd0f7480fea87d4c",
     "packages": [],
     "packages-dev": [
         {

sources/classes/File.php

@@ -0,0 +1,148 @@
+<?php
+
+namespace goodboyalex\php_components_pack\classes;
+
+/**
+ * Класс, реализующий функционал работы с файлами и выполнение операций над файлами одной командой.
+ *
+ * @author Александр Бабаев
+ * @package php_components_pack
+ * @version 1.0
+ * @since 1.0.21
+ */
+final class File
+{
+    /**
+     * Получает список файлов в директории и поддиректориях, соответствующей шаблону $pattern.
+     *
+     * @param string $dir Родительская директория
+     * @param string $pattern Шаблон имени файла
+     *
+     * @return false|array Список файлов или false в случае ошибки
+     */
+    public static function FindFiles (string $dir, string $pattern = '*.php'): false|array
+    {
+        // Получаем список файлов и каталогов в текущей директории
+        $files = glob("$dir/$pattern");
+
+        // Если произошла ошибка
+        if ($files === false)
+            // - то возвращаем false
+            return false;
+
+        // Перебираем поддиректории
+        foreach (glob("$dir/*", GLOB_ONLYDIR | GLOB_NOSORT) as $subDir) {
+            // - если ошибка
+            if ($subDir === false)
+                // - то пропускаем
+                continue;
+
+            // - рекурсивный вызов для каждой поддиректории
+            $files = array_merge($files, self::FindFiles($subDir, $pattern));
+        }
+
+        // Возвращаем список файлов
+        return $files;
+    }
+
+    /**
+     * Получает имя файла без пути к нему и расширения.
+     *
+     * @param string $fileName Полное имя файла с путем к нему.
+     *
+     * @return string Имя файла без пути к нему и расширения.
+     */
+    public static function ExtractFileNameWithoutExtension (string $fileName): string
+    {
+        // Имя файла без пути к нему
+        $fileNameOnly = self::ExtractFileName($fileName);
+
+        // Расширение файла
+        $fileExtension = self::ExtractFileExtension($fileName);
+
+        // Возвращаем имя файла без пути к нему и расширения.
+        return substr($fileNameOnly, 0, -strlen($fileExtension) - 1);
+    }
+
+    /**
+     * Получает имя файла без пути к нему, но с расширением.
+     *
+     * @param string $fileName Полное имя файла с путем к нему.
+     *
+     * @return string Имя файла без пути к нему, но с расширением.
+     */
+    public static function ExtractFileName (string $fileName): string
+    {
+        return basename($fileName);
+    }
+
+    /**
+     * Получает расширение файла.
+     *
+     * @param string $fileName Имя файла с путем к нему.
+     *
+     * @return string Расширение файла.
+     */
+    public static function ExtractFileExtension (string $fileName): string
+    {
+
+        return pathinfo($fileName, PATHINFO_EXTENSION);
+    }
+
+    /**
+     * Получает относительный путь к файлу, относительно заданной папки
+     *
+     * @param string $fullPath Полный путь к файлу
+     * @param string $basePath Вырезаемый путь (с начала)
+     *
+     * @return false|string Относительный путь к файлу
+     */
+    public static function GetRelativePath (string $fullPath, string $basePath): false|string
+    {
+        return stripos($fullPath, $basePath) !== false ? str_replace($basePath, "", $fullPath) : false;
+    }
+
+    /**
+     * Удаляет директорию вместе со всеми файлами и поддиректориями.
+     *
+     * @param string $directory Полный путь к директории.
+     *
+     * @return bool Результат удаления.
+     */
+    public static function RemoveDir (string $directory): bool
+    {
+        // Если директории не существует
+        if (!file_exists($directory))
+            // - то удаление не требуется
+            return true;
+
+        // Если это не директория
+        if (!is_dir($directory))
+            // - то удаляем файл
+            return unlink($directory);
+
+        // Перебираем все файлы и поддиректории
+        foreach (scandir($directory) as $item) {
+            // - если это '.' или '..'
+            if ($item == '.' || $item == '..')
+                // -- то пропускаем
+                continue;
+
+            // - задаём переменную - целевую директорию
+            $target = $directory . DIRECTORY_SEPARATOR . $item;
+
+            // - если это директория
+            if (is_dir($target))
+                // -- то рекурсивно удаляем её
+                if (!self::RemoveDir($target))
+                    // --- и прерываем удаление директории, если ошибка
+                    return false;
+                else
+                    // -- иначе удаляем файл
+                    unlink($target);
+        }
+
+        // Удаляем директорию
+        return rmdir($directory);
+    }
+}

sources/classes/Tuple.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace goodboyalex\php_components_pack\classes;
+
+use ArrayAccess;
+use ArrayIterator;
+use Countable;
+use Exception;
+use goodboyalex\php_components_pack\interfaces\ISerializable;
+use IteratorAggregate;
+use Traversable;
+
+/**
+ * Класс, реализующий функционал кортежей от C#.
+ *
+ * @author Александр Бабаев
+ * @package php_components_pack
+ * @version 1.2
+ * @since 1.0.20
+ */
+final class Tuple implements ISerializable, ArrayAccess, IteratorAggregate, Countable
+{
+    /**
+     * @var array Массив значений кортежа.
+     */
+    private array $Values;
+
+    /**
+     * Конструктор кортежа.
+     *
+     * @param mixed ...$values Значения кортежа.
+     */
+    public function __construct (...$values)
+    {
+        $this->Values = $values;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function Serialize (): string
+    {
+        return serialize($this->Values);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function UnSerialize (string $serialized): void
+    {
+        $this->Values = unserialize($serialized);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetExists (mixed $offset): bool
+    {
+        return isset($this->Values[$offset]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetGet (mixed $offset): mixed
+    {
+        // Если ключ не является целым числом
+        if (!is_int($offset))
+            // - возвращаем null
+            return null;
+
+        // Возвращаем значение кортежа по индексу
+        return $this->Get($offset);
+    }
+
+    /**
+     * Возвращает значение кортежа по индексу.
+     *
+     * @param int $index Индекс значения.
+     *
+     * @return mixed Значение кортежа по индексу.
+     */
+    public function Get (int $index): mixed
+    {
+        return $this->Values[$index] ?? null;
+    }
+
+    /**
+     * @inheritDoc
+     * @throws Exception Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed
+     *     after creation!
+     */
+    public function offsetSet (mixed $offset, mixed $value): void
+    {
+        throw new Exception('Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed after creation!');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetUnset (mixed $offset): void
+    {
+        unset($this->Values[$offset]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIterator (): Traversable
+    {
+        return new ArrayIterator($this->Values);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function count (): int
+    {
+        return count($this->Values);
+    }
+}

tests/classes/FileTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace goodboyalex\php_components_pack\tests\classes;
+
+use goodboyalex\php_components_pack\classes\File;
+use PHPUnit\Framework\TestCase;
+
+class FileTest extends TestCase
+{
+    public function testExtractFileName ()
+    {
+        $this->PrepareForTest();
+
+        $this->assertEquals("test.txt", File::ExtractFileName("c:\\tmp\\test.txt"));
+        $this->assertEquals("test.txt", File::ExtractFileName("c:/tmp/test.txt"));
+        $this->assertEquals("test.txt", File::ExtractFileName("\\tmp\\test.txt"));
+    }
+
+    private function PrepareForTest (): void
+    {
+        require_once __DIR__ . '/../../sources/classes/File.php';
+    }
+
+    public function testFindFiles ()
+    {
+        $this->PrepareForTest();
+
+        $result = File::FindFiles(__DIR__);
+
+        $this->assertIsArray($result);
+        $this->assertCount(8, $result);
+    }
+
+    public function testGetRelativePath ()
+    {
+        $this->PrepareForTest();
+
+        $fullPath = "c:\\source\\tmp\\test.txt";
+
+        $basePath = "c:\\source\\";
+
+        $this->assertEquals("tmp\\test.txt", File::GetRelativePath($fullPath, $basePath));
+    }
+
+    public function testExtractFileExtension ()
+    {
+        $this->PrepareForTest();
+
+        $this->assertEquals("txt", File::ExtractFileExtension("c:\\tmp\\test.txt"));
+        $this->assertEquals("txt", File::ExtractFileExtension("c:/tmp/test.txt"));
+        $this->assertEquals("txt", File::ExtractFileExtension("\\tmp\\test.txt"));
+    }
+
+    public function testExtractFileNameWithoutExtension ()
+    {
+        $this->PrepareForTest();
+
+        $this->assertEquals("test", File::ExtractFileNameWithoutExtension("c:\\tmp\\test.txt"));
+        $this->assertEquals("test", File::ExtractFileNameWithoutExtension("c:/tmp/test.txt"));
+        $this->assertEquals("test", File::ExtractFileNameWithoutExtension("\\tmp\\test.txt"));
+    }
+}

tests/classes/TupleTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace goodboyalex\php_components_pack\tests\classes;
+
+use Exception;
+use goodboyalex\php_components_pack\classes\Tuple;
+use PHPUnit\Framework\TestCase;
+
+class TupleTest extends TestCase
+{
+    public function testTuple ()
+    {
+        $this->PrepareForTest();
+
+        $tuple = new Tuple(1, 'string', ['array1', 'array2', 'array3']);
+
+        // Проверка на то, что возвращает значение кортежа при запросе значения по индексу
+        $this->assertEquals(1, $tuple->Get(0));
+        $this->assertEquals('string', $tuple->Get(1));
+        $this->assertEquals(['array1', 'array2', 'array3'], $tuple->Get(2));
+
+        // Проверка на то, что возвращает переменные
+        [$firstElement, $secondElement, $thirdElement] = $tuple;
+        $this->assertEquals(1, $firstElement);
+        $this->assertEquals('string', $secondElement);
+        $this->assertEquals(['array1', 'array2', 'array3'], $thirdElement);
+
+        // Проверка на то, что выбрасывает исключение при попытке задать данные в кортеж после его создания
+        $this->expectException(Exception::class);
+        $tuple[] = 'New data';
+    }
+
+    private function PrepareForTest (): void
+    {
+        require_once __DIR__ . '/../../sources/classes/Tuple.php';
+    }
+}