Merge pull request #871 from kenjis/update-min-CI4-version-435

refactor: update minimum CI4 version to 4.3.5
codeigniter4 · Oct 3, 2023 · e3ab1ac · e3ab1ac
2 parents defdd11 + 4c381f4
commit e3ab1ac
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ See the [An Official Auth Library](https://codeigniter.com/news/shield) for more
 
 Usage of Shield requires the following:
 
-- A [CodeIgniter 4.2.7+](https://github.com/codeigniter4/CodeIgniter4/) based project
+- A [CodeIgniter 4.3.5+](https://github.com/codeigniter4/CodeIgniter4/) based project
 - [Composer](https://getcomposer.org/) for package management
 - PHP 7.4.3+
 

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -2,6 +2,12 @@
 
 ## Version 1.0.0-beta.6 to 1.0.0-beta.7
 
+### The minimum CodeIgniter version
+
+Shield requires CodeIgniter 4.3.5 or later.
+Versions prior to 4.3.5 have known vulnerabilities.
+See https://github.com/codeigniter4/CodeIgniter4/security/advisories
+
 ### Mandatory Config Changes
 
 #### New Config\AuthToken

diff --git a/composer.json b/composer.json
@@ -31,7 +31,7 @@
     "require-dev": {
         "codeigniter/phpstan-codeigniter": "^1.3",
         "codeigniter4/devkit": "^1.0",
-        "codeigniter4/framework": "^4.2.7",
+        "codeigniter4/framework": "^4.3.5",
         "firebase/php-jwt": "^6.4",
         "mikey179/vfsstream": "^1.6.7",
         "mockery/mockery": "^1.0",

diff --git a/docs/getting_started/install.md b/docs/getting_started/install.md
@@ -5,7 +5,7 @@ These instructions assume that you have already [installed the CodeIgniter 4 app
 ## Requirements
 
 - [Composer](https://getcomposer.org)
-- Codeigniter **v4.2.7** or later
+- Codeigniter **v4.3.5** or later
 - A created database that you can access via the Spark CLI script
   - InnoDB (not MyISAM) is required if MySQL is used.
 

diff --git a/src/Test/MockInputOutput.php b/src/Test/MockInputOutput.php
@@ -5,7 +5,6 @@
 namespace CodeIgniter\Shield\Test;
 
 use CodeIgniter\CLI\CLI;
-use CodeIgniter\CodeIgniter;
 use CodeIgniter\Shield\Commands\Utils\InputOutput;
 use CodeIgniter\Shield\Exceptions\LogicException;
 use CodeIgniter\Test\Filters\CITestStreamFilter;
@@ -52,23 +51,21 @@ public function prompt(string $field, $options = null, $validation = null): stri
     {
         $input = array_shift($this->inputs);
 
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::registration();
-            CITestStreamFilter::addOutputFilter();
+        CITestStreamFilter::registration();
+        CITestStreamFilter::addOutputFilter();
 
-            PhpStreamWrapper::register();
-            PhpStreamWrapper::setContent($input);
+        PhpStreamWrapper::register();
+        PhpStreamWrapper::setContent($input);
 
-            $userInput = CLI::prompt($field, $options, $validation);
+        $userInput = CLI::prompt($field, $options, $validation);
 
-            PhpStreamWrapper::restore();
+        PhpStreamWrapper::restore();
 
-            CITestStreamFilter::removeOutputFilter();
-            CITestStreamFilter::removeErrorFilter();
+        CITestStreamFilter::removeOutputFilter();
+        CITestStreamFilter::removeErrorFilter();
 
-            if ($input !== $userInput) {
-                throw new LogicException($input . '!==' . $userInput);
-            }
+        if ($input !== $userInput) {
+            throw new LogicException($input . '!==' . $userInput);
         }
 
         return $input;
@@ -79,23 +76,13 @@ public function write(
         ?string $foreground = null,
         ?string $background = null
     ): void {
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::registration();
-            CITestStreamFilter::addOutputFilter();
-        } else {
-            CITestStreamFilter::$buffer = '';
-
-            $streamFilter = stream_filter_append(STDOUT, 'CITestStreamFilter');
-        }
+        CITestStreamFilter::registration();
+        CITestStreamFilter::addOutputFilter();
 
         CLI::write($text, $foreground, $background);
         $this->outputs[] = CITestStreamFilter::$buffer;
 
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::removeOutputFilter();
-            CITestStreamFilter::removeErrorFilter();
-        } else {
-            stream_filter_remove($streamFilter);
-        }
+        CITestStreamFilter::removeOutputFilter();
+        CITestStreamFilter::removeErrorFilter();
     }
 }
diff --git a/tests/Commands/SetupTest.php b/tests/Commands/SetupTest.php
@@ -4,7 +4,6 @@
 
 namespace Tests\Commands;
 
-use CodeIgniter\CodeIgniter;
 use CodeIgniter\Shield\Commands\Setup;
 use CodeIgniter\Test\Filters\CITestStreamFilter;
 use Config\Services;
@@ -16,31 +15,20 @@
  */
 final class SetupTest extends TestCase
 {
-    private $streamFilter;
-
     protected function setUp(): void
     {
         parent::setUp();
 
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::registration();
-            CITestStreamFilter::addOutputFilter();
-        } else {
-            CITestStreamFilter::$buffer = '';
-            $this->streamFilter         = stream_filter_append(STDOUT, 'CITestStreamFilter');
-        }
+        CITestStreamFilter::registration();
+        CITestStreamFilter::addOutputFilter();
     }
 
     protected function tearDown(): void
     {
         parent::tearDown();
 
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::removeOutputFilter();
-            CITestStreamFilter::removeErrorFilter();
-        } else {
-            stream_filter_remove($this->streamFilter);
-        }
+        CITestStreamFilter::removeOutputFilter();
+        CITestStreamFilter::removeErrorFilter();
     }
 
     public function testRun(): void

diff --git a/tests/Commands/UserModelGeneratorTest.php b/tests/Commands/UserModelGeneratorTest.php
@@ -4,7 +4,6 @@
 
 namespace Tests\Commands;
 
-use CodeIgniter\CodeIgniter;
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\Filters\CITestStreamFilter;
 
@@ -13,22 +12,13 @@
  */
 final class UserModelGeneratorTest extends CIUnitTestCase
 {
-    private $streamFilter;
-
     protected function setUp(): void
     {
         parent::setUp();
 
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::registration();
-            CITestStreamFilter::addOutputFilter();
-            CITestStreamFilter::addErrorFilter();
-        } else {
-            CITestStreamFilter::$buffer = '';
-
-            $this->streamFilter = stream_filter_append(STDOUT, 'CITestStreamFilter');
-            $this->streamFilter = stream_filter_append(STDERR, 'CITestStreamFilter');
-        }
+        CITestStreamFilter::registration();
+        CITestStreamFilter::addOutputFilter();
+        CITestStreamFilter::addErrorFilter();
 
         if (is_file(HOMEPATH . 'src/Models/UserModel.php')) {
             copy(HOMEPATH . 'src/Models/UserModel.php', HOMEPATH . 'src/Models/UserModel.php.bak');
@@ -41,12 +31,8 @@ protected function tearDown(): void
     {
         parent::tearDown();
 
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            CITestStreamFilter::removeOutputFilter();
-            CITestStreamFilter::removeErrorFilter();
-        } else {
-            stream_filter_remove($this->streamFilter);
-        }
+        CITestStreamFilter::removeOutputFilter();
+        CITestStreamFilter::removeErrorFilter();
 
         $this->deleteTestFiles();
 

diff --git a/tests/Controllers/LoginTest.php b/tests/Controllers/LoginTest.php
@@ -4,7 +4,6 @@
 
 namespace Tests\Controllers;
 
-use CodeIgniter\CodeIgniter;
 use CodeIgniter\Config\Factories;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Shield\Authentication\Actions\Email2FA;
@@ -110,11 +109,7 @@ public function testLoginTooLongPasswordArgon2id(): void
 
     public function testLoginActionEmailSuccess(): void
     {
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            Time::setTestNow('March 10, 2017', 'UTC');
-        } else {
-            Time::setTestNow('March 10, 2017', 'America/Chicago');
-        }
+        Time::setTestNow('March 10, 2017', 'UTC');
 
         $this->user->createEmailIdentity([
             'email'    => 'foo@example.com',
@@ -166,11 +161,7 @@ public function testAfterLoggedInNotDisplayLoginPage(): void
 
     public function testLoginActionUsernameSuccess(): void
     {
-        if (version_compare(CodeIgniter::CI_VERSION, '4.3.0', '>=')) {
-            Time::setTestNow('March 10, 2017', 'UTC');
-        } else {
-            Time::setTestNow('March 10, 2017', 'America/Chicago');
-        }
+        Time::setTestNow('March 10, 2017', 'UTC');
 
         // Add 'username' to $validFields
         $authConfig                = config('Auth');