Bump SonarQube minimum version to 4.5.2 LTS and refactor for deprecation

Author: mjdetullio

pom.xml

@@ -95,7 +95,7 @@
     <properties>
         <license.owner>${project.organization.name}</license.owner>
         <license.mailto>${project.organization.url}</license.mailto>
-        <sonar.version>4.3</sonar.version>
+        <sonar.version>4.5.2</sonar.version>
         <sslr.version>1.20</sslr.version>
         <orchestrator.version>3.10.1</orchestrator.version>
     </properties>

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/ObjectiveCAstScanner.java

@@ -19,9 +19,11 @@
  */
 package org.sonar.objectivec;
 
+import com.sonar.sslr.api.Grammar;
 import com.sonar.sslr.impl.Parser;
-import org.sonar.objectivec.api.ObjectiveCGrammar;
 import org.sonar.objectivec.api.ObjectiveCMetric;
+import org.sonar.objectivec.highlighter.SonarComponents;
+import org.sonar.objectivec.highlighter.SyntaxHighlighterVisitor;
 import org.sonar.objectivec.parser.ObjectiveCParser;
 import org.sonar.squidbridge.AstScanner;
 import org.sonar.squidbridge.CommentAnalyser;
@@ -35,22 +37,25 @@
 import org.sonar.squidbridge.metrics.LinesOfCodeVisitor;
 import org.sonar.squidbridge.metrics.LinesVisitor;
 
