Merge pull request #62 from picimako/100

v1.0.0

Author: picimako

CHANGELOG.md

@@ -4,6 +4,11 @@
 
 ## [Unreleased]
 
+## [1.0.0]
+### Changed
+- New support range of IDEs: 2022.3-2023.3
+- Various code optimizations based on new IntelliJ Platform inspections.
+
 ## [0.12.0]
 ### Added
 - [#52](https://github.com/picimako/mockitools/issues/52): Added code completion for parameters of methods in the `Mockito` class that need mock objects to be passed in (e.g. `reset()` or `verifyNoMoreInteractions()`).

gradle.properties

@@ -2,15 +2,15 @@
 
 pluginGroup = com.picimako.mockitools
 pluginName = Mockitools
-pluginVersion = 0.12.0
+pluginVersion = 1.0.0
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
-pluginSinceBuild = 222
-pluginUntilBuild = 232.*
+pluginSinceBuild = 223
+pluginUntilBuild = 233.*
 
 # IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
 platformType = IC
-platformVersion = 2022.2
+platformVersion = 2022.3
 
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
 # Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22

gradle/libs.versions.toml

@@ -5,7 +5,7 @@ annotations = "24.0.1"
 # plugins
 kotlin = "1.8.22"
 changelog = "2.1.0"
-gradleIntelliJPlugin = "1.14.2"
+gradleIntelliJPlugin = "1.15.0"
 lombok = "8.1.0"
 
 [libraries]

src/main/java/com/picimako/mockitools/Convention.java

@@ -0,0 +1,23 @@
+//Copyright 2023 Tamás Balog. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
+
+package com.picimako.mockitools;
+
+import static com.picimako.mockitools.MockitoQualifiedNames.ORG_MOCKITO_BDDMOCKITO;
+import static com.picimako.mockitools.MockitoQualifiedNames.ORG_MOCKITO_INORDER;
+import static com.picimako.mockitools.MockitoQualifiedNames.ORG_MOCKITO_MOCKITO;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Either standard {@code Mockito} and {@code InOrder} based stubbing and verification,
+ * or BDD-style via {@code BDDMockito}.
+ */
+@Getter
+@RequiredArgsConstructor
+public enum Convention {
+    MOCKITO(ORG_MOCKITO_MOCKITO + " / " + ORG_MOCKITO_INORDER),
+    BDD_MOCKITO(ORG_MOCKITO_BDDMOCKITO);
+
+    private final String classFqn;
+}

src/main/java/com/picimako/mockitools/EnforceConventionUtil.java

@@ -0,0 +1,52 @@
+//Copyright 2023 Tamás Balog. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
+
+package com.picimako.mockitools;
+
+import com.intellij.codeInsight.daemon.HighlightDisplayKey;
+import com.intellij.profile.codeInspection.InspectionProfileManager;
+import com.intellij.psi.PsiElement;
+import com.picimako.mockitools.inspection.stubbing.EnforceConventionInspection;
+
+/**
+ * Helpers for checking which {@link Convention} is enforced.
+ */
+public final class EnforceConventionUtil {
+
+    /**
+     * @see EnforceConventionInspection#SHORT_NAME
+     */
+    public static final String ENFORCE_CONVENTION_INSPECTION_SHORT_NAME = "EnforceConvention";
+
+    /**
+     * Returns whether {@link EnforceConventionInspection} is enabled in the inspection profile currently active in the current project,
+     * and {@link Convention#MOCKITO} is being enforced.
+     *
+     * @param methodCall the method call the intention availability is being checked
+     */
+    public static boolean isMockitoEnforced(PsiElement methodCall) {
+        return isEnforced(methodCall, Convention.MOCKITO);
+    }
+
+    /**
+     * Returns whether {@link EnforceConventionInspection} is enabled in the inspection profile currently active in the current project,
+     * and {@link Convention#BDD_MOCKITO} is being enforced.
+     *
+     * @param methodCall the method call the intention availability is being checked
+     */
+    public static boolean isBDDMockitoEnforced(PsiElement methodCall) {
+        return isEnforced(methodCall, Convention.BDD_MOCKITO);
+    }
+
+    private static boolean isEnforced(PsiElement methodCall, Convention convention) {
+        var profile = InspectionProfileManager.getInstance(methodCall.getProject()).getCurrentProfile();
+        if (profile.isToolEnabled(HighlightDisplayKey.find(ENFORCE_CONVENTION_INSPECTION_SHORT_NAME))) {
+            var enforceConvention = (EnforceConventionInspection) profile.getUnwrappedTool(ENFORCE_CONVENTION_INSPECTION_SHORT_NAME, methodCall);
+            return enforceConvention != null && enforceConvention.conventionToEnforce == convention;
+        }
+        return false;
+    }
+
+    private EnforceConventionUtil() {
+        //Utility class
+    }
+}

src/main/java/com/picimako/mockitools/completion/MockCompletionContributor.java

@@ -41,7 +41,7 @@
  *
  * @since 0.12.0
  */
-public class MockCompletionContributor extends CompletionContributor {
+final class MockCompletionContributor extends CompletionContributor {
 
     private static final Pattern MOCKITO_VERIFY_PATTERN = Pattern.compile("Mockito\\.(verifyNoInteractions|verifyNoMoreInteractions|verifyZeroInteractions)");
     private static final Pattern VERIFY_PATTERN = Pattern.compile("verifyNoInteractions|verifyNoMoreInteractions|verifyZeroInteractions");

src/main/java/com/picimako/mockitools/inspection/CallOnMockitoResetInspection.java

@@ -18,7 +18,7 @@
  * @see <a href="https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/Mockito.html#resetting_mocks">Resetting mocks</a>
  * @since 0.1.0
  */
-public class CallOnMockitoResetInspection extends MockitoolsBaseInspection {
+final class CallOnMockitoResetInspection extends MockitoolsBaseInspection {
 
     @Override
     protected void checkMethodCallExpression(PsiMethodCallExpression expression, @NotNull ProblemsHolder holder) {

src/main/java/com/picimako/mockitools/inspection/captor/CaptorFieldInitializationInspection.java

@@ -32,7 +32,7 @@
  * @see <a href="https://www.baeldung.com/mockito-annotations">Baeldung - Mockito Annotations</a>
  * @since 0.1.0
  */
-public class CaptorFieldInitializationInspection extends MockitoolsBaseInspection {
+final class CaptorFieldInitializationInspection extends MockitoolsBaseInspection {
 
     @Override
     public @NotNull PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly, @NotNull LocalInspectionToolSession session) {

src/main/java/com/picimako/mockitools/inspection/captor/CaptorFieldOfTypeArgumentCaptorInspection.java

@@ -34,7 +34,7 @@
  *
  * @since 0.1.0
  */
-public class CaptorFieldOfTypeArgumentCaptorInspection extends MockitoolsBaseInspection {
+final class CaptorFieldOfTypeArgumentCaptorInspection extends MockitoolsBaseInspection {
 
     @Override
     public @NotNull PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly, @NotNull LocalInspectionToolSession session) {

src/main/java/com/picimako/mockitools/inspection/consecutive/SimplifyConsecutiveReturnCallsInspection.java

@@ -28,7 +28,7 @@
  *
  * @since 0.3.0
  */
-public class SimplifyConsecutiveReturnCallsInspection extends SimplifyConsecutiveCallsInspectionBase {
+final class SimplifyConsecutiveReturnCallsInspection extends SimplifyConsecutiveCallsInspectionBase {
     private static final List<ConsecutiveCallAnalysisDescriptor> RETURN_DESCRIPTORS = List.of(
         Builder.forMockito(DO_RETURN)
             .inCallChainsBeginningWith(DO_RETURN, DO_THROW, "doNothing", "doAnswer", "doCallRealMethod").build(),