Fixes #23

README.md

@@ -76,6 +76,10 @@ Classes must be no more than 200 lines.
 ### Codor.Files.FunctionNameContainsAndOr ###
 Functions/methods cannot contain "And" or "Or". This could be a sign of a function that does more than one thing.
 
+### Codor.Files.IndentationLevel ###
+Functions/methods cannot have more than 1 level of indentation.
+
+
 ## Customizing Sniffs ##
 Some of the sniff rules can be customized to your liking. For example, if you'd want the `Codor.Files.FunctionLength` to make sure your functions are no more than 30 lines instead of 20, you can do that. Here's an example of a `codor.xml` file with that customization:
 ```
@@ -94,11 +98,13 @@ Some of the sniff rules can be customized to your liking. For example, if you'd
 
 ### Customizations Available
 * `Codor.Files.FunctionLength`
- * `maxLength`: The maximum number of lines a function/method can be.
+ * `maxLength`: The maximum number of lines a function/method can be (default = 200).
 * `Codor.Files.FunctionParameter`
- * `maxParameters`: The maximum number of parameters a function/method can have.
+ * `maxParameters`: The maximum number of parameters a function/method can have (default = 3).
 * `Codor.Classes.ClassLength`
- * `maxLength`: The maximum number of lines a Class can be.
+ * `maxLength`: The maximum number of lines a Class can be (default = 20).
+* `Codor.Files.IndentationLevel`
+ * `indentationLimit`: Cannot have more than or equal to this number of indentations (default = 2).
 
 ## Contributing ##
 Please see [CONTRIBUTING.md](CONTRIBUTING.md)

src/Codor/Sniffs/Files/FunctionNameContainsAndOrSniff.php

@@ -52,13 +52,12 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
      */
     protected function containsKeywords($string)
     {
+        $contains = false;
         foreach ($this->keywords as $keyword) {
-            if ($this->contains($keyword, $string)) {
-                return true;
-            }
+            $this->contains($keyword, $string) ? $contains = true : null;
         }
 
-        return false;
+        return $contains;
     }
 
     /**

src/Codor/Sniffs/Files/FunctionParameterSniff.php

@@ -40,9 +40,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
         $numberOfParameters = 0;
         for ($index=$openParenIndex+1; $index <= $closedParenIndex; $index++) {
-            if ($tokens[$index]['type'] == 'T_VARIABLE') {
-                $numberOfParameters++;
-            }
+            $tokens[$index]['type'] == 'T_VARIABLE' ? $numberOfParameters++ : null;
         }
 
         if ($numberOfParameters > $this->maxParameters) {

src/Codor/Sniffs/Files/IndentationLevelSniff.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Codor\Sniffs\Files;
+
+use PHP_CodeSniffer_Sniff;
+use PHP_CodeSniffer_File;
+
+class IndentationLevelSniff implements PHP_CodeSniffer_Sniff
+{
+    /**
+     * Indentations cannot be >= to this number.
+     * @var integer
+     */
+    public $indentationLimit = 2;
+
+    /**
+     * The highest indentation level found.
+     * @var integer
+     */
+    protected $maxIndentationFound;
+
+    /**
+     * Returns the token types that this sniff is interested in.
+     * @return array
+     */
+    public function register()
+    {
+        return [T_FUNCTION, T_CLOSURE, T_SWITCH];
+    }
+
+    /**
+     * Processes the tokens that this sniff is interested in.
+     *
+     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
+     * @param integer              $stackPtr  The position in the stack where
+     *                                    the token was found.
+     * @return void
+     */
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $token = $tokens[$stackPtr];
+        $this->maxIndentationFound = 0;
+
+        // Ignore functions with no body
+        if (isset($token['scope_opener']) === false) {
+            return;
+        }
+
+        $this->inspectScope($token, $tokens);
+
+        if ($this->maxIndentationFound <= $this->indentationLimit) {
+            return;
+        }
+
+        $phpcsFile->addError($this->getErrorMessage(), $stackPtr);
+    }
+
+    /**
+     * Inspect the tokens in the scope of the provided $token.
+     * @codingStandardsIgnoreStart
+     * @param  array $token  Token Data.
+     * @param  array $tokens Tokens.
+     * @return void
+     */
+    protected function inspectScope(array $token, array $tokens)
+    {
+        $start = $token['scope_opener'];
+        $end = $token['scope_closer'];
+        $this->relativeScopeLevel = $tokens[$start]['level'];
+        for ($index=$start; $index <= $end; $index++) {
+            $nestedToken = $tokens[$index];
+            if ($nestedToken['type'] === "T_SWITCH") {
+                return;
+            }
+            $this->adjustMaxIndentationFound($nestedToken);
+        }
+    }
+    // @codingStandardsIgnoreEnd
+
+    /**
+     * Adjust the maximum indentation level found value.
+     * @param  array $nestedToken Token data.
+     * @return void
+     */
+    protected function adjustMaxIndentationFound(array $nestedToken)
+    {
+        $tokenNestedLevel = $nestedToken['level'];
+        $nestedLevel = $tokenNestedLevel - $this->relativeScopeLevel;
+        $nestedLevel > $this->maxIndentationFound ? $this->maxIndentationFound = $nestedLevel : null;
+    }
+
+    /**
+     * Produce the error message.
+     * @return string
+     */
+    protected function getErrorMessage()
+    {
+        // Hack to fix the output numbers for the
+        // indentation levels found and the
+        // indentation limit.
+        $indentationFound = $this->maxIndentationFound - 1;
+        $indentationLimit = $this->indentationLimit - 1;
+        return "{$indentationFound} indenation levels found. " .
+        "Maximum of {$indentationLimit} indenation levels allowed.";
+    }
+}

src/Codor/Sniffs/Files/ReturnNullSniff.php

@@ -19,7 +19,7 @@ public function register()
 
     /**
      * Processes the tokens that this sniff is interested in.
-     *
+     * @codingStandardsIgnoreStart
      * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
      * @param integer              $stackPtr  The position in the stack where
      *                                    the token was found.
@@ -39,6 +39,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                 break;
             }
         }
+        // @codingStandardsIgnoreEnd
 
         if ($returnValueToken['type'] === 'T_NULL') {
             $error = "Return null value found.";

tests/Sniffs/Files/Assets/IndentationLevelSniff/ClosureWithNoCode.inc

@@ -0,0 +1,5 @@
+<?php
+
+$foo = function ()
+{
+};

tests/Sniffs/Files/Assets/IndentationLevelSniff/ClosureWithNoIndentation.inc

@@ -0,0 +1,6 @@
+<?php
+
+$foo = function ()
+{
+	$oneIndentation;
+};

tests/Sniffs/Files/Assets/IndentationLevelSniff/ClosureWithOneIndentation.inc

@@ -0,0 +1,9 @@
+<?php
+
+$foo = function ()
+{
+	$oneIndentation;
+	if (true) {
+		$twoIndentation;
+	}
+};

tests/Sniffs/Files/Assets/IndentationLevelSniff/ClosureWithTwoIndentation.inc

@@ -0,0 +1,12 @@
+<?php
+
+$foo = function ()
+{
+	$oneIndentation;
+	if (true) {
+		$twoIndentation;
+		if (true) {
+			$threeIndentation;
+		}
+	}
+};

tests/Sniffs/Files/Assets/IndentationLevelSniff/FunctionWithNoCode.inc

@@ -0,0 +1,6 @@
+<?php
+
+function foo()
+{
+
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/FunctionWithNoIndentation.inc

@@ -0,0 +1,6 @@
+<?php
+
+function foo()
+{
+	$oneIndentation;
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/FunctionWithOneIndentation.inc

@@ -0,0 +1,9 @@
+<?php
+
+function foo()
+{
+	$oneIndentation;
+	if (true) {
+		$twoIndentation;
+	}
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/FunctionWithTwoIndentation.inc

@@ -0,0 +1,12 @@
+<?php
+
+function foo()
+{
+	$oneIndentation;
+	if (true) {
+		$twoIndentation;
+		if (true) {
+			$threeIndentation;
+		}
+	}
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/InvalidClass.inc

@@ -0,0 +1,40 @@
+<?php
+
+class Foo
+{
+
+    protected $baz;
+
+    public function foo()
+    {
+        return true;
+    }
+
+    public function bar()
+    {
+        $one = 1;
+        $two = 2;
+        $three = 3;
+        return true;
+    }
+
+    public function baz()
+    {
+        if (true) {
+            return true;
+        }
+
+        return false;
+    }
+
+    public function tooMuchIndentation()
+    {
+        if (true) {
+            if (true) {
+                return "Uh oh";
+            }
+        }
+
+        return false;
+    }
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/MethodWithNoCode.inc

@@ -0,0 +1,8 @@
+<?php
+
+class foo
+{
+	public function bar()
+	{
+	}
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/MethodWithNoIndentation.inc

@@ -0,0 +1,9 @@
+<?php
+
+class foo
+{
+	public function bar()
+	{
+		$oneIndentation;
+	}
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/MethodWithOneIndentation.inc

@@ -0,0 +1,12 @@
+<?php
+
+class foo
+{
+	public function bar()
+	{
+		$oneIndentation;
+		if (true) {
+			$twoIndentation;
+		}
+	}
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/MethodWithTwoIndentation.inc

@@ -0,0 +1,15 @@
+<?php
+
+class foo
+{
+	public function bar()
+	{
+		$oneIndentation;
+		if (true) {
+			$twoIndentation;
+			if (true) {
+				$threeIndentation;
+			}
+		}
+	}
+}

tests/Sniffs/Files/Assets/IndentationLevelSniff/SwitchStatementInFunctionWithNoCode.inc

@@ -0,0 +1,8 @@
+<?php
+
+function foobar()
+{
+	switch ($condition) {
+	}
+}
+

tests/Sniffs/Files/Assets/IndentationLevelSniff/SwitchStatementInFunctionWithNoIndentation.inc

@@ -0,0 +1,9 @@
+<?php
+
+function foobar()
+{
+	switch ($condition) {
+		case true:
+	}
+}
+

tests/Sniffs/Files/Assets/IndentationLevelSniff/SwitchStatementInFunctionWithOneIndentation.inc

@@ -0,0 +1,11 @@
+<?php
+
+function foobar()
+{
+	switch ($condition) {
+		case '1':
+		    echo 'hi';
+		    break;
+	}
+}
+

tests/Sniffs/Files/Assets/IndentationLevelSniff/SwitchStatementInFunctionWithTwoIndentation.inc

@@ -0,0 +1,13 @@
+<?php
+
+function foobar()
+{
+	switch ($condition) {
+		case '1':
+		    if (true) {
+		    	$threeIndentation;
+		    }
+		    break;
+	}
+}
+