Extract InsertEdit dependencies to constructor params

MauricioFauth · MauricioFauth · commit 27bdd0d64d5f · 2022-06-01T23:42:47.000-03:00
Signed-off-by: Maurício Meneghini Fauth &lt;mauricio@fauth.dev&gt;
diff --git a/libraries/classes/InsertEdit.php b/libraries/classes/InsertEdit.php
@@ -1,7 +1,4 @@
 <?php
-/**
- * set of functions with the insert/edit features in pma
- */
 
 declare(strict_types=1);
 
@@ -54,16 +51,9 @@
 use const ENT_COMPAT;
 use const PASSWORD_DEFAULT;
 
-/**
- * PhpMyAdmin\InsertEdit class
- */
 class InsertEdit
 {
-    /**
-     * DatabaseInterface instance
-     *
-     * @var DatabaseInterface
-     */
+    /** @var DatabaseInterface */
     private $dbi;
 
     /** @var Relation */
@@ -76,18 +66,20 @@ class InsertEdit
     private $fileListing;
 
     /** @var Template */
-    public $template;
-
-    /**
-     * @param DatabaseInterface $dbi DatabaseInterface instance
-     */
-    public function __construct(DatabaseInterface $dbi)
-    {
+    private $template;
+
+    public function __construct(
+        DatabaseInterface $dbi,
+        Relation $relation,
+        Transformations $transformations,
+        FileListing $fileListing,
+        Template $template
+    ) {
         $this->dbi = $dbi;
-        $this->relation = new Relation($this->dbi);
-        $this->transformations = new Transformations();
-        $this->fileListing = new FileListing();
-        $this->template = new Template();
+        $this->relation = $relation;
+        $this->transformations = $transformations;
+        $this->fileListing = $fileListing;
+        $this->template = $template;
     }
 
     /**
diff --git a/libraries/services.php b/libraries/services.php
@@ -87,6 +87,7 @@
         'expression_language' => [
             'class' => Symfony\Component\ExpressionLanguage\ExpressionLanguage::class,
         ],
+        'file_listing' => ['class' => PhpMyAdmin\FileListing::class],
         'flash' => [
             'class' => PhpMyAdmin\FlashMessages::class,
         ],
@@ -102,7 +103,7 @@
         ],
         'insert_edit' => [
             'class' => PhpMyAdmin\InsertEdit::class,
-            'arguments' => ['@dbi'],
+            'arguments' => ['@dbi', '@relation', '@transformations', '@file_listing', '@template'],
         ],
         'navigation' => [
             'class' => PhpMyAdmin\Navigation\Navigation::class,
diff --git a/test/classes/Controllers/Table/ChangeControllerTest.php b/test/classes/Controllers/Table/ChangeControllerTest.php
@@ -7,10 +7,12 @@
 use PhpMyAdmin\Config\PageSettings;
 use PhpMyAdmin\ConfigStorage\Relation;
 use PhpMyAdmin\Controllers\Table\ChangeController;
+use PhpMyAdmin\FileListing;
 use PhpMyAdmin\InsertEdit;
 use PhpMyAdmin\Template;
 use PhpMyAdmin\Tests\AbstractTestCase;
 use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
+use PhpMyAdmin\Transformations;
 
 /**
  * @covers \PhpMyAdmin\Controllers\Table\ChangeController
@@ -37,11 +39,13 @@ public function testChangeController(): void
         $response = new ResponseRenderer();
         $pageSettings = new PageSettings('Edit');
 
+        $relation = new Relation($dbi);
+        $template = new Template();
         (new ChangeController(
             $response,
-            new Template(),
-            new InsertEdit($dbi),
-            new Relation($dbi)
+            $template,
+            new InsertEdit($dbi, $relation, new Transformations(), new FileListing(), $template),
+            $relation
         ))();
         $actual = $response->getHTMLResult();
 
diff --git a/test/classes/InsertEditTest.php b/test/classes/InsertEditTest.php
@@ -4,14 +4,18 @@
 
 namespace PhpMyAdmin\Tests;
 
+use PhpMyAdmin\ConfigStorage\Relation;
 use PhpMyAdmin\Core;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Dbal\Warning;
 use PhpMyAdmin\FieldMetadata;
+use PhpMyAdmin\FileListing;
 use PhpMyAdmin\InsertEdit;
 use PhpMyAdmin\ResponseRenderer;
 use PhpMyAdmin\Table;
+use PhpMyAdmin\Template;
 use PhpMyAdmin\Tests\Stubs\DummyResult;
+use PhpMyAdmin\Transformations;
 use PhpMyAdmin\Url;
 use ReflectionProperty;
 use stdClass;
@@ -70,7 +74,13 @@ protected function setUp(): void
         $GLOBALS['cfg']['Confirm'] = true;
         $GLOBALS['cfg']['LoginCookieValidity'] = 1440;
         $GLOBALS['cfg']['enable_drag_drop_import'] = true;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $this->dbi,
+            new Relation($this->dbi),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
     }
 
     /**
@@ -198,7 +208,13 @@ public function testAnalyzeWhereClause(): void
             );
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
         $result = $this->callFunction(
             $this->insertEdit,
             InsertEdit::class,
@@ -252,7 +268,13 @@ public function testShowEmptyResultMessageOrSetUniqueCondition(): void
             ->will($this->returnValue($meta_arr));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->callFunction(
             $this->insertEdit,
@@ -361,7 +383,13 @@ public function testLoadFirstRow($configValue, array $rowsValue): void
             ->will($this->returnValue($resultStub));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->callFunction(
             $this->insertEdit,
@@ -1414,7 +1442,13 @@ public function testGetSpecialCharsAndBackupFieldForExistingRow(): void
             ->getMock();
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $current_row['f'] = '123';
         $extracted_columnspec['spec_in_brackets'] = '20';
@@ -1639,7 +1673,13 @@ public function testSetSessionForEditNext(): void
         $GLOBALS['dbi'] = $dbi;
         $GLOBALS['db'] = 'db';
         $GLOBALS['table'] = 'table';
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
         $this->insertEdit->setSessionForEditNext('`a` = 2');
 
         $this->assertEquals('CONCAT(`table`.`orgname`) IS NULL', $_SESSION['edit_next']);
@@ -1738,7 +1778,13 @@ public function testExecuteSqlQuery(): void
         $GLOBALS['cfg']['IgnoreMultiSubmitErrors'] = false;
         $_POST['submit_type'] = '';
 
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
         $result = $this->insertEdit->executeSqlQuery([], $query);
 
         $this->assertEquals(['sql_query' => 'SELECT * FROM `test_db`.`test_table`;'], $result[0]);
@@ -1759,7 +1805,13 @@ public function testExecuteSqlQueryWithTryQuery(): void
         $GLOBALS['cfg']['IgnoreMultiSubmitErrors'] = true;
         $_POST['submit_type'] = '';
 
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
         $result = $this->insertEdit->executeSqlQuery([], $query);
 
         $this->assertEquals(['sql_query' => 'SELECT * FROM `test_db`.`test_table`;'], $result[0]);
@@ -1786,7 +1838,13 @@ public function testGetWarningMessages(): void
             ->will($this->returnValue($warnings));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->callFunction(
             $this->insertEdit,
@@ -1831,7 +1889,13 @@ public function testGetDisplayValueForForeignTableColumn(): void
             ->will($this->returnValue('2'));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->insertEdit->getDisplayValueForForeignTableColumn('=1', $map, 'f');
 
@@ -2054,7 +2118,13 @@ public function testGetCurrentValueAsAnArrayForMultipleEdit(): void
             ->will($this->returnValue('uuid1234'));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->insertEdit->getCurrentValueAsAnArrayForMultipleEdit(
             $multi_edit_funcs,
@@ -2118,7 +2188,13 @@ public function testGetCurrentValueAsAnArrayForMultipleEdit(): void
      */
     public function testGetCurrentValueForDifferentTypes(): void
     {
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->insertEdit->getCurrentValueForDifferentTypes(
             '123',
@@ -2355,7 +2431,13 @@ public function testVerifyWhetherValueCanBeTruncatedAndAppendExtraData(): void
             ->will($this->onConsecutiveCalls(false, '123', '2013-08-28 06:34:14'));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $this->insertEdit->verifyWhetherValueCanBeTruncatedAndAppendExtraData('db', 'table', 'a', $extra_data);
 
@@ -2394,7 +2476,13 @@ public function testGetTableColumns(): void
             ]));
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->insertEdit->getTableColumns('db', 'table');
 
@@ -2442,7 +2530,13 @@ public function testDetermineInsertOrEdit(): void
         $response->setAccessible(true);
         $response->setValue($responseMock);
 
-        $this->insertEdit = new InsertEdit($dbi);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $result = $this->insertEdit->determineInsertOrEdit('1', 'db', 'table');
 
@@ -2521,7 +2615,13 @@ public function testGetCommentsMap(): void
             );
 
         $GLOBALS['dbi'] = $dbi;
-        $this->insertEdit = new InsertEdit($GLOBALS['dbi']);
+        $this->insertEdit = new InsertEdit(
+            $GLOBALS['dbi'],
+            new Relation($GLOBALS['dbi']),
+            new Transformations(),
+            new FileListing(),
+            new Template()
+        );
 
         $this->assertEquals(
             [],
