Merge pull request #10 from wp-oop/fix/7-return-value-incompat

Add PSR-16 Exception Compatible Pool Wrapper

Author: XedinUnknown

.gitattributes

@@ -1,12 +1,10 @@
-test export-ignore
-nbproject export-ignore
+tests export-ignore
 .idea export-ignore
-.codeclimate.yml export-ignore
-.php_cs export-ignore
+docker export-ignore
+docker-compose.yml export-ignore
+.env.example export-ignore
 .travis.yml export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
 composer.lock export-ignore
 phpunit.xml export-ignore
-.env
-.env.example

.idea/sqldialects.xml

@@ -5,6 +5,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [[*next-version*]] - YYYY-MM-DD
+### Fixed
+- False-negative check used to confirm the negative because of wrong option name.
+- Non-getter interface methods of `CachePool` now return `true` on success.
+- Non-getter interface methods of `CachePool` now declare and throw proper exceptions.
+
+### Added
+- `SilentPool`, which wraps cache pools that throw non-PSR-16 exceptions and suppress them, making the pool compatible (#7).
+- Missing documentation.
+
+### Changed
+- Centralized behaviour like option deletion, and option/transient retrieval/assignment.
 
 ## [0.1.0-alpha1] - 2020-04-14
 Initial version.

CHANGELOG.md

@@ -23,6 +23,13 @@ transients as storage. Exceptions are raised, interfaces implemented, and true f
 Each instance of the cache pool is logically independent from other instances, provided that it is given a unique
 name. The application is once again in control, and modules that use cache can become platform agnostic.
 
+### Compatibility
+- `CachePool` and `CachePoolFactory` offer best-practices error handling, throwing meaningful exceptions
+when something goes wrong. This violates PSR-16, but allows you to know what is failing.
+- `SilentPool` and `SilentPoolFactory` offer PSR-16 compatibility at the cost of error handling,
+hiding exceptions, and returning standards-compatible values. This complies with PSR-16, but at the cost of
+clarity and verbosity.
+
 ### Usage
 ```php
 /*
@@ -31,10 +38,12 @@ name. The application is once again in control, and modules that use cache can b
 use wpdb;
 use Psr\SimpleCache\CacheInterface;
 use WpOop\TransientCache\CachePoolFactory;
+use WpOop\TransientCache\SilentPoolFactory;
 
 /* @var $wpdb wpdb */
 $factory = new CachePoolFactory($wpdb);
-
+// Optionally hide exceptions for PSR-16 compatibility
+$factory = new SilentPoolFactory($factory); // Optional, and not recommended for testing environments!
 
 /*
  * Create cache pools - usually somewhere else