Merge pull request #763 from cakephp/remove-tableregistry-usage

Remove usage of TableRegistry
cakephp · Jun 7, 2020 · 1858160 · 1858160
2 parents a0b70d1 + efc6759
commit 1858160
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 32 deletions.
diff --git a/src/Panel/HistoryPanel.php b/src/Panel/HistoryPanel.php
@@ -14,22 +14,24 @@
  */
 namespace DebugKit\Panel;
 
-use Cake\ORM\TableRegistry;
+use Cake\ORM\Locator\LocatorAwareTrait;
 use DebugKit\DebugPanel;
 
 /**
  * Provides debug information on previous requests.
  */
 class HistoryPanel extends DebugPanel
 {
+    use LocatorAwareTrait;
+
     /**
      * Get the data for the panel.
      *
      * @return array
      */
     public function data()
     {
-        $table = TableRegistry::getTableLocator()->get('DebugKit.Requests');
+        $table = $this->getTableLocator()->get('DebugKit.Requests');
         $recent = $table->find('recent');
 
         return [

diff --git a/src/Panel/SqlLogPanel.php b/src/Panel/SqlLogPanel.php
@@ -17,8 +17,8 @@
 use Cake\Core\Configure;
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
+use Cake\ORM\Locator\LocatorAwareTrait;
 use Cake\ORM\Table;
-use Cake\ORM\TableRegistry;
 use DebugKit\Database\Log\DebugLog;
 use DebugKit\DebugPanel;
 
@@ -27,6 +27,8 @@
  */
 class SqlLogPanel extends DebugPanel
 {
+    use LocatorAwareTrait;
+
     /**
      * Loggers connected
      *
@@ -84,7 +86,7 @@ public function data()
         return [
             'tables' => array_map(function (Table $table) {
                 return $table->getAlias();
-            }, TableRegistry::getTableLocator()->genericInstances()),
+            }, $this->getTableLocator()->genericInstances()),
             'loggers' => $this->_loggers,
         ];
     }

diff --git a/src/ToolbarService.php b/src/ToolbarService.php
@@ -19,7 +19,7 @@
 use Cake\Event\EventManager;
 use Cake\Http\ServerRequest;
 use Cake\Log\Log;
-use Cake\ORM\TableRegistry;
+use Cake\ORM\Locator\LocatorAwareTrait;
 use Cake\Routing\Router;
 use DebugKit\Panel\PanelRegistry;
 use PDOException;
@@ -34,6 +34,7 @@
 class ToolbarService
 {
     use InstanceConfigTrait;
+    use LocatorAwareTrait;
 
     /**
      * The panel registry.
@@ -230,7 +231,7 @@ public function saveData(ServerRequest $request, ResponseInterface $response)
             'panels' => [],
         ];
         /** @var \DebugKit\Model\Table\RequestsTable $requests */
-        $requests = TableRegistry::getTableLocator()->get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $requests->gc();
 
         $row = $requests->newEntity($data);

diff --git a/tests/TestCase/Controller/DashboardControllerTest.php b/tests/TestCase/Controller/DashboardControllerTest.php
@@ -15,7 +15,6 @@
  */
 namespace DebugKit\Test\TestCase\Controller;
 
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\IntegrationTestCase;
 use DebugKit\TestApp\Application;
 
@@ -43,7 +42,7 @@ public function setUp(): void
 
     public function testIndexNoRequests()
     {
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $requests->Panels->deleteAll('1=1');
         $requests->deleteAll('1=1');
 
@@ -56,7 +55,7 @@ public function testIndexNoRequests()
 
     public function testIndexWithRequests()
     {
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $request = $requests->newEntity(['url' => '/example']);
         $requests->save($request);
 
@@ -69,7 +68,7 @@ public function testIndexWithRequests()
 
     public function testReset()
     {
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $this->assertGreaterThan(0, $requests->find()->count(), 'precondition failed');
 
         $this->post('/debug-kit/dashboard/reset');

diff --git a/tests/TestCase/Controller/MailPreviewControllerTest.php b/tests/TestCase/Controller/MailPreviewControllerTest.php
@@ -15,7 +15,6 @@
  */
 namespace DebugKit\Test\TestCase\Controller;
 
-use Cake\ORM\TableRegistry;
 use Cake\Routing\Router;
 use Cake\TestSuite\IntegrationTestCase;
 use DebugKit\TestApp\Application;
@@ -106,7 +105,7 @@ public function testSentInvalidData()
      */
     public function testSentValidData()
     {
-        $panels = TableRegistry::get('Panels');
+        $panels = $this->getTableLocator()->get('Panels');
         $panel = $panels->newEntity(['request_id' => 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa']);
         $data = [
             'emails' => [
@@ -132,7 +131,7 @@ public function testSentValidData()
      */
     public function testSentValidDataRenderPart()
     {
-        $panels = TableRegistry::get('Panels');
+        $panels = $this->getTableLocator()->get('Panels');
         $panel = $panels->newEntity(['request_id' => 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa']);
         $data = [
             'emails' => [

diff --git a/tests/TestCase/DebugSqlTest.php b/tests/TestCase/DebugSqlTest.php
@@ -16,7 +16,6 @@
 
 use Cake\Database\Driver\Postgres;
 use Cake\Datasource\ConnectionManager;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DebugKit\DebugSql;
 
@@ -98,6 +97,6 @@ public function testSqlHtml()
      */
     private function newQuery()
     {
-        return TableRegistry::get('panels')->query();
+        return $this->getTableLocator()->get('panels')->query();
     }
 }
diff --git a/tests/TestCase/Middleware/DebugKitMiddlewareTest.php b/tests/TestCase/Middleware/DebugKitMiddlewareTest.php
@@ -21,7 +21,6 @@
 use Cake\Http\CallbackStream;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DebugKit\Middleware\DebugKitMiddleware;
 use Psr\Http\Server\RequestHandlerInterface;
@@ -102,7 +101,7 @@ public function testInvokeSaveData()
         $response = $middleware->process($request, $handler);
         $this->assertInstanceOf(Response::class, $response, 'Should return the response');
 
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $result = $requests->find()
             ->order(['Requests.requested_at' => 'DESC'])
             ->contain('Panels')
@@ -160,7 +159,7 @@ public function testInvokeNoModifyBinaryResponse()
         $result = $middleware->process($request, $handler);
         $this->assertInstanceOf(Response::class, $result, 'Should return a response');
 
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $total = $requests->find()->where(['url' => '/articles'])->count();
 
         $this->assertSame(1, $total, 'Should track response');
@@ -194,7 +193,7 @@ public function testInvokeNoModifyNonHtmlResponse()
         $result = $middleware->process($request, $handler);
         $this->assertInstanceOf(Response::class, $result, 'Should return a response');
 
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $total = $requests->find()->where(['url' => '/articles'])->count();
 
         $this->assertEquals(1, $total, 'Should track response');

diff --git a/tests/TestCase/Model/Behavior/TimedBehaviorTest.php b/tests/TestCase/Model/Behavior/TimedBehaviorTest.php
@@ -15,7 +15,6 @@
  */
 namespace DebugKit\Test\TestCase\Model\Behavior;
 
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DebugKit\DebugTimer;
 
@@ -44,7 +43,7 @@ class TimedBehaviorTest extends TestCase
     public function setUp(): void
     {
         parent::setUp();
-        $this->Article = TableRegistry::get('Articles');
+        $this->Article = $this->getTableLocator()->get('Articles');
         $this->Article->addBehavior('DebugKit.Timed');
     }
 

diff --git a/tests/TestCase/Model/Table/RequestTableTest.php b/tests/TestCase/Model/Table/RequestTableTest.php
@@ -18,7 +18,6 @@
 use Cake\Core\Configure;
 use Cake\Database\Driver\Sqlite;
 use Cake\Datasource\ConnectionManager;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 
 /**
@@ -54,8 +53,8 @@ public function testInitializeCreatesSchema()
         $stmt = $connection->execute('DROP TABLE IF EXISTS requests');
         $stmt->closeCursor();
 
-        TableRegistry::get('DebugKit.Requests');
-        TableRegistry::get('DebugKit.Panels');
+        $this->getTableLocator()->get('DebugKit.Requests');
+        $this->getTableLocator()->get('DebugKit.Panels');
 
         $schema = $connection->getSchemaCollection();
         $this->assertContains('requests', $schema->listTables());
@@ -69,7 +68,7 @@ public function testInitializeCreatesSchema()
      */
     public function testFindRecent()
     {
-        $table = TableRegistry::get('DebugKit.Requests');
+        $table = $this->getTableLocator()->get('DebugKit.Requests');
         $query = $table->find('recent');
         $this->assertSame(10, $query->clause('limit'));
         $this->assertNotEmpty($query->clause('order'));

diff --git a/tests/TestCase/Panel/SqlLogPanelTest.php b/tests/TestCase/Panel/SqlLogPanelTest.php
@@ -16,7 +16,6 @@
 
 use Cake\Core\Configure;
 use Cake\Datasource\ConnectionManager;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DebugKit\Panel\SqlLogPanel;
 use ReflectionProperty;
@@ -106,7 +105,7 @@ public function testData()
         $this->panel->initialize();
 
         /** @var Table $articles */
-        $articles = TableRegistry::get('Articles');
+        $articles = $this->getTableLocator()->get('Articles');
         $articles->findById(1)->first();
 
         $result = $this->panel->data();
@@ -123,7 +122,7 @@ public function testSummary()
         $this->panel->initialize();
 
         /** @var Table $articles */
-        $articles = TableRegistry::get('Articles');
+        $articles = $this->getTableLocator()->get('Articles');
         $articles->findById(1)->first();
 
         $result = $this->panel->summary();

diff --git a/tests/TestCase/Panel/VariablesPanelTest.php b/tests/TestCase/Panel/VariablesPanelTest.php
@@ -15,7 +15,6 @@
 namespace DebugKit\Test\TestCase\Panel;
 
 use Cake\Event\Event;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use Cake\View\ViewVarsTrait;
 use DebugKit\Panel\VariablesPanel;
@@ -62,7 +61,7 @@ public function tearDown(): void
      */
     public function testShutdown()
     {
-        $requests = TableRegistry::get('Requests');
+        $requests = $this->getTableLocator()->get('Requests');
         $query = $requests->find('all');
         $result = $requests->find()->all();
         $unbufferedQuery = $requests->find('all')->enableBufferedResults(false);

diff --git a/tests/TestCase/ToolbarServiceTest.php b/tests/TestCase/ToolbarServiceTest.php
@@ -22,7 +22,6 @@
 use Cake\Http\Response;
 use Cake\Http\ServerRequest as Request;
 use Cake\Log\Log;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DebugKit\Model\Entity\Request as RequestEntity;
 use DebugKit\ToolbarService;
@@ -187,7 +186,7 @@ public function testSaveData()
         $row = $bar->saveData($request, $response);
         $this->assertNotEmpty($row);
 
-        $requests = TableRegistry::get('DebugKit.Requests');
+        $requests = $this->getTableLocator()->get('DebugKit.Requests');
         $result = $requests->find()
             ->order(['Requests.requested_at' => 'DESC'])
             ->contain('Panels')