Merge pull request #39 from 8fold/go-deeper-with-content

BC: Require Path and Filename instances
8fold · Jan 20, 2024 · 85fa3b7 · 85fa3b7
2 parents 129a33b + 398a02a
commit 85fa3b7
Show file tree

Hide file tree

Showing 33 changed files with 232 additions and 360 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/FileSystem/Directories/PrivateDirectory.php b/src/FileSystem/Directories/PrivateDirectory.php
@@ -16,18 +16,12 @@ final class PrivateDirectory implements Findable, Stringable
 {
     private readonly SplFileInfo $fileInfo;
 
-    public static function inRoot(
-        Root $root,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Path $at): self
+    {
         return new self($root, $at);
     }
 
-    // TODO: mark as final
-    private function __construct(
+    final private function __construct(
         private readonly Root $root, // @phpstan-ignore-line
         private readonly Path $at // @phpstan-ignore-line
     ) {

diff --git a/src/FileSystem/Directories/PublicDirectory.php b/src/FileSystem/Directories/PublicDirectory.php
@@ -17,20 +17,13 @@ final class PublicDirectory implements Findable, Stringable
 {
     private readonly SplFileInfo $fileInfo;
 
-    public static function inRoot(
-        Root $root,
-        string|Path $at = ''
-    ): self {
+    public static function inRoot(Root $root, Path $at): self
+    {
         return self::inPublicRoot($root->publicRoot(), $at);
     }
 
-    public static function inPublicRoot(
-        PublicRoot $root,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inPublicRoot(PublicRoot $root, Path $at): self
+    {
         return new self($root, $at);
     }
 

diff --git a/src/FileSystem/Files/PrivateFile.php b/src/FileSystem/Files/PrivateFile.php
@@ -18,14 +18,8 @@ final class PrivateFile implements Findable, Stringable
 {
     private readonly SplFileInfo $fileInfo;
 
-    public static function inRoot(
-        Root $root,
-        string|Filename $filename, // TODO: Create filename class
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Filename $filename, Path $at): self
+    {
         return self::inPrivateDirectory(
             PrivateDirectory::inRoot($root, $at),
             $filename
@@ -34,15 +28,12 @@ public static function inRoot(
 
     public static function inPrivateDirectory(
         PrivateDirectory $directory,
-        string|Filename $filename
+        Filename $filename
     ): self {
-        if (is_string($filename)) {
-            $filename = Filename::fromString($filename);
-        }
         return new self($directory, $filename);
     }
 
-    private function __construct(
+    final private function __construct(
         private readonly PrivateDirectory $directory, // @phpstan-ignore-line
         private readonly Filename $filename // @phpstan-ignore-line
     ) {

diff --git a/src/FileSystem/Files/PublicContentFile.php b/src/FileSystem/Files/PublicContentFile.php
@@ -7,6 +7,7 @@
 use Eightfold\Amos\Php\Interfaces\Stringable;
 
 use Eightfold\Amos\FileSystem\Path;
+use Eightfold\Amos\FileSystem\Filename;
 
 use Eightfold\Amos\FileSystem\Directories\Root;
 use Eightfold\Amos\FileSystem\Directories\PublicRoot;
@@ -17,23 +18,16 @@ final class PublicContentFile implements Findable, Stringable
 {
     private const FILENAME = 'content.md';
 
-    public static function inRoot(
-        Root $root,
-        string|Path $at = ''
-    ): self {
+    public static function inRoot(Root $root, Path $at): self
+    {
         return self::inPublicRoot($root->publicRoot(), $at);
     }
 
-    public static function inPublicRoot(
-        PublicRoot $root,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
-        return new self(
-            PublicFile::inPublicRoot($root, self::FILENAME, $at)
-        );
+    public static function inPublicRoot(PublicRoot $root, Path $at): self
+    {
+        $filename = Filename::fromString(self::FILENAME);
+        $pFile    = PublicFile::inPublicRoot($root, $filename, $at);
+        return new self($pFile);
     }
 
     private function __construct(

diff --git a/src/FileSystem/Files/PublicFile.php b/src/FileSystem/Files/PublicFile.php
@@ -18,26 +18,16 @@ final class PublicFile implements Findable, Stringable
 {
     private readonly SplFileInfo $fileInfo;
 
-    public static function inRoot(
-        Root $root,
-        string|Filename $filename,
-        string|Path $at = ''
-    ): self {
+    public static function inRoot(Root $root, Filename $filename, Path $at): self
+    {
         return self::inPublicRoot($root->publicRoot(), $filename, $at);
     }
 
     public static function inPublicRoot(
         PublicRoot $root,
-        string|Filename $filename, // TODO: convert to class
-        string|Path $at = ''
+        Filename $filename,
+        Path $at
     ): self {
-        if (is_string($filename)) {
-            $filename = Filename::fromString($filename);
-        }
-
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
         return new self($root, $filename, $at);
     }
 

diff --git a/src/FileSystem/Files/PublicMetaFile.php b/src/FileSystem/Files/PublicMetaFile.php
@@ -7,6 +7,7 @@
 use Eightfold\Amos\Php\Interfaces\Stringable;
 
 use Eightfold\Amos\FileSystem\Path;
+use Eightfold\Amos\FileSystem\Filename;
 
 use Eightfold\Amos\FileSystem\Directories\Root;
 use Eightfold\Amos\FileSystem\Directories\PublicRoot;
@@ -17,29 +18,20 @@ final class PublicMetaFile implements Findable, Stringable
 {
     private const FILENAME = 'meta.json';
 
-    public static function inRoot(
-        Root $root,
-        string|Path $at = ''
-    ): self {
+    public static function inRoot(Root $root, Path $at): self
+    {
         return self::inPublicRoot($root->publicRoot(), $at);
     }
 
-    public static function inPublicRoot(
-        PublicRoot $root,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
-
-        return new self(
-            PublicFile::inPublicRoot($root, self::FILENAME, $at)
-        );
+    public static function inPublicRoot(PublicRoot $root, Path $at): self
+    {
+        $filename = Filename::fromString(self::FILENAME);
+        $pFile    = PublicFile::inPublicRoot($root, $filename, $at);
+        return new self($pFile);
     }
 
-    private function __construct(
-        private readonly PublicFile $publicFile
-    ) {
+    private function __construct(private readonly PublicFile $publicFile)
+    {
     }
 
     public function notFound(): bool

diff --git a/src/FileSystem/Path.php b/src/FileSystem/Path.php
@@ -49,6 +49,20 @@ public function parts(): array
         );
     }
 
+    public function toStringWithTrailingSlash(): string
+    {
+        $base = $this->toString();
+        if ($base === '/') {
+            return '/';
+        }
+
+        if (str_ends_with($base, '/')) {
+            return $base;
+        }
+
+        return $base . '/';
+    }
+
     public function toString(): string
     {
         return $this->path;

diff --git a/src/ObjectsFromJson/PrivateObject.php b/src/ObjectsFromJson/PrivateObject.php
@@ -9,6 +9,7 @@
 use Eightfold\Amos\Php\Interfaces\Findable;
 
 use Eightfold\Amos\FileSystem\Path;
+use Eightfold\Amos\FileSystem\Filename;
 
 use Eightfold\Amos\FileSystem\Directories\Root;
 use Eightfold\Amos\PlainText\PrivateJson as PlainTextPrivateJson;
@@ -17,14 +18,8 @@ final class PrivateObject implements Findable
 {
     private StdClass $object;
 
-    public static function inRoot(
-        Root $root,
-        string $filename,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Filename $filename, Path $at): self
+    {
         return new self(
             PlainTextPrivateJson::inRoot($root, $filename, $at)
         );

diff --git a/src/ObjectsFromJson/PublicMeta.php b/src/ObjectsFromJson/PublicMeta.php
@@ -17,13 +17,8 @@ final class PublicMeta implements Findable
 {
     private StdClass $object;
 
-    public static function inRoot(
-        Root $root,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Path $at): self
+    {
         return new self(
             PlainTextPublicMeta::inRoot($root, $at)
         );

diff --git a/src/ObjectsFromJson/PublicObject.php b/src/ObjectsFromJson/PublicObject.php
@@ -9,6 +9,7 @@
 use Eightfold\Amos\Php\Interfaces\Findable;
 
 use Eightfold\Amos\FileSystem\Path;
+use Eightfold\Amos\FileSystem\Filename;
 
 use Eightfold\Amos\FileSystem\Directories\Root;
 use Eightfold\Amos\PlainText\PublicJson as PlainTextPublicJson;
@@ -17,14 +18,8 @@ final class PublicObject implements Findable
 {
     private StdClass $object;
 
-    public static function inRoot(
-        Root $root,
-        string $filename,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Filename $filename, Path $at): self
+    {
         return new self(
             PlainTextPublicJson::inRoot($root, $filename, $at)
         );

diff --git a/src/PlainText/PrivateFile.php b/src/PlainText/PrivateFile.php
@@ -4,23 +4,19 @@
 namespace Eightfold\Amos\PlainText;
 
 use Eightfold\Amos\FileSystem\Path;
+use Eightfold\Amos\FileSystem\Filename;
 
 use Eightfold\Amos\FileSystem\Directories\Root;
+
 use Eightfold\Amos\FileSystem\Files\PrivateFile as FileSystemPrivateFile;
 
 use Eightfold\Amos\Php\Interfaces\Findable;
 use Eightfold\Amos\Php\Interfaces\Stringable;
 
 final class PrivateFile implements Findable, Stringable
 {
-    public static function inRoot(
-        Root $root,
-        string $filename,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Filename $filename, Path $at): self
+    {
         return new self(
             FileSystemPrivateFile::inRoot($root, $filename, $at)
         );

diff --git a/src/PlainText/PrivateJson.php b/src/PlainText/PrivateJson.php
@@ -4,23 +4,19 @@
 namespace Eightfold\Amos\PlainText;
 
 use Eightfold\Amos\FileSystem\Path;
+use Eightfold\Amos\FileSystem\Filename;
 
 use Eightfold\Amos\FileSystem\Directories\Root;
+
 use Eightfold\Amos\FileSystem\Files\PrivateFile;
 
 use Eightfold\Amos\Php\Interfaces\Findable;
 use Eightfold\Amos\Php\Interfaces\Stringable;
 
 final class PrivateJson implements Findable, Stringable
 {
-    public static function inRoot(
-        Root $root,
-        string $filename,
-        string|Path $at = ''
-    ): self {
-        if (is_string($at)) {
-            $at = Path::fromString($at);
-        }
+    public static function inRoot(Root $root, Filename $filename, Path $at): self
+    {
         return new self(
             PrivateFile::inRoot($root, $filename, $at)
         );