Merge branch '4.0.0-develop' into fix-bugs-tables-editing

Author: eduard13

README.md

@@ -43,8 +43,11 @@
 
 1. Check out this repository
 1. Open a folder with the project in the IntelliJ Ultimate using the `open` action button.
-1. Make sure that you on the latest develop branch (e.g `1.0.0-develop`)
-1. Right-click on the `build.gradle` file, choose "Import Gradle project" (you need to have Gradle plugin installed)
+1. Make sure that you on the latest develop branch (e.g `4.0.0-develop`)
+1. Right-click on the `build.gradle` file, choose "Import Gradle project" (if this is not exist look for "Build module '<root folder name>'") (you need to have Gradle plugin installed)
+1. Check if the right SDK version is used for the project.
+   - Current Java version for the project is **java 11**, so you should additionally download **SDK 11** and choose it in the module settings: `Right click by the project root > Open Module Settings > Project Settings > Project > Project SDK`
+   - Check if right SDK version is used for the Gradle plugin: `Intellij IDEA > Preferences... > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM` and choose your JDK.
 1. When the Gradle sections appeared in the right bar, navigate there and right-click `magento-2-php-storm-plugin > Tasks -> Intellij -> runIde`
 1. Click `Run "magento-2-php-storm-plugin"` to run the plugin. You should see a new instance of IntelliJ launched with the plugin installed. Make sure the plugin is enabled in IntelliJ settings and indexing is finished. Plugin features should be accessible at this point.
 

gradle-tasks/checkstyle/checkstyle.xml

@@ -330,4 +330,8 @@
         </module>
     </module>
     <module name="SuppressWarningsFilter"/>
+    <module name="RegexpHeader">
+        <property name="header" value="^\/\*\n \* Copyright © Magento, Inc."/>
+        <property name="fileExtensions" value="java"/>
+    </module>
 </module>

resources/META-INF/plugin.xml

@@ -246,6 +246,8 @@
         <defaultLiveTemplates file="/liveTemplates/MagentoPWA.xml"/>
 
         <postStartupActivity implementation="com.magento.idea.magento2plugin.project.startup.CheckIfMagentoPathIsValidActivity"/>
+
+        <errorHandler implementation="com.magento.idea.magento2plugin.project.diagnostic.DefaultErrorReportSubmitter"/>
     </extensions>
 
     <extensions defaultExtensionNs="com.jetbrains.php">

resources/fileTemplates/code/GitHub New Bug Issue Body Template.txt.ft

@@ -0,0 +1,33 @@
+**Describe the bug** (*)
+
+${BUG_DESCRIPTION}
+
+```
+${STACK_TRACE}
+```
+
+**To Reproduce** (*)
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior** (*)
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.
+
+**Please complete the following information:** (*)
+
+ - OS: [e.g. MacOS or Ubuntu Linux 20.04]
+ - PhpStorm/Intellij version: [e.g. 2019.3.3]
+ - Plugin Version: [e.g. 1.0.0]
+
+**Additional context**
+
+Add any other context about the problem here.

resources/fileTemplates/code/GitHub New Bug Issue Body Template.txt.html

@@ -68,4 +68,7 @@ common.template.id=Template ID
 common.template.label=Template Label
 common.template.filename=Template File Name
 common.template.subject=Email Subject
-common.template.type=Email Type
+common.template.type=Email Type
+common.diagnostic.reportButtonText=Report Me
+common.diagnostic.reportSubmittedTitle=The report is successfully submitted!
+common.diagnostic.reportSubmittedMessage=Thank you for submitting your report! We will check it as soon as possible.

resources/fileTemplates/code/Magento Entity Data Mapper.php.ft renamed to resources/fileTemplates/internal/Magento Entity Data Mapper.php.ft

