Merge pull request #477 from sleekbyte/at-460-ignoring-backticks

#460: Ignore enclosing backticks from identifier analysis.

Author: adityatrivedi

src/main/java/com/sleekbyte/tailor/listeners/ConstantNamingListener.java

@@ -30,9 +30,9 @@ public void enterTopLevel(TopLevelContext topLevelContext) {
 
         names.forEach(
             ctx -> {
-                String constantName = ctx.getText();
+                String constantName = CharFormatUtil.unescapeIdentifier(ctx.getText());
                 ParserRuleContext constantDecContext = ConstantDecHelper.getConstantDeclaration(ctx);
-                Location location = ListenerUtil.getContextStartLocation(ctx);
+                Location location = ListenerUtil.getIdentifierStartLocation(ctx);
 
                 if (ConstantDecHelper.isGlobal(constantDecContext)
                     || ConstantDecHelper.insideClass(constantDecContext)

src/main/java/com/sleekbyte/tailor/listeners/KPrefixListener.java

@@ -28,8 +28,8 @@ public void enterTopLevel(TopLevelContext topLevelCtx) {
         List<IdentifierContext> names = DeclarationListener.getConstantNames(topLevelCtx);
         names.forEach(
             ctx -> {
-                String constantName = ctx.getText();
-                Location location = ListenerUtil.getContextStartLocation(ctx);
+                String constantName = CharFormatUtil.unescapeIdentifier(ctx.getText());
+                Location location = ListenerUtil.getIdentifierStartLocation(ctx);
                 if (CharFormatUtil.isKPrefixed(constantName)) {
                     printer.warn(Rules.CONSTANT_K_PREFIX, Messages.CONSTANT + Messages.NAME + Messages.K_PREFIXED,
                         location);

src/main/java/com/sleekbyte/tailor/listeners/LowerCamelCaseListener.java

@@ -49,9 +49,9 @@ public void enterUnionStyleEnumCase(SwiftParser.UnionStyleEnumCaseContext ctx) {
     }
 
     private void verifyLowerCamelCase(String constructType, ParserRuleContext ctx) {
-        String constructName = ctx.getText();
+        String constructName = CharFormatUtil.unescapeIdentifier(ctx.getText());
         if (!CharFormatUtil.isLowerCamelCaseOrAcronym(constructName)) {
-            Location location = ListenerUtil.getContextStartLocation(ctx);
+            Location location = ListenerUtil.getIdentifierStartLocation(ctx);
             this.printer.error(Rules.LOWER_CAMEL_CASE, constructType + Messages.LOWER_CAMEL_CASE, location);
         }
     }

src/main/java/com/sleekbyte/tailor/utils/CharFormatUtil.java

@@ -24,6 +24,25 @@ public static boolean isLowerCamelCaseOrAcronym(String word) {
         return startsWithAcronym(word) || isLowerCamelCase(word);
     }
 
+    public static boolean isEnclosedInBackticks(String identifier) {
+        int length = identifier.length();
+        return length >= 2 && identifier.charAt(0) == '`' && identifier.charAt(length - 1) == '`';
+    }
+
+    /**
+     * Will strip leading and trailing ` character in given string if both present.
+     *
+     * @param identifier value to sanitize
+     * @return sanitized string
+     */
+    public static String unescapeIdentifier(String identifier) {
+        int length = identifier.length();
+        if (isEnclosedInBackticks(identifier)) {
+            return identifier.substring(1, length - 1);
+        }
+        return identifier;
+    }
+
     /**
      * Checks if a name is prefixed with a 'k' or 'K'.
      *

src/main/java/com/sleekbyte/tailor/utils/ListenerUtil.java

@@ -32,6 +32,20 @@ public static Location getContextStopLocation(ParserRuleContext ctx) {
         return new Location(ctx.getStop().getLine(), ctx.getStop().getCharPositionInLine() + 1);
     }
 
+    /**
+     * Gets the start location of the context string.
+     * @param ctx the context
+     * @return the start location of the provided context's string
+     */
+    public static Location getIdentifierStartLocation(ParserRuleContext ctx) {
+        Location location = getContextStartLocation(ctx);
+        // Ensure that the violation column number reports the character after the opening backtick.
+        if (CharFormatUtil.isEnclosedInBackticks(ctx.getText())) {
+            location.column += 1;
+        }
+        return location;
+    }
+
     public static Location getLocationOfChildToken(ParserRuleContext ctx, int childNumber) {
         Token token = ((TerminalNodeImpl) ctx.getChild(childNumber)).getSymbol();
         return ListenerUtil.getTokenLocation(token);

src/main/java/com/sleekbyte/tailor/utils/Pair.java

@@ -4,8 +4,8 @@
  * Couples together a pair of values, which may be of different types (L and R).
  * The individual values can be accessed via its public getter functions getFirst() and getSecond().
  *
- * @param <L> Type of member first.
- * @param <R> Type of member second.
+ * @param <L> Type of member first
+ * @param <R> Type of member second
  */
 public final class Pair<L, R> {
     private final L first;

src/test/java/com/sleekbyte/tailor/functional/ConstantNamingTest.java

@@ -62,6 +62,7 @@ protected void addAllExpectedMsgs() {
             + Messages.K_PREFIXED);
         addExpectedMsg(Rules.CONSTANT_K_PREFIX, 134, 20, Severity.WARNING, Messages.CONSTANT + Messages.NAME
             + Messages.K_PREFIXED);
+        addExpectedMsg(Rules.CONSTANT_NAMING, 152, 14, Severity.WARNING, Messages.CONSTANT + Messages.LOWER_CAMEL_CASE);
     }
 
     @Override

src/test/java/com/sleekbyte/tailor/functional/LowerCamelCaseTest.java

@@ -44,6 +44,7 @@ protected void addAllExpectedMsgs() {
         addExpectedMsg(176, 10, Severity.WARNING, Messages.ENUM_CASE + Messages.NAMES + Messages.LOWER_CAMEL_CASE);
         addExpectedMsg(177, 10, Severity.WARNING, Messages.ENUM_CASE + Messages.NAMES + Messages.LOWER_CAMEL_CASE);
         addExpectedMsg(190, 10, Severity.WARNING, Messages.ENUM_CASE + Messages.NAMES + Messages.LOWER_CAMEL_CASE);
+        addExpectedMsg(200, 10, Severity.WARNING, Messages.VARIABLE + Messages.NAMES + Messages.LOWER_CAMEL_CASE);
     }
 
     private void addExpectedMsg(int line, int column, Severity severity, String msg) {

src/test/java/com/sleekbyte/tailor/utils/CharFormatUtilTest.java

@@ -1,5 +1,6 @@
 package com.sleekbyte.tailor.utils;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
@@ -88,4 +89,17 @@ public void testStartsWithAcronym() {
         assertFalse(CharFormatUtil.startsWithAcronym("xURLS"));
         assertFalse(CharFormatUtil.startsWithAcronym("shieldPROGRAMMEmarvel"));
     }
+
+    @Test
+    public void testBacktickEscapedIdentifier() {
+        // Backtick(s) are not part of the identifier
+        assertTrue(CharFormatUtil.unescapeIdentifier("``").isEmpty());
+        assertTrue(CharFormatUtil.unescapeIdentifier("").isEmpty());
+        assertEquals("self", CharFormatUtil.unescapeIdentifier("`self`"));
+        assertEquals("s",CharFormatUtil.unescapeIdentifier("`s`"));
+        assertEquals("self",CharFormatUtil.unescapeIdentifier("`self`"));
+        assertEquals("`self", CharFormatUtil.unescapeIdentifier("`self"));
+        assertEquals("self`", CharFormatUtil.unescapeIdentifier("self`"));
+        assertEquals("`self", CharFormatUtil.unescapeIdentifier("``self`"));
+    }
 }

src/test/swift/com/sleekbyte/tailor/functional/ConstantNamingTest.swift

@@ -145,4 +145,10 @@ private struct Scaling {
     init?(URL url: NSURL, statusCode statusCode: Int, HTTPVersion HTTPVersion: String?, headerFields headerFields: [String: String]?) {
     }
 
+    let `open` = true
+    var `close` = false
+
+    func demo() {
+        let `Open` = true
+    }
 }

src/test/swift/com/sleekbyte/tailor/functional/LowerCamelCaseTest.swift

@@ -195,3 +195,16 @@ enum SomeEnum: Int {
         }
     }
 }
+
+func demo() {
+    var `Open` = true
+    var `close` = false
+    let `open` = true
+}
+
+func `func`() {
+}
+
+enum Test {
+    case `case`, `class`, notReserved
+}