Clarify terms (#4)

src/ModelMerge.php

@@ -29,79 +29,61 @@ public function __construct(?MergeModelStrategy $strategy = null)
      */
     public function useStrategy(?MergeModelStrategy $strategy = null): static
     {
-        $this->strategy = $strategy instanceof MergeModelStrategy ? $strategy : new MergeModelSimple();
+        if ($strategy instanceof MergeModelStrategy) {
+            $this->strategy = $strategy;
+        } else {
+            $this->strategy = new MergeModelSimple();
+        }
 
         return $this;
     }
 
-    /**
-     * Set model A
-     *
-     *
-     * @return $this
-     */
     public function setBaseModel(Model $model): static
     {
         $this->baseModel = $model;
 
         return $this;
     }
 
-    public function getBaseModel(): Model
+    public function setBase(Model $baseModel): static
     {
-        return $this->baseModel;
+        return $this->setBaseModel($baseModel);
     }
 
-    public function getDuplicateModel(): Model
+    public function getBaseModel(): Model
     {
-        return $this->duplicateModel;
+        return $this->baseModel;
     }
 
     public function getBase(): Model
     {
         return $this->getBaseModel();
     }
 
-    public function getDuplicate(): Model
-    {
-        return $this->getDuplicateModel();
-    }
-
-    /**
-     * Set model B
-     */
     public function setDuplicateModel(Model $model): static
     {
         $this->duplicateModel = $model;
 
         return $this;
     }
 
-    /**
-     * Alias for setBaseModel
-     */
-    public function setBase(Model $baseModel): static
+    public function setDuplicate(Model $duplicateModel): static
     {
-        $this->setBaseModel($baseModel);
-
-        return $this;
+        return $this->setDuplicateModel($duplicateModel);
     }
 
-    /**
-     * Alias for setDuplicateModel
-     */
-    public function setDuplicate(Model $duplicateModel): static
+    public function getDuplicateModel(): Model
     {
-        $this->setDuplicateModel($duplicateModel);
+        return $this->duplicateModel;
+    }
 
-        return $this;
+    public function getDuplicate(): Model
+    {
+        return $this->getDuplicateModel();
     }
 
     /**
      * Specify a compound key to match models and verify identity.
-     *
-     * @param  string|array  $keys  Keys that make the model identifiable
-     * @return $this
      */
     public function withKey(string|array $keys): static
     {
@@ -135,7 +117,7 @@ public function merge(): Model
     }
 
     /**
-     * Executes the merge and performs save/delete accordingly to preserve base and discard dupe
+     * Executes the merge and performs save/delete accordingly to preserve base and discard duplicate
      */
     public function unifyOnBase(): Model
     {
@@ -197,7 +179,7 @@ public function belongsTo(?string $belongsTo = null): static
     }
 
     /**
-     * Alias for belongsTo
+     * @alias belongsTo
      */
     public function mustBelongToSame(?string $belongsTo = null): static
     {
@@ -214,11 +196,11 @@ public function withRelationships(array $relationships): static
     public function transferRelationships(): void
     {
         foreach ($this->relationships as $relationship) {
-            $this->transferChilds($relationship);
+            $this->transferChildren($relationship);
         }
     }
 
-    public function transferChilds(mixed $relationship): void
+    public function transferChildren(mixed $relationship): void
     {
         foreach ($this->duplicateModel->$relationship as $child) {
             $this->baseModel->$relationship()->save($child);

src/Strategies/MergeModelSimple.php

@@ -7,15 +7,15 @@
 /** @api */
 class MergeModelSimple implements MergeModelStrategy
 {
-    public function merge(Model $modelA, Model $modelB): Model
+    public function merge(Model $baseModel, Model $duplicateModel): Model
     {
-        $dataA = $modelA->toArray();
-        $dataB = $modelB->toArray();
+        $base = $baseModel->toArray();
+        $duplicate = $duplicateModel->toArray();
 
-        $dataMerge = array_merge($dataB, $dataA);
+        $dataMerge = array_merge($duplicate, $base);
 
-        $modelA->fill($dataMerge);
+        $baseModel->fill($dataMerge);
 
-        return $modelA;
+        return $baseModel;
     }
 }

src/Strategies/MergeModelStrategy.php

@@ -6,5 +6,5 @@
 
 interface MergeModelStrategy
 {
-    public function merge(Model $modelA, Model $modelB): Model;
+    public function merge(Model $baseModel, Model $duplicateModel): Model;
 }