Utilise the new builder factory; Add mapToCollection methods (#13)

* Utilise the new builder factory; Add mapToCollection methods

* Require official version

* Add changelog entry

Author: DannyvdSluijs

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Utilise the new builder factory; Add mapToCollection methods [PR#13](https://github.com/JsonMapper/LaravelPackage/pull/13)
 
 ## [2.1.0] - 2021-01-28
 ### Changed

composer.json

@@ -12,7 +12,7 @@
     "license": "MIT",
     "minimum-stability": "stable",
     "require": {
-        "json-mapper/json-mapper": "^2.0",
+        "json-mapper/json-mapper": "^2.3",
         "php": "^7.2 || ^8.0",
         "illuminate/support": "^5.5|^6|^7|^8"
     },
@@ -40,6 +40,7 @@
         }
     },
     "require-dev": {
+        "ext-json": "*",
         "squizlabs/php_codesniffer": "^3.5",
         "phpstan/phpstan": "^0.12.19",
         "phpunit/phpunit": "^8.0 || ^9.0",

src/JsonMapper.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage;
+
+use Illuminate\Support\Collection;
+
+class JsonMapper extends \JsonMapper\JsonMapper implements JsonMapperInterface
+{
+    public function mapToCollection(array $json, object $object): Collection
+    {
+        return collect($this->mapArray($json, $object));
+    }
+
+    public function mapToCollectionFromString(string $json, object $object): Collection
+    {
+        return collect($this->mapArrayFromString($json, $object));
+    }
+}

src/JsonMapperInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage;
+
+use Illuminate\Support\Collection;
+
+interface JsonMapperInterface extends \JsonMapper\JsonMapperInterface
+{
+    public function mapToCollection(array $json, object $object): Collection;
+
+    public function mapToCollectionFromString(string $json, object $object): Collection;
+}

src/ServiceProvider.php

@@ -6,32 +6,37 @@
 
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 use JsonMapper\JsonMapper;
+use JsonMapper\JsonMapperBuilder;
 use JsonMapper\JsonMapperFactory;
 use JsonMapper\JsonMapperInterface;
 
 class ServiceProvider extends BaseServiceProvider
 {
     private const CONFIG_FILE = __DIR__ . '/../config/json-mapper.php';
 
-    /**
-     * @return void
-     */
+    /** @return void */
     public function register()
     {
         $this->mergeConfigFrom(self::CONFIG_FILE, 'json-mapper');
 
         $this->app->singleton(JsonMapperInterface::class, function ($app) {
             $config = $app->get('config')->get('json-mapper.type');
+            $builder = JsonMapperBuilder::new()
+                ->withJsonMapperClassName(\JsonMapper\LaravelPackage\JsonMapper::class);
+            $factory = new JsonMapperFactory($builder);
+
             switch ($config) {
                 case 'best-fit':
-                    return (new JsonMapperFactory())->bestFit();
+                    return $factory->bestFit();
                 case 'default':
                 default:
-                    return (new JsonMapperFactory())->default();
+                    return $factory->default();
             }
         });
 
         $this->app->alias(JsonMapperInterface::class, JsonMapper::class);
+        $this->app->alias(JsonMapperInterface::class, \JsonMapper\LaravelPackage\JsonMapperInterface::class);
+        $this->app->alias(JsonMapperInterface::class, \JsonMapper\LaravelPackage\JsonMapper::class);
     }
 
     /**

tests/Implementation/ChuckNorris/Joke.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage\Tests\Implementation\ChuckNorris;
+
+
+class Joke
+{
+    /** @var string[] */
+    public $categories;
+    /** @var \DateTimeImmutable */
+    public $created_at;
+    /** @var string */
+    public $icon_url;
+    /** @var string */
+    public $id;
+    /** @var \DateTimeImmutable */
+    public $updated_at;
+    /** @var string */
+    public $url;
+    /** @var string */
+    public $value;
+}

tests/Implementation/ChuckNorris/SearchResponse.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage\Tests\Implementation\ChuckNorris;
+
+
+class SearchResponse
+{
+    /** @var int */
+    public $total;
+    /** @var Joke[]  */
+    public $result;
+}

tests/Implementation/SimpleObject.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage\Tests\Implementation;
+
+
+class SimpleObject
+{
+    /** @var int */
+    private $number;
+
+    public function getNumber(): int
+    {
+        return $this->number;
+    }
+
+    public function setNumber(int $number): void
+    {
+        $this->number = $number;
+    }
+
+    public static function withNumber(int $number): self
+    {
+        $instance = new self();
+        $instance->setNumber($number);
+
+        return $instance;
+    }
+}

tests/Integration/JsonMapperTests.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage\Tests\Integration;
+
+use JsonMapper\LaravelPackage\JsonMapperInterface;
+use JsonMapper\LaravelPackage\ServiceProvider;
+use JsonMapper\LaravelPackage\Tests\Implementation\ChuckNorris\Joke;
+use \Orchestra\Testbench\TestCase;
+
+class JsonMapperTests extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [
+            ServiceProvider::class,
+        ];
+    }
+
+    /** @covers \JsonMapper\LaravelPackage\JsonMapper */
+    public function testJsonMapperCanMapToCollection(): void
+    {
+        /** @var JsonMapperInterface $mapper */
+        $mapper = $this->app->make(JsonMapperInterface::class);
+        $url = "https://api.chucknorris.io/jokes/search?query=save";
+        $data = (string) file_get_contents($url);
+        $json = json_decode($data, false);
+        $jokes = $mapper->mapToCollection($json->result, new Joke());
+
+        self::assertContainsOnlyInstancesOf(Joke::class, $jokes->all());
+    }
+
+    /** @covers \JsonMapper\LaravelPackage\JsonMapper */
+    public function testJsonMapperCanMapToCollectionWithLargeJson(): void
+    {
+        /** @var JsonMapperInterface $mapper */
+        $mapper = $this->app->make(JsonMapperInterface::class);
+        $url = "https://api.chucknorris.io/jokes/search?query=kick";
+        $data = (string) file_get_contents($url);
+        $json = json_decode($data, false);
+        $jokes = $mapper->mapToCollection($json->result, new Joke());
+
+        self::assertContainsOnlyInstancesOf(Joke::class, $jokes->all());
+    }
+
+}

