Merge pull request #667 from cakephp/table-scanner-ignore

Allow regex pattern for ignore
cakephp · Apr 5, 2020 · c88883e · c88883e
2 parents e11edef + 28b708a
commit c88883e
Show file tree

Hide file tree

Showing 16 changed files with 174 additions and 18 deletions.
diff --git a/src/Utility/TableScanner.php b/src/Utility/TableScanner.php
@@ -43,14 +43,14 @@ class TableScanner
      * Constructor
      *
      * @param \Cake\Database\Connection $connection The connection name in ConnectionManager
-     * @param string[]|null $ignore List of tables to ignore. If null, the default ignore
+     * @param string[]|null $ignore List of tables or regex pattern to ignore. If null, the default ignore
      *   list will be used.
      */
     public function __construct(Connection $connection, ?array $ignore = null)
     {
         $this->connection = $connection;
         if ($ignore === null) {
-            $ignore = ['i18n', 'cake_sessions', 'phinxlog', 'users_phinxlog'];
+            $ignore = ['i18n', 'cake_sessions', 'sessions', '/phinxlog/'];
         }
         $this->ignore = $ignore;
     }
@@ -69,7 +69,7 @@ public function listAll(): array
         }
         sort($tables);
 
-        return $tables;
+        return array_combine($tables, $tables);
     }
 
     /**
@@ -81,6 +81,34 @@ public function listUnskipped(): array
     {
         $tables = $this->listAll();
 
-        return array_diff($tables, $this->ignore);
+        foreach ($tables as $key => $table) {
+            if ($this->shouldSkip($table)) {
+                unset($tables[$key]);
+            }
+        }
+
+        return $tables;
+    }
+
+    /**
+     * @param string $table Table name.
+     *
+     * @return bool
+     */
+    protected function shouldSkip(string $table): bool
+    {
+        foreach ($this->ignore as $ignore) {
+            if (strpos($ignore, '/') === 0) {
+                if ((bool)preg_match($ignore, $table)) {
+                    return true;
+                }
+            }
+
+            if ($ignore === $table) {
+                return true;
+            }
+        }
+
+        return false;
     }
 }
diff --git a/tests/TestCase/Command/AllCommandTest.php b/tests/TestCase/Command/AllCommandTest.php
@@ -31,7 +31,7 @@ class AllCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.Products',
         'plugin.Bake.ProductVersions',
     ];

diff --git a/tests/TestCase/Command/ControllerAllCommandTest.php b/tests/TestCase/Command/ControllerAllCommandTest.php
@@ -33,7 +33,7 @@ class ControllerAllCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.BakeArticles',
         'plugin.Bake.BakeComments',
     ];

diff --git a/tests/TestCase/Command/ControllerCommandTest.php b/tests/TestCase/Command/ControllerCommandTest.php
@@ -34,7 +34,7 @@ class ControllerCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.BakeArticles',
         'plugin.Bake.BakeArticlesBakeTags',
         'plugin.Bake.BakeComments',

diff --git a/tests/TestCase/Command/FixtureAllCommandTest.php b/tests/TestCase/Command/FixtureAllCommandTest.php
@@ -32,7 +32,7 @@ class FixtureAllCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'core.Articles',
         'core.Comments',
     ];

diff --git a/tests/TestCase/Command/FixtureCommandTest.php b/tests/TestCase/Command/FixtureCommandTest.php
@@ -33,7 +33,7 @@ class FixtureCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'core.Articles',
         'core.Comments',
         'plugin.Bake.Datatypes',

diff --git a/tests/TestCase/Command/ModelAllCommandTest.php b/tests/TestCase/Command/ModelAllCommandTest.php
@@ -33,7 +33,7 @@ class ModelAllCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.TodoTasks',
         'plugin.Bake.TodoItems',
     ];

diff --git a/tests/TestCase/Command/ModelCommandAssociationDetectionTest.php b/tests/TestCase/Command/ModelCommandAssociationDetectionTest.php
@@ -39,7 +39,7 @@ class ModelCommandAssociationDetectionTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.Categories',
         'plugin.Bake.CategoriesProducts',
         'plugin.Bake.OldProducts',

diff --git a/tests/TestCase/Command/ModelCommandTest.php b/tests/TestCase/Command/ModelCommandTest.php
@@ -43,7 +43,7 @@ class ModelCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'core.Comments',
         'core.Tags',
         'core.ArticlesTags',

diff --git a/tests/TestCase/Command/TemplateAllCommandTest.php b/tests/TestCase/Command/TemplateAllCommandTest.php
@@ -33,7 +33,7 @@ class TemplateAllCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'core.Articles',
         'core.Comments',
     ];

