Merge pull request #43 from tedivm/refactor

Testing and Refactoring
tedious · May 7, 2014 · 1367d69 · 1367d69
2 parents a42ee0a + 10e3085
commit 1367d69
Show file tree

Hide file tree

Showing 24 changed files with 161 additions and 83 deletions.
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -0,0 +1,3 @@
+src_dir: ./
+coverage_clover: build/logs/clover.xml
+json_path: build/logs/coveralls-upload.json
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
+/.idea
 /.settings
 /.buildpath
 /.project
 /composer.lock
 /vendor
 /report
+/build
diff --git a/.travis.yml b/.travis.yml
@@ -7,10 +7,13 @@ php:
     - hhvm
 
 before_script:
-    - composer install --dev
+    - composer self-update && composer install --dev
 
-script: phpunit --verbose --coverage-text
+script: ./Tests/runTests.sh
+
+after_script:
+    - php vendor/bin/coveralls -v
 
 matrix:
-  allow_failures:
-    - php: hhvm
+    allow_failures:
+      - php: hhvm
diff --git a/Adapters/DoctrineAdapter.php b/Adapters/DoctrineAdapter.php
@@ -1,8 +1,6 @@
 <?php
 
 namespace Tedivm\StashBundle\Adapters;
-use Stash\Item as StashItem;
-use Stash\Drivers;
 use Doctrine\Common\Cache\Cache as DoctrineCacheInterface;
 
 class DoctrineAdapter implements DoctrineCacheInterface
