From c20b8fc7e1792645568bd1ea9161387b6bc121ab Mon Sep 17 00:00:00 2001
From: Bill Mitchell <wkmitch@gmail.com>
Date: Fri, 22 Sep 2017 14:02:59 -0700
Subject: [PATCH] WIP #114

---
 composer.json                                 |  2 +-
 .../Sniffs/Files/ForbiddenMethodsSniff.php    | 48 +++++++++++++++++++
 .../CallingForbiddenMethods.inc               |  5 ++
 .../CallingForbiddenMethodsStatic.inc         |  4 ++
 .../Files/ForbiddenMethodsSniffTest.php       | 46 ++++++++++++++++++
 5 files changed, 104 insertions(+), 1 deletion(-)
 create mode 100644 src/Codor/Sniffs/Files/ForbiddenMethodsSniff.php
 create mode 100644 tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethods.inc
 create mode 100644 tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethodsStatic.inc
 create mode 100644 tests/Sniffs/Files/ForbiddenMethodsSniffTest.php

diff --git a/composer.json b/composer.json
index 804d1b5..014dccc 100644
--- a/composer.json
+++ b/composer.json
@@ -35,7 +35,7 @@
         "larapack/dd": "^1.1"
     },
     "scripts": {
-        "test": [
+        "code-standards": [
             "vendor/bin/parallel-lint src tests",
             "vendor/bin/phpcs --standard=psr2 src -sp",
             "vendor/bin/phpcs --standard=phpcs.xml src tests --ignore=tests/Sniffs -sp",
diff --git a/src/Codor/Sniffs/Files/ForbiddenMethodsSniff.php b/src/Codor/Sniffs/Files/ForbiddenMethodsSniff.php
new file mode 100644
index 0000000..782f2f7
--- /dev/null
+++ b/src/Codor/Sniffs/Files/ForbiddenMethodsSniff.php
@@ -0,0 +1,48 @@
+<?php declare(strict_types = 1);
+
+namespace Codor\Sniffs\Files;
+
+use PHP_CodeSniffer_Sniff;
+use PHP_CodeSniffer_File;
+
+class ForbiddenMethodsSniff implements PHP_CodeSniffer_Sniff
+{
+    /**
+     * The methods that are forbidden.
+     * @var array
+     */
+    public $forbiddenMethods = ['raw', 'statement'];
+
+    /**
+     * Returns the token types that this sniff is interested in.
+     * @return array
+     */
+    public function register(): array
+    {
+        return [T_OBJECT_OPERATOR, T_DOUBLE_COLON];
+    }
+
+    /**
+     * 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();
+        $potentialMethodToken = $tokens[$stackPtr + 1];
+        $openParenToken = $tokens[$stackPtr + 2];
+
+        if ($openParenToken['type'] !== 'T_OPEN_PARENTHESIS') {
+            return;
+        }
+
+        $methodName = $potentialMethodToken['content'];
+        if (in_array($methodName, $this->forbiddenMethods, true)) {
+            $phpcsFile->addError("Call to method {$methodName} is forbidden.", $potentialMethodToken['line']);
+        }
+    }
+}
diff --git a/tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethods.inc b/tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethods.inc
new file mode 100644
index 0000000..a437101
--- /dev/null
+++ b/tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethods.inc
@@ -0,0 +1,5 @@
+<?php declare(strict_types = 1);
+
+
+$foo->raw();
+$foo->statement();
\ No newline at end of file
diff --git a/tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethodsStatic.inc b/tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethodsStatic.inc
new file mode 100644
index 0000000..a7bb52e
--- /dev/null
+++ b/tests/Sniffs/Files/Assets/ForbiddenMethodsSniff/CallingForbiddenMethodsStatic.inc
@@ -0,0 +1,4 @@
+<?php declare(strict_types = 1);
+
+DB::raw();
+DB::statement();
\ No newline at end of file
diff --git a/tests/Sniffs/Files/ForbiddenMethodsSniffTest.php b/tests/Sniffs/Files/ForbiddenMethodsSniffTest.php
new file mode 100644
index 0000000..eec24ba
--- /dev/null
+++ b/tests/Sniffs/Files/ForbiddenMethodsSniffTest.php
@@ -0,0 +1,46 @@
+<?php declare(strict_types = 1);
+
+namespace Codor\Tests\Sniffs\Files;
+
+use Codor\Tests\BaseTestCase;
+
+/** @group Files */
+class ForbiddenMethodsSniffTest extends BaseTestCase
+{
+    /**
+     * Sets up the test class.
+     * @return void
+     */
+    public function setup()
+    {
+        parent::setup();
+
+        $this->runner->setSniff('Codor.Files.ForbiddenMethods')->setFolder(__DIR__.'/Assets/ForbiddenMethodsSniff/');
+    }
+
+    /** @test */
+    public function it_produces_errors_for_each_forbidden_method_call_found()
+    {
+        $results = $this->runner->sniff('CallingForbiddenMethods.inc');
+        $this->assertSame(2, $results->getErrorCount());
+        $this->assertSame(0, $results->getWarningCount());
+
+        $errorMessages = $results->getAllErrorMessages();
+        $this->assertCount(2, $errorMessages);
+        $this->assertSame('Call to method raw is forbidden.', $errorMessages[0]);
+        $this->assertSame('Call to method statement is forbidden.', $errorMessages[1]);
+    }
+
+    /** @test */
+    public function it_produces_errors_for_each_forbidden_method_static_call_found()
+    {
+        $results = $this->runner->sniff('CallingForbiddenMethodsStatic.inc');
+        $this->assertSame(2, $results->getErrorCount());
+        $this->assertSame(0, $results->getWarningCount());
+
+        $errorMessages = $results->getAllErrorMessages();
+        $this->assertCount(2, $errorMessages);
+        $this->assertSame('Call to method raw is forbidden.', $errorMessages[0]);
+        $this->assertSame('Call to method statement is forbidden.', $errorMessages[1]);
+    }
+}