silviooosilva / CacheerPHP

src/Helpers/CacheRedisHelper.php

Indentation +27 added lines, -27 removed lines

@@ -13,29 +13,29 @@ 
 class CacheRedisHelper
 {
 
-  /**
-  * serializes or unserializes data based on the $serialize flag.
-  * 
-  * @param mixed $data
-  * @param bool  $serialize
-  * @return mixed
-  */
-  public static function serialize(mixed $data, bool $serialize = true): mixed
-  {
+    /**
+     * serializes or unserializes data based on the $serialize flag.
+     * 
+     * @param mixed $data
+     * @param bool  $serialize
+     * @return mixed
+     */
+    public static function serialize(mixed $data, bool $serialize = true): mixed
+    {
     if($serialize) {
-      return serialize($data);
+        return serialize($data);
     }
 
     return unserialize($data);
 
-  }
+    }
 
     /**
-    * Validates a cache item.
-    *  
-    * @param array $item
-    * @return void
-    */
+     * Validates a cache item.
+     *  
+     * @param array $item
+     * @return void
+     */
     public static function validateCacheItem(array $item): void
     {
         CacheerHelper::validateCacheItem(
@@ -55,17 +55,17 @@ 
         return CacheerHelper::mergeCacheData($cacheData);
     }
 
-  /**
-  * Generates an array identifier for cache data.
-  * 
-  * @param mixed $currentCacheData
-  * @param mixed $cacheData
-  * @return array
-  */
-  public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData): array
-  {
-      return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData);
-  }
+    /**
+     * Generates an array identifier for cache data.
+     * 
+     * @param mixed $currentCacheData
+     * @param mixed $cacheData
+     * @return array
+     */
+    public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData): array
+    {
+        return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData);
+    }
 
 }
 

src/Service/CacheMutator.php

Indentation +52 added lines, -52 removed lines

@@ -13,29 +13,29 @@ 
 class CacheMutator
 {
     /**
-    * @var Cacheer
-    */
+     * @var Cacheer
+     */
     private Cacheer $cacheer;
 
     /**
-    * CacheMutator constructor.
-    *
-    * @param Cacheer $cacheer
-    */
+     * CacheMutator constructor.
+     *
+     * @param Cacheer $cacheer
+     */
     public function __construct(Cacheer $cacheer)
     {
         $this->cacheer = $cacheer;
     }
 
     /**
-    * Adds a cache item if it does not already exist.
-    *
-    * @param string $cacheKey
-    * @param mixed $cacheData
-    * @param string $namespace
-    * @param int|string $ttl
-    * @return bool
-    */
+     * Adds a cache item if it does not already exist.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @param string $namespace
+     * @param int|string $ttl
+     * @return bool
+     */
     public function add(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600): bool
     {
         if (!empty($this->cacheer->getCache($cacheKey, $namespace))) {
@@ -49,13 +49,13 @@ 
     }
 
     /**
-    * Appends data to an existing cache item.
-    *
-    * @param string $cacheKey
-    * @param mixed $cacheData
-    * @param string $namespace
-    * @return bool
-    */
+     * Appends data to an existing cache item.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @param string $namespace
+     * @return bool
+     */
     public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->appendCache($cacheKey, $cacheData, $namespace);
@@ -65,12 +65,12 @@ 
     }
 
     /**
-    * Clears a specific cache item.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return bool
-    */
+     * Clears a specific cache item.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return bool
+     */
     public function clearCache(string $cacheKey, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->clearCache($cacheKey, $namespace);
@@ -80,13 +80,13 @@ 
     }
 
     /**
-    * Decrements a numeric cache item by a specified amount.
-    *
-    * @param string $cacheKey
-    * @param int $amount
-    * @param string $namespace
-    * @return bool
-    */
+     * Decrements a numeric cache item by a specified amount.
+     *
+     * @param string $cacheKey
+     * @param int $amount
+     * @param string $namespace
+     * @return bool
+     */
     public function decrement(string $cacheKey, int $amount = 1, string $namespace = ''): bool
     {
         return $this->increment($cacheKey, ($amount * -1), $namespace);
@@ -108,10 +108,10 @@ 
     }
 
     /**
-    * Flushes the entire cache.
-    *
-    * @return bool
-    */
+     * Flushes the entire cache.
+     *
+     * @return bool
+     */
     public function flushCache(): bool
     {
         $this->cacheer->cacheStore->flushCache();
@@ -160,13 +160,13 @@ 
     }
 
     /**
-    * Puts multiple cache items in a batch.
-    *
-    * @param array $items
-    * @param string $namespace
-    * @param int $batchSize
-    * @return bool
-    */
+     * Puts multiple cache items in a batch.
+     *
+     * @param array $items
+     * @param string $namespace
+     * @param int $batchSize
+     * @return bool
+     */
     public function putMany(array $items, string $namespace = '', int $batchSize = 100): bool
     {
         $this->cacheer->cacheStore->putMany($items, $namespace, $batchSize);
@@ -176,13 +176,13 @@ 
     }
 
     /**
-    * Renews the cache item with a new TTL.
-    *
-    * @param string $cacheKey
-    * @param int|string $ttl
-    * @param string $namespace
-    * @return bool
-    */
+     * Renews the cache item with a new TTL.
+     *
+     * @param string $cacheKey
+     * @param int|string $ttl
+     * @param string $namespace
+     * @return bool
+     */
     public function renewCache(string $cacheKey, int|string $ttl = 3600, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->renewCache($cacheKey, $ttl, $namespace);

tests/Unit/StaticAccessTest.php

Indentation +2 added lines, -2 removed lines

@@ -35,8 +35,8 @@
             'driver' => 'file',
             'path' => '/tmp/cache',
         ];
-       Cacheer::setUp($options);
-       self::assertSame($options, Cacheer::getOptions());
+        Cacheer::setUp($options);
+        self::assertSame($options, Cacheer::getOptions());
     }
 
     public function testSetUpStaticWithOptionBuilder(): void

