Merge pull request #11 from Nimlhug/master

Add getStringProperty($name) to AbstractRule.php
phpmd · Sep 7, 2012 · b7d659f · b7d659f
2 parents 4c543a6 + 4360229
commit b7d659f
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/src/main/php/PHP/PMD/AbstractRule.php b/src/main/php/PHP/PMD/AbstractRule.php
@@ -391,6 +391,25 @@ public function getIntProperty($name)
         throw new OutOfBoundsException('Property $' . $name . ' does not exist.');
     }
 
+
+    /**
+     * Returns the raw string value of a configured property or throws an 
+     * exception when no property with <b>$name</b> exists.
+     *
+     * @param string $name The property identifier.
+     *
+     * @return string
+     * @throws OutOfBoundsException When no property for <b>$name</b> exists.
+     */
+    public function getStringProperty($name)
+    {
+        if (isset($this->_properties[$name])) {
+            return $this->_properties[$name];
+        }
+        throw new OutOfBoundsException('Property $' . $name . ' does not exist.');
+
+    }
+
     /**
      * This method adds a violation to all reports for this violation type and
      * for the given <b>$node</b> instance.

diff --git a/src/test/php/PHP/PMD/AbstractTest.php b/src/test/php/PHP/PMD/AbstractTest.php
@@ -558,6 +558,9 @@ public static function init()
 
         $autoload = new PHP_Depend_Autoload();
         $autoload->register();
+
+        // Prevent timezone warnings if no default TZ is set (PHP > 5.1.0) 
+        date_default_timezone_set('UTC');
     }
 
     /**

diff --git a/src/test/php/PHP/PMD/RuleTest.php b/src/test/php/PHP/PMD/RuleTest.php
@@ -156,4 +156,29 @@ public function testGetBooleanPropertyThrowsExceptionWhenNoPropertyForNameExists
         $rule = $this->getMockForAbstractClass('PHP_PMD_AbstractRule');
         $rule->getBooleanProperty(__FUNCTION__);
     }
+
+    /**
+     * testStringPropertyThrowsExceptionWhenNoPropertyForNameExists
+     *
+     * @return void
+     * @expectedException OutOfBoundsException
+     */
+    public function testGetStringPropertyThrowsExceptionWhenNoPropertyForNameExists()
+    {
+        $rule = $this->getMockForAbstractClass('PHP_PMD_AbstractRule');
+        $rule->getStringProperty(__FUNCTION__);
+    }
+
+    /**
+     * testGetStringPropertyReturnsStringValue
+     *
+     * @return void
+     */
+    public function testGetStringPropertyReturnsString()
+    {
+        $rule = $this->getMockForAbstractClass('PHP_PMD_AbstractRule');
+        $rule->addProperty(__FUNCTION__, 'Fourty Two');
+
+        $this->assertSame('Fourty Two', $rule->getStringProperty(__FUNCTION__));
+    }
 }