VisualPHPUnit · localgod · May 31, 2015 · May 31, 2015 · May 31, 2015 · May 31, 2015
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ app/resource/cache
 bin/phpcbf
 bin/phpcs
 bin/phpunit
+build
 vendor
 .buildpath
 .project

diff --git a/.travis.yml b/.travis.yml
@@ -10,11 +10,16 @@ php:
 
 before_script:
 - composer install
+- wget -nc -O ./phpDocumentor.phar http://www.phpdoc.org/phpDocumentor.phar
+- chmod 755 ./phpDocumentor.phar
+- wget -nc -O ./phpcs.phar --no-check-certificate https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+- chmod 755 ./phpcs.phar
 - phpenv rehash
 
 matrix:
   allow_failures:
   - php: 5.6
 
 script:
-- bin/phpcs
+- php ./phpcs.phar
+- php ./phpDocumentor.phar -f phpdoc.dist.xml
diff --git a/app/config/Routes.php b/app/config/Routes.php
@@ -1,45 +1,98 @@
 <?php
-
+/**
+ * VisualPHPUnit
+ *
+ * VisualPHPUnit is a visual front-end for PHPUnit.
+ *
+ * PHP Version 5.3<
+ *
+ * @author    Nick Sinopoli <NSinopoli@gmail.com>
+ * @copyright 2011-2015 VisualPHPUnit
+ * @license   http://opensource.org/licenses/BSD-3-Clause The BSD License
+ * @link      https://github.com/VisualPHPUnit/VisualPHPUnit VisualPHPUnit
+ */
 namespace app\config;
 
+/**
+ * Routes
+ *
+ * Routing class for http requests
+ *
+ * @author Nick Sinopoli <NSinopoli@gmail.com>
+ */
 class Routes
 {
 
+    /**
+     * Gret routes
+     *
+     * @return array
+     */
     public static function getRoutes()
     {
         return array(
-            array(array('get', 'post'), '/', function ($request) {
-                $controller = new \app\controller\Home();
-                return $controller->call('index', $request);
-            }),
-
-            array('get', '/archives', function ($request) {
-                $controller = new \app\controller\Archives();
-                return $controller->call('index', $request);
-            }),
-
-            array(array('get', 'post'), '/graphs', function ($request) {
-                $controller = new \app\controller\Graph();
-                return $controller->call('index', $request);
-            }),
-
-            array('get', '/file-list', function ($request) {
-                $controller = new \app\controller\FileList();
-                return $controller->call('index', $request);
-            }),
-
-            array('get', '/help', function ($request) {
-                $controller = new \app\controller\Home();
-                return $controller->call('help', $request);
-            }),
-
+            array(
+                array(
+                    'get',
+                    'post'
+                ),
+                '/',
+                function ($request) {
+                    $controller = new \app\controller\Home();
+                    return $controller->call('index', $request);
+                }
+            ),
+
+            array(
+                'get',
+                '/archives',
+                function ($request) {
+                    $controller = new \app\controller\Archives();
+                    return $controller->call('index', $request);
+                }
+            ),
+
+            array(
+                array(
+                    'get',
+                    'post'
+                ),
+                '/graphs',
+                function ($request) {
+                    $controller = new \app\controller\Graph();
+                    return $controller->call('index', $request);
+                }
+            ),
+
+            array(
+                'get',
+                '/file-list',
+                function ($request) {
+                    $controller = new \app\controller\FileList();
+                    return $controller->call('index', $request);
+                }
+            ),
+
+            array(
+                'get',
+                '/help',
+                function ($request) {
+                    $controller = new \app\controller\Home();
+                    return $controller->call('help', $request);
+                }
+            ),
+
             // 404
-            array('get', '*', function ($request) {
-                return array(
-                    'status' => 404,
-                    'body'   => '<h1>Not Found</h1>'
-                );
-            })
+            array(
+                'get',
+                '*',
+                function ($request) {
+                    return array(
+                        'status' => 404,
+                        'body' => '<h1>Not Found</h1>'
+                    );
+                }
+            )
         );
     }
 }
diff --git a/app/config/bootstrap.php b/app/config/bootstrap.php
@@ -1,5 +1,16 @@
 <?php
