codereview

lmc-eu · Apr 24, 2020 · 25bdd69 · 25bdd69
1 parent 1d6807f
commit 25bdd69
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-
 # PHP API Client for Matej recommendation engine
 
 [![Latest Stable Version](https://img.shields.io/packagist/v/lmc/matej-client.svg?style=flat-square)](https://packagist.org/packages/lmc/matej-client)

diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -25,9 +25,9 @@ $recommendation = UserRecommendation::create('user-id', 5, 'scenario', 1.0, 3600
 #### After
 ```php
 $recommendation = UserRecommendation::create('user-id', 'scenario')
-	->setCount(5)
-	->setRotationRate(1.0)
-	->setRotationTime(3600);
+    ->setCount(5)
+    ->setRotationRate(1.0)
+    ->setRotationTime(3600);
 ```
 
 which is equivalent to
@@ -49,18 +49,18 @@ We replaced them with constructors for creating Interaction based on `$itemId` o
 
 ```php
 Interaction::withItem(
-	string $interactionType,
-	string $userId,
-	string $itemId,
-	int $timestamp = null
+    string $interactionType,
+    string $userId,
+    string $itemId,
+    int $timestamp = null
 ```
 
 ```php
 Interaction::withAliasedItem(
-	string $interactionType,
-	string $userId,
-	array $itemIdAlias,
-	int $timestamp = null):
+    string $interactionType,
+    string $userId,
+    array $itemIdAlias,
+    int $timestamp = null):
 ```
 
 The first argument is always a string representing interaction type. Consult the table bellow to find out the correct value to fill in:
@@ -89,7 +89,7 @@ $interaction = Interaction::withItem('bookmarks', 'user-id', 'item_id', time());
 Interactions now support custom attributes. These can be added using fluent API
 methods `setAttribute()` and `setAttributes()`.
 
-Argument `value` was removed from constructor methods and has to be set using new attribute methods. Its real name might have change as well. For example, for interaction type `bookmarks`, it was renamed to `stars`.
+Argument `value` was removed from constructor methods and has to be set using new attribute methods. Its real name might have change as well. For example, for interaction type `ratings`, it was renamed to `stars`.
 
 **Attribute `context` is no longer supported and was removed.**
 
@@ -101,7 +101,7 @@ $interaction = Interaction::rating('user-id', 'item_id', 0.5);
 #### After
 ```php
 $interaction = Interaction::create('ratings', 'user-id', 'item_id')
-				->setAttribute('stars', 0.5)
+                ->setAttribute('stars', 0.5)
 ```
 
 which is equivalent to

diff --git a/src/Model/Command/Interaction.php b/src/Model/Command/Interaction.php
@@ -67,11 +67,9 @@ public static function withAliasedItem(
         string $itemId,
         int $timestamp = null
     ): self {
-        $interaction = new static(
+        return new static(
             $interactionType, $userId, $itemIdAlias, $itemId, $timestamp
         );
-
-        return $interaction;
     }
 
     public function getUserId(): string
@@ -114,16 +112,13 @@ public function setAttribute(string $name, $value): self
 
     public function getCommandParameters(): array
     {
-        $common = [
+        return [
             'interaction_type' => $this->interactionType,
             'user_id' => $this->userId,
             'timestamp' => $this->timestamp,
             'attributes' => $this->attributes,
             $this->itemIdAlias => $this->itemId,
         ];
-        $common[$this->itemIdAlias] = $this->itemId;
-
-        return $common;
     }
 
     protected function setInteractionType(string $interactionType): void

diff --git a/tests/unit/Model/Command/InteractionTest.php b/tests/unit/Model/Command/InteractionTest.php
@@ -25,10 +25,10 @@ public function initTimeMock(): void
      */
     public function shouldRaiseExceptionWithInvalidAttributeName(): void
     {
+        $command = Interaction::withItem('bookmarks', 'user-id', 'item-id');
         $this->expectException(DomainException::class);
         $this->expectExceptionMessage(
-            'Value "invalid^*!@" does not match type identifier format requirement (must contain only of alphanumeric chars, dash or underscore)');
-        $command = Interaction::withItem('bookmarks', 'user-id', 'item-id');
+            'invalid^*!@" does not match type identifier format requirement');
         $command->setAttribute('invalid^*!@', 'value');
     }
 
@@ -37,10 +37,10 @@ public function shouldRaiseExceptionWithInvalidAttributeName(): void
      */
     public function shouldRaiseExceptionWithInvalidAttributeNameInBatch(): void
     {
+        $command = Interaction::withItem('bookmarks', 'user-id', 'item-id');
         $this->expectException(DomainException::class);
         $this->expectExceptionMessage(
-            'Value "invalid^*!@" does not match type identifier format requirement (must contain only of alphanumeric chars, dash or underscore)');
-        $command = Interaction::withItem('bookmarks', 'user-id', 'item-id');
+            '"invalid^*!@" does not match type identifier format requirement');
         $command->setAttributes([
             'valid' => 'value1',
             'invalid^*!@' => 'value2',
@@ -54,7 +54,7 @@ public function shouldRaiseExceptionWithInvalidInteractionType(): void
     {
         $this->expectException(DomainException::class);
         $this->expectExceptionMessage(
-            'Value "invalid^*!@" does not match type identifier format requirement (must contain only of alphanumeric chars, dash or underscore)');
+            '"invalid^*!@" does not match type identifier format requirement');
         $command = Interaction::withItem('invalid^*!@', 'user-id', 'item-id');
     }
 
@@ -65,7 +65,7 @@ public function shouldRaiseExceptionWithInvalidUserId(): void
     {
         $this->expectException(DomainException::class);
         $this->expectExceptionMessage(
-            'Value "invalid^*!@" does not match type identifier format requirement (must contain only of alphanumeric chars, dash or underscore)');
+            '"invalid^*!@" does not match type identifier format requirement');
         $command = Interaction::withItem('bookmarks', 'invalid^*!@', 'item-id');
     }
 
@@ -76,7 +76,7 @@ public function shouldRaiseExceptionWithInvalidItemId(): void
     {
         $this->expectException(DomainException::class);
         $this->expectExceptionMessage(
-            'Value "invalid^*!@" does not match type identifier format requirement (must contain only of alphanumeric chars, dash or underscore)');
+            '"invalid^*!@" does not match type identifier format requirement');
         $command = Interaction::withItem('bookmarks', 'user-id', 'invalid^*!@');
     }
 
@@ -87,7 +87,7 @@ public function shouldRaiseExceptionWithInvalidItemIdAliasName(): void
     {
         $this->expectException(DomainException::class);
         $this->expectExceptionMessage(
-            'Value "invalid^*!@" does not match type identifier format requirement (must contain only of alphanumeric chars, dash or underscore)');
+            '"invalid^*!@" does not match type identifier format requirement');
         $command = Interaction::withAliasedItem('bookmarks', 'user-id', 'invalid^*!@', 'item-id');
     }