issue #7 - improve exception messages providing the current class

Author: mikaelcom

src/Element/AbstractAssignedValueElement.php

@@ -31,7 +31,7 @@ public function __construct($name, $value = null, $access = parent::ACCESS_PUBLI
     public function setValue($value)
     {
         if ($this->getAcceptNonScalarValue() === false && !is_scalar($value) && $value !== null) {
-            throw new \InvalidArgumentException(sprintf('Value of type "%s" is not a valid scalar value', gettype($value)));
+            throw new \InvalidArgumentException(sprintf('Value of type "%s" is not a valid scalar value for %s object', gettype($value), $this->getCalledClass()));
         }
         $this->value = $value;
         return $this;

src/Element/AbstractElement.php

@@ -32,7 +32,7 @@ public function __construct($name)
     public function setName($name)
     {
         if (!self::nameIsValid($name)) {
-            throw new \InvalidArgumentException(sprintf('Name "%s" is invalid, please provide a valid name', $name));
+            throw new \InvalidArgumentException(sprintf('Name "%s" is invalid when instantiating %s object', $name, $this->getCalledClass()));
         }
         $this->name = $name;
         return $this;
@@ -84,7 +84,7 @@ public function toString($indentation = null)
     {
         $lines = array(
             $this->getToStringDeclaration($indentation),
-            $this->getToStringBeforeChildren($indentation),
+            $this->getToStringBeforeChildren($indentation)
         );
         foreach ($this->getChildren() as $child) {
             $lines[] = $this->getChildContent($child, $indentation + ($this->useBracketsForChildren() ? 1 : 0));
@@ -329,4 +329,11 @@ public function getIndentedString($string, $indentation = null)
         }
         return implode(self::BREAK_LINE_CHAR, $strings);
     }
+    /**
+     * @return string
+     */
+    final public function getCalledClass()
+    {
+        return substr(get_called_class(), strrpos(get_called_class(), '\\') + 1);
+    }
 }

tests/Element/PhpAnnotationTest.php

@@ -68,4 +68,13 @@ public function testHasContent()
 
         $this->assertTrue($annotation->hasContent());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpAnnotation(0, '');
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpAnnotation object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpClassTest.php

@@ -255,4 +255,13 @@ public function testExtendsFromNamespace()
 
         $this->assertSame("class Foo extends \\DOMDocument\n{\n}", $class->toString());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpClass(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpClass object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpConstantTest.php

@@ -131,4 +131,22 @@ public function testGetChildrenTypes()
 
         $this->assertSame(array(), $constant->getChildrenTypes());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpConstant(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpConstant object', $e->getMessage());
+        }
+    }
+
+    public function testExceptionMessageOnValue()
+    {
+        try {
+            new PhpConstant('Foo', new \stdClass());
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Value of type "object" is not a valid scalar value for PhpConstant object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpFileTest.php

@@ -81,4 +81,13 @@ public function testAnnotationClassMethodBlockToString()
 
         $this->assertSame("<?php\n/**\n * date is the key\n * time is the core key\n */\nclass Foo\n{\n    public function Bar()\n    {\n    }\n}\n", $file->toString());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpFile(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpFile object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpFunctionParameterTest.php

@@ -55,4 +55,13 @@ public function testToStringWithNamespace()
 
         $this->assertSame('My\Name\Space $foo = null', $functionParameter->toString());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpFunctionParameter(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpFunctionParameter object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpFunctionTest.php

@@ -114,4 +114,13 @@ public function testToStringWithBody()
 
         $this->assertSame("function foo(\$bar, \$demo = 1, \$sample = null, \$deamon = true)\n{\n    \$bar = 1;\n    return \$bar;\n}", $function->toString());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpFunction(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpFunction object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpInterfaceTest.php

@@ -97,4 +97,13 @@ public function testSimpleIntefaceEmptyPublicMethodToString()
 
         $this->assertSame("interface Foo\n{\n    public function bar();\n}", $interface->toString());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpInterface(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpInterface object', $e->getMessage());
+        }
+    }
 }

tests/Element/PhpMethodTest.php

@@ -186,4 +186,13 @@ public function testPublicWithBodyToString()
 
         $this->assertSame("public function foo(\$bar, \$demo = 1, \$sample = null, \$deamon = true)\n{\n    \$bar = 1;\n    return \$bar;\n}", $method->toString());
     }
+
+    public function testExceptionMessageOnName()
+    {
+        try {
+            new PhpMethod(0);
+        } catch (\InvalidArgumentException $e) {
+            $this->assertSame('Name "0" is invalid when instantiating PhpMethod object', $e->getMessage());
+        }
+    }
 }