Merge remote-tracking branch 'upstream/develop' into 4.3

kenjis · kenjis · commit a3e5f1d907db · 2023-01-01T08:08:14.000+09:00
Conflicts:
	user_guide_src/source/changelogs/index.rst
	user_guide_src/source/installation/upgrading.rst
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -25,10 +25,10 @@ body:
       description: Which PHP versions did you run your code?
       multiple: true
       options:
-        - '7.3'
         - '7.4'
         - '8.0'
         - '8.1'
+        - '8.2'
     validations:
       required: true
 
diff --git a/.github/workflows/deploy-apidocs.yml b/.github/workflows/deploy-apidocs.yml
@@ -11,9 +11,14 @@ on:
       - 'system/**'
       - '.github/workflows/deploy-apidocs.yml'
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Deploy to api
+    permissions:
+      contents: write
     if: github.repository == 'codeigniter4/CodeIgniter4'
     runs-on: ubuntu-22.04
 
diff --git a/.github/workflows/deploy-distributables.yml b/.github/workflows/deploy-distributables.yml
@@ -6,6 +6,9 @@ on:
   release:
     types: [published]
 
+permissions:
+  contents: read
+
 jobs:
   check-version:
     name: Check for updated version
@@ -31,6 +34,9 @@ jobs:
 
   framework:
     name: Deploy to framework
+    permissions:
+      # Allow actions/github-script to create release
+      contents: write
     if: github.repository == 'codeigniter4/CodeIgniter4'
     runs-on: ubuntu-22.04
     needs: check-version
@@ -78,6 +84,9 @@ jobs:
 
   appstarter:
     name: Deploy to appstarter
+    permissions:
+      # Allow actions/github-script to create release
+      contents: write
     if: github.repository == 'codeigniter4/CodeIgniter4'
     runs-on: ubuntu-22.04
     needs: check-version
@@ -125,6 +134,9 @@ jobs:
 
   userguide:
     name: Deploy to userguide
+    permissions:
+      # Allow actions/github-script to create release
+      contents: write
     if: github.repository == 'codeigniter4/CodeIgniter4'
     runs-on: ubuntu-22.04
     needs: check-version
diff --git a/.github/workflows/deploy-userguide-latest.yml b/.github/workflows/deploy-userguide-latest.yml
@@ -12,9 +12,15 @@ on:
     paths:
       - 'user_guide_src/**'
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Deploy to gh-pages
+    permissions:
+      # Allow ad-m/github-push-action to push commit to branch gh-pages
+      contents: write
     if: (github.repository == 'codeigniter4/CodeIgniter4')
     runs-on: ubuntu-latest
     steps:
diff --git a/.github/workflows/test-autoreview.yml b/.github/workflows/test-autoreview.yml
@@ -18,6 +18,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   auto-review-tests:
     uses: ./.github/workflows/reusable-serviceless-phpunit-test.yml # @TODO Extract to codeigniter4/.github repo
diff --git a/.github/workflows/test-coding-standards.yml b/.github/workflows/test-coding-standards.yml
@@ -16,6 +16,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   lint:
     name: PHP ${{ matrix.php-version }} Lint with PHP CS Fixer
diff --git a/.github/workflows/test-deptrac.yml b/.github/workflows/test-deptrac.yml
@@ -28,6 +28,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Architectural Inspection
diff --git a/.github/workflows/test-phpcpd.yml b/.github/workflows/test-phpcpd.yml
@@ -27,6 +27,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Duplicate Code Detection
diff --git a/.github/workflows/test-phpstan.yml b/.github/workflows/test-phpstan.yml
@@ -31,6 +31,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: PHP ${{ matrix.php-versions }} Static Analysis
diff --git a/.github/workflows/test-phpunit.yml b/.github/workflows/test-phpunit.yml
@@ -31,6 +31,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   # Any environment variables set in an env context defined at the workflow level
   # in the caller workflow are not propagated to the called workflow.
diff --git a/.github/workflows/test-rector.yml b/.github/workflows/test-rector.yml
@@ -33,6 +33,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: PHP ${{ matrix.php-versions }} Analyze code (Rector) on ${{ matrix.paths }}
diff --git a/.github/workflows/test-scss.yml b/.github/workflows/test-scss.yml
@@ -23,6 +23,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Compilation of SCSS (Dart Sass)
diff --git a/.github/workflows/test-userguide.yml b/.github/workflows/test-userguide.yml
@@ -14,6 +14,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   syntax_check:
     name: Check User Guide syntax
diff --git a/app/Config/Migrations.php b/app/Config/Migrations.php
@@ -38,9 +38,12 @@ class Migrations extends BaseConfig
      *
      * This is the format that will be used when creating new migrations
      * using the CLI command:
-     *   > php spark migrate:create
+     *   > php spark make:migration
      *