@@ -0,0 +1,116 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.project.diagnostic;
+
+import com.intellij.ide.BrowserUtil;
+import com.intellij.ide.DataManager;
+import com.intellij.openapi.actionSystem.CommonDataKeys;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.diagnostic.ErrorReportSubmitter;
+import com.intellij.openapi.diagnostic.IdeaLoggingEvent;
+import com.intellij.openapi.diagnostic.SubmittedReportInfo;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.NlsActions;
+import com.intellij.util.Consumer;
+import com.magento.idea.magento2plugin.bundles.CommonBundle;
+import com.magento.idea.magento2plugin.project.diagnostic.github.GitHubNewIssueBodyBuilderUtil;
+import com.magento.idea.magento2plugin.project.diagnostic.github.GitHubNewIssueUrlBuilderUtil;
+import java.awt.Component;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import javax.swing.JOptionPane;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class DefaultErrorReportSubmitter extends ErrorReportSubmitter {
+
+    private static final String DEFAULT_ISSUE_TITLE = "Bug Report %date";
+    private static final String DEFAULT_ISSUE_DESCRIPTION
+            = "A clear and concise description of what the bug is.";
+    private final CommonBundle commonBundle;
+
+    /**
+     * Default error report submitter.
+     */
+    public DefaultErrorReportSubmitter() {
+        super();
+        commonBundle = new CommonBundle();
+    }
+
+    /**
+     * Open GitHub link with creation of the new bug report issue.
+     *
+     * @param events IdeaLoggingEvent[]
+     * @param additionalInfo String
+     * @param parentComponent Component
+     * @param consumer Consumer
+     *
+     * @return boolean
+     */
+    @Override
+    public boolean submit(
+            final @NotNull IdeaLoggingEvent[] events,
+            final @Nullable String additionalInfo,
+            final @NotNull Component parentComponent,
+            final @NotNull Consumer<? super SubmittedReportInfo> consumer
+    ) {
+        final DataContext context = DataManager.getInstance().getDataContext(parentComponent);
+        final Project project = CommonDataKeys.PROJECT.getData(context);
+
+        if (project == null) {
+            return false;
+        }
+        final StringBuilder stackTrace = new StringBuilder();
+
+        for (final IdeaLoggingEvent event : events) {
+            stackTrace.append(event.getThrowableText()).append("\r\n");
+        }
+
+        final String bugReportBody = GitHubNewIssueBodyBuilderUtil.buildNewBugReportBody(
+                project,
+                additionalInfo == null ? DEFAULT_ISSUE_DESCRIPTION : additionalInfo,
+                stackTrace.toString()
+        );
+
+        BrowserUtil.browse(
+                GitHubNewIssueUrlBuilderUtil.buildNewBugIssueUrl(
+                        getDefaultIssueTitle(),
+                        bugReportBody
+                )
+        );
+
+        ApplicationManager.getApplication().invokeLater(() -> {
+            JOptionPane.showMessageDialog(
+                    parentComponent,
+                    commonBundle.message("common.diagnostic.reportSubmittedMessage"),
+                    commonBundle.message("common.diagnostic.reportSubmittedTitle"),
+                    JOptionPane.INFORMATION_MESSAGE
+            );
+            consumer.consume(
+                    new SubmittedReportInfo(SubmittedReportInfo.SubmissionStatus.NEW_ISSUE)
+            );
+        });
+
+        return true;
+    }
+
+    @Override
+    public @NlsActions.ActionText @NotNull String getReportActionText() {
+        return commonBundle.message("common.diagnostic.reportButtonText");
+    }
+
+    /**
+     * Get default bug issue title.
+     *
+     * @return String
+     */
+    private String getDefaultIssueTitle() {
+        final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd");
+
+        return DEFAULT_ISSUE_TITLE.replace("%date", formatter.format(LocalDateTime.now()));
+    }
+}

resources/fileTemplates/code/Magento Entity Data Mapper.html.ft renamed to resources/fileTemplates/internal/Magento Entity Data Mapper.php.html

@@ -0,0 +1,49 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.project.diagnostic.github;
+
+import com.intellij.ide.fileTemplates.FileTemplate;
+import com.intellij.ide.fileTemplates.FileTemplateManager;
+import com.intellij.openapi.project.Project;
+import java.io.IOException;
+import java.util.Properties;
+import org.jetbrains.annotations.NotNull;
+
+public final class GitHubNewIssueBodyBuilderUtil {
+
+    private static final String BUR_REPORT_TEMPLATE = "GitHub New Bug Issue Body Template";
+
+    private GitHubNewIssueBodyBuilderUtil() {}
+
+    /**
+     * Build BUG report body.
+     *
+     * @param project Project
+     * @param bugDescription String
+     * @param stackTrace String
+     *
+     * @return String
+     */
+    public static String buildNewBugReportBody(
+            final @NotNull Project project,
+            final @NotNull String bugDescription,
+            final @NotNull String stackTrace
+    ) {
+        final FileTemplateManager templateManager = FileTemplateManager.getInstance(project);
+        final FileTemplate errorReportTemplate =
+                templateManager.getCodeTemplate(BUR_REPORT_TEMPLATE);
+
+        final Properties properties = new Properties();
+        properties.setProperty("BUG_DESCRIPTION", bugDescription);
+        properties.setProperty("STACK_TRACE", stackTrace);
+
+        try {
+            return errorReportTemplate.getText(properties);
+        } catch (IOException exception) {
+            return "";
+        }
+    }
+}