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

kenjis · kenjis · commit 49d1ba0735a4 · 2023-11-28T08:35:16.000+09:00
Conflicts:
	user_guide_src/source/testing/overview.rst
diff --git a/composer.json b/composer.json
@@ -33,7 +33,7 @@
         "phpunit/phpcov": "^8.2",
         "phpunit/phpunit": "^9.1",
         "predis/predis": "^1.1 || ^2.0",
-        "rector/rector": "0.18.10",
+        "rector/rector": "0.18.11",
         "vimeo/psalm": "^5.0"
     },
     "suggest": {
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
@@ -150,8 +150,8 @@ public function deleteMatching(string $pattern)
      */
     public function increment(string $key, int $offset = 1)
     {
-        $key = static::validateKey($key, $this->prefix);
-        $tmp = $this->getItem($key);
+        $prefixedKey = static::validateKey($key, $this->prefix);
+        $tmp         = $this->getItem($prefixedKey);
 
         if ($tmp === false) {
             $tmp = ['data' => 0, 'ttl' => 60];
diff --git a/tests/system/Cache/Handlers/FileHandlerTest.php b/tests/system/Cache/Handlers/FileHandlerTest.php
@@ -67,6 +67,10 @@ protected function tearDown(): void
                     chmod($this->config->file['storePath'] . DIRECTORY_SEPARATOR . $key, 0777);
                     unlink($this->config->file['storePath'] . DIRECTORY_SEPARATOR . $key);
                 }
+                if (is_file($this->config->file['storePath'] . DIRECTORY_SEPARATOR . $this->config->prefix . $key)) {
+                    chmod($this->config->file['storePath'] . DIRECTORY_SEPARATOR . $this->config->prefix . $key, 0777);
+                    unlink($this->config->file['storePath'] . DIRECTORY_SEPARATOR . $this->config->prefix . $key);
+                }
             }
 
             rmdir($this->config->file['storePath']);
@@ -233,6 +237,22 @@ public function testIncrement(): void
         $this->assertSame(10, $this->handler->increment(self::$key3, 10));
     }
 
+    public function testIncrementWithDefaultPrefix(): void
+    {
+        $this->config->prefix = 'test_';
+        $this->handler        = new FileHandler($this->config);
+        $this->handler->initialize();
+
+        $this->handler->save(self::$key1, 1);
+        $this->handler->save(self::$key2, 'value');
+
+        $this->assertSame(11, $this->handler->increment(self::$key1, 10));
+        $this->assertSame($this->handler->increment(self::$key1, 10), $this->handler->get(self::$key1));
+        $this->assertFalse($this->handler->increment(self::$key2, 10));
+        $this->assertSame(10, $this->handler->increment(self::$key3, 10));
+        $this->assertSame($this->handler->increment(self::$key3, 10), $this->handler->get(self::$key3));
+    }
+
     public function testDecrement(): void
     {
         $this->handler->save(self::$key1, 10);
@@ -246,6 +266,21 @@ public function testDecrement(): void
         $this->assertSame(-1, $this->handler->decrement(self::$key3, 1));
     }
 
