Close #186

Author: neomerx

sample/Application/EncodeSamples.php

@@ -183,9 +183,9 @@ public function getDynamicSchemaExample()
      *
      * @param int $iterations
      *
-     * @return mixed
+     * @return array
      */
-    public function runPerformanceTestForSmallNestedResources($iterations)
+    public function runPerformanceTestForSmallNestedResources(int $iterations): array
     {
         $closure = function () use ($iterations) {
             $options = new EncodingParameters(
@@ -217,20 +217,21 @@ public function runPerformanceTestForSmallNestedResources($iterations)
             }
         };
 
-        $timeSpent = null;
-        $this->getTime($closure, $timeSpent);
+        $timeSpent = 0;
+        $bytesUsed = 0;
+        $this->getTime($closure, $timeSpent, $bytesUsed);
 
-        return $timeSpent;
+        return [$timeSpent, $bytesUsed];
     }
 
     /**
      * Run performance test one time for big collection of resources.
      *
      * @param int $numberOfItems
      *
-     * @return mixed
+     * @return array
      */
-    public function runPerformanceTestForBigCollection($numberOfItems)
+    public function runPerformanceTestForBigCollection(int $numberOfItems): array
     {
         $closure = function() use ($numberOfItems) {
             $sites = [];
@@ -262,26 +263,32 @@ public function runPerformanceTestForBigCollection($numberOfItems)
             $encoder->encodeData($sites, $options);
         };
 
-        $timeSpent = null;
-        $this->getTime($closure, $timeSpent);
+        $timeSpent = 0;
+        $bytesUsed = 0;
+        $this->getTime($closure, $timeSpent, $bytesUsed);
 
-        return $timeSpent;
+        return [$timeSpent, $bytesUsed];
     }
 
     /**
      * @param Closure $closure
      * @param float   &$time
+     * @param int     &$memory
      *
      * @return mixed
      */
-    private function getTime(Closure $closure, &$time)
+    private function getTime(Closure $closure, float &$time, int &$memory)
     {
-        $time_start = microtime(true);
+        $timeStart  = microtime(true);
+        $bytesStart = memory_get_usage();
         try {
             return $closure();
         } finally {
-            $time_end = microtime(true);
-            $time     = $time_end - $time_start;
+            $bytesEnd = memory_get_usage();
+            $timeEnd  = microtime(true);
+
+            $time   = $timeEnd - $timeStart;
+            $memory = $bytesEnd - $bytesStart;
         }
     }
 }

sample/composer.json

@@ -10,10 +10,12 @@
     ],
     "autoload": {
         "psr-4": {
+            "Neomerx\\JsonApi\\": "./../src",
             "Neomerx\\Samples\\JsonApi\\": "./"
         }
     },
     "require": {
-        "neomerx/json-api": "dev-develop"
+        "php": ">=7.1.0",
+        "psr/log": "^1.0"
     }
 }

sample/docker-compose.yml

@@ -0,0 +1,29 @@
+# Usefull links
+# =============
+# https://hub.docker.com/_/php/
+# https://docs.docker.com/compose/overview/
+# https://docs.docker.com/compose/compose-file/
+
+cli_7_1_php:
+  image: php:7.1-cli
+  container_name: cli_php_7_1_json_api
+  volumes:
+    - ./..:/app
+  working_dir: /app
+  tty: true
+
+cli_7_2_php:
+  image: php:7.2-cli
+  container_name: cli_php_7_2_json_api
+  volumes:
+    - ./..:/app
+  working_dir: /app
+  tty: true
+
+cli_7_3_php:
+  image: php:7.3-cli
+  container_name: cli_php_7_3_json_api
+  volumes:
+    - ./..:/app
+  working_dir: /app
+  tty: true

sample/sample.php

@@ -16,15 +16,13 @@
  * limitations under the License.
  */
 
-use \Neomerx\JsonApi\Schema\Link;
-use \Neomerx\JsonApi\Encoder\Encoder;
-use \Neomerx\JsonApi\Encoder\EncoderOptions;
-use \Neomerx\Samples\JsonApi\Application\EncodeSamples;
-use \Neomerx\JsonApi\Http\Parameters\EncodingParameters;
+use Neomerx\JsonApi\Http\Parameters\EncodingParameters;
+use Neomerx\JsonApi\Schema\Link;
+use Neomerx\Samples\JsonApi\Application\EncodeSamples;
 
 require './vendor/autoload.php';
 
-/**
+/** @noinspection PhpIllegalPsrClassPathInspection
  * @package Neomerx\Samples\JsonApi
  */
 class Application
@@ -98,8 +96,9 @@ private function dynamicSchemaExample()
     private function runPerformanceTestForSmallNestedResources($num)
     {
         echo "Neomerx JSON API performance test ($num iterations for small resources)... ";
-        $time = $this->samples->runPerformanceTestForSmallNestedResources($num);
-        echo $time . ' seconds' . PHP_EOL;
+        [$time, $bytes] = $this->samples->runPerformanceTestForSmallNestedResources($num);
+        $bytes = number_format($bytes);
+        echo "$time  seconds ($bytes bytes used)." . PHP_EOL;
     }
 
     /**
@@ -110,8 +109,9 @@ private function runPerformanceTestForSmallNestedResources($num)
     private function runPerformanceTestForBigCollection($num)
     {
         echo "Neomerx JSON API performance test (1 iteration for $num resources)... ";
-        $time = $this->samples->runPerformanceTestForBigCollection($num);
-        echo $time . ' seconds' . PHP_EOL;
+        [$time, $bytes] = $this->samples->runPerformanceTestForBigCollection($num);
+        $bytes = number_format($bytes);
+        echo "$time  seconds ($bytes bytes used)." . PHP_EOL;
     }
 
     /**

tests/Sample/EncodeTest.php

@@ -295,15 +295,15 @@ public function testDynamicSchemaExample()
      */
     public function testPerformanceTestForSmallNestedResources()
     {
-        $this->assertGreaterThan(0, $this->samples->runPerformanceTestForSmallNestedResources(10));
+        $this->assertGreaterThan(0, $this->samples->runPerformanceTestForSmallNestedResources(10)[0]);
     }
 
     /**
      * Test performance sample.
      */
     public function testPerformanceTestForBigCollection()
     {
-        $this->assertGreaterThan(0, $this->samples->runPerformanceTestForBigCollection(10));
+        $this->assertGreaterThan(0, $this->samples->runPerformanceTestForBigCollection(10)[0]);
     }
 
     /**