refact: Get rid of Properties trait

Author: lukasbestle

src/classes/Instance.php

@@ -6,7 +6,6 @@
 use Kirby\Exception\Exception;
 use Kirby\Exception\LogicException;
 use Kirby\Toolkit\I18n;
-use Kirby\Toolkit\Properties;
 
 /**
  * Instance
@@ -20,8 +19,6 @@
  */
 class Instance
 {
-	use Properties;
-
 	/**
 	 * Cache for the changes object for this instance
 	 */
@@ -40,7 +37,7 @@ class Instance
 	/**
 	 * Current commit of this instance
 	 */
-	protected string|null $currentCommit = null;
+	protected string|null $currentCommit;
 
 	/**
 	 * Instance name that is displayed in the Panel
@@ -59,7 +56,11 @@ class Instance
 	 */
 	public function __construct(array $props)
 	{
-		$this->setProperties($props);
+		$this->color         = $props['color'];
+		$this->contentRoot   = rtrim($props['contentRoot'], '/\\');
+		$this->currentCommit = $props['currentCommit'] ?? null;
+		$this->name          = $props['name'];
+		$this->plugin        = $props['plugin'];
 
 		// validate that the instance has a Git repo set up
 		try {
@@ -279,16 +280,18 @@ public function setCurrentCommit(string|null $currentCommit = null): self
 	 */
 	public function toArray(): array
 	{
-		$array = $this->propertiesToArray();
-		$array['changes']   = $this->changes()->overall();
-		$array['isCurrent'] = $this->isCurrent();
-
 		$version = $this->version();
-		$array['version']      = ($version !== null)? $version->name() : null;
-		$array['versionLabel'] = ($version !== null)? $version->label() : null;
 
-		ksort($array);
-		return $array;
+		return [
+			'changes'       => $this->changes()->overall(),
+			'color'         => $this->color(),
+			'contentRoot'   => $this->contentRoot(),
+			'currentCommit' => $this->currentCommit(),
+			'isCurrent'     => $this->isCurrent(),
+			'name'          => $this->name(),
+			'version'       => ($version !== null) ? $version->name() : null,
+			'versionLabel'  => ($version !== null) ? $version->label() : null,
+		];
 	}
 
 	/**
@@ -302,40 +305,4 @@ public function version(): Version|null
 
 		return $this->plugin->versions()->findBy('commit', $this->currentCommit());
 	}
-
-	/**
-	 * Sets the CSS color for display in the Panel
-	 */
-	protected function setColor(string $color): self
-	{
-		$this->color = $color;
-		return $this;
-	}
-
-	/**
-	 * Sets the path to the content directory
-	 */
-	protected function setContentRoot(string $contentRoot): self
-	{
-		$this->contentRoot = rtrim($contentRoot, '/\\');
-		return $this;
-	}
-
-	/**
-	 * Sets the instance name that is displayed in the Panel
-	 */
-	protected function setName(string $name): self
-	{
-		$this->name = $name;
-		return $this;
-	}
-
-	/**
-	 * Sets the instance of the Plugin class
-	 */
-	protected function setPlugin(Plugin $plugin): self
-	{
-		$this->plugin = $plugin;
-		return $this;
-	}
 }

src/classes/Version.php

@@ -8,7 +8,6 @@
 use Kirby\Filesystem\F;
 use Kirby\Toolkit\Collection;
 use Kirby\Toolkit\I18n;
-use Kirby\Toolkit\Properties;
 
 /**
  * Version
@@ -22,8 +21,6 @@
  */
 class Version
 {
-	use Properties;
-
 	/**
 	 * Commit hash of this version
 	 */
@@ -32,17 +29,17 @@ class Version
 	/**
 	 * Creation timestamp
 	 */
-	protected int|null $created = null;
+	protected int|null $created;
 
 	/**
 	 * Email address of the creator
 	 */
-	protected string|null $creatorEmail = null;
+	protected string|null $creatorEmail;
 
 	/**
 	 * Name of the creator
 	 */
-	protected string|null $creatorName = null;
+	protected string|null $creatorName;
 
 	/**
 	 * Custom label
@@ -58,7 +55,7 @@ class Version
 	 * Name of the instance where the version was
 	 * originally created
 	 */
-	protected string|null $originInstance = null;
+	protected string|null $originInstance;
 
 	/**
 	 * Instance of the Plugin class
@@ -70,7 +67,14 @@ class Version
 	 */
 	public function __construct(array $props)
 	{
-		$this->setProperties($props);
+		$this->commit         = $props['commit'];
+		$this->created        = $this->normalizeCreated($props['created'] ?? null);
+		$this->creatorEmail   = $this->normalizeCreatorEmail($props['creatorEmail'] ?? null);
+		$this->creatorName    = $this->normalizeCreatorName($props['creatorName'] ?? null);
+		$this->label          = $props['label'];
+		$this->name           = $props['name'];
+		$this->originInstance = $props['originInstance'] ?? null;
+		$this->plugin         = $props['plugin'];
 	}
 
 	/**
@@ -229,26 +233,22 @@ public function originInstance(): string|null
 	 */
 	public function toArray(): array
 	{
-		$array = $this->propertiesToArray();
-		$array['instances'] = $this->instances()->keys();
-
-		ksort($array);
-		return $array;
-	}
-
-	/**
-	 * Sets the commit hash of this version
-	 */
-	protected function setCommit(string $commit): self
-	{
-		$this->commit = $commit;
-		return $this;
+		return [
+			'commit'         => $this->commit(),
+			'created'        => $this->created(),
+			'creatorEmail'   => $this->creatorEmail(),
+			'creatorName'    => $this->creatorName(),
+			'instances'      => $this->instances()->keys(),
+			'label'          => $this->label(),
+			'name'           => $this->name(),
+			'originInstance' => $this->originInstance(),
+		];
 	}
 
 	/**
-	 * Sets the creation timestamp
+	 * Normalizes the creation timestamp for the property
 	 */
-	protected function setCreated(int|string|null $created = null): self
+	protected function normalizeCreated(int|string|null $created): int|null
 	{
 		if (is_string($created) === true) {
 			$created = $created ? strtotime($created) : null;
@@ -261,76 +261,34 @@ protected function setCreated(int|string|null $created = null): self
 			]);
 		}
 
-		$this->created = $created;
-		return $this;
+		return $created;
 	}
 
 	/**
-	 * Sets the email address of the creator
+	 * Normalizes the email address of the creator for the property
 	 */
-	protected function setCreatorEmail(string|null $creatorEmail = null): self
+	protected function normalizeCreatorEmail(string|null $creatorEmail): string|null
 	{
 		// Git will output an empty string if the value is not available
-		if ($creatorEmail === '') {
-			$creatorEmail = null;
-		} elseif ($creatorEmail !== null) {
-			// trim the angle brackets around the email address
-			// that come from Git's output
-			$creatorEmail = trim($creatorEmail, '<>');
+		if ($creatorEmail === '' || $creatorEmail === null) {
+			return null;
 		}
 
-		$this->creatorEmail = $creatorEmail;
-		return $this;
+		// trim the angle brackets around the email address
+		// that come from Git's output
+		return trim($creatorEmail, '<>');
 	}
 
 	/**
-	 * Sets the name of the creator
+	 * Normalizes the name of the creator for the property
 	 */
-	protected function setCreatorName(string|null $creatorName = null): self
+	protected function normalizeCreatorName(string|null $creatorName): string|null
 	{
 		// Git will output an empty string if the value is not available
 		if ($creatorName === '') {
-			$creatorName = null;
+			return null;
 		}
 
-		$this->creatorName = $creatorName;
-		return $this;
-	}
-
-	/**
-	 * Sets the custom label
-	 */
-	protected function setLabel(string $label): self
-	{
-		$this->label = $label;
-		return $this;
-	}
-
-	/**
-	 * Sets the unique version name
-	 */
-	protected function setName(string $name): self
-	{
-		$this->name = $name;
-		return $this;
-	}
-
-	/**
-	 * Sets the name of the instance where
-	 * the version was originally created
-	 */
-	protected function setOriginInstance(string|null $originInstance = null): self
-	{
-		$this->originInstance = $originInstance;
-		return $this;
-	}
-
-	/**
-	 * Sets the instance of the Plugin class
-	 */
-	protected function setPlugin(Plugin $plugin): self
-	{
-		$this->plugin = $plugin;
-		return $this;
+		return $creatorName;
 	}
 }

tests/Versions/InstanceTest.php

@@ -47,7 +47,12 @@ public function testConstructErrorNoGitRepo()
 			'Git repo, please either initialize a new repo or connect it as a worktree'
 		);
 
