Merge branch 'bcrowe:master' into master

Author: ishanvyas22

.github/workflows/ci.yml

@@ -0,0 +1,125 @@
+name: CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "*" ]
+  schedule:
+    - cron: "0 0 * * 0" # Runs at 00:00 UTC on Sun.
+
+permissions:
+  contents: read
+
+jobs:
+  #########################
+  # Run PHPUnit testsuite #
+  #########################
+  testsuite:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3']
+        db-type: [mysql]
+        prefer-lowest: ['', 'prefer-lowest']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup MySQL 8
+      if: matrix.db-type == 'mysql'
+      run: docker run --rm --name=mysqld -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=cakephp -p 3306:3306 -d mysql:8 --default-authentication-plugin=mysql_native_password --disable-log-bin
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Get composer cache directory
+      id: composer-cache
+      run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+    - name: Get date part for cache key
+      id: key-date
+      run: echo "date=$(date +'%Y-%m')" >> $GITHUB_OUTPUT
+
+    - name: Cache composer dependencies
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.composer-cache.outputs.dir }}
+        key: test-${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}-${{ matrix.prefer-lowest }}
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+        extensions: mbstring, intl
+
+    - name: Install composer dependencies
+      run: |
+        if ${{ matrix.prefer-lowest == 'prefer-lowest' }}; then
+          composer update --prefer-lowest --prefer-stable
+        elif ${{ matrix.php-version == '8.2' }}; then
+          composer update --ignore-platform-req=php
+        else
+          composer update
+        fi
+
+    - name: Wait for MySQL
+      if: matrix.db-type == 'mysql'
+      run: while ! `mysqladmin ping -h 127.0.0.1 --silent`; do printf 'Waiting for MySQL...\n'; sleep 2; done;
+
+    - name: Run PHPUnit testsuite
+      run: |
+        if [[ ${{ matrix.db-type }} == 'mysql' ]]; then
+          export DB_URL='mysql://root:[email protected]/cakephp';
+          mysql -h 127.0.0.1 -u root -proot cakephp < ./tests/Schema/articles.sql
+        fi
+        vendor/bin/phpunit --stderr;
+
+  ##############
+  # Code style #
+  ##############
+  cs:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-versions: ['7.4']
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Get composer cache directory
+      id: composer-cache
+      run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+    - name: Get date part for cache key
+      id: key-date
+      run: echo "date=$(date +'%Y-%m')" >> $GITHUB_OUTPUT
+
+    - name: Cache composer dependencies
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.composer-cache.outputs.dir }}
+        key: cs-${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}-${{ matrix.prefer-lowest }}
+        restore-keys: |
+          cs-${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}-${{ matrix.prefer-lowest }}
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+        extensions: mbstring, intl
+
+    - name: Install composer dependencies
+      run: composer update --no-interaction
+
+    - name: Run CS check
+      run: composer cs-check

.travis.yml

@@ -2,14 +2,16 @@
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
 [![Software License][ico-license]](LICENSE.md)
-[![Build Status][ico-travis]][link-travis]
+[![Build Status][ico-github]][link-github]
 [![Coverage Status][ico-scrutinizer]][link-scrutinizer]
 [![Quality Score][ico-code-quality]][link-code-quality]
 [![Total Downloads][ico-downloads]][link-downloads]
 
-This is a simple component for CakePHP 4 which injects pagination information
+This is a simple component for CakePHP 4.2+ which injects pagination information
 from CakePHP's Paginator into serialized JsonView and XmlView responses.
 
+See `1.x` and `2.x` releases and branches of this plugin for support of previous versions of CakePHP before `4.2`.
+
 ## Install
 
 Via Composer
@@ -18,10 +20,19 @@ Via Composer
 $ composer require bcrowe/cakephp-api-pagination
 ```
 
-Load the plugin in your application's `bootstrap.php` file:
+Load the plugin by adding `$this->addPlugin('BryanCrowe/ApiPagination');` to the `bootsrap` method in your project’s `src/Application.php`:
 
 ``` php
-Plugin::load('BryanCrowe/ApiPagination');
+public function bootstrap(): void
+{
+    parent::bootstrap();
+    
+    // ... bootstrap code ...
+
+    // load more plugins here
+    
+    $this->addPlugin('BryanCrowe/ApiPagination');
+}
 ```
 
 ## Usage
@@ -40,10 +51,9 @@ Then, go ahead and set your paginated view variable like so:
 
 ``` php
 $this->set('articles', $this->paginate($this->Articles));
