Merge pull request #35 from Zenify/method-getter-docblock

FunctionComment sniff enabled [closes #30]

src/ZenifyCodingStandard/ruleset.xml

@@ -15,6 +15,7 @@
 	<rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
 
 	<!-- Commenting -->
+	<rule ref="Squiz.Commenting.FunctionComment"/>
 	<rule ref="Squiz.Commenting.VariableComment"/>
 
 	<!-- ControlStructures -->

tests/CodeSnifferRunner.php

@@ -53,9 +53,9 @@ public function getErrorCountInFile($source)
 	 * @param string $name
 	 * @return string
 	 */
-	public function detectRulesetFromSniffName($sniff)
+	public function detectRulesetFromSniffName($name)
 	{
-		$standard = $this->detectStandardFromSniffName($sniff);
+		$standard = $this->detectStandardFromSniffName($name);
 
 		if (isset($this->standardRulesets[$standard])) {
 			return $this->standardRulesets[$standard];

tests/Squiz/Commenting/FunctionComment/FunctionCommentSniffTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Zenify\CodingStandard\Tests\Squiz\Commenting\VariableComment;
+
+use PHPUnit_Framework_TestCase;
+use Zenify\CodingStandard\Tests\CodeSnifferRunner;
+
+
+/**
+ * @covers Squiz_Sniffs_Commenting_FunctionCommentSniff
+ */
+final class FunctionCommentSniffTest extends PHPUnit_Framework_TestCase
+{
+
+	public function testDetection()
+	{
+		$codeSnifferRunner = new CodeSnifferRunner('Squiz.Commenting.FunctionComment');
+
+		$this->assertSame(1, $codeSnifferRunner->getErrorCountInFile(__DIR__ . '/wrong.php'));
+		$this->assertSame(0, $codeSnifferRunner->getErrorCountInFile(__DIR__ . '/correct.php'));
+	}
+
+}

tests/Squiz/Commenting/FunctionComment/correct.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace SomeNamespace;
+
+
+class SomeClass
+{
+
+	/**
+	 * @return string
+	 */
+	public function getSome()
+	{
+		return 'some';
+	}
+
+}

tests/Squiz/Commenting/FunctionComment/wrong.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SomeNamespace;
+
+
+class SomeClass
+{
+
+	public function getSome()
+	{
+	}
+
+}