-		$this->instance->clone(['contentRoot' => '/dev/null']);
+		new Instance([
+			'name'        => 'Test Instance',
+			'contentRoot' => '/dev/null',
+			'color'       => 'black',
+			'plugin'      => $this->plugin
+		]);
 	}
 
 	/**
@@ -123,8 +128,11 @@ public function testIsCurrent()
 		$this->assertTrue($this->instance->isCurrent());
 
 		mkdir($this->contentRoot1 . '/dir');
-		$instance = $this->instance->clone([
-			'contentRoot' => $this->contentRoot1 . '/dir'
+		$instance = new Instance([
+			'name'          => 'Test Instance',
+			'contentRoot'   => $this->contentRoot1 . '/dir',
+			'color'         => 'black',
+			'plugin'        => $this->plugin
 		]);
 		$this->assertFalse($instance->isCurrent());
 	}
@@ -135,11 +143,7 @@ public function testIsCurrent()
 	 * @covers ::contentRoot
 	 * @covers ::currentCommit
 	 * @covers ::name
-	 * @covers ::setColor
-	 * @covers ::setContentRoot
 	 * @covers ::setCurrentCommit
-	 * @covers ::setName
-	 * @covers ::setPlugin
 	 */
 	public function testMeta()
 	{
@@ -149,8 +153,12 @@ public function testMeta()
 		$this->assertSame('Test Instance', $this->instance->name());
 
 		// optional property
-		$instance = $this->instance->clone([
-			'currentCommit' => 'abcdefg'
+		$instance = new Instance([
+			'name'          => 'Test Instance',
+			'contentRoot'   => $this->contentRoot1,
+			'currentCommit' => 'abcdefg',
+			'color'         => 'black',
+			'plugin'        => $this->plugin
 		]);
 		$this->assertSame('abcdefg', $instance->currentCommit());
 	}