feat(asFileName): the function will now return an instance of CatPaw\…

…Cpre\FileName

This new class allows you to manage file names located within the file system or within the .phar archive (if one exists).

composer.json

@@ -42,13 +42,10 @@
  "dev:fix": "php -dxdebug.mode=off ./vendor/bin/php-cs-fixer fix .",
  "dev:precommit": "pre-commit install && pre-commit autoupdate",
  "dev:tips": "[ ! -f catpaw.phar ] && echo '' || php catpaw.phar --tips",
- "download:psalm": "[ ! -f psalm.phar ] && wget https://github.com/vimeo/psalm/releases/latest/download/psalm.phar || echo ''",
  "post-autoload-dump": [
- "@download:psalm",
  "@dev:tips"
  ],
  "post-create-project-cmd": [
- "@download:psalm",
  "@dev:tips"
  ]
  },

dev-gui-example.sh

@@ -1,8 +1,8 @@
 #!/bin/bash
 
-pushd src/lib/Gui/lib &&\
-go build -o main.so -buildmode=c-shared main.go &&\
-cpp -P ./main.h ./main.static.h &&\
-popd || exit
+# pushd src/lib/Gui/lib &&\
+# go build -o main.so -buildmode=c-shared main.go &&\
+# cpp -P ./main.h ./main.static.h &&\
+# popd || exit
 
 php -dxdebug.mode=debug -dxdebug.start_with_request=yes -dphar.readonly=0 ./bin/start --libraries='./src/lib' --entry='./src/gui-example.php'

src/gui-example.php

@@ -1,5 +1,6 @@
 <?php
 use function CatPaw\Core\error;
+
 use function CatPaw\Core\goffi;
 use CatPaw\Gui\Contract;
 

src/lib/Core/FileName.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace CatPaw\Core;
+
+use Phar;
+use Stringable;
+
+class FileName implements Stringable {
+ /**
+ * Create a file name starting from a `$base` directory.
+ * @param array<string> $base
+ * @return FileName
+ */
+ public static function create(array $path):self {
+ return new self($path);
+ }
+
+ private bool $checkPhar = false;
+
+ /**
+ * @param array<string> $path
+ */
+ private function __construct(private array $path) {
+ }
+
+ /**
+ * Given a `$path`, create a file name.
+ * @param array<string> $path
+ * @return string
+ */
+ private static function asFileName(array $path):string {
+ $parts = [];
+ $count = count($path);
+ for ($index = 0; $index < $count; $index++) {
+ $pathName = $path[$index];
+ if ($index < $count - 1 && !str_ends_with($pathName, '/')) {
+ $pathName = "$pathName/";
+ }
+ $parts[] = $pathName;
+ }
+ return join($parts)?:'';
+ }
+
+ /**
+ * Lookup the file in in the `.phar` before falling back to the file system.
+ * @return self
+ */
+ public function withPhar(): self {
+ $this->checkPhar = true;
+ return $this;
+ }
+
+ public function __toString(): string {
+ if (isPhar()) {
+ $phar = Phar::running();
+ $localizedFileName = str_replace("$phar/", '', self::asFileName($this->path));
+
+ if ($this->checkPhar) {
+ $pharFileName = "$phar/$localizedFileName";
+ if (!file_exists($pharFileName)) {
+ return realpath($localizedFileName);
+ }
+ return $pharFileName;
+ }
+ return realpath($localizedFileName);
+ } else {
+ return realpath(self::asFileName($this->path));
+ }
+ }
+}

src/scripts/Core/functions.php

@@ -349,20 +349,11 @@ function stop(string|Error $error) {
 
 /**
  * Given a `$path`, create a file name.
- * @param string ...$path
- * @return string
+ * @param string  ...$path
+ * @return FileName
  */
-function asFileName(string ...$path):string {
- $parts = [];
- $count = count($path);
- for ($index = 0; $index < $count; $index++) {
- $pathName = $path[$index];
- if ($index < $count - 1 && !str_ends_with($pathName, '/')) {
- $pathName = "$pathName/";
- }
- $parts[] = $pathName;
- }
- return realpath(join($parts))?:'';
+function asFileName(string ...$path):FileName {
+ return FileName::create($path);
 }
 
 /**
@@ -372,7 +363,8 @@ function asFileName(string ...$path):string {
  */
 function asPharFileName(string ...$path):string {
  if (isPhar()) {
- $phar = Phar::running();
+ $phar = Phar::running();
+
  $path = [$phar, ...$path];
  $parts = [];
  $count = count($path);