tests/Unit/JsonMapperTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonMapper\LaravelPackage\Tests\Unit;
+
+use Illuminate\Config\Repository;
+use Illuminate\Foundation\Application;
+use JsonMapper\LaravelPackage\JsonMapperInterface;
+use JsonMapper\LaravelPackage\ServiceProvider;
+use JsonMapper\LaravelPackage\Tests\Implementation\SimpleObject;
+use PHPUnit\Framework\TestCase;
+
+class JsonMapperTest extends TestCase
+{
+    /** @covers \JsonMapper\LaravelPackage\JsonMapper */
+    public function testCanMapToCollection(): void
+    {
+        $app = new Application();
+        $app->offsetSet('config', new Repository(['json-mapper.type' => 'best-fit']));
+        $serviceProvider = new ServiceProvider($app);
+
+        $serviceProvider->boot();
+        $serviceProvider->register();
+        /** @var JsonMapperInterface $jsonMapper */
+        $jsonMapper = $app->make(JsonMapperInterface::class);
+        $data = json_decode('[{"number": 12}, {"number": 13}]', false);
+
+        $result = $jsonMapper->mapToCollection($data, new SimpleObject());
+
+        self::assertCount(2, $result);
+        self::assertEquals(collect([SimpleObject::withNumber(12), SimpleObject::withNumber(13)]), $result);
+    }
+
+    /** @covers \JsonMapper\LaravelPackage\JsonMapper */
+    public function testCanMapToCollectionFromstring(): void
+    {
+        $app = new Application();
+        $app->offsetSet('config', new Repository(['json-mapper.type' => 'best-fit']));
+        $serviceProvider = new ServiceProvider($app);
+
+        $serviceProvider->boot();
+        $serviceProvider->register();
+        /** @var JsonMapperInterface $jsonMapper */
+        $jsonMapper = $app->make(JsonMapperInterface::class);
+
+        $result = $jsonMapper->mapToCollectionFromString('[{"number": 12}, {"number": 13}]', new SimpleObject());
+
+        self::assertCount(2, $result);
+        self::assertEquals(collect([SimpleObject::withNumber(12), SimpleObject::withNumber(13)]), $result);
+    }
+}