-$this->set('_serialize', ['articles']);
+$this->viewBuilder()->setOption('serialize', ['articles']);
 ```
-
-**Note:** It is important that your `_serialize` variable is an array, e.g.
+**Note:** It is important that your `serialize` option is an array, e.g.
 `['articles']`, so that your pagination information can be set under its own
 pagination key.
 
@@ -153,16 +163,16 @@ information.
 
 [ico-version]: https://img.shields.io/packagist/v/bcrowe/cakephp-api-pagination.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/bcrowe/cakephp-api-pagination/master.svg?style=flat-square
+[ico-github]: https://github.com/bcrowe/cakephp-api-pagination/workflows/CI/badge.svg
 [ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/bcrowe/cakephp-api-pagination.svg?style=flat-square
 [ico-code-quality]: https://img.shields.io/scrutinizer/g/bcrowe/cakephp-api-pagination.svg?style=flat-square
 [ico-downloads]: https://img.shields.io/packagist/dt/bcrowe/cakephp-api-pagination.svg?style=flat-square
 
 [link-packagist]: https://packagist.org/packages/bcrowe/cakephp-api-pagination
-[link-travis]: https://travis-ci.org/bcrowe/cakephp-api-pagination
+[link-github]: https://github.com/bcrowe/cakephp-api-pagination/actions
 [link-scrutinizer]: https://scrutinizer-ci.com/g/bcrowe/cakephp-api-pagination/code-structure
 [link-code-quality]: https://scrutinizer-ci.com/g/bcrowe/cakephp-api-pagination
 [link-downloads]: https://packagist.org/packages/bcrowe/cakephp-api-pagination
 [link-author]: https://github.com/bcrowe
 [link-contributors]: ../../contributors
-[link-dataviews]: http://book.cakephp.org/3.0/en/views/json-and-xml-views.html#enabling-data-views-in-your-application
+[link-dataviews]: https://book.cakephp.org/4/en/views/json-and-xml-views.html#enabling-data-views-in-your-application

README.md

@@ -17,12 +17,12 @@
     ],
     "require": {
         "php": ">=7.2",
-        "cakephp/cakephp": "^4.0"
+        "cakephp/cakephp": "^4.2"
     },
     "require-dev": {
-        "phpunit/phpunit" : "^8.5",
+        "phpunit/phpunit" : "^8.5.23",
         "scrutinizer/ocular": "1.7",
-        "cakephp/cakephp-codesniffer": "~4.0.0"
+        "cakephp/cakephp-codesniffer": "^4.7"
     },
     "autoload": {
         "psr-4": {
@@ -45,5 +45,10 @@
         "branch-alias": {
             "dev-master": "1.0-dev"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }

composer.json

@@ -16,8 +16,7 @@
     </testsuites>
     <listeners>
         <listener
-        class="\Cake\TestSuite\Fixture\FixtureInjector"
-        file="./vendor/cakephp/cakephp/src/TestSuite/Fixture/FixtureInjector.php">
+            class="\Cake\TestSuite\Fixture\FixtureInjector">
             <arguments>
                 <object class="\Cake\TestSuite\Fixture\FixtureManager" />
             </arguments>

phpunit.xml.dist

@@ -46,7 +46,10 @@ public function beforeRender(Event $event)
 
         $subject = $event->getSubject();
         $modelName = ucfirst($this->getConfig('model', $subject->getName()));
-        $this->pagingInfo = $this->getController()->getRequest()->getAttribute('paging')[$modelName];
+        if (isset($this->getController()->getRequest()->getAttribute('paging')[$modelName])) {
+            $this->pagingInfo = $this->getController()->getRequest()->getAttribute('paging')[$modelName];
+        }
+
         $config = $this->getConfig();
 
         if (!empty($config['aliases'])) {
@@ -59,8 +62,11 @@ public function beforeRender(Event $event)
 
         $subject->set($config['key'], $this->pagingInfo);
         $data = $subject->viewBuilder()->getOption('serialize') ?? [];
-        $data[] = $config['key'];
-        $subject->viewBuilder()->setOption('serialize', $data);
+
+        if (is_array($data)) {
+            $data[] = $config['key'];
+            $subject->viewBuilder()->setOption('serialize', $data);
+        }
     }
 
     /**

src/Controller/Component/ApiPaginationComponent.php

@@ -7,13 +7,6 @@ class ArticlesFixture extends TestFixture
 {
     public $table = 'bryancrowe_articles';
 
-    public $fields = [
-        'id' => ['type' => 'integer'],
-        'title' => ['type' => 'string', 'null' => false],
-        'body' => 'text',
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
-    ];
-
     public $records = [
         ['title' => 'Post #1', 'body' => 'This is the article body.'],
         ['title' => 'Post #2', 'body' => 'This is the article body.'],

tests/Fixture/ArticlesFixture.php

@@ -0,0 +1,5 @@
+CREATE TABLE `bryancrowe_articles` (
+  `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  `title` varchar(255) NOT NULL,
+  `body` text NOT NULL
+);

tests/Schema/articles.sql

@@ -74,11 +74,10 @@ public function testVariousModelValueOnNonConventionalController(array $config,
     public function dataForTestVariousModelValueOnNonConventionalController(): array
     {
         return [
-
-            [[], null],
+            [[], []],
             [['model' => 'Articles'], $this->getDefaultPagination()],
             [['model' => 'articles'], $this->getDefaultPagination()],
-            [['model' => 'NonExistingModel'], null],
+            [['model' => 'NonExistingModel'], []],
         ];
     }
 

tests/TestCase/Controller/Component/ApiPaginationComponentOnNonConventionalControllerNameTest.php

@@ -10,6 +10,5 @@ class ArticlesController extends Controller
     public function initialize(): void
     {
         parent::initialize();
-        $this->loadComponent('Paginator');
     }
 }