SONARPY-201 Remove PythonFile.file()

pynicolas · pynicolas · commit 46bbdae8e781 · 2017-05-05T12:54:24.000+02:00
diff --git a/python-checks/src/main/java/org/sonar/python/checks/MissingNewlineAtEndOfFileCheck.java b/python-checks/src/main/java/org/sonar/python/checks/MissingNewlineAtEndOfFileCheck.java
@@ -41,7 +41,7 @@ public class MissingNewlineAtEndOfFileCheck extends PythonCheck {
   public void visitFile(@Nullable AstNode astNode) {
     String fileContent = getContext().pythonFile().content();
     if (fileContent.length() > 0 && !fileContent.endsWith("\n") && !fileContent.endsWith("\r")){
-      addFileIssue(String.format(MESSAGE, getContext().pythonFile().file().getName()));
+      addFileIssue(String.format(MESSAGE, getContext().pythonFile().fileName()));
     }
   }
 
diff --git a/python-checks/src/main/java/org/sonar/python/checks/ModuleNameCheck.java b/python-checks/src/main/java/org/sonar/python/checks/ModuleNameCheck.java
@@ -49,7 +49,7 @@ public class ModuleNameCheck extends PythonCheck {
 
   @Override
   public void visitFile(@Nullable AstNode astNode) {
-    String fileName = getContext().pythonFile().file().getName();
+    String fileName = getContext().pythonFile().fileName();
     int dotIndex = fileName.lastIndexOf('.');
     if (dotIndex > 0) {
       String moduleName = fileName.substring(0, dotIndex);
diff --git a/python-checks/src/main/java/org/sonar/python/checks/TooManyLinesInFileCheck.java b/python-checks/src/main/java/org/sonar/python/checks/TooManyLinesInFileCheck.java
@@ -60,7 +60,7 @@ public void visitNode(AstNode astNode) {
 
     if (lines > maximum) {
       String message = "File \"{0}\" has {1} lines, which is greater than {2} authorized. Split it into smaller files.";
-      addFileIssue(MessageFormat.format(message, getContext().pythonFile().file().getName(), lines, maximum));
+      addFileIssue(MessageFormat.format(message, getContext().pythonFile().fileName(), lines, maximum));
     }
   }
 }
diff --git a/python-squid/src/main/java/org/sonar/python/PythonFile.java b/python-squid/src/main/java/org/sonar/python/PythonFile.java
@@ -19,13 +19,10 @@
  */
 package org.sonar.python;
 
-import java.io.File;
-
 public interface PythonFile {
 
   String content();
 
-  @Deprecated
-  File file();
+  String fileName();
 
 }
diff --git a/python-squid/src/main/java/org/sonar/python/TestPythonVisitorRunner.java b/python-squid/src/main/java/org/sonar/python/TestPythonVisitorRunner.java
@@ -71,8 +71,8 @@ public String content() {
     }
 
     @Override
-    public File file() {
-      return file;
+    public String fileName() {
+      return file.getName();
     }
 
   }
diff --git a/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonHighlighter.java b/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonHighlighter.java
@@ -86,11 +86,12 @@ public class PythonHighlighter extends PythonVisitor {
 
   private NewHighlighting newHighlighting;
 
-  private final SensorContext context;
   private Set<Token> docStringTokens;
 
-  public PythonHighlighter(SensorContext context) {
-    this.context = context;
+  public PythonHighlighter(SensorContext context, InputFile inputFile) {
+    docStringTokens = new HashSet<>();
+    newHighlighting = context.newHighlighting();
+    newHighlighting.onFile(inputFile);
   }
 
   @Override
@@ -102,14 +103,6 @@ public Set<AstNodeType> subscribedKinds() {
     );
   }
 
-  @Override
-  public void visitFile(@Nullable AstNode astNode) {
-    docStringTokens = new HashSet<>();
-    newHighlighting = context.newHighlighting();
-    InputFile inputFile = context.fileSystem().inputFile(context.fileSystem().predicates().is(getContext().pythonFile().file().getAbsoluteFile()));
-    newHighlighting.onFile(inputFile);
-  }
-
   @Override
   public void visitNode(AstNode astNode) {
     if (astNode.is(PythonGrammar.FILE_INPUT)) {
diff --git a/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonScanner.java b/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonScanner.java
@@ -99,7 +99,7 @@ private void scanFile(InputFile inputFile) {
       saveIssues(inputFile, check, check.scanFileForIssues(visitorContext));
     }
 
-    new PythonHighlighter(context).scanFile(visitorContext);
+    new PythonHighlighter(context, inputFile).scanFile(visitorContext);
   }
 
   private void saveIssues(InputFile inputFile, PythonCheck check, List<PreciseIssue> issues) {
diff --git a/sonar-python-plugin/src/main/java/org/sonar/plugins/python/SonarQubePythonFile.java b/sonar-python-plugin/src/main/java/org/sonar/plugins/python/SonarQubePythonFile.java
@@ -46,8 +46,8 @@ public String content() {
   }
 
   @Override
-  public File file() {
-    return file;
+  public String fileName() {
+    return file.getName();
   }
 
 }
diff --git a/sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonHighlighterTest.java b/sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonHighlighterTest.java
@@ -49,7 +49,7 @@ public void scanFile() {
     context = SensorContextTester.create(new File(dir));
     context.fileSystem().add(inputFile);
 
-    PythonHighlighter pythonHighlighter = new PythonHighlighter(context);
+    PythonHighlighter pythonHighlighter = new PythonHighlighter(context, inputFile);
     TestPythonVisitorRunner.scanFile(file, pythonHighlighter);
   }
 

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public class MissingNewlineAtEndOfFileCheck extends PythonCheck {`
`41`	`41`	`public void visitFile(@Nullable AstNode astNode) {`
`42`	`42`	`String fileContent = getContext().pythonFile().content();`
`43`	`43`	`if (fileContent.length() > 0 && !fileContent.endsWith("\n") && !fileContent.endsWith("\r")){`
`44`		`- addFileIssue(String.format(MESSAGE, getContext().pythonFile().file().getName()));`
	`44`	`+ addFileIssue(String.format(MESSAGE, getContext().pythonFile().fileName()));`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public void visitNode(AstNode astNode) {`
`60`	`60`
`61`	`61`	`if (lines > maximum) {`
`62`	`62`	`String message = "File \"{0}\" has {1} lines, which is greater than {2} authorized. Split it into smaller files.";`
`63`		`- addFileIssue(MessageFormat.format(message, getContext().pythonFile().file().getName(), lines, maximum));`
	`63`	`+ addFileIssue(MessageFormat.format(message, getContext().pythonFile().fileName(), lines, maximum));`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,8 +71,8 @@ public String content() {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`@Override`
`74`		`- public File file() {`
`75`		`- return file;`
	`74`	`+ public String fileName() {`
	`75`	`+ return file.getName();`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ private void scanFile(InputFile inputFile) {`
`99`	`99`	`saveIssues(inputFile, check, check.scanFileForIssues(visitorContext));`
`100`	`100`	`}`
`101`	`101`
`102`		`- new PythonHighlighter(context).scanFile(visitorContext);`
	`102`	`+ new PythonHighlighter(context, inputFile).scanFile(visitorContext);`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`private void saveIssues(InputFile inputFile, PythonCheck check, List<PreciseIssue> issues) {`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ public String content() {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`@Override`
`49`		`- public File file() {`
`50`		`- return file;`
	`49`	`+ public String fileName() {`
	`50`	`+ return file.getName();`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public void scanFile() {`
`49`	`49`	`context = SensorContextTester.create(new File(dir));`
`50`	`50`	`context.fileSystem().add(inputFile);`
`51`	`51`
`52`		`- PythonHighlighter pythonHighlighter = new PythonHighlighter(context);`
	`52`	`+ PythonHighlighter pythonHighlighter = new PythonHighlighter(context, inputFile);`
`53`	`53`	`TestPythonVisitorRunner.scanFile(file, pythonHighlighter);`
`54`	`54`	`}`
`55`	`55`