Merge pull request #6 from moufmouf/improved_exceptions

Improved exception messages when table not found

Author: moufmouf

.gitignore

@@ -1,2 +1,3 @@
 composer.lock
 /vendor/
+/build/

.travis.yml

@@ -2,14 +2,19 @@ language: php
 
 php:
  - 5.5
+ - 5.6
+ - 7.0
+
+env:
+  matrix:
+    - PREFER_LOWEST="--prefer-lowest"
+    - PREFER_LOWEST=""
 
 before_script:
- - wget http://getcomposer.org/composer.phar
- - php composer.phar install --no-interaction
+ - composer update --prefer-source $PREFER_LOWEST
 
 script:
- - mkdir -p build/logs
- - phpunit --coverage-clover build/logs/clover.xml
+ - ./vendor/bin/phpunit
 
 after_script:
  - php vendor/bin/coveralls -v

composer.json

@@ -16,6 +16,7 @@
     "require": {
         "clue/graph": "~0.9.0",
         "doctrine/dbal": "~2.4",
+        "doctrine/cache": "^1.4.1",
         "graphp/algorithms": "~0.8.0"
     },
     "require-dev": {

phpunit.xml.dist

@@ -21,4 +21,9 @@
             <directory suffix=".php">src</directory>
         </whitelist>
     </filter>
+
+    <logging>
+        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
 </phpunit>

src/SchemaAnalyzer.php

@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\DBAL\Schema\Table;
 use Fhaculty\Graph\Edge\Base;
 use Fhaculty\Graph\Graph;
@@ -229,6 +230,9 @@ public function getShortestPath($fromTable, $toTable)
      */
     private function getShortestPathWithoutCache($fromTable, $toTable)
     {
+        $this->checkTableExists($fromTable);
+        $this->checkTableExists($toTable);
+
         $graph = $this->buildSchemaGraph();
 
         try {
@@ -278,6 +282,15 @@ private function getShortestPathWithoutCache($fromTable, $toTable)
         return $foreignKeys;
     }
 
+    private function checkTableExists($tableName)
+    {
+        try {
+            $this->getSchema()->getTable($tableName);
+        } catch (SchemaException $e) {
+            throw SchemaAnalyzerTableNotFoundException::tableNotFound($tableName, $this->schema, $e);
+        }
+    }
+
     private function buildSchemaGraph()
     {
         $graph = new Graph();

src/SchemaAnalyzerTableNotFoundException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Mouf\Database\SchemaAnalyzer;
+
+use Doctrine\DBAL\Schema\Schema;
+
+class SchemaAnalyzerTableNotFoundException extends SchemaAnalyzerException
+{
+    public static function tableNotFound($tableName, Schema $schema, \Exception $previousException = null)
+    {
+        $closestTableName = '';
+        $closestScore = INF;
+        foreach ($schema->getTables() as $testedTable) {
+            $testedTableName = $testedTable->getName();
+            $l = levenshtein($testedTableName, $tableName);
+            if ($l < $closestScore) {
+                $closestScore = $l;
+                $closestTableName = $testedTableName;
+            }
+        }
+
+        return new self("Could not find table '$tableName'. Did you mean '$closestTableName'?", 0, $previousException);
+    }
+}

tests/SchemaAnalyzerTest.php

@@ -509,4 +509,16 @@ public function testInheritanceRelationship()
         $this->assertEquals('user', $schemaAnalyzer->getChildrenRelationships('contact')[0]->getLocalTableName());
         $this->assertEquals([], $schemaAnalyzer->getChildrenRelationships('user'));
     }
+
+    /**
+     * @expectedException \Mouf\Database\SchemaAnalyzer\SchemaAnalyzerTableNotFoundException
+     * @expectedExceptionMessage Could not find table 'rights'. Did you mean 'right'?
+     */
+    public function testWringTableName()
+    {
+        $schemaManager = $this->getCompleteSchemaManager();
+
+        $schemaAnalyzer = new SchemaAnalyzer($schemaManager);
+        $junctionTables = $schemaAnalyzer->getShortestPath('role', 'rights');
+    }
 }