Merge pull request #537 from Geolim4/final

Added test for cache option "itemDetailedDate" + Removed VersionEye badge 😭

Author: Geolim4

README.md

@@ -1,4 +1,4 @@
-[![Total Downloads](http://img.shields.io/packagist/dt/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Dependency Status](https://www.versioneye.com/php/phpfastcache:phpfastcache/badge.svg)](https://www.versioneye.com/php/phpfastcache:phpfastcache) [![Latest Stable Version](http://img.shields.io/packagist/v/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![License](https://img.shields.io/packagist/l/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Coding Standards](https://img.shields.io/badge/CI-PSR6-orange.svg)](https://github.com/php-fig/cache)  [![Coding Standards](https://img.shields.io/badge/CS-PSR16-orange.svg)](https://github.com/php-fig/simple-cache)    
+[![Total Downloads](http://img.shields.io/packagist/dt/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Latest Stable Version](http://img.shields.io/packagist/v/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![License](https://img.shields.io/packagist/l/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Coding Standards](https://img.shields.io/badge/CI-PSR6-orange.svg)](https://github.com/php-fig/cache)  [![Coding Standards](https://img.shields.io/badge/CS-PSR16-orange.svg)](https://github.com/php-fig/simple-cache)    
 [![Code Climate](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache/badges/gpa.svg)](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache/badges/quality-score.png?b=final)](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache/?branch=final) [![Build Status](https://travis-ci.org/PHPSocialNetwork/phpfastcache.svg?branch=final)](https://travis-ci.org/PHPSocialNetwork/phpfastcache) [![Semver compliant](https://img.shields.io/badge/Semver-2.0.0-yellow.svg)](http://semver.org/spec/v2.0.0.html)
 
 :exclamation: V6 USERS, PLEASE NOTE THAT THE V6 REQUIRES PHP 5.6 AT LEAST :exclamation:

tests/CacheItemDetailedDate.test.php

@@ -0,0 +1,94 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <[email protected]>
+ */
+
+use phpFastCache\CacheManager;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
+use phpFastCache\Helper\TestHelper;
+
+chdir(__DIR__);
+require_once __DIR__ . '/../src/autoload.php';
+$testHelper = new TestHelper('Cache option: itemDetailedDate');
+$defaultDriver = (!empty($argv[ 1 ]) ? ucfirst($argv[ 1 ]) : 'Files');
+$cacheInstance = CacheManager::getInstance($defaultDriver, ['itemDetailedDate' => true, 'path' => __DIR__ . '/../cache/']);
+$cacheKey = 'cacheKey';
+$RandomCacheValue = str_shuffle(uniqid('pfc', true));
+
+$testHelper->printText('Preparing cache test item...');
+$realCreationDate = new \DateTime();
+$cacheItem = $cacheInstance->getItem($cacheKey);
+$cacheItem->set($RandomCacheValue)->expiresAfter(60);
+$cacheInstance->save($cacheItem);
+$cacheInstance->detachAllItems();
+$diffSeconds = 3;
+
+unset($cacheItem);
+for($i = 0; $i < $diffSeconds; $i++){
+    $testHelper->printText(sprintf("Sleeping {$diffSeconds} seconds (%ds elapsed)", $i + 1));
+    sleep(1);
+}
+$testHelper->printText('Triggering modification date...');
+
+$cacheItem = $cacheInstance->getItem($cacheKey);
+$cacheItem->set(str_shuffle($RandomCacheValue));
+$realModificationDate = new \DateTime();
+$cacheInstance->save($cacheItem);
+$cacheInstance->detachAllItems();
+unset($cacheItem);
+
+for($i = 0; $i < $diffSeconds; $i++){
+    $testHelper->printText(sprintf("Sleeping {$diffSeconds} additional seconds (%ds elapsed)", $i + 1));
+    sleep(1);
+}
+$cacheItem = $cacheInstance->getItem($cacheKey);
+
+try{
+    $creationDate = $cacheItem->getCreationDate();
+    if($creationDate instanceof \DateTimeInterface){
+        $testHelper->printPassText('The method getCreationDate() returned a DateTimeInterface object');
+        if($creationDate->format(DateTime::W3C) === $realCreationDate->format(DateTime::W3C)){
+            $testHelper->printPassText('The item creation date effectively represents the real creation date (obviously).');
+        }else{
+            $testHelper->printFailText('The item creation date does not represents the real creation date.');
+        }
+    }else{
+        $testHelper->printFailText('The method getCreationDate() does not returned a DateTimeInterface object, got: ' . var_export($creationDate, true));
+    }
+}catch(phpFastCacheLogicException $e){
+    $testHelper->printFailText('The method getCreationDate() unexpectedly thrown a phpFastCacheLogicException');
+}
+
+try{
+    $modificationDate = $cacheItem->getModificationDate();
+    if($modificationDate instanceof \DateTimeInterface){
+        $testHelper->printPassText('The method getModificationDate() returned a DateTimeInterface object');
+        if($modificationDate->format(DateTime::W3C) === $realModificationDate->format(DateTime::W3C)){
+            $testHelper->printPassText('The item modification date effectively represents the real modification date (obviously).');
+        }else{
+            $testHelper->printFailText('The item modification date does not represents the real modification date.');
+        }
+        /**
+         * Using >= operator instead of === due to a possible micro time
+         * offset that can often results to a value of 6 seconds (rounded)
+         */
+        if($modificationDate->getTimestamp() - $cacheItem->getCreationDate()->getTimestamp() >= $diffSeconds){
+            $testHelper->printPassText("The item modification date is effectively {$diffSeconds} seconds greater than the creation date.");
+        }else{
+            $testHelper->printFailText('The item modification date effectively is not greater than the creation date.');
+        }
+    }else{
+        $testHelper->printFailText('The method getModificationDate() does not returned a DateTimeInterface object, got: ' . var_export($modificationDate, true));
+    }
+}catch(phpFastCacheLogicException $e){
+    $testHelper->printFailText('The method getModificationDate() unexpectedly thrown a phpFastCacheLogicException');
+}
+
+$cacheInstance->clear();
+unset($cacheInstance);
+CacheManager::clearInstances();
+$cacheInstance = CacheManager::getInstance($defaultDriver, ['itemDetailedDate' => false]);
+
+$testHelper->terminateTest();