From 4d7d196a3cdc277a6040cab195874983603601dd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20B=C3=B6hmer?= <mail@jan-boehmer.de>
Date: Fri, 17 Nov 2023 18:36:49 +0100
Subject: [PATCH] Added some documentation and tests to PartAssociations

---
 src/Entity/Parts/PartAssociation.php       | 46 ++++++++++++++++++++++
 tests/Entity/Parts/PartAssociationTest.php | 43 ++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 tests/Entity/Parts/PartAssociationTest.php

diff --git a/src/Entity/Parts/PartAssociation.php b/src/Entity/Parts/PartAssociation.php
index 81732057..2fe6975e 100644
--- a/src/Entity/Parts/PartAssociation.php
+++ b/src/Entity/Parts/PartAssociation.php
@@ -81,55 +81,101 @@ class PartAssociation extends AbstractDBElement
         message: 'validator.part_association.part_cannot_be_associated_with_itself')]
     protected ?Part $other = null;
 
+    /**
+     * Returns the (semantic) relation type of this association as an AssociationType enum value.
+     * If the type is set to OTHER, then the other_type field value is used for the user defined type.
+     * @return AssociationType
+     */
     public function getType(): AssociationType
     {
         return $this->type;
     }
 
+    /**
+     * Sets the (semantic) relation type of this association as an AssociationType enum value.
+     * @param  AssociationType  $type
+     * @return $this
+     */
     public function setType(AssociationType $type): PartAssociation
     {
         $this->type = $type;
         return $this;
     }
 
+    /**
+     * Returns a comment, which describes this association further.
+     * @return string|null
+     */
     public function getComment(): ?string
     {
         return $this->comment;
     }
 
+    /**
+     * Sets a comment, which describes this association further.
+     * @param  string|null  $comment
+     * @return $this
+     */
     public function setComment(?string $comment): PartAssociation
     {
         $this->comment = $comment;
         return $this;
     }
 
+    /**
+     * Returns the part which "owns" this association, e.g. the part which is a replacement for another part.
+     * @return Part|null
+     */
     public function getOwner(): ?Part
     {
         return $this->owner;
     }
 
+    /**
+     * Sets the part which "owns" this association, e.g. the part which is a replacement for another part.
+     * @param  Part|null  $owner
+     * @return $this
+     */
     public function setOwner(?Part $owner): PartAssociation
     {
         $this->owner = $owner;
         return $this;
     }
 
+    /**
+     * Returns the part which is "owned" by this association, e.g. the part which is replaced by another part.
+     * @return Part|null
+     */
     public function getOther(): ?Part
     {
         return $this->other;
     }
 
+    /**
+     * Sets the part which is "owned" by this association, e.g. the part which is replaced by another part.
+     * @param  Part|null  $other
+     * @return $this
+     */
     public function setOther(?Part $other): PartAssociation
     {
         $this->other = $other;
         return $this;
     }
 
+    /**
+     * Returns the user defined association type, which is used if the type is set to OTHER.
+     * @return string|null
+     */
     public function getOtherType(): ?string
     {
         return $this->other_type;
     }
 
+    /**
+     * Sets the user defined association type, which is used if the type is set to OTHER.
+     * @param  string|null  $other_type
+     * @return $this
+     */
     public function setOtherType(?string $other_type): PartAssociation
     {
         $this->other_type = $other_type;
diff --git a/tests/Entity/Parts/PartAssociationTest.php b/tests/Entity/Parts/PartAssociationTest.php
new file mode 100644
index 00000000..d541c468
--- /dev/null
+++ b/tests/Entity/Parts/PartAssociationTest.php
@@ -0,0 +1,43 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace App\Tests\Entity\Parts;
+
+use App\Entity\Parts\AssociationType;
+use App\Entity\Parts\PartAssociation;
+use PHPUnit\Framework\TestCase;
+
+class PartAssociationTest extends TestCase
+{
+
+    public function testGetTypeTranslationKey(): void
+    {
+        $assoc = new PartAssociation();
+        $assoc->setType(AssociationType::COMPATIBLE);
+        $assoc->setOtherType('Custom Type');
+
+        //If the type is not OTHER the translation key should be the same as the type
+        $this->assertEquals($assoc->getType()->getTranslationKey(), $assoc->getTypeTranslationKey());
+
+        //If the type is OTHER the translation key should be the other type
+        $assoc->setType(AssociationType::OTHER);
+        $this->assertEquals($assoc->getOtherType(), $assoc->getTypeTranslationKey());
+    }
+}