Merge pull request #13 from andrej-griniuk/cake5

Cake5
andrej-griniuk · Dec 11, 2023 · cd8f6d5 · cd8f6d5
2 parents e70270a + f66a353
commit cd8f6d5
Show file tree

Hide file tree

Showing 13 changed files with 81 additions and 124 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,9 +2,8 @@
 /composer.phar
 /phpunit.xml
 /.phpunit.result.cache
+/.phpunit.cache
 /phpunit.phar
 /config/Migrations/schema-dump-default.lock
 /vendor/
 /.idea/
-/build/
-/tmp/
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,14 @@
 language: php
 
+dist: jammy
+addons:
+  apt:
+    packages:
+      - "libonig5"
+
 php:
-  - 7.4
-  - 8.0
   - 8.1
+  - 8.2
 
 sudo: false
 
@@ -17,16 +22,16 @@ matrix:
   fast_finish: true
 
   include:
-    - php: 7.4
+    - php: 8.2
       env: PHPCS=1 DEFAULT=0
 
-    - php: 7.4
+    - php: 8.2
       env: COVERAGE=1 DEFAULT=0
 
 before_script:
   - composer self-update
   - composer install --prefer-source --no-interaction --dev
-  - if [[ $PHPCS == 1 ]]; then composer require --dev cakephp/cakephp-codesniffer:^4.0 ; fi
+  - if [[ $PHPCS == 1 ]]; then composer require --dev cakephp/cakephp-codesniffer:^5.0 ; fi
 
 script:
   - if [[ $COVERAGE == 1 ]]; then export XDEBUG_MODE=coverage && vendor/bin/phpunit --coverage-clover=coverage.xml ; fi

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ This plugin is a thin wrapper for `JsonView` that allows using [Fractal transfor
 
 ## Requirements
 
-- CakePHP 4.x (use ~1.0 for CakePHP 3.x)
+- CakePHP 5.x (use ~1.0 for CakePHP 3.x, ~2.0 for CakePHP 4.x)
 
 ## Installation
 

diff --git a/composer.json b/composer.json
@@ -12,13 +12,13 @@
         }
     ],
     "require": {
-        "php": ">=7.4",
-        "cakephp/cakephp": "~4.0",
+        "php": ">=8.1",
+        "cakephp/cakephp": "^5.0",
         "league/fractal": "^0.20.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.3",
-        "cakephp/bake": "^2.8"
+        "phpunit/phpunit": "^10",
+        "cakephp/bake": "^3.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml → phpunit.xml.dist b/phpunit.xml → phpunit.xml.dist
@@ -1,25 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" processIsolation="false" stopOnFailure="false" bootstrap="tests/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" processIsolation="false" stopOnFailure="false" bootstrap="tests/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" cacheDirectory=".phpunit.cache">
+    <coverage/>
     <php>
         <ini name="memory_limit" value="-1"/>
         <ini name="apc.enable_cli" value="1"/>
     </php>
-
     <!-- Add any additional test suites you want to run here -->
     <testsuites>
         <testsuite name="FractalTransformerView">
             <directory>tests/TestCase/</directory>
         </testsuite>
     </testsuites>
-
-    <!-- Load extension for fixtures -->
-    <extensions>
-        <extension class="Cake\TestSuite\Fixture\PHPUnitExtension"/>
-    </extensions>
-
-    <coverage>
+    <!-- Setup a listener for fixtures -->
+    <source>
         <include>
             <directory suffix=".php">src/</directory>
         </include>
-    </coverage>
+    </source>
+    <extensions>
+        <bootstrap class="Cake\TestSuite\Fixture\Extension\PHPUnitExtension"/>
+    </extensions>
 </phpunit>
diff --git a/src/Command/BakeTransformerCommand.php b/src/Command/BakeTransformerCommand.php
@@ -15,7 +15,7 @@ class BakeTransformerCommand extends SimpleBakeCommand
      *
      * @var string
      */
-    protected $pathFragment = 'Model/Transformer/';
+    protected string $pathFragment = 'Model/Transformer/';
 
     /**
      * Get the generated object's name.

diff --git a/src/FractalTransformerViewPlugin.php b/src/FractalTransformerViewPlugin.php
@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace FractalTransformerView;
+
+use Cake\Console\CommandCollection;
+use Cake\Core\BasePlugin;
+use FractalTransformerView\Command\BakeTransformerCommand;
+
+/**
+ * Plugin for FractalTransformerView
+ */
+class FractalTransformerViewPlugin extends BasePlugin
+{
+    /**
+     * Add console commands for the plugin.
+     *
+     * @param \Cake\Console\CommandCollection $commands The command collection to update
+     * @return \Cake\Console\CommandCollection
+     */
+    public function console(CommandCollection $commands): CommandCollection
+    {
+        if (class_exists('Bake\Command\SimpleBakeCommand')) {
+            $commands->add('bake transformer', BakeTransformerCommand::class);
+        }
+
+        return $commands;
+    }
+}
diff --git a/src/Plugin.php b/src/Plugin.php
diff --git a/src/View/FractalTransformerView.php b/src/View/FractalTransformerView.php
@@ -5,7 +5,10 @@
 
 use Cake\Collection\CollectionInterface;
 use Cake\Datasource\EntityInterface;
+use Cake\Datasource\Paging\PaginatedResultSet;
+use Cake\Datasource\ResultSetDecorator;
 use Cake\ORM\Query;
+use Cake\ORM\ResultSet;
 use Cake\Utility\Hash;
 use Cake\View\JsonView;
 use Exception;
@@ -20,11 +23,6 @@
  */
 class FractalTransformerView extends JsonView
 {
-    /**
-     * @var \League\Fractal\Serializer\SerializerAbstract
-     */
-    protected $_serializer;
-
     /**
      * Default config options.
      *
@@ -47,7 +45,7 @@ class FractalTransformerView extends JsonView
      * @var array
      * @pslam-var array{serialize:string|bool|null, jsonOptions: int|null, jsonp: bool|string|null}
      */
-    protected $_defaultConfig = [
+    protected array $_defaultConfig = [
         'serialize' => null,
         'jsonOptions' => null,
         'jsonp' => null,
@@ -60,14 +58,21 @@ class FractalTransformerView extends JsonView
     /**
      * Get transform class name for given var by figuring out which entity it belongs to. Return FALSE otherwise
      *
-     * @param \Cake\ORM\Query|\Cake\Collection\CollectionInterface|\Cake\Datasource\EntityInterface $var variable
+     * @param \Cake\ORM\Query|\Cake\ORM\ResultSet|\Cake\Datasource\ResultSetDecorator|\Cake\Datasource\EntityInterface|\Cake\Collection\CollectionInterface|mixed $var variable
      * @return string|null
      */
-    protected function getTransformerClass($var): ?string
+    protected function getTransformerClass(mixed $var): ?string
     {
         $entity = null;
         if ($var instanceof Query) {
             $entity = $var->getRepository()->newEmptyEntity();
+        } elseif ($var instanceof PaginatedResultSet) {
+            /** @phpstan-ignore-next-line */
+            $entity = $var->items()->first();
+        } elseif ($var instanceof ResultSetDecorator) {
+            $entity = $var->first();
+        } elseif ($var instanceof ResultSet) {
+            $entity = $var->first();
         } elseif ($var instanceof CollectionInterface) {
             $entity = $var->first();
         } elseif ($var instanceof EntityInterface) {
@@ -76,7 +81,7 @@ protected function getTransformerClass($var): ?string
             $entity = reset($var);
         }
 
-        if (!$entity || !$entity instanceof EntityInterface) {
+        if (!$entity || !is_object($entity)) {
             return null;
         }
 
@@ -98,7 +103,7 @@ protected function getTransformerClass($var): ?string
      * @return \League\Fractal\TransformerAbstract|null
      * @throws \Exception
      */
-    protected function getTransformer($var, $varName = null): ?TransformerAbstract
+    protected function getTransformer(mixed $var, ?string $varName = null): ?TransformerAbstract
     {
         $_transform = $this->getConfig('transform');
         $transformerClass = $varName
@@ -136,10 +141,10 @@ protected function getTransformer($var, $varName = null): ?TransformerAbstract
      * @param \League\Fractal\Manager $manager Manager
      * @param mixed $var Variable
      * @param string|null $varName Variable name
-     * @return array
+     * @return mixed
      * @throws \Exception
      */
-    protected function transform(Manager $manager, $var, $varName = null)
+    protected function transform(Manager $manager, mixed $var, ?string $varName = null): mixed
     {
         $transformer = $this->getTransformer($var, $varName);
         if (!$transformer) {
@@ -148,7 +153,7 @@ protected function transform(Manager $manager, $var, $varName = null)
 
         $resourceKey = $this->getConfig('resourceKey');
 
-        if (is_array($var) || $var instanceof Query || $var instanceof CollectionInterface) {
+        if (is_array($var) || $var instanceof Query || $var instanceof ResultSet || $var instanceof ResultSetDecorator || $var instanceof PaginatedResultSet) {
             $resource = new Collection($var, $transformer, $resourceKey);
         } elseif ($var instanceof EntityInterface) {
             $resource = new Item($var, $transformer, $resourceKey);
@@ -166,7 +171,7 @@ protected function transform(Manager $manager, $var, $varName = null)
      * @return mixed The data to serialize.
      * @throws \Exception
      */
-    protected function _dataToSerialize($serialize)
+    protected function _dataToSerialize(array|string $serialize): mixed
     {
         $data = parent::_dataToSerialize($serialize);
 

diff --git a/tests/Fixture/ArticlesFixture.php b/tests/Fixture/ArticlesFixture.php
@@ -15,7 +15,7 @@ class ArticlesFixture extends TestFixture
      *
      * @var array
      */
-    public $records = [
+    public array $records = [
         ['title' => 'First Article', 'body' => 'First Article Body', 'published' => 'Y'],
         ['title' => 'Second Article', 'body' => 'Second Article Body', 'published' => 'Y'],
         ['title' => 'Third Article', 'body' => 'Third Article Body', 'published' => 'Y'],

diff --git a/tests/Fixture/AuthorsFixture.php b/tests/Fixture/AuthorsFixture.php
@@ -15,7 +15,7 @@ class AuthorsFixture extends TestFixture
      *
      * @var array
      */
-    public $records = [
+    public array $records = [
         ['name' => 'mariano'],
         ['name' => 'nate'],
         ['name' => 'larry'],

diff --git a/tests/TestCase/View/FractalTransformerViewTest.php b/tests/TestCase/View/FractalTransformerViewTest.php
@@ -8,14 +8,15 @@
 use FractalTransformerView\Serializer\ArraySerializer;
 use FractalTransformerView\View\FractalTransformerView;
 use League\Fractal\Manager;
+use ReflectionClass;
 use stdClass;
 
 /**
  * FractalTransformerViewTest
  */
 class FractalTransformerViewTest extends TestCase
 {
-    public $fixtures = ['plugin.FractalTransformerView.Articles', 'plugin.FractalTransformerView.Authors'];
+    public array $fixtures = ['plugin.FractalTransformerView.Articles', 'plugin.FractalTransformerView.Authors'];
 
     /**
      * @var \Cake\ORM\Table
@@ -370,9 +371,8 @@ public function testDataToSerializeSingle(): void
      */
     public function protectedMethodCall(object $obj, string $name, array $args = [])
     {
-        $class = new \ReflectionClass($obj);
+        $class = new ReflectionClass($obj);
         $method = $class->getMethod($name);
-        $method->setAccessible(true);
 
         return $method->invokeArgs($obj, $args);
     }