-
+/**
+ * VisualPHPUnit
+ *
+ * VisualPHPUnit is a visual front-end for PHPUnit.
+ *
+ * PHP Version 5.3<
+ *
+ * @author    Nick Sinopoli <NSinopoli@gmail.com>
+ * @copyright 2011-2015 VisualPHPUnit
+ * @license   http://opensource.org/licenses/BSD-3-Clause The BSD License
+ * @link      https://github.com/VisualPHPUnit/VisualPHPUnit VisualPHPUnit
+ */
 $root = dirname(dirname(__DIR__));
 
 $config = array(

diff --git a/app/controller/Archives.php b/app/controller/Archives.php
@@ -1,18 +1,42 @@
 <?php
-
+/**
+ * VisualPHPUnit
+ *
+ * VisualPHPUnit is a visual front-end for PHPUnit.
+ *
+ * PHP Version 5.3<
+ *
+ * @author    Nick Sinopoli <NSinopoli@gmail.com>
+ * @copyright 2011-2015 VisualPHPUnit
+ * @license   http://opensource.org/licenses/BSD-3-Clause The BSD License
+ * @link      https://github.com/VisualPHPUnit/VisualPHPUnit VisualPHPUnit
+ */
 namespace app\controller;
 
+/**
+ * Archives
+ *
+ * Class for managing archives
+ *
+ * @author Nick Sinopoli <NSinopoli@gmail.com>
+ */
 class Archives extends \app\core\Controller
 {
 
-    // GET
+    /**
+     * Index
+     *
+     * @param string $request
+     *            The request to process
+     * @return array
+     */
     public function index($request)
     {
         $snapshot_directory = \app\lib\Library::retrieve('snapshot_directory');
-        if (!$request->is('ajax')) {
+        if (! $request->is('ajax')) {
             $snapshots = array();
             $handler = @opendir($snapshot_directory);
-            if (!$handler) {
+            if (! $handler) {
                 return compact('snapshots');
             }
             while (($file = readdir($handler)) !== false) {
@@ -24,16 +48,15 @@ public function index($request)
             }
             closedir($handler);
             rsort($snapshots);
-
+            
             return compact('snapshots');
         }
-
-        if (!isset($request->query['snapshot'])) {
+        
+        if (! isset($request->query['snapshot'])) {
             return '';
         }
-
-        $file = realpath($snapshot_directory)
-            . "/{$request->query['snapshot']}";
-        return ( file_exists($file) ) ? file_get_contents($file) : '';
+
+        $file = realpath($snapshot_directory) . "/{$request->query['snapshot']}";
+        return (file_exists($file)) ? file_get_contents($file) : '';
     }
 }
diff --git a/app/controller/FileList.php b/app/controller/FileList.php
@@ -1,22 +1,46 @@
 <?php
-
+/**
+ * VisualPHPUnit
+ *
+ * VisualPHPUnit is a visual front-end for PHPUnit.
+ *
+ * PHP Version 5.3<
+ *
+ * @author    Nick Sinopoli <NSinopoli@gmail.com>
+ * @copyright 2011-2015 VisualPHPUnit
+ * @license   http://opensource.org/licenses/BSD-3-Clause The BSD License
+ * @link      https://github.com/VisualPHPUnit/VisualPHPUnit VisualPHPUnit
+ */
 namespace app\controller;
 
+/**
+ * FileList
+ *
+ * Class for managing file lists
+ *
+ * @author Nick Sinopoli <NSinopoli@gmail.com>
+ */
 class FileList extends \app\core\Controller
 {
-
-    // GET
+
+    /**
+     * Index
+     *
+     * @param string $request
+     *            The request to process
+     * @return array
+     */
     public function index($request)
     {
-        if (!$request->is('ajax')) {
+        if (! $request->is('ajax')) {
             return $this->redirect('/');
         }
-
+        
         $dir = realpath(urldecode($request->query['dir']));
-        if (!$dir) {
+        if (! $dir) {
             return array();
         }
-
+        
         $test_directories = \app\lib\Library::retrieve('test_directories');
         $valid_dir = false;
         $group_name = '';
@@ -28,28 +52,26 @@ public function index($request)
             }
         }
 
-        //echo 'here';
-
-        if (!$valid_dir) {
+        // echo 'here';
+        
+        if (! $valid_dir) {
             return array();
         }
-
+        
         $dir .= '/';
         $files = scandir($dir);
         // Don't return anything if 'files' are '.' or '..'
         if (count($files) < 3) {
             return array();
         }
-
+        
         $ignore_hidden = \app\lib\Library::retrieve('ignore_hidden_folders');
-
+        
         $final_dirs = array();
         $final_files = array();
         foreach ($files as $file) {
-            $is_hidden = ( strpos($file, '.') === 0 );
-            if ($file != '.' && $file != '..'
-                && (!$is_hidden || !$ignore_hidden)
-            ) {
+            $is_hidden = (strpos($file, '.') === 0);
+            if ($file != '.' && $file != '..' && (! $is_hidden || ! $ignore_hidden)) {
                 $path = $dir . $file;
                 $ext = strtolower(pathinfo($path, PATHINFO_EXTENSION));
                 if (is_dir($path)) {
@@ -60,14 +82,17 @@ public function index($request)
                     );
                 } elseif (is_file($path) && $ext == 'php') {
                     $final_files[] = array(
-                        'type'      => 'file',
-                        'name'      => $file,
-                        'path'      => $path
+                        'type' => 'file',
+                        'name' => $file,
+                        'path' => $path
                     );
                 }
             }
         }
-
-        return array('name' => $group_name, 'results' => array_merge($final_dirs, $final_files));
+
+        return array(
+            'name' => $group_name,
+            'results' => array_merge($final_dirs, $final_files)
+        );
     }
 }