diff --git a/tests/TestCase/Command/TemplateCommandTest.php b/tests/TestCase/Command/TemplateCommandTest.php
@@ -37,7 +37,7 @@ class TemplateCommandTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'core.Articles',
         'core.Tags',
         'core.ArticlesTags',

diff --git a/tests/TestCase/Command/TestCommandTest.php b/tests/TestCase/Command/TestCommandTest.php
@@ -37,7 +37,7 @@ class TestCommandTest extends TestCase
      *
      * @var string
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.BakeArticles',
         'plugin.Bake.BakeArticlesBakeTags',
         'plugin.Bake.BakeComments',

diff --git a/tests/TestCase/Utility/Model/AssociationFilterTest.php b/tests/TestCase/Utility/Model/AssociationFilterTest.php
@@ -33,7 +33,7 @@ class AssociationFilterTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'core.Authors',
         'core.Tags',
         'core.Articles',

diff --git a/tests/TestCase/Utility/TableScannerTest.php b/tests/TestCase/Utility/TableScannerTest.php
@@ -0,0 +1,128 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         2.0.0
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Bake\Test\TestCase\Utility;
+
+use Bake\Test\TestCase\TestCase;
+use Bake\Utility\TableScanner;
+use Cake\Datasource\ConnectionManager;
+
+class TableScannerTest extends TestCase
+{
+    /**
+     * @var string[]
+     */
+    protected $fixtures = [
+        'plugin.Bake.TodoTasks',
+        'plugin.Bake.TodoItems',
+    ];
+
+    /**
+     * @var \Bake\Utility\TableScanner
+     */
+    protected $tableScanner;
+
+    /**
+     * @var \Cake\Database\Connection
+     */
+    protected $connection;
+
+    /**
+     * setUp method
+     *
+     * @return void
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->connection = ConnectionManager::get('test');
+    }
+
+    /**
+     * tearDown method
+     *
+     * @return void
+     */
+    public function tearDown(): void
+    {
+        parent::tearDown();
+        unset($this->tableScanner);
+    }
+
+    /**
+     * @return void
+     */
+    public function testListAll()
+    {
+        $this->tableScanner = new TableScanner($this->connection);
+
+        $result = $this->tableScanner->listAll();
+        $list = [
+            'todo_items' => true,
+            'todo_tasks' => true,
+        ];
+        foreach ($list as $key => $expected) {
+            if ($expected) {
+                $this->assertArrayHasKey($key, $result);
+            } else {
+                $this->assertArrayNotHasKey($key, $result);
+            }
+        }
+    }
+
+    /**
+     * @return void
+     */
+    public function testListUnskipped()
+    {
+        $this->tableScanner = new TableScanner($this->connection, ['todo_items']);
+
+        $result = $this->tableScanner->listUnskipped();
+        $list = [
+            'todo_items' => false,
+            'todo_tasks' => true,
+        ];
+        foreach ($list as $key => $expected) {
+            if ($expected) {
+                $this->assertArrayHasKey($key, $result);
+            } else {
+                $this->assertArrayNotHasKey($key, $result);
+            }
+        }
+    }
+
+    /**
+     * @return void
+     */
+    public function testListUnskippedRegex()
+    {
+        $this->tableScanner = new TableScanner($this->connection, ['/tasks$/']);
+
+        $result = $this->tableScanner->listUnskipped();
+        $list = [
+            'todo_items' => true,
+            'todo_tasks' => false,
+        ];
+        foreach ($list as $key => $expected) {
+            if ($expected) {
+                $this->assertArrayHasKey($key, $result);
+            } else {
+                $this->assertArrayNotHasKey($key, $result);
+            }
+        }
+    }
+}
diff --git a/tests/TestCase/Utility/TemplateRendererTest.php b/tests/TestCase/Utility/TemplateRendererTest.php
@@ -26,7 +26,7 @@
 class TemplateRendererTest extends TestCase
 {
     /**
-     * @var \Bake\Utility\TemplateRenderer|\PHPUnit\Framework\MockObject\MockObject
+     * @var \Bake\Utility\TemplateRenderer
      */
     protected $renderer;
 

diff --git a/tests/TestCase/View/Helper/BakeHelperTest.php b/tests/TestCase/View/Helper/BakeHelperTest.php
@@ -36,7 +36,7 @@ class BakeHelperTest extends TestCase
      *
      * @var array
      */
-    public $fixtures = [
+    protected $fixtures = [
         'plugin.Bake.BakeArticles',
         'plugin.Bake.BakeComments',
         'plugin.Bake.BakeArticlesBakeTags',