Add action to analyse context menu (#669)

Author: jshiell

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

@@ -0,0 +1,31 @@
+package org.infernus.idea.checkstyle.actions;
+
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.Presentation;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import static com.intellij.openapi.actionSystem.CommonDataKeys.VIRTUAL_FILE;
+
+/**
+ * Action to execute a CheckStyle scan on the current editor file.
+ */
+public class AnalyseCurrentFile extends ScanCurrentFile {
+
+    @Override
+    protected @Nullable VirtualFile selectedFile(@NotNull final Project project,
+                                                 @NotNull final AnActionEvent event) {
+        return event.getDataContext().getData(VIRTUAL_FILE);
+    }
+
+    @Override
+    public void update(@NotNull final AnActionEvent event) {
+        // update event does not expose selected file, so we always enable
+        final Presentation presentation = event.getPresentation();
+        project(event).ifPresentOrElse(
+                project -> presentation.setEnabled(!staticScanner(project).isScanInProgress()),
+                () -> presentation.setEnabled(false));
+    }
+}

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

@@ -43,13 +43,12 @@ public void actionPerformed(final @NotNull AnActionEvent event) {
                 final ToolWindow toolWindow = toolWindow(project);
                 toolWindow.activate(() -> {
                     try {
+                        final VirtualFile selectedFile = selectedFile(project, event);
+
                         setProgressText(toolWindow, "plugin.status.in-progress.current");
 
                         final ConfigurationLocation overrideIfExists = getSelectedOverride(toolWindow);
-                        final VirtualFile selectedFile = getSelectedValidFile(
-                                project,
-                                overrideIfExists);
-                        if (selectedFile != null) {
+                        if (validForScanning(selectedFile, project, overrideIfExists)) {
                             staticScanner(project).asyncScanFiles(
                                     singletonList(selectedFile),
                                     overrideIfExists);
@@ -68,32 +67,30 @@ public void actionPerformed(final @NotNull AnActionEvent event) {
         });
     }
 
-    @Nullable
-    private VirtualFile getSelectedValidFile(
-            final Project project,
-            final @Nullable ConfigurationLocation overrideIfExists) {
-        final VirtualFile selectedFile = getSelectedFile(project);
+    protected @Nullable VirtualFile selectedFile(@NotNull final Project project,
+                                                 @NotNull final AnActionEvent event) {
+        return getSelectedFile(project);
+    }
+
+    protected boolean validForScanning(final VirtualFile selectedFile,
+                                       final @NotNull Project project,
+                                       final @Nullable ConfigurationLocation overrideIfExists) {
         if (selectedFile == null) {
-            return null;
+            return false;
         }
 
         final PluginConfiguration pluginConfiguration = configurationManager(project).getCurrent();
         if (!isFileValidAgainstScanScope(project, pluginConfiguration, selectedFile)) {
-            return null;
+            return false;
         }
 
         final List<NamedScope> namedScopes = getNamedScopesToCheck(pluginConfiguration, overrideIfExists);
         if (!namedScopes.isEmpty() && namedScopes.stream().map(NamedScope::getValue).allMatch(Objects::isNull)) {
-            return selectedFile;
+            return true;
         }
 
-        final boolean isFileInScope = namedScopes.stream()
+        return namedScopes.stream()
                 .anyMatch((NamedScope namedScope) -> NamedScopeHelper.isFileInScope(psiFileFor(project, selectedFile), namedScope));
-        if (isFileInScope) {
-            return selectedFile;
-        }
-
-        return null;
     }
 
     @NotNull
@@ -171,7 +168,9 @@ public void update(final @NotNull AnActionEvent event) {
         final Presentation presentation = event.getPresentation();
 
         project(event).ifPresentOrElse(project -> {
-            if (getSelectedFile(project) != null) {
+            final VirtualFile selectedFile = selectedFile(project, event);
+            final ConfigurationLocation overrideIfExists = getSelectedOverride(toolWindow(project));
+            if (selectedFile != null && validForScanning(selectedFile, project, overrideIfExists)) {
                 presentation.setEnabled(!staticScanner(project).isScanInProgress());
             } else {
                 presentation.setEnabled(false);

src/main/resources/META-INF/plugin.xml

@@ -104,6 +104,15 @@
     </extensions>
 
     <actions>
+        <action
+                id="AnalyseCurrentFileAction"
+                class="org.infernus.idea.checkstyle.actions.AnalyseCurrentFile"
+                text="Scan with Checkstyle..."
+                description="Scan the current file with the configured rules for Checkstyle">
+
+            <add-to-group group-id="AnalyzeMenu" anchor="last"/>
+        </action>
+
         <group id="CheckStylePluginTreeActions" text="Filter" popup="true">
             <action id="CheckStyleScrollToSourceAction"
                     class="org.infernus.idea.checkstyle.actions.ScrollToSource"