+    public function testDecrementWithDefaultPrefix(): void
+    {
+        $this->handler->save(self::$key1, 10);
+        $this->handler->save(self::$key2, 'value');
+
+        // Line following commented out to force the cache to add a zero entry for key3
+        // $this->fileHandler->save(self::$key3, 0);
+
+        $this->assertSame(9, $this->handler->decrement(self::$key1, 1));
+        $this->assertSame($this->handler->decrement(self::$key1, 1), $this->handler->get(self::$key1));
+        $this->assertFalse($this->handler->decrement(self::$key2, 1));
+        $this->assertSame(-1, $this->handler->decrement(self::$key3, 1));
+        $this->assertSame($this->handler->decrement(self::$key3, 1), $this->handler->get(self::$key3));
+    }
+
     public function testClean(): void
     {
         $this->handler->save(self::$key1, 1);
diff --git a/user_guide_src/source/incoming/restful.rst b/user_guide_src/source/incoming/restful.rst
@@ -52,6 +52,12 @@ the controller that should be used:
 
 .. literalinclude:: restful/003.php
 
+.. literalinclude:: restful/017.php
+
+.. literalinclude:: restful/018.php
+
+See also :ref:`controllers-namespace`.
+
 Change the Placeholder Used
 ===========================
 
@@ -122,6 +128,12 @@ the controller that should be used:
 
 .. literalinclude:: restful/011.php
 
+.. literalinclude:: restful/019.php
+
+.. literalinclude:: restful/020.php
+
+See also :ref:`controllers-namespace`.
+
 Change the Placeholder Used
 ===========================
 
diff --git a/user_guide_src/source/incoming/restful/003.php b/user_guide_src/source/incoming/restful/003.php
@@ -1,6 +1,5 @@
 <?php
 
-$routes->resource('photos', ['controller' => 'App\Gallery']);
-
+$routes->resource('photos', ['controller' => 'Gallery']);
 // Would create routes like:
-$routes->get('photos', 'App\Gallery::index');
+$routes->get('photos', '\App\Controllers\Gallery::index');
diff --git a/user_guide_src/source/incoming/restful/011.php b/user_guide_src/source/incoming/restful/011.php
@@ -1,6 +1,5 @@
 <?php
 
-$routes->presenter('photos', ['controller' => 'App\Gallery']);
-
+$routes->presenter('photos', ['controller' => 'Gallery']);
 // Would create routes like:
-$routes->get('photos', 'App\Gallery::index');
+$routes->get('photos', '\App\Controllers\Gallery::index');
diff --git a/user_guide_src/source/incoming/restful/017.php b/user_guide_src/source/incoming/restful/017.php
@@ -0,0 +1,5 @@
+<?php
+
+$routes->resource('photos', ['controller' => '\App\Gallery']);
+// Would create routes like:
+$routes->get('photos', '\App\Gallery::index');
diff --git a/user_guide_src/source/incoming/restful/018.php b/user_guide_src/source/incoming/restful/018.php
@@ -0,0 +1,7 @@
+<?php
+
+use App\Controllers\Gallery;
+
+$routes->resource('photos', ['namespace' => '', 'controller' => Gallery::class]);
+// Would create routes like:
+$routes->get('photos', '\App\Controllers\Gallery::index');
diff --git a/user_guide_src/source/incoming/restful/019.php b/user_guide_src/source/incoming/restful/019.php
@@ -0,0 +1,5 @@
+<?php
+
+$routes->presenter('photos', ['controller' => '\App\Gallery']);
+// Would create routes like:
+$routes->get('photos', '\App\Gallery::index');
diff --git a/user_guide_src/source/incoming/restful/020.php b/user_guide_src/source/incoming/restful/020.php
@@ -0,0 +1,7 @@
+<?php
+
+use App\Controllers\Gallery;
+
+$routes->presenter('photos', ['namespace' => '', 'controller' => Gallery::class]);
+// Would create routes like:
+$routes->get('photos', '\App\Controllers\Gallery::index');
diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst
@@ -83,6 +83,8 @@ You can supply multiple verbs that a route should match by passing them in as an
 Specifying Route Handlers
 =========================
 
+.. _controllers-namespace:
+
 Controller's Namespace
 ----------------------
 
diff --git a/user_guide_src/source/models/entities.rst b/user_guide_src/source/models/entities.rst
@@ -2,7 +2,7 @@
 Using Entity Classes
 #####################
 
-CodeIgniter supports Entity classes as a first-class citizen in it's database layer, while keeping
+CodeIgniter supports Entity classes as a first-class citizen, while keeping
 them completely optional to use. They are commonly used as part of the Repository pattern, but can
 be used directly with the :doc:`Model </models/model>` if that fits your needs better.
 
@@ -16,9 +16,17 @@ Entity Usage
 
 At its core, an Entity class is simply a class that represents a single database row. It has class properties
 to represent the database columns, and provides any additional methods to implement the business logic for
-that row. The core feature, though, is that it doesn't know anything about how to persist itself. That's the
+that row.
+
+.. note:: For ease of understanding, the explanation here is based on the case of
+    using a database. However, Entity can also be used for data that does not come
+    from a database.
+
+The core feature, though, is that it doesn't know anything about how to persist itself. That's the
 responsibility of the model or the repository class. That way, if anything changes on how you need to save the
-object, you don't have to change how that object is used throughout the application. This makes it possible to
+object, you don't have to change how that object is used throughout the application.
+
+This makes it possible to
 use JSON or XML files to store the objects during a rapid prototyping stage, and then easily switch to a
 database when you've proven the concept works.
 
@@ -70,7 +78,7 @@ access them as if they were public properties. The base class, ``CodeIgniter\Ent
 well as providing the ability to check the properties with ``isset()``, or ``unset()`` the property, and keep track
 of what columns have changed since the object was created or pulled from the database.
 
-.. note:: The Entity class stores the data in the property ``$attributes``.
+.. note:: The Entity class stores the data in the class property ``$attributes`` internally.
 
 When the User is passed to the model's ``save()`` method, it automatically takes care of reading the  properties
 and saving any changes to columns listed in the model's ``$allowedFields`` property. It also knows whether to create
diff --git a/user_guide_src/source/testing/overview.rst b/user_guide_src/source/testing/overview.rst
@@ -266,3 +266,20 @@ component name:
 .. literalinclude:: overview/017.php
 
 .. note:: All component Factories are reset by default between each test. Modify your test case's ``$setUpMethods`` if you need instances to persist.
+
+Testing and Time
+================
+
+Testing time-dependent code can be challenging. However, when using the
+:doc:`Time <../libraries/time>` class, the current time can be fixed or changed
+at will during testing.
+
+Below is a sample test code that fixes the current time:
+
+.. literalinclude:: overview/021.php
+
+You can fix the current time with the ``Time::setTestNow()`` method.
+Optionally, you can specify a locale as the second parameter.
+
+Don't forget to reset the current time after the test with calling it without
+parameters.
diff --git a/user_guide_src/source/testing/overview/021.php b/user_guide_src/source/testing/overview/021.php
@@ -0,0 +1,24 @@
+<?php
+
+use CodeIgniter\I18n\Time;
+use CodeIgniter\Test\CIUnitTestCase;
+
+final class TimeDependentCodeTest extends CIUnitTestCase
+{
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        // Reset the current time.
+        Time::setTestNow();
+    }
+
+    public function testFixTime(): void
+    {
+        // Fix the current time to "2023-11-25 12:00:00".
+        Time::setTestNow('2023-11-25 12:00:00');
+
+        // This assertion always passes.
+        $this->assertSame('2023-11-25 12:00:00', (string) Time::now());
+    }
+}