-     * Typical formats:
+     * Note: if you set an unsupported format, migration runner will not find
+     *       your migration files.
+     *
+     * Supported formats:
      * - YmdHis_
      * - Y-m-d-His_
      * - Y_m_d_His_
diff --git a/system/Database/MigrationRunner.php b/system/Database/MigrationRunner.php
@@ -67,7 +67,7 @@ class MigrationRunner
      *
      * @var string
      */
-    protected $regex = '/^\d{4}[_-]?\d{2}[_-]?\d{2}[_-]?\d{6}_(\w+)$/';
+    protected $regex = '/\A(\d{4}[_-]?\d{2}[_-]?\d{2}[_-]?\d{6})_(\w+)\z/';
 
     /**
      * The main database connection. Used to store
@@ -448,6 +448,8 @@ public function findNamespaceMigrations(string $namespace): array
     /**
      * Create a migration object from a file path.
      *
+     * @param string $path Full path to a valid migration file.
+     *
      * @return false|object Returns the migration object, or false on failure
      */
     protected function migrationFromFile(string $path, string $namespace)
@@ -456,18 +458,18 @@ protected function migrationFromFile(string $path, string $namespace)
             return false;
         }
 
-        $name = basename($path, '.php');
+        $filename = basename($path, '.php');
 
