Handle non conventional controller names

Author: pabloelcolombiano

.gitignore

@@ -2,3 +2,4 @@ build
 composer.lock
 vendor
 .phpunit.result.cache
+.idea

README.md

@@ -73,7 +73,7 @@ and will look something like this:
 
 ### Configuring the Pagination Output
 
-ApiPagination has three keys for configuration: `key`, `aliases`, and `visible`.
+ApiPagination has four keys for configuration: `key`, `aliases`, `visible` and `model`.
 
 * `key` allows you to change the name of the pagination key.
 
@@ -83,6 +83,10 @@ ApiPagination has three keys for configuration: `key`, `aliases`, and `visible`.
   response. **Note:** Whenever setting a key's visibility, make sure to use the
   aliased name if you've given it one.
 
+* `model` allows you to set the name of the model the pagination is applied on
+  if the controller does not follow CakePHP conventions, e.g. `ArticlesIndexController`.
+  Per default the model is the name of the controller, e.g. `Articles` for `ArticlesController`.
+
 An example using all these configuration keys:
 
 ``` php
@@ -97,7 +101,8 @@ $this->loadComponent('BryanCrowe/ApiPagination.ApiPagination', [
         'resultCount',
         'prevPage',
         'nextPage'
-    ]
+    ],
+    'model' => 'Articles',
 ]);
 ```
 

src/Controller/Component/ApiPaginationComponent.php

@@ -45,7 +45,8 @@ public function beforeRender(Event $event)
         }
 
         $subject = $event->getSubject();
-        $this->pagingInfo = $this->getController()->getRequest()->getAttribute('paging')[$subject->getName()];
+        $modelName = ucfirst($this->getConfig('model', $subject->getName()));
+        $this->pagingInfo = $this->getController()->getRequest()->getAttribute('paging')[$modelName];
         $config = $this->getConfig();
 
         if (!empty($config['aliases'])) {

tests/TestCase/Controller/Component/ApiPaginationComponentOnNonConventionalControllerNameTest.php

@@ -0,0 +1,113 @@
+<?php
+declare(strict_types=1);
+
+namespace BryanCrowe\ApiPagination\Test;
+
+use BryanCrowe\ApiPagination\Controller\Component\ApiPaginationComponent;
+use BryanCrowe\ApiPagination\TestApp\Controller\ArticlesIndexController;
+use Cake\Event\Event;
+use Cake\Http\ServerRequest as Request;
+use Cake\ORM\TableRegistry;
+use Cake\TestSuite\TestCase;
+
+/**
+ * ApiPaginationComponentTest class
+ *
+ * @property ArticlesIndexController $controller
+ */
+class ApiPaginationComponentOnNonConventionalControllerNameTest extends TestCase
+{
+    public $fixtures = ['plugin.BryanCrowe/ApiPagination.Articles'];
+
+    /**
+     * setUp method
+     *
+     * @return void
+     */
+    public function setUp(): void
+    {
+        $this->request = new Request(['url' => '/articles']);
+        $this->response = $this->createMock('Cake\Http\Response');
+        $this->controller = new ArticlesIndexController($this->request, $this->response);
+        $this->Articles = TableRegistry::getTableLocator()->get('BryanCrowe/ApiPagination.Articles', ['table' => 'bryancrowe_articles']);
+        parent::setUp();
+    }
+
+    /**
+     * tearDown method
+     *
+     * @return void
+     */
+    public function tearDown(): void
+    {
+        parent::tearDown();
+    }
+
+    /**
+     * Test that a non conventional controller name is supported using the 'model' config.
+     *
+     * @dataProvider dataForTestVariousModelValueOnNonConventionalController
+     * @param array $config
+     * @param $expected
+     * @return void
+     */
+    public function testVariousModelValueOnNonConventionalController(array $config, $expected)
+    {
+        $this->controller->setRequest(
+            $this->controller->getRequest()->withEnv('HTTP_ACCEPT', 'application/json')
+        );
+        $this->controller->set('data', $this->controller->paginate($this->Articles));
+        $apiPaginationComponent = new ApiPaginationComponent($this->controller->components(), $config);
+        $event = new Event('Controller.beforeRender', $this->controller);
+        $apiPaginationComponent->beforeRender($event);
+
+        $result = $apiPaginationComponent->getController()->viewBuilder()->getVar('pagination');
+        $this->assertSame($expected, $result);
+    }
+
+    /**
+     * If the name of the paginated model is not specified, the result of the pagination
+     * on a controller not having the same name as the model fails.
+     *
+     * @return array[]
+     */
+    public function dataForTestVariousModelValueOnNonConventionalController(): array
+    {
+        return [
+
+            [[], null],
+            [['model' => 'Articles'], $this->getDefaultPagination()],
+            [['model' => 'articles'], $this->getDefaultPagination()],
+            [['model' => 'NonExistingModel'], null],
+        ];
+    }
+
+    /**
+     * Returns the standard pagination result.
+     *
+     * @return array
+     */
+    private function getDefaultPagination(): array
+    {
+        return [
+            'count' => 23,
+            'current' => 20,
+            'perPage' => 20,
+            'page' => 1,
+            'requestedPage' => 1,
+            'pageCount' => 2,
+            'start' => 1,
+            'end' => 20,
+            'prevPage' => false,
+            'nextPage' => true,
+            'sort' => null,
+            'direction' => null,
+            'sortDefault' => false,
+            'directionDefault' => false,
+            'completeSort' => [],
+            'limit' => null,
+            'scope' => null,
+            'finder' => 'all',
+        ];
+    }
+}

tests/TestCase/Controller/Component/ApiPaginationComponentTest.php

@@ -29,7 +29,7 @@ public function setUp(): void
         $this->request = new Request(['url' => '/articles']);
         $this->response = $this->createMock('Cake\Http\Response');
         $this->controller = new ArticlesController($this->request, $this->response);
-        $this->Articles = TableRegistry::get('BryanCrowe/ApiPagination.Articles', ['table' => 'bryancrowe_articles']);
+        $this->Articles = TableRegistry::getTableLocator()->get('BryanCrowe/ApiPagination.Articles', ['table' => 'bryancrowe_articles']);
         parent::setUp();
     }
 

tests/test_app/TestApp/Controller/ArticlesIndexController.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace BryanCrowe\ApiPagination\TestApp\Controller;
+
+use Cake\Controller\Controller;
+
+class ArticlesIndexController extends Controller
+{
+    public function initialize(): void
+    {
+        parent::initialize();
+        $this->loadComponent('Paginator');
+    }
+}