@@ -60,15 +58,15 @@ public function fetch($id)
     {
         $id = $this->normalizeId($id);
 
-        if(isset($this->caches[$id])) {
+        if (isset($this->caches[$id])) {
             $cache = $this->caches[$id];
             unset($this->caches[$id]);
         } else {
             $cache = $this->cacheService->getItem($id);
         }
 
         $value = $cache->get();
-        if($cache->isMiss()) {
+        if ($cache->isMiss()) {
             return false;
         } else {
             return $value;
@@ -84,7 +82,7 @@ public function contains($id)
 
         $this->caches[$id] = $this->cacheService->getItem($id);
 
-        return !$this->caches[$id]->isMiss(); 
+        return !$this->caches[$id]->isMiss();
     }
 
     /**
@@ -143,9 +141,10 @@ public function flushAll()
      */
     protected function normalizeId($id)
     {
-        if(isset($this->namespace)) {
+        if (isset($this->namespace)) {
             $id = sprintf('zz_%s_zz/%s', $this->namespace, $id);
             $id = trim($id, '/');
+
             return $id;
         } else {
             return $id;

diff --git a/Adapters/SessionHandlerAdapter.php b/Adapters/SessionHandlerAdapter.php
@@ -4,7 +4,7 @@
 
 use Stash\Session;
 
-if(version_compare(phpversion(), '5.4.0', '>=')){
+if (version_compare(phpversion(), '5.4.0', '>=')) {
     class SessionHandlerAdapterShim extends Session {}
 } else {
     class SessionHandlerAdapterShim extends Session implements \SessionHandlerInterface {}
@@ -27,4 +27,4 @@ public function clearAll()
         $item = $this->pool->getItem('ss_ss');
         $item->clear();
     }
-}
+}
diff --git a/Collector/CacheDataCollector.php b/Collector/CacheDataCollector.php
@@ -4,10 +4,8 @@
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Stash\Item;
 use Stash\Drivers;
 
-
 /**
  * Collects data stored in the static variables of the Stash class for use in profiling/debugging. Currently
  * records total cache calls and returns, along with calls and returns on each individual cache node.
@@ -67,7 +65,7 @@ public function addLogger($logger)
     public function collect(Request $request, Response $response, \Exception $exception = null)
     {
         $info = array('calls' => 0, 'hits' => 0);
-        foreach($this->loggers as $logger) {
+        foreach ($this->loggers as $logger) {
             $name = $logger->getName();
             $calls = $logger->getCalls();
             $hits = $logger->getHits();
@@ -82,10 +80,10 @@ public function collect(Request $request, Response $response, \Exception $except
         }
 
         $handlers = Drivers::getDrivers();
-        foreach($handlers as $handler) {
+        foreach ($handlers as $handler) {
             $pieces = explode('\\', $handler);
             $name = array_pop($pieces);
-            if(!in_array($name, array('Ephemeral', 'Composite'))) {
+            if (!in_array($name, array('Ephemeral', 'Composite'))) {
                 $info['availableDrivers'][] = $name;
             }
         }

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -3,7 +3,6 @@
 namespace Tedivm\StashBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\ConfigurationInterface;
-use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Stash\Drivers;
 
@@ -105,8 +104,8 @@ protected function getCachesNode()
                 ->booleanNode('inMemory')->defaultTrue()->end()
             ;
 
-            foreach($handlers as $handler) {
-                if($handler !== 'Composite') {
+            foreach ($handlers as $handler) {
+                if ($handler !== 'Composite') {
                     $this->addHandlerSettings($handler, $childNode);
                 }
             }
@@ -117,14 +116,13 @@ protected function getCachesNode()
         return $node;
     }
 
-
     public function addHandlerSettings($handler, $rootNode)
     {
         $handlerNode = $rootNode
             ->arrayNode($handler)
                 ->fixXmlConfig('server');
 
-            if($handler == 'Memcache') {
+            if ($handler == 'Memcache') {
                 $finalNode = $handlerNode
                     ->info('All options except "servers" are Memcached options. See http://www.php.net/manual/en/memcached.constants.php')
                     ->addDefaultsIfNotSet()
@@ -163,7 +161,7 @@ public function addHandlerSettings($handler, $rootNode)
                         ->end()
                     ->end()
                ;
-            } elseif($handler == 'Redis') {
+            } elseif ($handler == 'Redis') {
                 $finalNode = $handlerNode
                     ->info("Accepts server info, password, and database.")
                     ->addDefaultsIfNotSet()
@@ -193,7 +191,7 @@ public function addHandlerSettings($handler, $rootNode)
                     ->addDefaultsIfNotSet()
                     ->children();
 
-                    foreach($defaults as $setting => $default) {
+                    foreach ($defaults as $setting => $default) {
                         $node
                             ->scalarNode($setting)
                             ->defaultValue($default)

diff --git a/DependencyInjection/TedivmStashExtension.php b/DependencyInjection/TedivmStashExtension.php
@@ -37,7 +37,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $caches = array();
         $options = array();
-        foreach($config['caches'] as $name => $cache) {
+        foreach ($config['caches'] as $name => $cache) {
             $caches[$name] = sprintf('stash.%s_cache', $name);
             $options[$name] = $cache;
             $this->addCacheService($name, $cache, $container);
@@ -55,7 +55,7 @@ protected function addCacheService($name, $cache, $container)
         $handlers = $cache['handlers'];
         unset($cache['handlers']);
 
-        if(isset($cache['inMemory']) && $cache['inMemory']) {
+        if (isset($cache['inMemory']) && $cache['inMemory']) {
             array_unshift($handlers, 'Ephemeral');
         }
         unset($cache['inMemory']);
@@ -94,7 +94,7 @@ protected function addCacheService($name, $cache, $container)
             ->setAbstract(false)
         ;
 
-        if(interface_exists("\\Doctrine\\Common\\Cache\\Cache") && $doctrine) {
+        if (interface_exists("\\Doctrine\\Common\\Cache\\Cache") && $doctrine) {
             $container
                 ->setDefinition(sprintf('stash.adapter.doctrine.%s_cache', $name), new DefinitionDecorator('stash.adapter.doctrine'))
                 ->setArguments(array(
@@ -104,7 +104,7 @@ protected function addCacheService($name, $cache, $container)
             ;
         }
 
-        if($session) {
+        if ($session) {
             $container
                 ->setDefinition(sprintf('stash.adapter.session.%s_cache', $name), new DefinitionDecorator('stash.adapter.session'))
                 ->setArguments(array(
@@ -127,4 +127,4 @@ public function getAlias()
     {
         return 'stash';
     }
-}
+}
diff --git a/Factory/HandlerFactory.php b/Factory/HandlerFactory.php
@@ -4,22 +4,22 @@
 use Stash\Drivers,
     Stash\Interfaces\DriverInterface;
 
-class HandlerFactory {
-
+class HandlerFactory
+{
     /**
      * Given a list of cache types and options, creates a CompositeDrivers wrapping the specified drivers.
      *
      * @param $types
      * @param $options
      * @return DriverInterface
      */
-    static function createHandler($types, $options)
+    public static function createHandler($types, $options)
     {
         $handlers = Drivers::getDrivers();
 
         $h = array();
 
-        foreach($types as $type) {
+        foreach ($types as $type) {
             $class = $handlers[$type];
             if ($type === 'Memcache' && isset($options[$type])) {
                 // Fix servers spec since underlying drivers expect plain arrays, not hashes.
@@ -39,7 +39,7 @@ static function createHandler($types, $options)
             $h[] = new $class($opts);
         }
 
-        if(count($h) == 1) {
+        if (count($h) == 1) {
             return reset($h);
         }
 

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,24 @@
+Copyright (c) 2014, Robert Hafner, Josh Hall-Bachner
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Stash Project nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Robert Hafner BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -32,4 +32,4 @@
             <tag name="data_collector" id="stash" template="TedivmStashBundle:Profiler:layout"/>
         </service>
     </services>
-</container>
+</container>
diff --git a/Resources/meta/LICENSE b/Resources/meta/LICENSE
@@ -0,0 +1,24 @@
+Copyright (c) 2014, Robert Hafner, Josh Hall-Bachner
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Stash Project nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Robert Hafner BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Resources/views/Profiler/layout.html.twig b/Resources/views/Profiler/layout.html.twig
@@ -132,4 +132,4 @@
 
 
     {% endfor %}
-{% endblock %}
+{% endblock %}
diff --git a/Service/CacheLogger.php b/Service/CacheLogger.php
@@ -69,16 +69,16 @@ public function enableQueryLogging($lq = true)
     public function logRequest($key, $hit, $value)
     {
         $this->calls++;
-        if($hit) {
+        if ($hit) {
             $this->hits++;
         }
 
-        if(!$this->logQueries) {
+        if (!$this->logQueries) {
             return;
         }
 
         $leader = sprintf('@@_%s_@@/', $this->name);
-        if(strpos($key, $leader) === 0) {
+        if (strpos($key, $leader) === 0) {
             $key = substr($key, strlen($leader));
         }
 

diff --git a/Service/CacheResultObject.php b/Service/CacheResultObject.php
@@ -1,7 +1,6 @@
 <?php
 
 namespace Tedivm\StashBundle\Service;
-use Stash\Drivers;
 
 /**
  * Simple result-object provider for the Stash class.
@@ -44,9 +43,9 @@ public function __construct($cache, $logger = null)
      */
     public function __call($name, $args)
     {
-        if($name === 'get') {
+        if ($name === 'get') {
             return $this->getAndLog($args);
-        } elseif($name === 'getKey') {
+        } elseif ($name === 'getKey') {
             return $this->getShortenedKey();
         } else {
             return call_user_func_array(array($this->cache, $name), $args);
@@ -62,7 +61,7 @@ protected function getShortenedKey()
     {
         $key = $this->cache->getKey();
         $parts = explode('/', $key);
-        if( (strpos($parts[0], '@@_') === 0) && (strpos(strrev($parts[0]), '@@_') === 0) ) {
+        if ( (strpos($parts[0], '@@_') === 0) && (strpos(strrev($parts[0]), '@@_') === 0) ) {
             array_shift($parts);
         }
 
@@ -81,7 +80,7 @@ protected function getAndLog($args)
         $miss = $this->cache->isMiss();
         $key = $this->cache->getKey();
 
-        if(isset($this->logger)) {
+        if (isset($this->logger)) {
             $this->logger->logRequest($key, !($miss), $result);
         }