+import javax.annotation.Nullable;
 import java.io.File;
 import java.util.Collection;
 
 public class ObjectiveCAstScanner {
 
     private ObjectiveCAstScanner() {
+        // prevents outside instantiation
     }
 
     /**
      * Helper method for testing checks without having to deploy them on a Sonar instance.
      */
-    public static SourceFile scanSingleFile(File file, SquidAstVisitor<ObjectiveCGrammar>... visitors) {
+    @SafeVarargs
+    public static SourceFile scanSingleFile(File file, SquidAstVisitor<Grammar>... visitors) {
         if (!file.isFile()) {
             throw new IllegalArgumentException("File '" + file + "' not found.");
         }
-        AstScanner<ObjectiveCGrammar> scanner = create(new ObjectiveCConfiguration(), visitors);
+        AstScanner<Grammar> scanner = create(new ObjectiveCConfiguration(), null, visitors);
         scanner.scanFile(file);
         Collection<SourceCode> sources = scanner.getIndex().search(new QueryByType(SourceFile.class));
         if (sources.size() != 1) {
@@ -59,12 +64,13 @@ public static SourceFile scanSingleFile(File file, SquidAstVisitor<ObjectiveCGra
         return (SourceFile) sources.iterator().next();
     }
 
-    public static AstScanner<ObjectiveCGrammar> create(ObjectiveCConfiguration conf,
-            SquidAstVisitor<ObjectiveCGrammar>... visitors) {
-        final SquidAstVisitorContextImpl<ObjectiveCGrammar> context = new SquidAstVisitorContextImpl<ObjectiveCGrammar>(new SourceProject("Objective-C Project"));
-        final Parser<ObjectiveCGrammar> parser = ObjectiveCParser.create(conf);
+    @SafeVarargs
+    public static AstScanner<Grammar> create(ObjectiveCConfiguration conf,
+            @Nullable SonarComponents sonarComponents, SquidAstVisitor<Grammar>... visitors) {
+        final SquidAstVisitorContextImpl<Grammar> context = new SquidAstVisitorContextImpl<>(new SourceProject("Objective-C Project"));
+        final Parser<Grammar> parser = ObjectiveCParser.create(conf);
 
-        AstScanner.Builder<ObjectiveCGrammar> builder = AstScanner.<ObjectiveCGrammar>builder(context).setBaseParser(parser);
+        AstScanner.Builder<Grammar> builder = AstScanner.builder(context).setBaseParser(parser);
 
         /* Metrics */
         builder.withMetrics(ObjectiveCMetric.values());
@@ -92,13 +98,23 @@ public String getContents(String comment) {
         builder.setFilesMetric(ObjectiveCMetric.FILES);
 
         /* Metrics */
-        builder.withSquidAstVisitor(new LinesVisitor<ObjectiveCGrammar>(ObjectiveCMetric.LINES));
-        builder.withSquidAstVisitor(new LinesOfCodeVisitor<ObjectiveCGrammar>(ObjectiveCMetric.LINES_OF_CODE));
-        builder.withSquidAstVisitor(CommentsVisitor.<ObjectiveCGrammar>builder().withCommentMetric(ObjectiveCMetric.COMMENT_LINES)
+        builder.withSquidAstVisitor(new LinesVisitor<>(ObjectiveCMetric.LINES));
+        builder.withSquidAstVisitor(new LinesOfCodeVisitor<>(ObjectiveCMetric.LINES_OF_CODE));
+        builder.withSquidAstVisitor(CommentsVisitor.builder().withCommentMetric(ObjectiveCMetric.COMMENT_LINES)
                 .withNoSonar(true)
                 .withIgnoreHeaderComment(conf.getIgnoreHeaderComments())
                 .build());
 
+        /* Syntax highlighter */
+        if (sonarComponents != null) {
+            builder.withSquidAstVisitor(new SyntaxHighlighterVisitor(sonarComponents, conf.getCharset()));
+        }
+
+        /* External visitors */
+        for (SquidAstVisitor<Grammar> visitor : visitors) {
+            builder.withSquidAstVisitor(visitor);
+        }
+
         return builder.build();
     }
 

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/ObjectiveCConfiguration.java

@@ -28,6 +28,7 @@ public class ObjectiveCConfiguration extends SquidConfiguration {
     private boolean ignoreHeaderComments;
 
     public ObjectiveCConfiguration() {
+        // no-op
     }
 
     public ObjectiveCConfiguration(Charset charset) {

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/api/ObjectiveCGrammar.java

@@ -20,27 +20,22 @@
 package org.sonar.objectivec.api;
 
 import com.sonar.sslr.api.Grammar;
-import com.sonar.sslr.api.Rule;
+import org.sonar.sslr.grammar.GrammarRuleKey;
+import org.sonar.sslr.grammar.LexerfulGrammarBuilder;
 
-public class ObjectiveCGrammar extends Grammar {
+import static com.sonar.sslr.api.GenericTokenType.EOF;
 
-    public Rule identifierName;
+public enum ObjectiveCGrammar implements GrammarRuleKey {
 
-    // A.1 Lexical
+    COMPILATION_UNIT;
 
-    public Rule literal;
-    public Rule nullLiteral;
-    public Rule booleanLiteral;
-    public Rule stringLiteral;
+    public static Grammar create() {
+        LexerfulGrammarBuilder b = LexerfulGrammarBuilder.create();
 
-    public Rule program;
+        b.rule(COMPILATION_UNIT).is(b.zeroOrMore(b.nextNot(EOF), b.anyToken()), EOF);
+        b.setRootRule(COMPILATION_UNIT);
 
-    public Rule sourceElements;
-    public Rule sourceElement;
-
-    @Override
-    public Rule getRootRule() {
-        return program;
+        return b.buildWithMemoizationOfMatchesForAllRules();
     }
 
 }

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/api/ObjectiveCKeyword.java

@@ -154,14 +154,17 @@ public enum ObjectiveCKeyword implements TokenType {
         this.value = value;
     }
 
+    @Override
     public String getName() {
         return name();
     }
 
+    @Override
     public String getValue() {
         return value;
     }
 
+    @Override
     public boolean hasToBeSkippedFromAst(AstNode node) {
         return false;
     }

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/api/ObjectiveCMetric.java

@@ -30,22 +30,27 @@ public enum ObjectiveCMetric implements MetricDef {
     COMPLEXITY,
     FUNCTIONS;
 
+    @Override
     public String getName() {
         return name();
     }
 
+    @Override
     public boolean isCalculatedMetric() {
         return false;
     }
 
+    @Override
     public boolean aggregateIfThereIsAlreadyAValue() {
         return true;
     }
 
+    @Override
     public boolean isThereAggregationFormula() {
         return true;
     }
 
+    @Override
     public CalculatedMetricFormula getCalculatedMetricFormula() {
         return null;
     }

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/api/ObjectiveCPunctuator.java

@@ -93,18 +93,21 @@ public enum ObjectiveCPunctuator implements TokenType {
 
     private final String value;
 
-    private ObjectiveCPunctuator(String word) {
+    /*private*/ ObjectiveCPunctuator(String word) {
         this.value = word;
     }
 
+    @Override
     public String getName() {
         return name();
     }
 
+    @Override
     public String getValue() {
         return value;
     }
 
+    @Override
     public boolean hasToBeSkippedFromAst(AstNode node) {
         return false;
     }

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/api/ObjectiveCTokenType.java

@@ -26,14 +26,17 @@ public enum ObjectiveCTokenType implements TokenType {
 
     NUMERIC_LITERAL;
 
+    @Override
     public String getName() {
         return name();
     }
 
+    @Override
     public String getValue() {
         return name();
     }
 
+    @Override
     public boolean hasToBeSkippedFromAst(AstNode node) {
         return false;
     }

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/checks/CheckList.java

@@ -27,13 +27,13 @@ public final class CheckList {
 
     public static final String REPOSITORY_KEY = "objectivec";
 
-    public static final String SONAR_WAY_PROFILE = "Sonar way";
+    public static final String SONAR_WAY_PROFILE = "SonarQube way";
 
     private CheckList() {
     }
 
     public static List<Class> getChecks() {
-        return ImmutableList.<Class>of(
+        return ImmutableList.of(
                 // Add checks here
         );
     }

sonar-objective-c-plugin/src/main/java/org/sonar/objectivec/highlighter/SonarComponents.java

@@ -0,0 +1,49 @@
+/*
+ * SonarQube Objective-C (Community) Plugin
+ * Copyright (C) 2012-2016 OCTO Technology, Backelite, and contributors
+ * mailto:[email protected]
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.objectivec.highlighter;
+
+import org.sonar.api.BatchExtension;
+import org.sonar.api.batch.fs.FileSystem;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.component.ResourcePerspectives;
+import org.sonar.api.source.Highlightable;
+
+import javax.annotation.CheckForNull;
+import java.io.File;
+
+public class SonarComponents implements BatchExtension {
+
+    private final ResourcePerspectives resourcePerspectives;
+    private final FileSystem fs;
+
+    public SonarComponents(ResourcePerspectives resourcePerspectives, FileSystem fs) {
+        this.resourcePerspectives = resourcePerspectives;
+        this.fs = fs;
+    }
+
+    @CheckForNull
+    public InputFile inputFileFor(File file) {
+        return fs.inputFile(fs.predicates().hasAbsolutePath(file.getAbsolutePath()));
+    }
+
+    public Highlightable highlightableFor(InputFile inputFile) {
+        return resourcePerspectives.as(Highlightable.class, inputFile);
+    }
+}