Reduce direct usages of PCM.getCurrent in scanning actions (#679)

Author: jshiell

src/main/java/org/infernus/idea/checkstyle/CheckStyleInspection.java

@@ -14,6 +14,7 @@
 import org.infernus.idea.checkstyle.checker.Problem;
 import org.infernus.idea.checkstyle.checker.ScannableFile;
 import org.infernus.idea.checkstyle.config.ConfigurationLocationSource;
+import org.infernus.idea.checkstyle.config.PluginConfiguration;
 import org.infernus.idea.checkstyle.config.PluginConfigurationManager;
 import org.infernus.idea.checkstyle.csapi.SeverityLevel;
 import org.infernus.idea.checkstyle.exception.CheckStylePluginParseException;
@@ -68,11 +69,13 @@ public ProblemDescriptor[] checkFile(@NotNull final PsiFile psiFile,
         }
 
         final Module module = moduleOf(psiFile);
+        final PluginConfiguration pluginConfiguration = configurationManager(manager.getProject()).getCurrent();
+
         List<ScannableFile> scannableFiles = ScannableFile.createAndValidate(
                 singletonList(psiFile),
-                manager.getProject(),
                 module,
-                null);
+                null,
+                pluginConfiguration);
         if (scannableFiles.isEmpty()) {
             LOG.debug("Inspection has been cancelled as file is not scannable: " + psiFile.getName());
             return noProblemsFound(manager);
@@ -82,7 +85,7 @@ public ProblemDescriptor[] checkFile(@NotNull final PsiFile psiFile,
             return asProblemDescriptors(
                     asyncResultOf(() -> {
                         try {
-                            return inspectFile(psiFile, scannableFiles, module, manager);
+                            return inspectFile(psiFile, scannableFiles, module, manager, pluginConfiguration);
                         } finally {
                             scannableFiles.forEach(ScannableFile::deleteIfRequired);
                         }
@@ -117,7 +120,8 @@ private Module moduleOf(@NotNull final PsiFile psiFile) {
     private List<Problem> inspectFile(@NotNull final PsiFile psiFile,
                                       @NotNull final List<ScannableFile> scannableFiles,
                                       @Nullable final Module module,
-                                      @NotNull final InspectionManager manager) {
+                                      @NotNull final InspectionManager manager,
+                                      @NotNull final PluginConfiguration pluginConfiguration) {
         LOG.debug("Inspection has been invoked for " + psiFile.getName());
 
         ArrayList<ConfigurationLocation> configurationLocations = new ArrayList<>();
@@ -131,7 +135,7 @@ private List<Problem> inspectFile(@NotNull final PsiFile psiFile,
                     .filter(not(ConfigurationLocation::isBlocked))
                     .map(configurationLocation -> checkerFactory(psiFile.getProject())
                             .checker(module, configurationLocation)
-                            .map(checker -> checker.scan(scannableFiles, configurationManager(psiFile.getProject()).getCurrent().isSuppressErrors()))
+                            .map(checker -> checker.scan(scannableFiles, pluginConfiguration.isSuppressErrors()))
                             .map(results -> results.get(psiFile))
                             .map(this::dropIgnoredProblems)
                             .orElse(NO_PROBLEMS_FOUND)

src/main/java/org/infernus/idea/checkstyle/actions/ScanCurrentFile.java

@@ -87,7 +87,7 @@ protected boolean validForScanning(final VirtualFile selectedFile,
         }
 
         final PluginConfiguration pluginConfiguration = configurationManager(project).getCurrent();
-        if (!isFileValidAgainstScanScope(project, pluginConfiguration, selectedFile)) {
+        if (!isFileValidAgainstScanScope(project, selectedFile, pluginConfiguration.getScanScope())) {
             return false;
         }
 
@@ -113,10 +113,8 @@ private static PsiFile psiFileFor(@NotNull final Project project,
     }
 
     private static boolean isFileValidAgainstScanScope(@NotNull final Project project,
-                                                       @NotNull final PluginConfiguration pluginConfiguration,
-                                                       @NotNull final VirtualFile selectedFile) {
-        final ScanScope scanScope = pluginConfiguration.getScanScope();
-
+                                                       @NotNull final VirtualFile selectedFile,
+                                                       @NotNull ScanScope scanScope) {
         if (scanScope != ScanScope.Everything) {
             return ReadAction.compute(() -> {
                 final ProjectFileIndex projectFileIndex = ProjectFileIndex.getInstance(project);

src/main/java/org/infernus/idea/checkstyle/checker/ScanFiles.java

@@ -11,6 +11,7 @@
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiManager;
 import org.infernus.idea.checkstyle.config.ConfigurationLocationSource;
+import org.infernus.idea.checkstyle.config.PluginConfiguration;
 import org.infernus.idea.checkstyle.config.PluginConfigurationManager;
 import org.infernus.idea.checkstyle.exception.CheckStylePluginException;
 import org.infernus.idea.checkstyle.exception.CheckStylePluginParseException;
@@ -185,13 +186,14 @@ private List<ScanResult> checkFiles(final Module module,
                                         final List<ConfigurationLocation> configurationLocations) {
         final List<ScannableFile> scannableFiles = new ArrayList<>();
         try {
-            scannableFiles.addAll(ScannableFile.createAndValidate(filesToScan, module.getProject(), module, this.overrideConfigLocation));
+            PluginConfiguration pluginConfiguration = configurationManager().getCurrent();
+            scannableFiles.addAll(ScannableFile.createAndValidate(filesToScan, module, this.overrideConfigLocation, pluginConfiguration));
 
             final List<ScanResult> scanResults = new ArrayList<>();
             for (ConfigurationLocation configurationLocation : configurationLocations) {
                 var checker = checkerFactory().checker(module, configurationLocation);
                 if (checker.isPresent()) {
-                    var problems = checker.get().scan(scannableFiles, configurationManager().getCurrent().isSuppressErrors());
+                    var problems = checker.get().scan(scannableFiles, pluginConfiguration.isSuppressErrors());
                     scanResults.add(new ScanResult(ConfigurationLocationResult.of(configurationLocation, PRESENT), module, problems));
                 } else {
                     throw new CheckStylePluginException("Could not create checker for location " + configurationLocation + ", see logs for details.");

src/main/java/org/infernus/idea/checkstyle/checker/ScannableFile.java

@@ -5,15 +5,14 @@
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.fileEditor.FileDocumentManager;
 import com.intellij.openapi.module.Module;
-import com.intellij.openapi.project.Project;
 import com.intellij.openapi.project.ProjectUtil;
 import com.intellij.openapi.roots.ModuleRootManager;
 import com.intellij.openapi.util.ThrowableComputable;
 import com.intellij.openapi.vfs.LocalFileSystem;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiJavaFile;
-import org.infernus.idea.checkstyle.config.PluginConfigurationManager;
+import org.infernus.idea.checkstyle.config.PluginConfiguration;
 import org.infernus.idea.checkstyle.model.ConfigurationLocation;
 import org.infernus.idea.checkstyle.util.TempDirProvider;
 import org.jetbrains.annotations.NotNull;
@@ -72,25 +71,21 @@ public ScannableFile(@NotNull final PsiFile psiFile, @Nullable final Module modu
     }
 
     public static List<ScannableFile> createAndValidate(@NotNull final Collection<PsiFile> psiFiles,
-                                                        @NotNull final Project project,
                                                         @Nullable final Module module,
-                                                        @Nullable final ConfigurationLocation overrideConfigLocation) {
+                                                        @Nullable final ConfigurationLocation overrideConfigLocation,
+                                                        @NotNull final PluginConfiguration pluginConfiguration) {
         ThrowableComputable<List<ScannableFile>, RuntimeException> action = () -> psiFiles.stream()
                 .filter(currentFile -> PsiFileValidator.isScannable(
                         currentFile,
                         module,
-                        configurationManager(project).getCurrent(),
+                        pluginConfiguration,
                         overrideConfigLocation))
                 .map(currentFile -> ScannableFile.create(currentFile, module))
                 .filter(Objects::nonNull)
                 .collect(Collectors.toCollection(CopyOnWriteArrayList::new));
         return ReadAction.compute(action);
     }
 
-    private static PluginConfigurationManager configurationManager(final Project project) {
-        return project.getService(PluginConfigurationManager.class);
-    }
-
     @Nullable
     private static ScannableFile create(@NotNull final PsiFile psiFile, @Nullable final Module module) {
         try {