PHPCS / PHPUNIT / Missed Corrections

Author: James Galecki

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @traderinteractive/opensource

CONTRIBUTING.md

@@ -1,28 +1,28 @@
 # Memoize
 A PHP library for memoizing repeated function calls.
 
-[![Build Status](http://img.shields.io/travis/dominionenterprises/memoize-php.svg?style=flat)](https://travis-ci.org/dominionenterprises/memoize-php)
-[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/dominionenterprises/memoize-php.svg?style=flat)](https://scrutinizer-ci.com/g/dominionenterprises/memoize-php/)
-[![Code Coverage](http://img.shields.io/coveralls/dominionenterprises/memoize-php.svg?style=flat)](https://coveralls.io/r/dominionenterprises/memoize-php)
+[![Build Status](http://img.shields.io/travis/traderinteractive/memoize-php.svg?style=flat)](https://travis-ci.org/traderinteractive/memoize-php)
+[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/traderinteractive/memoize-php.svg?style=flat)](https://scrutinizer-ci.com/g/traderinteractive/memoize-php/)
+[![Code Coverage](http://img.shields.io/coveralls/traderinteractive/memoize-php.svg?style=flat)](https://coveralls.io/r/traderinteractive/memoize-php)
 
-[![Latest Stable Version](http://img.shields.io/packagist/v/dominionenterprises/memoize.svg?style=flat)](https://packagist.org/packages/dominionenterprises/memoize)
-[![Total Downloads](http://img.shields.io/packagist/dt/dominionenterprises/memoize.svg?style=flat)](https://packagist.org/packages/dominionenterprises/memoize)
-[![License](http://img.shields.io/packagist/l/dominionenterprises/memoize.svg?style=flat)](https://packagist.org/packages/dominionenterprises/memoize)
+[![Latest Stable Version](http://img.shields.io/packagist/v/traderinteractive/memoize.svg?style=flat)](https://packagist.org/packages/traderinteractive/memoize)
+[![Total Downloads](http://img.shields.io/packagist/dt/traderinteractive/memoize.svg?style=flat)](https://packagist.org/packages/traderinteractive/memoize)
+[![License](http://img.shields.io/packagist/l/traderinteractive/memoize.svg?style=flat)](https://packagist.org/packages/traderinteractive/memoize)
 
 ## Requirements
 This library requires PHP 5.4, or newer.
 
 ## Installation
 This package uses [composer](https://getcomposer.org) so you can just add
-`dominionenterprises/memoize` as a dependency to your `composer.json` file.
+`traderinteractive/memoize` as a dependency to your `composer.json` file.
 
 ## Memoization
 [Memoization](http://en.wikipedia.org/wiki/Memoization) is a way of optimizing
 a function that is called repeatedly by caching the results of a function call.
 
 ## Memoization Providers
 This library includes several built-in providers for memoization.  Each one
-implements the `\DominionEnterprises\Memoize\Memoize` interface:
+implements the `\TraderInteractive\Memoize\Memoize` interface:
 ```php
 interface Memoize
 {
@@ -90,7 +90,7 @@ rather than only caching computation for the current process.
 #### Example
 ```php
 $predis = new \Predis\Client($redisUrl);
-$memoize = new \DominionEnterprises\Memoize\Predis($predis);
+$memoize = new \TraderInteractive\Memoize\Predis($predis);
 
 $compute = function() {
     // Perform some long operation that you want to memoize
@@ -106,7 +106,7 @@ moment and only keeps the results around as long as the memoizer is in memory.
 
 #### Example
 ```php
-$memoize = new \DominionEnterprises\Memoize\Memory();
+$memoize = new \TraderInteractive\Memoize\Memory();
 
 $compute = function() {
     // Perform some long operation that you want to memoize
@@ -123,7 +123,7 @@ out for this one and everything will still work.
 
 #### Example
 ```php
-$memoize = new \DominionEnterprises\Memoize\Never();
+$memoize = new \TraderInteractive\Memoize\Never();
 
 $compute = function() {
     // Perform some long operation that you want to memoize

README.md

@@ -26,6 +26,6 @@
         "predis/predis": "Allows for Redis-based memoization."
     },
     "autoload": {
-        "psr-4": { "DominionEnterprises\\Memoize\\": "src/" }
+        "psr-4": { "TraderInteractive\\Memoize\\": "src/" }
     }
 }

composer.json

@@ -1,14 +1,16 @@
 <?php
-namespace DominionEnterprises\Memoize;
+
+namespace TraderInteractive\Memoize;
 
 interface Memoize
 {
     /**
      * Gets the value stored in the cache or uses the passed function to compute the value and save to cache.
      *
-     * @param string $key The key to fetch
-     * @param callable $compute A function to run if the value was not cached that will return the result.
-     * @param int $cacheTime The number of seconds to cache the response for, or null to not expire it ever.
+     * @param string   $key       The key to fetch
+     * @param callable $compute   A function to run if the value was not cached that will return the result.
+     * @param int      $cacheTime The number of seconds to cache the response for, or null to not expire it ever.
+     *
      * @return mixed The data requested, optionally pulled from cache
      */
     public function memoizeCallable($key, $compute, $cacheTime = null);

src/Memoize.php

@@ -1,5 +1,6 @@
 <?php
-namespace DominionEnterprises\Memoize;
+
+namespace TraderInteractive\Memoize;
 
 /**
  * An in-memory memoizer that keeps the cached values around for the lifetime of this instance.
@@ -11,7 +12,7 @@ class Memory implements Memoize
      *
      * @var array
      */
-    private $_cache = [];
+    private $cache = [];
 
     /**
      * $cacheTime is ignored - this will keep the results around for the lifetime of this instance.
@@ -20,12 +21,12 @@ class Memory implements Memoize
      */
     public function memoizeCallable($key, $compute, $cacheTime = null)
     {
-        if (array_key_exists($key, $this->_cache)) {
-            return $this->_cache[$key];
+        if (array_key_exists($key, $this->cache)) {
+            return $this->cache[$key];
         }
 
         $result = call_user_func($compute);
-        $this->_cache[$key] = $result;
+        $this->cache[$key] = $result;
 
         return $result;
     }

src/Memory.php

@@ -1,8 +1,10 @@
 <?php
-namespace DominionEnterprises\Memoize;
+
+namespace TraderInteractive\Memoize;
 
 /**
- * A memoizer that never caches and always recomputes the result.  This is useful for turning off memoization (e.g., for debugging).
+ * A memoizer that never caches and always recomputes the result.
+ * This is useful for turning off memoization (e.g., for debugging).
  */
 class Never implements Memoize
 {

src/Never.php

@@ -1,10 +1,11 @@
 <?php
-namespace DominionEnterprises\Memoize;
+
+namespace TraderInteractive\Memoize;
 
 use \Predis\Client;
 
 /**
- * A memoizer that caches the results in a redis cache.  
+ * A memoizer that caches the results in a redis cache.
  */
 class Predis implements Memoize
 {
@@ -13,37 +14,38 @@ class Predis implements Memoize
      *
      * @var \Predis\Client
      */
-    private $_client;
+    private $client;
 
     /**
      * Cache refresh
      *
      * @var boolean
      */
-    private $_refresh;
+    private $refresh;
 
     /**
      * Sets the predis client.
      *
-     * @param \Predis\Client $client The predis client to use
-     * @param boolean $refresh If true we will always overwrite cache even if it is already set
+     * @param \Predis\Client $client  The predis client to use
+     * @param boolean        $refresh If true we will always overwrite cache even if it is already set
      */
-    public function __construct(Client $client, $refresh = false)
+    public function __construct(Client $client, bool $refresh = false)
     {
-        $this->_client = $client;
-        $this->_refresh = $refresh;
+        $this->client = $client;
+        $this->refresh = $refresh;
     }
 
     /**
-     * The value is stored in redis as a json_encoded string, so make sure that the value you return from $compute is json-encodable.
+     * The value is stored in redis as a json_encoded string,
+     * so make sure that the value you return from $compute is json-encode-able.
      *
      * @see Memoize::memoizeCallable
      */
     public function memoizeCallable($key, $compute, $cacheTime = null)
     {
-        if (!$this->_refresh) {
+        if (!$this->refresh) {
             try {
-                $cached = $this->_client->get($key);
+                $cached = $this->client->get($key);
                 if ($cached !== null) {
                     $data = json_decode($cached, true);
                     return $data['result'];
@@ -55,30 +57,33 @@ public function memoizeCallable($key, $compute, $cacheTime = null)
 
         $result = call_user_func($compute);
 
-        $this->_cache($key, json_encode(['result' => $result]), $cacheTime);
+        $this->cache($key, json_encode(['result' => $result]), $cacheTime);
 
         return $result;
     }
 
     /**
      * Caches the value into redis with errors suppressed.
      *
-     * @param string $key The key.
-     * @param string $value The value.
-     * @param int $cacheTime The optional cache time
+     * @param string $key       The key.
+     * @param string $value     The value.
+     * @param int    $cacheTime The optional cache time
+     *
      * @return void
      */
-    private function _cache($key, $value, $cacheTime = null)
+    private function cache(string $key, string $value, int $cacheTime = null)
     {
         try {
-            $this->_client->set($key, $value);
+            $this->client->set($key, $value);
 
             if ($cacheTime !== null) {
-                $this->_client->expire($key, $cacheTime);
+                $this->client->expire($key, $cacheTime);
             }
         } catch (\Exception $e) {
-            // We don't want exceptions in accessing the cache to break functionality.  The cache should be as transparent as possible.
-            // If insight is needed into these exceptions, a better way would be by notifying an observer with the errors.
+            // We don't want exceptions in accessing the cache to break functionality.
+            // The cache should be as transparent as possible.
+            // If insight is needed into these exceptions,
+            // a better way would be by notifying an observer with the errors.
         }
     }
 }

src/Predis.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace DominionEnterprises\Memoize;
+namespace TraderInteractive\Memoize;
 
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \DominionEnterprises\Memoize\Memory
+ * @coversDefaultClass \TraderInteractive\Memoize\Memory
  */
 class MemoryTest extends TestCase
 {
@@ -18,7 +18,7 @@ public function memoizeCallableTwice()
         $count = 0;
         $key = 'foo';
         $value = 'bar';
-        $compute = function() use(&$count, $value) {
+        $compute = function () use (&$count, $value) {
             $count++;
 
             return $value;

tests/MemoryTest.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace DominionEnterprises\Memoize;
+namespace TraderInteractive\Memoize;
 
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \DominionEnterprises\Memoize\Never
+ * @coversDefaultClass \TraderInteractive\Memoize\Never
  */
 class NeverTest extends TestCase
 {
@@ -18,13 +18,13 @@ public function memoizeCallableTwice()
         $count = 0;
         $key = 'foo';
         $value = 'bar';
-        $compute = function() use(&$count, $value) {
+        $compute = function () use (&$count, $value) {
             $count++;
 
             return $value;
         };
 
-        $memoizer = new \DominionEnterprises\Memoize\Never();
+        $memoizer = new Never();
 
         $this->assertSame($value, $memoizer->memoizeCallable($key, $compute));
         $this->assertSame($value, $memoizer->memoizeCallable($key, $compute));