Fixed docs and configuration files

Author: Geolim4

.codeclimate.yml

@@ -29,19 +29,11 @@ engines:
     enabled: true
   phpmd:
     enabled: true
-    checks:
-      CleanCode/ElseExpression:
-        enabled: false
-      CleanCode/BooleanArgumentFlag:
-        enabled: false
-      Controversial/Superglobals:
-        enabled: false
-      Controversial/CamelCaseVariableName:
-        enabled: false
-      Design/TooManyPublicMethods:
-        enabled: false
-      Design/NpathComplexity:
-        enabled: false
+    config:
+      file_extensions:
+        - php
+        - inc
+      rulesets: "phpmd.xml"
 ratings:
   paths:
   - "**.inc"

CODING_GUIDELINE.md

@@ -5,7 +5,7 @@ Fork the project, create a feature branch, and send us a pull request.
 Preferably on a distinct branch.
 
 To ensure a consistent code base, you should make sure the code follows
-the [PSR-2 Coding Standards](http://www.php-fig.org/psr/psr-2/). You can also
+the [PSR-12: Extended Coding Style](https://www.php-fig.org/psr/psr-12/). You can also
 run [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) with the
 configuration file that can be found in the project root directory.
 
@@ -24,7 +24,7 @@ As of the V7 your contributions MUST comply the following standards:
   - E.g: `$dateFormat = \DATE_ISO8601`
 
 ### PHP CORE CLASSES
-- Do not imports non-namespaced classes, use an absolute path instead:  
+- Do not import non-namespaced classes, use an absolute path instead:  
   - E.g: `$date = new \DateTime();`
 
 ### CODE STYLE

CONTRIBUTING.md

@@ -23,14 +23,16 @@ Developer notes
 If you want to contribute to the repository you will need to install/configure some things first.
 
 To run tests follow the steps:
-- Run `./bin/ci/scripts/install_dependencies.sh`
-- Run `./vendor/bin/phpcs lib/  --report=summary`
-- Run `./vendor/bin/phpmd lib/ ansi phpmd.xml`
-- Run `./vendor/bin/phpstan analyse lib/ -l 2 -c phpstan_lite.neon 2>&1`
-- Run `php -f ./bin/ci/run_tests.php`
+1) Run `./bin/ci/scripts/install_dependencies.sh`
+2) Run `./vendor/bin/phpcs lib/  --report=summary`
+3) Run `./vendor/bin/phpmd lib/ ansi phpmd.xml`
+4) Run `./vendor/bin/phpstan analyse lib/ -l 2 -c phpstan_lite.neon 2>&1`
+5) Run `php -f ./bin/ci/run_tests.php`
 
-The last command will run all the tests including the quality tests (phpmd, phpcs, phpstan).
+If you are on Windows environment simply run the file `quality.bat` located at the root of the project to run the step 2, 3 and 4 in once.
+
+The last command will run all the unit tests of the project.
 If an error appears, fix it then you can submit your pull request.
 
-Don't worry if you don't have some services installed like "memcached", "couchdb", "couchbase", "mongodb", etc.
-The tests will be skipped on your computer but will be running in Github CI/Travis CI.
+Some tests will be skipped if you don't have special dependencies installed (Arangodb, Couchbase, Couchdb, Firestore credential and SDK, Dynamodb credential, etc.).\
+So don't worry if those tests are skipped as long as they **pass** on the Github and Travis CIs.

docs/DRIVERS.md

@@ -10,8 +10,8 @@
 * Cookie **(REMOVED in V9)**
   * A cookie driver to store non-sensitive scalar (only) data. Limited storage up to 4Ko.
 * Couchbase **(REMOVED in V9)**
-  * A very high-performance NoSQL driver using a key-value pair system, replaced by Couchbasev3 as of V9.
-* Couchbasev3 **(Added in V8.0.8)**
+  * A very high-performance NoSQL driver using a key-value pair system, replaced by Couchbasev3 as of v8.0.8.
+* Couchbasev3 **(Added in v8.0.8)**
   * Same as Couchbase but for Couchbase PHP-SDK 3.0 support.
 * Couchdb
   * A very high-performance NoSQL driver using a key-value pair system.
@@ -21,7 +21,7 @@
    * A development driver that return null for driverRead() and driverIsHit() (get actions) and true for other action such as driverDelete, DriverClear() etc.
 * Devtrue **(REMOVED in V9)**
    * A development driver that return true for everything including driverCheck().
-* Devrandom **(Added in V8.0.8)**
+* Devrandom **(Added in v8.0.8)**
   * A development driver with configurable factor chance and data length.
 * Dynamodb **(Added in V9)**
   * An AWS cloud NoSQL driver using a key-value pair system. Be careful when flushing the table as it will delete and recreate the table due to a Dynamodb limitation.
@@ -43,7 +43,7 @@
   * A high-performance memory driver using a in-memory data structure storage. Less efficient than Redis driver as it is an embedded library.
 * Redis
   * A very high-performance memory driver using a in-memory data structure storage. More efficient than Predis driver as it is an compiled library.
-* Riak **(REMOVED in V8.0.6)**
+* Riak **(REMOVED in v8.0.6)**
   * A very high-performance NoSQL driver using a key-value pair system.
 * Sqlite
   * A Sqlite driver that use serialization for storing data for regular performances. A _$path_ config must be specified, else the system temporary directory will be used.

lib/Phpfastcache/CacheContract.php

@@ -1,16 +1,16 @@
 <?php
 
 /**
+ *
  * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
  * For full copyright and license information, please see the docs/CREDITS.txt and LICENCE files.
  *
- * @author Squiz Pty Ltd <[email protected]>
- * @author Squiz Pty Ltd <[email protected]>
+ * @author Georges.L (Geolim4)  <[email protected]>
+ * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
  */
-
 declare(strict_types=1);
 
 namespace Phpfastcache;

lib/Phpfastcache/Config/AbstractConfigurationOption.php

@@ -10,7 +10,6 @@
  * @author Georges.L (Geolim4)  <[email protected]>
  * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
  */
-
 declare(strict_types=1);
 
 namespace Phpfastcache\Config;

lib/Phpfastcache/Helper/Psr16Adapter.php

@@ -196,7 +196,7 @@ public function deleteMultiple(iterable $keys): bool
                 return $this->internalCacheInstance->deleteItems($keys);
             }
 
-            throw new phpFastCacheInvalidArgumentException('$keys must be an array/Traversable instance.');
+            throw new PhpfastcacheInvalidArgumentException('$keys must be an array/Traversable instance.');
         } catch (PhpfastcacheInvalidArgumentException $e) {
             throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e);
         }