src/Cacheer.php

Indentation +60 added lines, -60 removed lines

@@ -63,66 +63,66 @@ 
 final class Cacheer
 {
     /**
-    * @var string
-    */
+     * @var string
+     */
     private string $message;
 
     /**
-    * @var boolean
-    */
+     * @var boolean
+     */
     private bool $success;
 
     /**
-    * @var boolean
-    */
+     * @var boolean
+     */
     private bool $formatted = false;
 
     /**
-    * @var bool
-    */
+     * @var bool
+     */
     private bool $compression = false;
 
     /**
-    * @var string|null
-    */
+     * @var string|null
+     */
     private ?string $encryptionKey = null;
 
     /**
-    * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore
-    */
+     * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore
+     */
     public RedisCacheStore|DatabaseCacheStore|ArrayCacheStore|FileCacheStore $cacheStore;
 
     /**
-    * @var array
-    */
+     * @var array
+     */
     public array $options = [];
 
     /**
-    * @var CacheRetriever
-    */
+     * @var CacheRetriever
+     */
     private CacheRetriever $retriever;
 
     /**
-    * @var CacheMutator
-    */
+     * @var CacheMutator
+     */
     private CacheMutator $mutator;
 
     /**
-    * @var CacheConfig
-    */
+     * @var CacheConfig
+     */
     private CacheConfig $config;
 
     /**
-    * @var Cacheer|null
-    */
+     * @var Cacheer|null
+     */
     private static ?Cacheer $staticInstance = null;
 
 /**
-    * Cacheer constructor.
-    *
-    * @param array $options
-    * @param bool  $formatted
-    * @throws RuntimeException|Exceptions\CacheFileException
+ * Cacheer constructor.
+ *
+ * @param array $options
+ * @param bool  $formatted
+ * @throws RuntimeException|Exceptions\CacheFileException
  */
     public function __construct(array $options = [], bool $formatted = false)
     {
@@ -182,11 +182,11 @@ 
     }
 
     /**
-    * Enable encryption for cached data
-    *
-    * @param string $key
-    * @return $this
-    */
+     * Enable encryption for cached data
+     *
+     * @param string $key
+     * @return $this
+     */
     public function useEncryption(string $key): Cacheer
     {
         $this->encryptionKey = $key;
@@ -194,11 +194,11 @@ 
     }
 
     /**
-    * Enable or disable data compression
-    *
-    * @param bool $status
-    * @return $this
-    */
+     * Enable or disable data compression
+     *
+     * @param bool $status
+     * @return $this
+     */
     public function useCompression(bool $status = true): Cacheer
     {
         $this->compression = $status;
@@ -206,43 +206,43 @@ 
     }
 
     /**
-    * Enables or disables the formatter for cache data.
-    * 
-    * @return void
-    */
+     * Enables or disables the formatter for cache data.
+     * 
+     * @return void
+     */
     public function useFormatter(): void
     {
         $this->formatted = !$this->formatted;
     }
 
     /**
-    * Validates the options provided for the Cacheer instance.
-    * 
-    * @param array $options
-    * @return void
-    */
+     * Validates the options provided for the Cacheer instance.
+     * 
+     * @param array $options
+     * @return void
+     */
     private function validateOptions(array $options): void
     {
         $this->options = $options;
     }
 
     /**
-    * Checks if the last operation was successful.
-    * 
-    * @return bool
-    */
+     * Checks if the last operation was successful.
+     * 
+     * @return bool
+     */
     public function isSuccess(): bool
     {
         return $this->success;
     }
 
     /**
-    * Sets a message for the cache operation.
-    *
-    * @param string  $message
-    * @param boolean $success
-    * @return void
-    */
+     * Sets a message for the cache operation.
+     *
+     * @param string  $message
+     * @param boolean $success
+     * @return void
+     */
     private function setMessage(string $message, bool $success): void
     {
         $this->message = $message;
@@ -250,10 +250,10 @@ 
     }
 
     /**
-    * Retrieves the message from the last operation.
-    * 
-    * @return string
-    */
+     * Retrieves the message from the last operation.
+     * 
+     * @return string
+     */
     public function getMessage(): string
     {
         return $this->message;

tests/Feature/RedisOptionBuilderFeatureTest.php

Indentation +13 added lines, -13 removed lines

@@ -4,13 +4,13 @@ 
 
 class RedisOptionBuilderFeatureTest extends TestCase
 {
-  public function test_it_builds_redis_options()
-  {
+    public function test_it_builds_redis_options()
+    {
     $options = OptionBuilder::forRedis()
-      ->setNamespace('app:')
-      ->expirationTime('2 hours')
-      ->flushAfter('1 day')
-      ->build();
+        ->setNamespace('app:')
+        ->expirationTime('2 hours')
+        ->flushAfter('1 day')
+        ->build();
 
     $this->assertArrayHasKey('namespace', $options);
     $this->assertArrayHasKey('expirationTime', $options);
@@ -19,16 +19,16 @@ 
     $this->assertSame('app:', $options['namespace']);
     $this->assertSame('2 hours', $options['expirationTime']);
     $this->assertSame('1 day', $options['flushAfter']);
-  }
+    }
 
-  public function test_it_allows_timebuilder_for_redis()
-  {
+    public function test_it_allows_timebuilder_for_redis()
+    {
     $options = OptionBuilder::forRedis()
-      ->expirationTime()->minute(30)
-      ->flushAfter()->day(2)
-      ->build();
+        ->expirationTime()->minute(30)
+        ->flushAfter()->day(2)
+        ->build();
 
     $this->assertSame('30 minutes', $options['expirationTime']);
     $this->assertSame('2 days', $options['flushAfter']);
-  }
+    }
 }

tests/Feature/DatabaseOptionBuilderFeatureTest.php

Indentation +13 added lines, -13 removed lines

@@ -4,13 +4,13 @@ 
 
 class DatabaseOptionBuilderFeatureTest extends TestCase
 {
-  public function test_it_builds_database_options()
-  {
+    public function test_it_builds_database_options()
+    {
     $options = OptionBuilder::forDatabase()
-      ->table('cache_items')
-      ->expirationTime('12 hours')
-      ->flushAfter('7 days')
-      ->build();
+        ->table('cache_items')
+        ->expirationTime('12 hours')
+        ->flushAfter('7 days')
+        ->build();
 
     $this->assertArrayHasKey('table', $options);
     $this->assertArrayHasKey('expirationTime', $options);
@@ -19,16 +19,16 @@ 
     $this->assertSame('cache_items', $options['table']);
     $this->assertSame('12 hours', $options['expirationTime']);
     $this->assertSame('7 days', $options['flushAfter']);
-  }
+    }
 
-  public function test_it_allows_timebuilder_for_database()
-  {
+    public function test_it_allows_timebuilder_for_database()
+    {
     $options = OptionBuilder::forDatabase()
-      ->expirationTime()->hour(6)
-      ->flushAfter()->week(1)
-      ->build();
+        ->expirationTime()->hour(6)
+        ->flushAfter()->week(1)
+        ->build();
 
     $this->assertSame('6 hours', $options['expirationTime']);
     $this->assertSame('1 weeks', $options['flushAfter']);
-  }
+    }
 }

tests/Unit/RedisOptionBuilderStoreTest.php

Indentation +20 added lines, -20 removed lines

@@ -8,38 +8,38 @@ 
 
 class RedisOptionBuilderStoreTest extends TestCase
 {
-  private ?PredisClient $client = null;
+    private ?PredisClient $client = null;
 
-  protected function setUp(): void
-  {
+    protected function setUp(): void
+    {
     // Try to connect to Redis; skip if not available
     try {
-      PredisAutoloader::register();
-      $this->client = new PredisClient([
+        PredisAutoloader::register();
+        $this->client = new PredisClient([
         'scheme' => 'tcp',
         'host'   => REDIS_CONNECTION_CONFIG['REDIS_HOST'] ?? '127.0.0.1',
         'port'   => REDIS_CONNECTION_CONFIG['REDIS_PORT'] ?? 6379,
-      ]);
-      $this->client->connect();
-      // simple call to verify
-      $this->client->ping();
+        ]);
+        $this->client->connect();
+        // simple call to verify
+        $this->client->ping();
     } catch (\Throwable $e) {
-      $this->markTestSkipped('Redis not available: ' . $e->getMessage());
+        $this->markTestSkipped('Redis not available: ' . $e->getMessage());
+    }
     }
-  }
 
-  protected function tearDown(): void
-  {
+    protected function tearDown(): void
+    {
     if ($this->client) {
-      $this->client->disconnect();
+        $this->client->disconnect();
+    }
     }
-  }
 
-  public function test_redis_store_uses_namespace_from_option_builder()
-  {
+    public function test_redis_store_uses_namespace_from_option_builder()
+    {
     $options = OptionBuilder::forRedis()
-      ->setNamespace('app:')
-      ->build();
+        ->setNamespace('app:')
+        ->build();
 
     $cache = new Cacheer($options);
     $cache->setDriver()->useRedisDriver();
@@ -55,6 +55,6 @@ 
 
     $read = $cache->getCache($key);
     $this->assertEquals($data, $read);
-  }
+    }
 }
 

tests/Unit/RedisOptionBuilderTTLAndFlushTest.php

Indentation +26 added lines, -26 removed lines

@@ -9,37 +9,37 @@ 
 
 class RedisOptionBuilderTTLAndFlushTest extends TestCase
 {
-  private ?PredisClient $client = null;
+    private ?PredisClient $client = null;
 
-  protected function setUp(): void
-  {
+    protected function setUp(): void
+    {
     try {
-      PredisAutoloader::register();
-      $this->client = new PredisClient([
+        PredisAutoloader::register();
+        $this->client = new PredisClient([
         'scheme' => 'tcp',
         'host'   => REDIS_CONNECTION_CONFIG['REDIS_HOST'] ?? '127.0.0.1',
         'port'   => REDIS_CONNECTION_CONFIG['REDIS_PORT'] ?? 6379,
-      ]);
-      $this->client->connect();
-      $this->client->ping();
+        ]);
+        $this->client->connect();
+        $this->client->ping();
     } catch (\Throwable $e) {
-      $this->markTestSkipped('Redis not available: ' . $e->getMessage());
+        $this->markTestSkipped('Redis not available: ' . $e->getMessage());
+    }
     }
-  }
 
-  protected function tearDown(): void
-  {
+    protected function tearDown(): void
+    {
     if ($this->client) {
-      $this->client->disconnect();
+        $this->client->disconnect();
+    }
     }
-  }
 
-  public function test_expiration_time_from_options_sets_default_ttl()
-  {
+    public function test_expiration_time_from_options_sets_default_ttl()
+    {
     $options = OptionBuilder::forRedis()
-      ->setNamespace('app:')
-      ->expirationTime('1 seconds')
-      ->build();
+        ->setNamespace('app:')
+        ->expirationTime('1 seconds')
+        ->build();
 
     $cache = new Cacheer($options);
     $cache->setDriver()->useRedisDriver();
@@ -50,14 +50,14 @@ 
 
     sleep(2);
     $this->assertNull($cache->getCache($key));
-  }
+    }
 
-  public function test_flush_after_from_options_triggers_auto_flush()
-  {
+    public function test_flush_after_from_options_triggers_auto_flush()
+    {
     $options = OptionBuilder::forRedis()
-      ->setNamespace('app:')
-      ->flushAfter('1 seconds')
-      ->build();
+        ->setNamespace('app:')
+        ->flushAfter('1 seconds')
+        ->build();
 
     $flushFile = FlushHelper::pathFor('redis', 'app:');
     file_put_contents($flushFile, (string) (time() - 3600));
@@ -71,5 +71,5 @@ 
     $cache = new Cacheer($options);
     $cache->setDriver()->useRedisDriver();
     $this->assertFalse((bool)$this->client->exists('app:to_be_flushed'));
-  }
+    }
 }

tests/Unit/DatabaseOptionBuilderStoreTest.php

Indentation +14 added lines, -14 removed lines

@@ -7,11 +7,11 @@ 
 
 class DatabaseOptionBuilderStoreTest extends TestCase
 {
-  private ?PDO $pdo = null;
-  private string $table = 'cache_items';
+    private ?PDO $pdo = null;
+    private string $table = 'cache_items';
 
-  protected function setUp(): void
-  {
+    protected function setUp(): void
+    {
     // Ensure SQLite connection and create a custom table for this test
     $this->pdo = Connect::getInstance();
 
@@ -30,20 +30,20 @@ 
     CREATE INDEX IF NOT EXISTS idx_{$this->table}_expirationTime ON {$this->table} (expirationTime);
     CREATE INDEX IF NOT EXISTS idx_{$this->table}_key_namespace ON {$this->table} (cacheKey, cacheNamespace);
     ");
-  }
+    }
 
-  protected function tearDown(): void
-  {
+    protected function tearDown(): void
+    {
     if ($this->pdo instanceof PDO) {
-      $this->pdo->exec("DROP TABLE IF EXISTS {$this->table}");
+        $this->pdo->exec("DROP TABLE IF EXISTS {$this->table}");
+    }
     }
-  }
 
-  public function test_database_store_uses_custom_table_from_option_builder()
-  {
+    public function test_database_store_uses_custom_table_from_option_builder()
+    {
     $options = OptionBuilder::forDatabase()
-      ->table($this->table)
-      ->build();
+        ->table($this->table)
+        ->build();
 
     $cache = new Cacheer($options);
     $cache->setDriver()->useDatabaseDriver();
@@ -67,6 +67,6 @@ 
     // And ensure Cacheer can read it back through the store
     $read = $cache->getCache($key);
     $this->assertEquals($data, $read);
-  }
+    }
 }