Changeset 124

Timestamp:

03/02/08 20:30:30 (10 months ago)

Author:

iteman

Message:

- Added missing method descriptions.
- Removed some unused comments.

Files:

• trunk/src/Stagehand/TestRunner/AlterationMonitor.php (modified) (7 diffs)

trunk/src/Stagehand/TestRunner/AlterationMonitor.php

@@ -42 +42 @@
 
 /**
+ * The file and directory alteration monitor.
+ *
  * @package    Stagehand_TestRunner
  * @copyright  2008 KUBO Atsuhiro <iteman@users.sourceforge.net>
@@ -93 +95 @@
 
     /**
+     * Sets a directory and command string to the properties.
+     *
      * @param string $directory
      * @param string $command
@@ -106 +110 @@
 
     /**
+     * Watches for changes in the directory and runs tests in the directory
+     * recursively when changes are detected.
      */
     public function monitor()
@@ -115 +121 @@
             $this->_waitForChanges();
 
-            print "Any changes are detected! Running tests ...\n";
+            print "Any changes are detected! Running tests ...\n\n";
             $this->_runTests();
         }
@@ -136 +142 @@
 
     /**
-     * @throws Stagehand_TestRunner_Exception
+     * Runs tests in the directory recursively.
      */
     private function _runTests()
     {
-/*         passthru($this->_command, $result); */
         passthru($this->_command, $result);
-/*         if ($result !== 0) { */
-/*             throw new Stagehand_TestRunner_Exception(); */
-/*         } */
-    }
-
-    // }}}
-    // {{{ _collectElements()
-
-    /**
-     */
-    private function _collectElements($directory)
-    {
-        $files = scandir($directory);
-        for ($i = 0, $count = count($files); $i < $count; ++$i) {
-            if ($files[$i] == '.' || $files[$i] == '..') {
-                continue;
-            }
-
-            foreach ($this->_excludePatterns as $excludePattern) {
-                if (preg_match($excludePattern, $files[$i])) {
-                    continue 2;
-                }
-            }
-
-            $element = $directory . DIRECTORY_SEPARATOR . $files[$i];
-            if (!$this->_isFirstTime) {
-                if (!array_key_exists($element, $this->_previousElements)) {
-                    throw new Stagehand_TestRunner_Exception();
-                }
-
-                if (!is_dir($element)) {
-                    $mtime = filemtime($element);
-                    if ($this->_previousElements[$element]['mtime'] != $mtime) {
-                        throw new Stagehand_TestRunner_Exception();
-                    }
-                }
-
-                $perms = fileperms($element);
-                if ($this->_previousElements[$element]['perms'] != $perms) {
-                    throw new Stagehand_TestRunner_Exception();
-                }
-            }
-
-            if (!is_dir($element)) {
-                $this->_currentElements[$element]['mtime'] = filemtime($element);
-            }
-
-            $this->_currentElements[$element]['perms'] = fileperms($element);
-
-            if (is_dir($element)) {
-                $this->_collectElements($element);
-            }
-        }
     }
 
@@ -201 +153 @@
 
     /**
+     * Watches for changes in the directory and returns immediately when
+     * changes are detected.
      */
     private function _waitForChanges()
@@ -229 +183 @@
             $this->_previousElements = $this->_currentElements;
             $this->_isFirstTime = false;
+        }
+    }
+
+    // }}}
+    // {{{ _collectElements()
+
+    /**
+     * Collects all files and directories in the directory and detects any
+     * changes of a file or directory immediately.
+     *
+     * @param string $directory
+     * @throws Stagehand_TestRunner_Exception
+     */
+    private function _collectElements($directory)
+    {
+        $files = scandir($directory);
+        for ($i = 0, $count = count($files); $i < $count; ++$i) {
+            if ($files[$i] == '.' || $files[$i] == '..') {
+                continue;
+            }
+
+            foreach ($this->_excludePatterns as $excludePattern) {
+                if (preg_match($excludePattern, $files[$i])) {
+                    continue 2;
+                }
+            }
+
+            $element = $directory . DIRECTORY_SEPARATOR . $files[$i];
+            if (!$this->_isFirstTime) {
+                if (!array_key_exists($element, $this->_previousElements)) {
+                    throw new Stagehand_TestRunner_Exception();
+                }
+
+                if (!is_dir($element)) {
+                    $mtime = filemtime($element);
+                    if ($this->_previousElements[$element]['mtime'] != $mtime) {
+                        throw new Stagehand_TestRunner_Exception();
+                    }
+                }
+
+                $perms = fileperms($element);
+                if ($this->_previousElements[$element]['perms'] != $perms) {
+                    throw new Stagehand_TestRunner_Exception();
+                }
+            }
+
+            if (!is_dir($element)) {
+                $this->_currentElements[$element]['mtime'] = filemtime($element);
+            }
+
+            $this->_currentElements[$element]['perms'] = fileperms($element);
+
+            if (is_dir($element)) {
+                $this->_collectElements($element);
+            }
         }
     }