Merge branch '1.0.0-develop' into new-module-creation-add-license

Vitaliy · web-flow · commit 62fa18ca3a8a · 2020-04-01T20:42:21.000+03:00
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -0,0 +1,60 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Run automated tests
+
+on:
+  pull_request:
+    branches: [ master, 1.0.0-develop ]
+
+jobs:
+  build-linux:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Gradle wrapper
+      run: gradle wrapper
+    - name: Grant execute permission for gradlew
+      run: chmod +x gradlew
+    - name: Run automated tests
+      run: ./gradlew test -i
+
+  build-windows:
+
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Gradle wrapper
+        run: gradle wrapper
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Run automated tests
+        run: ./gradlew test -i
+
+  build-macos:
+
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Gradle wrapper
+        run: gradle wrapper
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Run automated tests
+        run: ./gradlew test -i
diff --git a/.gitignore b/.gitignore
@@ -50,3 +50,5 @@ out
 .idea-sandbox
 build
 gradle
+gradlew
+gradlew.bat
diff --git a/README.md b/README.md
@@ -7,12 +7,12 @@
 This is a plugin for Magento 2 development in the PhpStorm IDE. It is available via the [JetBrains Plugin Repository](https://plugins.jetbrains.com/plugin/8024)
 ## Installation
 
-1. Go to Settings / Preferences in the PhpStorm IDE
-2. Navigate to "Plugins"
-3. Click the "Browse repositories..." button and search for "Magento PhpStorm"
+1. Go to `Settings > Preferences` in the PhpStorm IDE
+2. Navigate to `Plugins`
+3. Click the `Browse repositories...` button and search for "Magento PhpStorm"
 4. Install the plugin and restart PhpStorm
-5. Go to Settings / Preferences / Languages & Frameworks / PHP / Magento in the PhpStorm IDE
-6. Check "Enable" and "OK" button. 
+5. Go to `Settings > Preferences > Languages & Frameworks > PHP > Magento` in the PhpStorm IDE
+6. Check `Enable` and `OK` button.
 
 ## Works with
 * PhpStorm >= 2019.3.3
@@ -21,20 +21,38 @@ This is a plugin for Magento 2 development in the PhpStorm IDE. It is available
 ## Features
 
 * Configuration smart completion and references for XML/JavaScript files
-* "Navigate to configuration" reference in scope of class/interface
-* "Go to plugin" reference in scope of class/interface and method
-* "Navigate to Web API configuration" reference in scope of class/interface and method
+* `Navigate to configuration` reference in scope of class/interface
+* `Go to plugin` reference in scope of class/interface and method
+* `Navigate to Web API configuration` reference in scope of class/interface and method
 * Plugin class methods generation
 * Plugin declaration inspection
-* RequireJs reference navigation and completion
+* RequireJS reference navigation and completion
 * MFTF reference navigation and completion
 * GraphQL navigation line markers
 * Code generation
 * Inspections for XML configuration
 
+## Setting up development environment
+
+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"
+1. When the Gradle sections appeared in the right bar, navigate there and right-click `magento-2-php-storm-plguin > 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.
+
+## How to contribute
+1) Start with looking into [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/projects/2). Any ticket in `Ready for Development` and `Good First Issue` columns are a good candidates to start.
+2) Didn't satisfy your requirements? [Create a new issue](https://github.com/magento/magento2-phpstorm-plugin/issues/new). It can be for example:
+   - **Bug report** - Found a bug in the code? Let us know!
+   - **Enhancement** - Know how to improve existing functionality? Open an issue describe how to enhance the plugin.
+   - **New feature proposal** - Know how to make a killer feature? Do not hesitate to submit your proposal.
+3) The issue will appear in the `Ready for Grooming` column of the [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/projects/2). Once it will be discussed and approved the issue will be ready for development.
+
+### <img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" width="20"> Join [#phpstorm-plugin](https://magentocommeng.slack.com/archives/C010C2LUCEA) Slack channel for more details.
+
+
 ## License
 Each Magento source file included in this distribution is licensed under OSL-3.0 license.
 
 Please see [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/master/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).
-
-### <img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" width="20"> Join [#phpstorm-plugin](https://magentocommeng.slack.com/archives/C010C2LUCEA) channel for more details.
diff --git a/build.gradle b/build.gradle
@@ -33,6 +33,12 @@ intellij {
 }
 
 sourceSets {
-    main.java.srcDirs = ['src']
-    main.resources.srcDirs = ['resources']
+    main {
+        java.srcDirs 'src'
+        resources.srcDir 'resources'
+    }
+    test {
+        java.srcDir 'tests'
+        resources.srcDir 'testData'
+    }
 }
diff --git a/gradlew b/gradlew
diff --git a/gradlew.bat b/gradlew.bat
diff --git a/src/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspection.java b/src/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspection.java
@@ -15,19 +15,21 @@
 import org.jetbrains.annotations.NotNull;
 
 public class CacheableFalseInDefaultLayoutInspection extends XmlSuppressableInspectionTool {
+    public static final String CacheDisableProblemDescription = "Cacheable false attribute on the default layout will disable cache site-wide";
+
     @NotNull
     @Override
     public PsiElementVisitor buildVisitor(final @NotNull ProblemsHolder holder, final boolean isOnTheFly) {
         return new XmlElementVisitor() {
-            private static final String CacheDisableProblemDescription = "Cacheable false attribute on the default layout will disable cache site-wide";
             @Override
             public void visitXmlAttribute(XmlAttribute attribute) {
                 String fileName = holder.getFile().getName();
                 if (!fileName.equals(LayoutXml.DefaultFileName)) return;
                 final String text = attribute.getValue();
                 final String attributeName = attribute.getName();
                 if (!attributeName.equals(LayoutXml.CacheableAttributeName)) return;
-                if (!attribute.getParent().getName().equals(LayoutXml.BlockAttributeTagName)) return;
+                if (!attribute.getParent().getName().equals(LayoutXml.BlockAttributeTagName)
+                && !attribute.getParent().getName().equals(LayoutXml.ReferenceBlockAttributeTagName)) return;
                 if (text == null) return;
                 if (text.equals(LayoutXml.CacheableAttributeFalseValue)) {
                     holder.registerProblem(attribute, CacheDisableProblemDescription,
diff --git a/src/com/magento/idea/magento2plugin/magento/files/LayoutXml.java b/src/com/magento/idea/magento2plugin/magento/files/LayoutXml.java
@@ -9,4 +9,5 @@ public class LayoutXml {
     public static String CacheableAttributeName = "cacheable";
     public static String CacheableAttributeFalseValue = "false";
     public static String BlockAttributeTagName = "block";
+    public static String ReferenceBlockAttributeTagName = "referenceBlock";
 }
diff --git a/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlock/default.xml b/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlock/default.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page>
+    <body>
+        <referenceBlock name="footer_links" <warning descr="Cacheable false attribute on the default layout will disable cache site-wide">cacheable="false"</warning>/>
+    </body>
+</page>
diff --git a/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlockNotDefaultLayout/some_layout_index.xml b/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlockNotDefaultLayout/some_layout_index.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page>
+    <body>
+        <referenceBlock name="footer_links" cacheable="false" />
+    </body>
+</page>
diff --git a/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withoutCacheableFalseBlock/default.xml b/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withoutCacheableFalseBlock/default.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page>
+    <body>
+        <referenceBlock name="footer_links"/>
+    </body>
+</page>
diff --git a/tests/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspectionTest.java b/tests/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspectionTest.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.inspections.xml;
+
+import com.magento.idea.magento2plugin.magento.files.LayoutXml;
+import com.intellij.testFramework.fixtures.BasePlatformTestCase;
+import java.io.File;
+
+//tested referenceBlock only as block tag is Special markup for the tests
+//@see https://www.jetbrains.org/intellij/sdk/docs/basics/testing_plugins/test_project_and_testdata_directories.html
+public class CacheableFalseInDefaultLayoutInspectionTest extends BasePlatformTestCase {
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.enableInspections(CacheableFalseInDefaultLayoutInspection.class);
+    }
+
+    @Override
+    protected String getTestDataPath() {
+        return new File("testData/inspections/xml/"
+                + getClass().getSimpleName().replace("Test", "")).getAbsolutePath();
+    }
+
+    @Override
+    protected boolean isWriteActionRequired() {
+        return false;
+    }
+
+    public void testWithCacheableFalseBlock() throws Exception {
+        myFixture.configureByFile(getTestName(true) + "/" + LayoutXml.DefaultFileName);
+        myFixture.testHighlighting(true, false, false);
+    }
+
+    public void testWithoutCacheableFalseBlock() throws Exception {
+        myFixture.configureByFile(getTestName(true) + "/" + LayoutXml.DefaultFileName);
+        myFixture.testHighlighting(true, true, true);
+    }
+
+    public void testWithCacheableFalseBlockNotDefaultLayout() throws Exception {
+        myFixture.configureByFile(getTestName(true) + "/" + "some_layout_index.xml");
+        myFixture.testHighlighting(true, true, true);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,12 @@ intellij {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`sourceSets {`
`36`		`- main.java.srcDirs = ['src']`
`37`		`- main.resources.srcDirs = ['resources']`
	`36`	`+ main {`
	`37`	`+ java.srcDirs 'src'`
	`38`	`+ resources.srcDir 'resources'`
	`39`	`+ }`
	`40`	`+ test {`
	`41`	`+ java.srcDir 'tests'`
	`42`	`+ resources.srcDir 'testData'`
	`43`	`+ }`
`38`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,5 @@ public class LayoutXml {`
`9`	`9`	`public static String CacheableAttributeName = "cacheable";`
`10`	`10`	`public static String CacheableAttributeFalseValue = "false";`
`11`	`11`	`public static String BlockAttributeTagName = "block";`
	`12`	`+ public static String ReferenceBlockAttributeTagName = "referenceBlock";`
`12`	`13`	`}`