Changeset 47122 for trunk/tests/phpunit/tests/cache.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/tests/cache.php (modified) (14 diffs)

trunk/tests/phpunit/tests/cache.php

@@ -9 +9 @@
     function setUp() {
         parent::setUp();
-        // create two cache objects with a shared cache dir
-        // this simulates a typical cache situation, two separate requests interacting
+        // Create two cache objects with a shared cache directory.
+        // This simulates a typical cache situation, two separate requests interacting.
         $this->cache =& $this->init_cache();
     }
@@ -43 +43 @@
         $val = 0;
 
-        // you can store zero in the cache
+        // You can store zero in the cache.
         $this->cache->add( $key, $val );
         $this->assertEquals( $val, $this->cache->get( $key ) );
@@ -53 +53 @@
 
         $this->assertTrue( $this->cache->add( $key, $val ) );
-        // null is converted to empty string
+        // Null is converted to empty string.
         $this->assertEquals( '', $this->cache->get( $key ) );
     }
@@ -62 +62 @@
         $val2 = 'val2';
 
-        // add $key to the cache
+        // Add $key to the cache.
         $this->assertTrue( $this->cache->add( $key, $val1 ) );
         $this->assertEquals( $val1, $this->cache->get( $key ) );
-        // $key is in the cache, so reject new calls to add()
+        // $key is in the cache, so reject new calls to add().
         $this->assertFalse( $this->cache->add( $key, $val2 ) );
         $this->assertEquals( $val1, $this->cache->get( $key ) );
@@ -75 +75 @@
         $val2 = 'val2';
 
-        // memcached rejects replace() if the key does not exist
+        // memcached rejects replace() if the key does not exist.
         $this->assertFalse( $this->cache->replace( $key, $val ) );
         $this->assertFalse( $this->cache->get( $key ) );
@@ -89 +89 @@
         $val2 = 'val2';
 
-        // memcached accepts set() if the key does not exist
+        // memcached accepts set() if the key does not exist.
         $this->assertTrue( $this->cache->set( $key, $val1 ) );
         $this->assertEquals( $val1, $this->cache->get( $key ) );
-        // Second set() with same key should be allowed
+        // Second set() with same key should be allowed.
         $this->assertTrue( $this->cache->set( $key, $val2 ) );
         $this->assertEquals( $val2, $this->cache->get( $key ) );
@@ -108 +108 @@
 
         $this->cache->add( $key, $val );
-        // item is visible to both cache objects
+        // Item is visible to both cache objects.
         $this->assertEquals( $val, $this->cache->get( $key ) );
         $this->cache->flush();
@@ -115 +115 @@
     }
 
-    // Make sure objects are cloned going to and from the cache
+    // Make sure objects are cloned going to and from the cache.
     function test_object_refs() {
         $key           = __FUNCTION__ . '_1';
@@ -205 +205 @@
         $val = 'val';
 
-        // Verify set
+        // Verify set.
         $this->assertTrue( $this->cache->set( $key, $val ) );
         $this->assertEquals( $val, $this->cache->get( $key ) );
 
-        // Verify successful delete
+        // Verify successful delete.
         $this->assertTrue( $this->cache->delete( $key ) );
         $this->assertFalse( $this->cache->get( $key ) );
@@ -220 +220 @@
         $val = 'val';
 
-        // Verify set
+        // Verify set.
         $this->assertTrue( wp_cache_set( $key, $val ) );
         $this->assertEquals( $val, wp_cache_get( $key ) );
 
-        // Verify successful delete
+        // Verify successful delete.
         $this->assertTrue( wp_cache_delete( $key ) );
         $this->assertFalse( wp_cache_get( $key ) );
 
         // wp_cache_delete() does not have a $force method.
-        // Delete returns (bool) true when key is not set and $force is true
+        // Delete returns (bool) true when key is not set and $force is true.
         // $this->assertTrue( wp_cache_delete( $key, 'default', true ) );
 
@@ -255 +255 @@
             $this->assertEquals( $val2, $this->cache->get( $key ) );
         } else {
-            // Multisite should have separate per-blog caches
+            // Multisite should have separate per-blog caches.
             $this->assertTrue( $this->cache->set( $key, $val ) );
             $this->assertEquals( $val, $this->cache->get( $key ) );
@@ -270 +270 @@
         }
 
-        // Global group
+        // Global group.
         $this->assertTrue( $this->cache->set( $key, $val, 'global-cache-test' ) );
         $this->assertEquals( $val, $this->cache->get( $key, 'global-cache-test' ) );
@@ -288 +288 @@
 
         if ( wp_using_ext_object_cache() ) {
-            // External caches will contain property values that contain non-matching resource IDs
+            // External caches will contain property values that contain non-matching resource IDs.
             $this->assertInstanceOf( 'WP_Object_Cache', $wp_object_cache );
         } else {
@@ -302 +302 @@
         $fake_key = 'my-fake-key';
 
-        // Save the first value to cache and verify
+        // Save the first value to cache and verify.
         wp_cache_set( $key, $val1 );
         $this->assertEquals( $val1, wp_cache_get( $key ) );
 
-        // Replace the value and verify
+        // Replace the value and verify.
         wp_cache_replace( $key, $val2 );
         $this->assertEquals( $val2, wp_cache_get( $key ) );
 
-        // Non-existant key should fail
+        // Non-existant key should fail.
         $this->assertFalse( wp_cache_replace( $fake_key, $val1 ) );
 
-        // Make sure $fake_key is not stored
+        // Make sure $fake_key is not stored.
         $this->assertFalse( wp_cache_get( $fake_key ) );
     }