Merge pull request #8 from factorio-item-browser/feature/icon-size

feature/icon-size

Author: BluePsyduck

.travis.yml

@@ -3,8 +3,8 @@ language: php
 matrix:
   fast_finish: true
   include:
-    - php: 7.2
-    - php: 7.3
+    - php: '7.2'
+    - php: '7.3'
 
 cache:
   directories:
@@ -14,7 +14,8 @@ install:
   - composer install --prefer-dist --no-interaction --no-suggest
 
 script:
-  - vendor/bin/phpunit --coverage-clover=coverage.xml
+  - vendor/bin/phpunit --testsuite=unit-test --coverage-clover=coverage.xml
+  - vendor/bin/phpunit --testsuite=serializer-test
   - vendor/bin/coverage-check coverage.xml 100
   - vendor/bin/phpcs -np --colors
   - vendor/bin/phpstan analyse --no-interaction

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.1.0 - 2019-07-15
+
+### Added
+
+- Attribute `size` to the generic icon response.
+
 ## 2.0.0 - 2019-04-07
 
 ### Added

README.md

@@ -125,7 +125,7 @@ $apiClient->sendRequest($modListRequest); // Non-blocking
 /* @var  ItemRandomResponse $randomItemsResponse */
 $randomItemsResponse = $apiClient->fetchResponse($randomItemRequest); // Blocking 
 /* @var ModListResponse $modListResponse */
-$modListResponse = $apiClient->fetchResponse($modListRequest); // Non-blocking
+$modListResponse = $apiClient->fetchResponse($modListRequest); // Blocking
 
 // Do something with the received data.
 var_dump($randomItemsResponse->getItems());

composer.json

@@ -21,7 +21,7 @@
   },
   "require-dev": {
     "ext-json": "*",
-    "bluepsyduck/common": "^1.0",
+    "bluepsyduck/test-helper": "^1.0",
     "phpstan/phpstan": "^0.11",
     "phpstan/phpstan-phpunit": "^0.11",
     "phpstan/phpstan-strict-rules": "^0.11",
@@ -51,9 +51,11 @@
     "phpcbf": "phpcbf -p --colors",
     "phpcs": "phpcs -p --colors",
     "phpstan": "phpstan analyse --no-interaction --ansi",
-    "phpunit": "phpunit --colors=always --coverage-html=test/log --coverage-clover=test/log/clover.xml",
+    "test-unit": "phpunit --testsuite unit-test --colors=always --coverage-html=test/coverage --coverage-clover=test/coverage/clover.xml",
+    "test-serialize": "phpunit --testsuite serializer-test --colors=always",
     "test": [
-      "@phpunit",
+      "@test-unit",
+      "@test-serialize",
       "@coverage-check",
       "@phpcs",
       "@phpstan"

config/serializer/Entity.Icon.yml

@@ -6,3 +6,5 @@ FactorioItemBrowser\Api\Client\Entity\Icon:
       type: array<FactorioItemBrowser\Api\Client\Entity\Entity>
     content:
       type: base64
+    size:
+      type: int

phpunit.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" ?>
 <phpunit colors="true">
     <testsuites>
-        <testsuite name="FactorioItemBrowser\Api\Client">
+        <testsuite name="unit-test">
             <directory>test/src</directory>
         </testsuite>
-        <testsuite name="FactorioItemBrowser\Api\Client Serializer">
+        <testsuite name="serializer-test">
             <directory>test/serializer</directory>
         </testsuite>
     </testsuites>

src/Entity/Icon.php

@@ -24,6 +24,12 @@ class Icon
      */
     protected $content = '';
 
+    /**
+     * The size of the icon.
+     * @var int
+     */
+    protected $size = 0;
+
     /**
      * Sets the entities of the entity.
      * @param array|Entity[] $entities
@@ -74,4 +80,24 @@ public function getContent(): string
     {
         return $this->content;
     }
+
+    /**
+     * Sets the size of the icon.
+     * @param int $size
+     * @return $this
+     */
+    public function setSize(int $size): self
+    {
+        $this->size = $size;
+        return $this;
+    }
+
+    /**
+     * Returns the size of the icon.
+     * @return int
+     */
+    public function getSize(): int
+    {
+        return $this->size;
+    }
 }

test/serializer/Entity/IconTest.php

@@ -33,7 +33,8 @@ protected function getObject(): object
 
         $result = new Icon();
         $result->setEntities([$entity1, $entity2])
-               ->setContent('mno');
+               ->setContent('mno')
+               ->setSize(42);
 
         return $result;
     }
@@ -56,6 +57,7 @@ protected function getData(): array
                 ],
             ],
             'content' => 'bW5v',
+            'size' => 42,
         ];
     }
 }

test/serializer/Response/Generic/GenericIconResponseTest.php

@@ -24,10 +24,12 @@ class GenericIconResponseTest extends SerializerTestCase
     protected function getObject(): object
     {
         $icon1 = new Icon();
-        $icon1->setContent('abc');
+        $icon1->setContent('abc')
+              ->setSize(42);
 
         $icon2 = new Icon();
-        $icon2->setContent('def');
+        $icon2->setContent('def')
+              ->setSize(1337);
 
         $result = new GenericIconResponse();
         $result->setIcons([$icon1, $icon2]);
@@ -46,10 +48,12 @@ protected function getData(): array
                 [
                     'entities' => [],
                     'content' => 'YWJj',
+                    'size' => 42,
                 ],
                 [
                     'entities' => [],
                     'content' => 'ZGVm',
+                    'size' => 1337,
                 ],
             ],
         ];

test/src/ApiClientFactoryTest.php

@@ -4,7 +4,7 @@
 
 namespace FactorioItemBrowserTest\Api\Client;
 
-use BluePsyduck\Common\Test\ReflectionTrait;
+use BluePsyduck\TestHelper\ReflectionTrait;
 use FactorioItemBrowser\Api\Client\ApiClient;
 use FactorioItemBrowser\Api\Client\ApiClientFactory;
 use FactorioItemBrowser\Api\Client\Client\Options;