Fixed diagonal tile bug, finished tests, updated README, added LICENSE

Author: mwatson

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike Watson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -3,4 +3,60 @@ BoggleSolver
 
 This is a PHP class that solves Boggle. I made it for fun.
 
-Check out the examples for how to use it.
+## Installing
+
+If you use composer:
+
+```json
+{
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/mwatson/BoggleSolver.git"
+        }
+    ],
+    "require": {
+        "mwatson/BoggleSolver": "0.3.0"
+    }
+}
+```
+
+## Usage
+
+```php
+$boggle = new \BoggleSolver\BoggleSolver();
+
+try {
+    $boggle->loadBoard(
+        "A M T O".
+        "L N S T".
+        "L X T G".
+        "E T A N";
+    );
+} catch (\BoggleSolver\BoggleException $e) {
+    die("exiting on error: " . $e->getMessage());
+}
+
+// retrieve the list of words
+$words = $boggle->findWords();
+````
+
+See the files in the `examples` directory for more info.
+
+## Tests
+
+If you have composer and make installed, you can run the following:
+
+```
+composer install
+make tests
+```
+
+The `make coverage` command will also build coverage maps in HTML. `make clean` 
+will delete the coverage directory.
+
+## License
+
+© Mike Watson
+
+Released under the [MIT license](http://opensource.org/licenses/MIT). See the `LICENSE` file.

src/BoggleSolver.php

@@ -28,7 +28,7 @@ public function __construct()
 
     public function getWords()
     {
-        return explode("\r\n", static::getDictFileContents());
+        return explode("\r\n", $this->getDictFileContents());
     }
 
     public function loadDict()
@@ -195,8 +195,6 @@ public function findWords()
             } else if ($ptr->s !== null) {
                 $ptr = &$ptr->s;
                 $dir = $dir == "e" ? "w" : "e";
-            } else {
-                break;
             }
         }
 
@@ -205,12 +203,8 @@ public function findWords()
         return array_keys($words);
     }
 
-    public function findWordsFromOneTile($boardPtr = null, $dictPtr = null, $words = array())
+    public function findWordsFromOneTile($boardPtr, $dictPtr = null, $words = array())
     {
-        if ($boardPtr === null) {
-            $boardPtr = &$this->board[0];
-        }
-
         if ($dictPtr === null) {
             $dictPtr = &$this->dict;
         }
@@ -240,8 +234,8 @@ public function findWordsFromOneTile($boardPtr = null, $dictPtr = null, $words =
             if (strlen($dir) == 2) {
                 $d1 = $dir[0];
                 $d2 = $dir[1];
-                if ($boardPtr->$d1->pathTo == $boardPtr->$d2->id && 
-                    $boardPtr->$d2->pathTo == $boardPtr->$d2->id
+                if ($boardPtr->$d1->pathTo == $boardPtr->$d2->id || 
+                    $boardPtr->$d2->pathTo == $boardPtr->$d1->id
                 ) {
                     continue;
                 }
@@ -264,8 +258,10 @@ public function findWordsFromOneTile($boardPtr = null, $dictPtr = null, $words =
         return $words;
     }
 
-    public static function getDictFileContents()
+    // @codeCoverageIgnoreStart
+    public function getDictFileContents()
     {
         return file_get_contents(__DIR__ . static::$dictFile);
     }
+    // @codeCoverageIgnoreEnd
 }

tests/BoggleSolver/BoggleSolverTest.php

@@ -4,19 +4,19 @@
 
 class BoggleSolverTest extends \PHPUnit_Framework_TestCase
 {
-    public $lessWords = array(
-        "ABCD", "ABC", "ABBA", "ABABA", "ABQU", "XYZ", "ABBBBBBBBBBBBBBBB", "AB"
-    );
-
     public function testLoadDictBuildsDictionary()
     { 
         $solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
                            ->setMethods(array('getWords'))
                            ->getMock();
 
+        $lessWords = array(
+            "ABCD", "ABC", "ABBA", "ABABA", "ABQU", "XYZ", "ABBBBBBBBBBBBBBBB", "AB"
+        );
+                           
         $solverMock->expects($this->once())
                    ->method('getWords')
-                   ->will($this->returnValue($this->lessWords));
+                   ->will($this->returnValue($lessWords));
 
         $solverMock->boardLookup = array('A' => 1);
         $solverMock->size = 3;
@@ -131,21 +131,38 @@ public function testFindWords()
                            ->setMethods(array('getWords'))
                            ->getMock();
 
+        $words = array('XXX', 'ALL', 'XXXXLA');
+                           
         $solverMock->expects($this->once())
                    ->method('getWords')
-                   ->will($this->returnValue($this->lessWords));
+                   ->will($this->returnValue($words));
 
         $solverMock->boardLookup = array('A' => 1);
         $solverMock->size = 3;
 
-        $solverMock->loadBoard("ABCABDABA");
+        $solverMock->loadBoard("X X A L L X L L X");
 
         $result = $solverMock->findWords();
 
         $expected = array(
-            "ABC", "ABCD", "ABBA", "ABABA",
+            'XXX', 'ALL'
         );
 
         $this->assertEquals($expected, $result);
     }
+    
+    public function testGetWords()
+    {
+        $solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
+                           ->setMethods(array('getDictFileContents'))
+                           ->getMock();
+                           
+        $solverMock->expects($this->once())
+                   ->method('getDictFileContents')
+                   ->will($this->returnValue("XYZ\r\nABC\r\nQRS"));
+               
+        $result = $solverMock->getWords();
+        
+        $this->assertEquals(array('XYZ', 'ABC', 'QRS'), $result);
+    }
 }