-        if (! preg_match($this->regex, $name)) {
+        if (! preg_match($this->regex, $filename)) {
             return false;
         }
 
         $locator = Services::locator(true);
 
         $migration = new stdClass();
 
-        $migration->version   = $this->getMigrationNumber($name);
-        $migration->name      = $this->getMigrationName($name);
+        $migration->version   = $this->getMigrationNumber($filename);
+        $migration->name      = $this->getMigrationName($filename);
         $migration->path      = $path;
         $migration->class     = $locator->getClassname($path);
         $migration->namespace = $namespace;
@@ -525,23 +527,29 @@ public function setSilent(bool $silent)
 
     /**
      * Extracts the migration number from a filename
+     *
+     * @param string $migration A migration filename w/o path.
      */
     protected function getMigrationNumber(string $migration): string
     {
-        preg_match('/^\d{4}[_-]?\d{2}[_-]?\d{2}[_-]?\d{6}/', $migration, $matches);
+        preg_match($this->regex, $migration, $matches);
 
-        return count($matches) ? $matches[0] : '0';
+        return count($matches) ? $matches[1] : '0';
     }
 
     /**
-     * Extracts the migration class name from a filename
+     * Extracts the migration name from a filename
+     *
+     * Note: The migration name should be the classname, but maybe they are
+     *       different.
+     *
+     * @param string $migration A migration filename w/o path.
      */
     protected function getMigrationName(string $migration): string
     {
-        $parts = explode('_', $migration);
-        array_shift($parts);
+        preg_match($this->regex, $migration, $matches);
 
-        return implode('_', $parts);
+        return count($matches) ? $matches[2] : '';
     }
 
     /**
diff --git a/system/Model.php b/system/Model.php
@@ -714,8 +714,12 @@ public function insert($data = null, bool $returnID = true)
             }
         }
 
-        if ($this->useAutoIncrement === false && isset($data[$this->primaryKey])) {
-            $this->tempPrimaryKeyValue = $data[$this->primaryKey];
+        if ($this->useAutoIncrement === false) {
+            if (is_array($data) && isset($data[$this->primaryKey])) {
+                $this->tempPrimaryKeyValue = $data[$this->primaryKey];
+            } elseif (is_object($data) && isset($data->{$this->primaryKey})) {
+                $this->tempPrimaryKeyValue = $data->{$this->primaryKey};
+            }
         }
 
         $this->escape   = $this->tempData['escape'] ?? [];
diff --git a/tests/system/Database/Migrations/MigrationRunnerTest.php b/tests/system/Database/Migrations/MigrationRunnerTest.php
@@ -186,6 +186,24 @@ public function testGetMigrationNumberReturnsZeroIfNoneFound()
         $this->assertSame('0', $method('Foo'));
     }
 
+    public function testGetMigrationNameDashes()
+    {
+        $runner = new MigrationRunner($this->config);
+
+        $method = $this->getPrivateMethodInvoker($runner, 'getMigrationName');
+
+        $this->assertSame('Foo_bar', $method('2019-08-06-235100_Foo_bar'));
+    }
+
+    public function testGetMigrationNameUnderscores()
+    {
+        $runner = new MigrationRunner($this->config);
+
+        $method = $this->getPrivateMethodInvoker($runner, 'getMigrationName');
+
+        $this->assertSame('Foo_bar', $method('2019_08_06_235100_Foo_bar'));
+    }
+
     public function testSetSilentStoresValue()
     {
         $runner = new MigrationRunner($this->config);
diff --git a/tests/system/Models/SaveModelTest.php b/tests/system/Models/SaveModelTest.php
@@ -322,4 +322,27 @@ public function testUseAutoIncrementSetToFalseSave(): void
         $this->assertSame($insert['key'], $this->model->getInsertID());
         $this->seeInDatabase('without_auto_increment', $update);
     }
+
+    public function testUseAutoIncrementSetToFalseSaveObject(): void
+    {
+        $this->createModel(WithoutAutoIncrementModel::class);
+
+        $insert = [
+            'key'   => 'some_random_key',
+            'value' => 'some value',
+        ];
+        $this->model->save((object) $insert);
+
+        $this->assertSame($insert['key'], $this->model->getInsertID());
+        $this->seeInDatabase('without_auto_increment', $insert);
+
+        $update = [
+            'key'   => 'some_random_key',
+            'value' => 'some different value',
+        ];
+        $this->model->save((object) $update);
+
+        $this->assertSame($insert['key'], $this->model->getInsertID());
+        $this->seeInDatabase('without_auto_increment', $update);
+    }
 }
diff --git a/user_guide_src/source/changelogs/index.rst b/user_guide_src/source/changelogs/index.rst
@@ -13,6 +13,7 @@ See all the changes.
     :titlesonly:
 
     v4.3.0
+    v4.2.12
     v4.2.11
     v4.2.10
     v4.2.9
diff --git a/user_guide_src/source/changelogs/v4.2.12.rst b/user_guide_src/source/changelogs/v4.2.12.rst
@@ -0,0 +1,20 @@
+Version 4.2.12
+##############
+
+Release Date: Unreleased
+
+**4.2.12 release of CodeIgniter4**
+
+.. contents::
+    :local:
+    :depth: 2
+
+Bugs Fixed
+**********
+
+- Fixed ``Request::getIPaddress()`` causes an error on CLI.
+- Fixed ``link_tag()`` missing ``type="application/rss+xml"``.
+- Fixed ``spark migrate:status`` shows incorrect filenames when format is ``Y_m_d_His_``.
+- Fixed an error when ``Model::save()`` saves an object if ``$useAutoIncrement`` is false.
+
+See the repo's `CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_ for a complete list of bugs fixed.
diff --git a/user_guide_src/source/cli/cli_commands.rst b/user_guide_src/source/cli/cli_commands.rst
@@ -22,11 +22,11 @@ and must extend ``CodeIgniter\CLI\BaseCommand``, and implement the ``run()`` met
 The following properties should be used in order to get listed in CLI commands and to add help functionality to your command:
 
 * ``$group``: a string to describe the group the command is lumped under when listing commands. For example: ``Database``
-* ``$name``: a string to describe the command's name. For example: ``migrate:create``
-* ``$description``: a string to describe the command. For example: ``Creates a new migration file.``
-* ``$usage``: a string to describe the command usage. For example: ``migrate:create [name] [options]``
-* ``$arguments``: an array of strings to describe each command argument. For example: ``'name' => 'The migration file name'``
-* ``$options``: an array of strings to describe each command option. For example: ``'-n' => 'Set migration namespace'``
+* ``$name``: a string to describe the command's name. For example: ``make:controller``
+* ``$description``: a string to describe the command. For example: ``Generates a new controller file.``
+* ``$usage``: a string to describe the command usage. For example: ``make:controller <name> [options]``
+* ``$arguments``: an array of strings to describe each command argument. For example: ``'name' => 'The controller class name.'``
+* ``$options``: an array of strings to describe each command option. For example: ``'--force' => 'Force overwrite existing file.'``
 
 **Help description will be automatically generated according to the above parameters.**
 
diff --git a/user_guide_src/source/cli/cli_commands/001.php b/user_guide_src/source/cli/cli_commands/001.php
@@ -1,3 +1,3 @@
 <?php
 
-echo command('migrate:create TestMigration');
+echo command('make:migration TestMigration');
diff --git a/user_guide_src/source/cli/cli_generators.rst b/user_guide_src/source/cli/cli_generators.rst
@@ -34,7 +34,7 @@ where ``<generator_command>`` will be replaced with the command to check.
     namespace defined in your ``$psr4`` array in ``Config\Autoload`` or defined in your composer autoload
     file. Otherwise, code generation will be interrupted.
 
-.. important:: Use of ``migrate:create`` to create migration files is now deprecated. It will be removed in
+.. important:: Since v4.0.5, use of ``migrate:create`` to create migration files has been deprecated. It will be removed in
     future releases. Please use ``make:migration`` as replacement. Also, please use ``make:migration --session``
     to use instead of the deprecated ``session:migration``.
 
diff --git a/user_guide_src/source/installation/upgrade_4212.rst b/user_guide_src/source/installation/upgrade_4212.rst
diff --git a/user_guide_src/source/installation/upgrade_423.rst b/user_guide_src/source/installation/upgrade_423.rst
diff --git a/user_guide_src/source/installation/upgrade_database.rst b/user_guide_src/source/installation/upgrade_database.rst
diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst
