Merge pull request #5 from wavevision/feature/zip

Feature/zip

Author: rozsival

.gitignore

@@ -5,3 +5,4 @@
 /.phpunit.result.cache
 /temp/
 /vendor/
+test.zip

README.md

@@ -23,6 +23,7 @@ The package contains useful classes for:
 - [ContentTypes](./src/Utils/ContentTypes.php) – format extensions and filenames for content types
 - [DOM](./src/Utils/DOM) – create and format data attributes for HTML elements
 - [ExternalProgram](./src/Utils/ExternalProgram/Executor.php) – simple external command runner
+- [FileInfo](./src/Utils/FileInfo.php) – get file info (basename, dirname, extension etc.)
 - [Finder](./src/Utils/Finder.php) – adds sorting to [nette/finder](https://github.com/nette/finder)
 - [ImageInfo](./src/Utils/ImageInfo.php) – get image content type and size
 - [Json](./src/Utils/Json.php) – JSON pretty encoder with PHP and JavaScript indents
@@ -33,3 +34,4 @@ The package contains useful classes for:
 - [Strings](./src/Utils/Strings.php) – string helpers (encode, transform etc.)
 - [Tokenizer](./src/Utils/Tokenizer/Tokenizer.php) – get structure from file (e.g. a class)
 - [Validators](./src/Utils/Validators.php) – validate Czech and Slovak numbers (phone, personal, business)
+- [Zip](./src/Utils/Zip) – simple ZIP archive helper (compress, extract)

composer.json

@@ -34,7 +34,10 @@
     "sort-packages": true
   },
   "require": {
+    "ext-fileinfo": "*",
     "ext-iconv": "*",
+    "ext-json": "*",
+    "ext-zip": "*",
     "flow/jsonpath": "^0.4.0",
     "nette/finder": "^2.5",
     "nette/utils": "^3.1",

src/Utils/DOM/DataAttribute.php

@@ -44,6 +44,15 @@ public function asArray($value = null): array
 		return [$this->currentName => $this->value($value)];
 	}
 
+	/**
+	 * @param mixed $value
+	 * @return array<string>
+	 */
+	public function asTuple($value = null): array
+	{
+		return [$this->currentName, $this->value($value)];
+	}
+
 	/**
 	 * @param Html<mixed> $element
 	 * @param mixed $value

src/Utils/ExternalProgram/Executor.php

@@ -2,9 +2,13 @@
 
 namespace Wavevision\Utils\ExternalProgram;
 
+use Nette\StaticClass;
+
 class Executor
 {
 
+	use StaticClass;
+
 	public static function executeUnchecked(string $command): Result
 	{
 		exec($command . ' 2>&1', $output, $returnValue);

src/Utils/ExternalProgram/Result.php

@@ -2,9 +2,13 @@
 
 namespace Wavevision\Utils\ExternalProgram;
 
+use Nette\SmartObject;
+
 class Result
 {
 
+	use SmartObject;
+
 	private string $command;
 
 	/**

src/Utils/FileInfo.php

@@ -16,6 +16,8 @@ class FileInfo
 
 	private string $baseName;
 
+	private string $dirName;
+
 	private string $extension;
 
 	private string $contentType;
@@ -31,6 +33,7 @@ public function __construct(string $pathName)
 		}
 		$this->pathName = $pathName;
 		$this->baseName = basename($pathName);
+		$this->dirName = dirname($pathName);
 		$this->extension = pathinfo($pathName, PATHINFO_EXTENSION);
 		$this->contentType = (string)(new finfo(FILEINFO_MIME_TYPE))->file($pathName);
 		$this->size = (int)filesize($pathName);
@@ -42,14 +45,22 @@ public function getPathName(): string
 		return $this->pathName;
 	}
 
-	public function getBaseName(): string
+	public function getBaseName(bool $withoutExtension = false): string
 	{
+		if ($withoutExtension) {
+			return str_replace($this->getExtension(true), '', $this->baseName);
+		}
 		return $this->baseName;
 	}
 
-	public function getExtension(): string
+	public function getDirName(): string
+	{
+		return $this->dirName;
+	}
+
+	public function getExtension(bool $withDot = false): string
 	{
-		return $this->extension;
+		return $withDot ? '.' . $this->extension : $this->extension;
 	}
 
 	public function getContentType(): string

src/Utils/Zip/ZipArchive.php

@@ -0,0 +1,96 @@
+<?php declare (strict_types = 1);
+
+namespace Wavevision\Utils\Zip;
+
+use Nette\FileNotFoundException;
+use Nette\SmartObject;
+use Wavevision\Utils\FileInfo;
+use Wavevision\Utils\Path;
+use ZipArchive as Zip;
+
+class ZipArchive
+{
+
+	use SmartObject;
+
+	/**
+	 * @var ZipArchiveFile[]
+	 */
+	private array $files;
+
+	private string $path;
+
+	private Zip $zip;
+
+	public function __construct(string $path, ZipArchiveFile ...$files)
+	{
+		$this->files = $files;
+		$this->path = $path;
+		$this->zip = new Zip();
+	}
+
+	public function addFile(ZipArchiveFile $file): self
+	{
+		$this->files[] = $file;
+		return $this;
+	}
+
+	public function close(): self
+	{
+		$this->zip->close();
+		return $this;
+	}
+
+	public function compress(): self
+	{
+		foreach ($this->files as $file) {
+			$this->zip->addFile($this->getFilePath($file), $file->getName());
+		}
+		return $this->close();
+	}
+
+	public function extract(?string $dir = null): self
+	{
+		$this->zip->extractTo($dir ?? $this->getExtractDir());
+		return $this;
+	}
+
+	public function getName(): string
+	{
+		return basename($this->getPath());
+	}
+
+	public function getPath(): string
+	{
+		return $this->path;
+	}
+
+	public function read(): self
+	{
+		$this->zip->open($this->getPath());
+		return $this;
+	}
+
+	public function write(): self
+	{
+		$flag = is_file($this->getPath()) ? Zip::OVERWRITE : Zip::CREATE;
+		$this->zip->open($this->getPath(), $flag);
+		return $this;
+	}
+
+	private function getExtractDir(): string
+	{
+		$fileInfo = new FileInfo($this->getPath());
+		return Path::join($fileInfo->getDirName(), $fileInfo->getBaseName(true));
+	}
+
+	private function getFilePath(ZipArchiveFile $file): string
+	{
+		$path = $file->getPath();
+		if (!file_exists($path)) {
+			throw new FileNotFoundException("Zip archive file '$path' not found.");
+		}
+		return $path;
+	}
+
+}

src/Utils/Zip/ZipArchiveFile.php

@@ -0,0 +1,32 @@
+<?php declare (strict_types = 1);
+
+namespace Wavevision\Utils\Zip;
+
+use Nette\SmartObject;
+
+final class ZipArchiveFile
+{
+
+	use SmartObject;
+
+	private string $name;
+
+	private string $path;
+
+	public function __construct(string $path, ?string $name = null)
+	{
+		$this->name = $name ?? basename($path);
+		$this->path = $path;
+	}
+
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
+	public function getPath(): string
+	{
+		return $this->path;
+	}
+
+}

tests/UtilsTests/DOM/DataAttributeTest.php

@@ -26,6 +26,11 @@ public function testAsString(): void
 		$this->assertEquals('data-prefix-test=""', (string)$this->createDataAttribute('prefix'));
 	}
 
+	public function testAsTuple(): void
+	{
+		$this->assertEquals(['data-test', ''], $this->createDataAttribute()->asTuple());
+	}
+
 	public function testAssign(): void
 	{
 		$attribute = $this->createDataAttribute();