From 00efcd294fd01b4b571bc3a3e8ecb7342fa57ef7 Mon Sep 17 00:00:00 2001
From: Joshua Spence <josh@freelancer.com>
Date: Wed, 2 Dec 2015 07:41:37 +1100
Subject: [PATCH] Add a linter rule for hexadecimal number casing

Summary: Hexadecimal numbers should be written as `0xFF` and not `0xff` or `0Xff`.

Test Plan: Added test cases.

Reviewers: epriestley, #blessed_reviewers

Reviewed By: epriestley, #blessed_reviewers

Subscribers: Korvin

Differential Revision: https://secure.phabricator.com/D14612
---
 src/__phutil_library_map__.php                |  4 ++
 ...malNumericScalarCasingXHPASTLinterRule.php | 50 +++++++++++++++++++
 ...icScalarCasingXHPASTLinterRuleTestCase.php | 11 ++++
 .../hexadecimal.lint-test                     | 12 +++++
 4 files changed, 77 insertions(+)
 create mode 100644 src/lint/linter/xhpast/rules/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule.php
 create mode 100644 src/lint/linter/xhpast/rules/__tests__/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase.php
 create mode 100644 src/lint/linter/xhpast/rules/__tests__/hexadecimal-numeric-scalar-casing/hexadecimal.lint-test

diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index 218a1fa9..3c859155 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -163,6 +163,8 @@ phutil_register_library_map(array(
     'ArcanistHLintLinter' => 'lint/linter/ArcanistHLintLinter.php',
     'ArcanistHLintLinterTestCase' => 'lint/linter/__tests__/ArcanistHLintLinterTestCase.php',
     'ArcanistHelpWorkflow' => 'workflow/ArcanistHelpWorkflow.php',
+    'ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule' => 'lint/linter/xhpast/rules/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule.php',
+    'ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase' => 'lint/linter/xhpast/rules/__tests__/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase.php',
     'ArcanistHgClientChannel' => 'hgdaemon/ArcanistHgClientChannel.php',
     'ArcanistHgProxyClient' => 'hgdaemon/ArcanistHgProxyClient.php',
     'ArcanistHgProxyServer' => 'hgdaemon/ArcanistHgProxyServer.php',
@@ -561,6 +563,8 @@ phutil_register_library_map(array(
     'ArcanistHLintLinter' => 'ArcanistExternalLinter',
     'ArcanistHLintLinterTestCase' => 'ArcanistExternalLinterTestCase',
     'ArcanistHelpWorkflow' => 'ArcanistWorkflow',
+    'ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule' => 'ArcanistXHPASTLinterRule',
+    'ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase' => 'ArcanistXHPASTLinterRuleTestCase',
     'ArcanistHgClientChannel' => 'PhutilProtocolChannel',
     'ArcanistHgProxyClient' => 'Phobject',
     'ArcanistHgProxyServer' => 'Phobject',
diff --git a/src/lint/linter/xhpast/rules/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule.php b/src/lint/linter/xhpast/rules/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule.php
new file mode 100644
index 00000000..790526a4
--- /dev/null
+++ b/src/lint/linter/xhpast/rules/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule.php
@@ -0,0 +1,50 @@
+<?php
+
+final class ArcanistHexadecimalNumericScalarCasingXHPASTLinterRule
+  extends ArcanistXHPASTLinterRule {
+
+  const ID = 127;
+
+  public function getLintName() {
+    return pht('Hexadecimal Casing');
+  }
+
+  public function getLintSeverity() {
+    return ArcanistLintSeverity::SEVERITY_WARNING;
+  }
+
+  public function process(XHPASTNode $root) {
+    $hexadecimals = $this->getHexadecimalNumericScalars($root);
+
+    foreach ($hexadecimals as $hexadecimal) {
+      $value = substr($hexadecimal->getConcreteString(), 2);
+
+      if (!preg_match('/^0x[0-9A-F]+$/', $hexadecimal->getConcreteString())) {
+        $this->raiseLintAtNode(
+          $hexadecimal,
+          pht(
+            'For consistency, write hexadecimals in uppercase '.
+            'with a leading `%s`.',
+            '0x'),
+          '0x'.strtoupper($value));
+      }
+    }
+  }
+
+  private function getHexadecimalNumericScalars(XHPASTNode $root) {
+    $numeric_scalars = $root->selectDescendantsOfType('n_NUMERIC_SCALAR');
+    $hexadecimal_numeric_scalars = array();
+
+    foreach ($numeric_scalars as $numeric_scalar) {
+      $number = $numeric_scalar->getConcreteString();
+
+      if (preg_match('/^0x[0-9A-F]+$/i', $number)) {
+        $hexadecimal_numeric_scalars[] = $numeric_scalar;
+      }
+    }
+
+    return $hexadecimal_numeric_scalars;
+
+  }
+
+}
diff --git a/src/lint/linter/xhpast/rules/__tests__/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase.php b/src/lint/linter/xhpast/rules/__tests__/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase.php
new file mode 100644
index 00000000..f73d2b02
--- /dev/null
+++ b/src/lint/linter/xhpast/rules/__tests__/ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase.php
@@ -0,0 +1,11 @@
+<?php
+
+final class ArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCase
+  extends ArcanistXHPASTLinterRuleTestCase {
+
+  public function testLinter() {
+    $this->executeTestsInDirectory(
+      dirname(__FILE__).'/hexadecimal-numeric-scalar-casing/');
+  }
+
+}
diff --git a/src/lint/linter/xhpast/rules/__tests__/hexadecimal-numeric-scalar-casing/hexadecimal.lint-test b/src/lint/linter/xhpast/rules/__tests__/hexadecimal-numeric-scalar-casing/hexadecimal.lint-test
new file mode 100644
index 00000000..aae5eec7
--- /dev/null
+++ b/src/lint/linter/xhpast/rules/__tests__/hexadecimal-numeric-scalar-casing/hexadecimal.lint-test
@@ -0,0 +1,12 @@
+<?php
+0xFF;
+0xff;
+0XFF;
+~~~~~~~~~~
+warning:3:1
+warning:4:1
+~~~~~~~~~~
+<?php
+0xFF;
+0xFF;
+0xFF;